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}
                         [--hosting-mode]
                         [--identity-type]
                         [--ip-rules]
                         [--location]
                         [--no-wait]
                         [--partition-count]
                         [--public-access]
                         [--replica-count]

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

--hosting-mode

The hosting mode; possible values include: "default", "highDensity"; Note that "highDensity" is only applicable to the standard3 SKU.

default value: default

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

default value: False

--partition-count

Number of partitions in the search service.

default value: 0

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

default value: 0

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

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

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

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

Required Parameters

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

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]
                         [--identity-type]
                         [--ip-rules]
                         [--no-wait]
                         [--partition-count]
                         [--public-access]
                         [--remove]
                         [--replica-count]
                         [--set]

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

default value: []

--force-string

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

default value: False

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

default value: False

--partition-count

Number of partitions in the search service.

default value: 0

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

default value: []

--replica-count

Number of replicas in the search service.

default value: 0

--set

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

default value: []

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az search service wait

Wait for async service operations.

az search service wait --name
                       --resource-group
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--interval]
                       [--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'.

default value: False

--custom

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

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.