az search service
Manage Azure Search services.
Commands
| az search service create |
Creates a Search service in the given resource group. |
| az search service delete |
Deletes a Search service in the given resource group, along with its associated resources. |
| az search service list |
Gets a list of all Search services in the given resource group. |
| az search service show |
Gets the Search service with the given name in the given resource group. |
| az search service update |
Update partition and replica of the given search service. |
az search service create
Creates a Search service in the given resource group.
az search service create --name
--resource-group
--sku
[--location]
[--partition-count]
[--replica-count]
[--subscription]Required Parameters
The name of the search service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The SKU of the search service, which determines price tier and capacity limits.
Optional Parameters
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Number of partitions in the search service.
Number of replicas in the search service.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az search service delete
Deletes a Search service in the given resource group, along with its associated resources.
az search service delete --name
--resource-group
[--subscription]
[--yes]Required Parameters
The name of the search service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az search service list
Gets a list of all Search services in the given resource group.
az search service list --resource-group
[--query-examples]
[--subscription]Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az search service show
Gets the Search service with the given name in the given resource group.
az search service show --name
--resource-group
[--query-examples]
[--subscription]Required Parameters
The name of the search service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az search service update
Update partition and replica of the given search service.
az search service update --name
--resource-group
[--add]
[--force-string]
[--partition-count]
[--remove]
[--replica-count]
[--set]
[--subscription]Required Parameters
The name of the search service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Number of partitions in the search service.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Number of replicas in the search service.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.