Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az search shared-private-link-resource

Manage Azure AI Search shared private link resources.

Commands

Name Description Type Status
az search shared-private-link-resource create

Create shared privatelink resources in a Search service in the given resource group.

 Core GA
az search shared-private-link-resource delete

Initiates the deletion of the shared private link resource from the search service.

 Core GA
az search shared-private-link-resource list

Gets a list of all shared private link resources managed by the given service.

 Core GA
az search shared-private-link-resource show

Gets the details of the shared private link resource managed by the search service in the given resource group.

 Core GA
az search shared-private-link-resource update

Update shared privatelink resources in a Search service in the given resource group.

 Core GA
az search shared-private-link-resource wait

Wait for async shared private link resource operations.

 Core GA

az search shared-private-link-resource create

Create shared privatelink resources in a Search service in the given resource group.

az search shared-private-link-resource create --group-id
 --name
 --resource-group
 --resource-id
 --service-name
 [--acquire-policy-token]
 [--change-reference]
 [--no-wait]
 [--request-message]

Required Parameters

--group-id

The group id of the resource; for example: blob, sql or vault.

--name -n

Name of the shared private link resource.

--resource-group -g

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

--resource-id

Fully qualified resource ID for the resource. for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/ {resourceProviderNamespace}/{resourceType}/{resourceName}.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

Property Value
Default value: False
--request-message

Custom request message when creating or updating the shared privatelink resources.

Property Value
Default value: Please approve

az search shared-private-link-resource delete

Initiates the deletion of the shared private link resource from the search service.

az search shared-private-link-resource delete --name
 --resource-group
 --service-name
 [--acquire-policy-token]
 [--change-reference]
 [--yes]

Required Parameters

--name -n

The name of the shared private link resource managed by the Azure AI Search service within 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False

az search shared-private-link-resource list

Gets a list of all shared private link resources managed by the given service.

az search shared-private-link-resource 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.

az search shared-private-link-resource show

Gets the details of the shared private link resource managed by the search service in the given resource group.

az search shared-private-link-resource show --name
 --resource-group
 --service-name

Required Parameters

--name -n

The name of the shared private link resource managed by the Azure AI Search service within 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.

az search shared-private-link-resource update

Update shared privatelink resources in a Search service in the given resource group.

az search shared-private-link-resource update --group-id
 --name
 --request-message
 --resource-group
 --resource-id
 --service-name
 [--acquire-policy-token]
 [--change-reference]
 [--no-wait]

Required Parameters

--group-id

The group id of the resource; for example: blob, sql or vault.

--name -n

Name of the shared private link resource.

--request-message

Custom request message when creating or updating the shared privatelink resources.

--resource-group -g

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

--resource-id

Fully qualified resource ID for the resource; for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/ {resourceProviderNamespace}/{resourceType}/{resourceName}.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

Property Value
Default value: False

az search shared-private-link-resource wait

Wait for async shared private link resource operations.

az search shared-private-link-resource wait --name
 --resource-group
 --service-name
 [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--interval]
 [--timeout]
 [--updated]

Required Parameters

--name -n

The name of the shared private link resource managed by the Azure AI Search service within 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False

Feedback

Was this page helpful?