az search private-endpoint-connection

Manage Azure Search private endpoint connections.

Commands

Name	Description	Type	Status
az search private-endpoint-connection delete	Disconnects the private endpoint connection and deletes it from the search service.	Core	GA
az search private-endpoint-connection list	Gets a list of all private endpoint connections in the given service.	Core	GA
az search private-endpoint-connection show	Gets the details of the private endpoint connection to the search service in the given resource group.	Core	GA
az search private-endpoint-connection update	Update an existing private endpoint connection in a Search service in the given resource group.	Core	GA

az search private-endpoint-connection delete

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

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

Required Parameters

--name --private-endpoint-connection-name -n

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

--resource-group -g

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

--service-name

The name of the search service.

Optional Parameters

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

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

--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 private-endpoint-connection list

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

az search private-endpoint-connection list --resource-group
                                           --service-name

Required Parameters

--resource-group -g

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

--service-name

The name of the search service.

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 private-endpoint-connection show

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

az search private-endpoint-connection show --name --private-endpoint-connection-name
                                           --resource-group
                                           --service-name

Required Parameters

--name --private-endpoint-connection-name -n

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

--resource-group -g

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

--service-name

The name of the search service.

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 private-endpoint-connection update

Update an existing private endpoint connection in a Search service in the given resource group.

az search private-endpoint-connection update --actions-required
                                             --description
                                             --name
                                             --resource-group
                                             --service-name
                                             --status

Required Parameters

--actions-required

Custom 'actions required' message when updating the private endpoint connection resource.

--description

Custom description when updating the private endpoint connection resource.

--name -n

Name of the private endpoint connection resource; for example: {the name of the private endpoint resource}.{guid}.

--resource-group -g

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

--service-name

The name of the search service.

--status

The updated status of the private endpoint connection resource. Possible values include: "Pending", "Approved", "Rejected", "Disconnected".

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