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 wait

Wait for async service operations.

az search service create

Creates a Search service in the given resource group.

az search service create --name
                         --resource-group
                         --sku {Basic, Free, Standard, Standard2, Standard3}
                         [--identity-type]
                         [--ip-rules]
                         [--location]
                         [--no-wait]
                         [--partition-count]
                         [--public-access]
                         [--replica-count]
                         [--subscription]

Required Parameters

--name -n

The name of the search service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

The SKU of the search service, which determines price tier and capacity limits. Accepted Values: Free, Basic, Standard, Standard2, Standard3.

accepted values: Basic, Free, Standard, Standard2, Standard3

Optional Parameters

--identity-type

The identity type; possible values include: "None", "SystemAssigned".

--ip-rules

Public IP(v4) addresses or CIDR ranges to the search service, seperated by comma or semicolon; these IP rules are applicable only when --public-network-access is "enabled".

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

--partition-count

Number of partitions in the search service.

--public-access --public-network-access

Public accessibility to the search service; allowed values are "enabled" or "disabled".

default value: enabled
--replica-count

Number of replicas in the search service.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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

--name -n

The name of the search service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--query-examples

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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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

--name -n

The name of the search service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--query-examples

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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az search service update

Update partition and replica of the given search service.

az search service update --name
                         --resource-group
                         [--add]
                         [--force-string]
                         [--identity-type]
                         [--ip-rules]
                         [--no-wait]
                         [--partition-count]
                         [--public-access]
                         [--remove]
                         [--replica-count]
                         [--set]
                         [--subscription]

Required Parameters

--name -n

The name of the search service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--add

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>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--identity-type

The identity type; possible values include: "None", "SystemAssigned".

--ip-rules

Public IP(v4) addresses or CIDR ranges to the search service, seperated by comma(',') or semicolon(';'); If spaces (' '), ',' or ';' is provided, any existing IP rule will be nullified and no public IP rule is applied. These IP rules are applicable only when public_network_access is "enabled".

--no-wait

Do not wait for the long-running operation to finish.

--partition-count

Number of partitions in the search service.

--public-access --public-network-access

Public accessibility to the search service; allowed values are "enabled" or "disabled".

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--replica-count

Number of replicas in the search service.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az search service wait

Wait for async service operations.

az search service wait --name
                       --resource-group
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--interval]
                       [--subscription]
                       [--timeout]
                       [--updated]

Required Parameters

--name -n

The name of the search service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.