Share via

az search service shared-private-link-resource

Manage Shared Private Link Resource.

Commands

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

Create the creation or update of a shared private link resource managed by the search service in the given resource group.

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

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

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

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

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

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

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

Update the creation or update of a shared private link resource managed by the search service in the given resource group.

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

Place the CLI in a waiting state until a condition is met.

 Core GA
Edit

Create the creation or update of a shared private link resource managed by the search service in the given resource group.

az search service shared-private-link-resource create --name --shared-private-link-resource-name
                                                      --resource-group
                                                      --search-service-name
                                                      [--group-id]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--private-link-resource-id --resource-id]
                                                      [--provisioning-state {Deleting, Failed, Incomplete, Succeeded, Updating}]
                                                      [--request-message]
                                                      [--resource-region]
                                                      [--status {Approved, Disconnected, Pending, Rejected}]
--name --shared-private-link-resource-name -n

The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.

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

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

--group-id

The group ID from the provider of resource the shared private link resource is for.

Property Value
Parameter group: Properties Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-link-resource-id --resource-id

The resource ID of the resource the shared private link resource is for.

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

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

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

The message for requesting approval of the shared private link resource.

Property Value
Parameter group: Properties Arguments
--resource-region

Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).

Property Value
Parameter group: Properties Arguments
--status

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

Property Value
Parameter group: Properties Arguments
Accepted values: Approved, Disconnected, Pending, Rejected
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
Edit

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

az search service shared-private-link-resource delete [--ids]
                                                      [--name --shared-private-link-resource-name]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--search-service-name]
                                                      [--subscription]
                                                      [--yes]

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 --shared-private-link-resource-name -n

The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
Edit

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

az search service shared-private-link-resource list --resource-group
                                                    --search-service-name
                                                    [--max-items]
                                                    [--next-token]
--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.

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
Edit

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

az search service shared-private-link-resource show [--ids]
                                                    [--name --shared-private-link-resource-name]
                                                    [--resource-group]
                                                    [--search-service-name]
                                                    [--subscription]

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 --shared-private-link-resource-name -n

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

Update the creation or update of a shared private link resource managed by the search service in the given resource group.

az search service shared-private-link-resource update [--add]
                                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--group-id]
                                                      [--ids]
                                                      [--name --shared-private-link-resource-name]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--private-link-resource-id --resource-id]
                                                      [--provisioning-state {Deleting, Failed, Incomplete, Succeeded, Updating}]
                                                      [--remove]
                                                      [--request-message]
                                                      [--resource-group]
                                                      [--resource-region]
                                                      [--search-service-name]
                                                      [--set]
                                                      [--status {Approved, Disconnected, Pending, Rejected}]
                                                      [--subscription]

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
--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 from the provider of resource the shared private link resource 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 --shared-private-link-resource-name -n

The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-link-resource-id --resource-id

The resource ID of the resource the shared private link resource is for.

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

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

Property Value
Parameter group: Properties Arguments
Accepted values: 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
--request-message

The message for requesting approval of the shared private link resource.

Property Value
Parameter group: Properties 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
--resource-region

Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).

Property Value
Parameter group: Properties 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
--status

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

Property Value
Parameter group: Properties Arguments
Accepted values: Approved, Disconnected, Pending, Rejected
--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
Edit

Place the CLI in a waiting state until a condition is met.

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

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

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --shared-private-link-resource-name -n

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