Share via

az search service private-endpoint-connection

Manage Private Endpoint Connection.

Commands

Name Description Type Status
az search service private-endpoint-connection delete

Delete the private endpoint connection and deletes it from the search service.

 Core GA
az search service private-endpoint-connection list

List a list of all private endpoint connections in the given service.

 Core GA
az search service private-endpoint-connection show

Get the details of the private endpoint connection to the search service in the given resource group.

 Core GA
az search service private-endpoint-connection update

Update a private endpoint connection to the search service in the given resource group.

 Core GA

az search service private-endpoint-connection delete

Edit

Delete the private endpoint connection and deletes it from the search service.

az search service private-endpoint-connection delete [--ids]
                                                     [--name --private-endpoint-connection-name]
                                                     [--resource-group]
                                                     [--search-service-name]
                                                     [--subscription]
                                                     [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --private-endpoint-connection-name -n

The name of the private endpoint connection to the Azure AI Search service with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--search-service-name

The name of the Azure AI Search service associated with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az search service private-endpoint-connection list

Edit

List a list of all private endpoint connections in the given service.

az search service private-endpoint-connection list --resource-group
                                                   --search-service-name
                                                   [--max-items]
                                                   [--next-token]

Required Parameters

--resource-group -g

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

--search-service-name

The name of the Azure AI Search service associated with the specified resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az search service private-endpoint-connection show

Edit

Get the details of the private endpoint connection to the search service in the given resource group.

az search service private-endpoint-connection show [--ids]
                                                   [--name --private-endpoint-connection-name]
                                                   [--resource-group]
                                                   [--search-service-name]
                                                   [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --private-endpoint-connection-name -n

The name of the private endpoint connection to the Azure AI Search service with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--search-service-name

The name of the Azure AI Search service associated with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az search service private-endpoint-connection update

Edit

Update a private endpoint connection to the search service in the given resource group.

az search service private-endpoint-connection update [--add]
                                                     [--connection-state --private-link-service-connection-state]
                                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--group-id]
                                                     [--ids]
                                                     [--name --private-endpoint-connection-name]
                                                     [--private-endpoint]
                                                     [--provisioning-state {Canceled, Deleting, Failed, Incomplete, Succeeded, Updating}]
                                                     [--remove]
                                                     [--resource-group]
                                                     [--search-service-name]
                                                     [--set]
                                                     [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--connection-state --private-link-service-connection-state

Describes the current state of an existing Azure Private Link service connection to the private endpoint. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--group-id

The group ID of the Azure resource for which the private link service is for.

Property Value
Parameter group: Properties Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --private-endpoint-connection-name -n

The name of the private endpoint connection to the Azure AI Search service with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--private-endpoint

The private endpoint resource from Microsoft.Network provider. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--provisioning-state

The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

Property Value
Parameter group: Properties Arguments
Accepted values: Canceled, Deleting, Failed, Incomplete, Succeeded, Updating
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--search-service-name

The name of the Azure AI Search service associated with the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False