Share via

az healthcareapis workspace private-endpoint-connection

  • Reference

Note

This reference is part of the healthcareapis extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az healthcareapis workspace private-endpoint-connection command. Learn more about extensions.

Manage workspace private endpoint connection with healthcareapis.

Commands

Name Description Type Status
az healthcareapis workspace private-endpoint-connection create

Update the state of the specified private endpoint connection associated with the workspace.

 Extension GA
az healthcareapis workspace private-endpoint-connection delete

Deletes a private endpoint connection.

 Extension GA
az healthcareapis workspace private-endpoint-connection list

Lists all private endpoint connections for a workspace.

 Extension GA
az healthcareapis workspace private-endpoint-connection show

Gets the specified private endpoint connection associated with the workspace.

 Extension GA
az healthcareapis workspace private-endpoint-connection update

Update the state of the specified private endpoint connection associated with the workspace.

 Extension GA
az healthcareapis workspace private-endpoint-connection wait

Place the CLI in a waiting state until a condition of the healthcareapis workspace private-endpoint-connection is met.

 Extension GA

az healthcareapis workspace private-endpoint-connection create

Update the state of the specified private endpoint connection associated with the workspace.

az healthcareapis workspace private-endpoint-connection create --name
                                                               --resource-group
                                                               --workspace-name
                                                               [--no-wait]
                                                               [--private-link-service-connection-state]

Examples

WorkspacePrivateEndpointConnection_CreateOrUpdate

az healthcareapis workspace private-endpoint-connection create --private-endpoint-connection-name "myConnection" --private-link-service-connection-state description="Auto-Approved" status="Approved" --resource-group "testRG" --workspace-name "workspace1"

Required Parameters

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

The name of the private endpoint connection associated with the Azure resource.

--resource-group -g

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

--workspace-name

The name of workspace resource.

Optional Parameters

--no-wait

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

Default value: False
--private-link-service-connection-state -s

A collection of information about the state of the connection between service consumer and provider.

Usage: --private-link-service-connection-state status=XX description=XX actions-required=XX

status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. description: The reason for approval/rejection of the connection. actions-required: A message indicating if changes on the service provider require any updates on the consumer.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 healthcareapis workspace private-endpoint-connection delete

Deletes a private endpoint connection.

az healthcareapis workspace private-endpoint-connection delete [--ids]
                                                               [--name]
                                                               [--no-wait]
                                                               [--resource-group]
                                                               [--subscription]
                                                               [--workspace-name]
                                                               [--yes]

Examples

WorkspacePrivateEndpointConnections_Delete

az healthcareapis workspace private-endpoint-connection delete --private-endpoint-connection-name "myConnection" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

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

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

The name of the private endpoint connection associated with the Azure resource.

--no-wait

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

Default value: False
--resource-group -g

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

--subscription

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

--workspace-name

The name of workspace resource.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 healthcareapis workspace private-endpoint-connection list

Lists all private endpoint connections for a workspace.

az healthcareapis workspace private-endpoint-connection list --resource-group
                                                             --workspace-name

Examples

WorkspacePrivateEndpointConnection_List

az healthcareapis workspace private-endpoint-connection list --resource-group "testRG" --workspace-name "workspace1"

Required Parameters

--resource-group -g

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

--workspace-name

The name of workspace resource.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 healthcareapis workspace private-endpoint-connection show

Gets the specified private endpoint connection associated with the workspace.

az healthcareapis workspace private-endpoint-connection show [--ids]
                                                             [--name]
                                                             [--resource-group]
                                                             [--subscription]
                                                             [--workspace-name]

Examples

WorkspacePrivateEndpointConnection_GetConnection

az healthcareapis workspace private-endpoint-connection show --private-endpoint-connection-name "myConnection" --resource-group "testRG" --workspace-name "workspace1"

Optional Parameters

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

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

The name of the private endpoint connection associated with the Azure resource.

--resource-group -g

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

--subscription

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

--workspace-name

The name of workspace resource.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 healthcareapis workspace private-endpoint-connection update

Update the state of the specified private endpoint connection associated with the workspace.

az healthcareapis workspace private-endpoint-connection update [--add]
                                                               [--force-string]
                                                               [--ids]
                                                               [--name]
                                                               [--no-wait]
                                                               [--private-link-service-connection-state]
                                                               [--remove]
                                                               [--resource-group]
                                                               [--set]
                                                               [--subscription]
                                                               [--workspace-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
--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.

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

The name of the private endpoint connection associated with the Azure resource.

--no-wait

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

Default value: False
--private-link-service-connection-state -s

A collection of information about the state of the connection between service consumer and provider.

Usage: --private-link-service-connection-state status=XX description=XX actions-required=XX

status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. description: The reason for approval/rejection of the connection. actions-required: A message indicating if changes on the service provider require any updates on the consumer.

--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
--subscription

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

--workspace-name

The name of workspace resource.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 healthcareapis workspace private-endpoint-connection wait

Place the CLI in a waiting state until a condition of the healthcareapis workspace private-endpoint-connection is met.

az healthcareapis workspace private-endpoint-connection wait [--created]
                                                             [--custom]
                                                             [--deleted]
                                                             [--exists]
                                                             [--ids]
                                                             [--interval]
                                                             [--name]
                                                             [--resource-group]
                                                             [--subscription]
                                                             [--timeout]
                                                             [--updated]
                                                             [--workspace-name]

Examples

Pause executing next line of CLI script until the healthcareapis workspace private-endpoint-connection is successfully created.

az healthcareapis workspace private-endpoint-connection wait --private-endpoint-connection-name "myConnection" --resource-group "testRG" --workspace-name "workspace1" --created

Pause executing next line of CLI script until the healthcareapis workspace private-endpoint-connection is successfully updated.

az healthcareapis workspace private-endpoint-connection wait --private-endpoint-connection-name "myConnection" --resource-group "testRG" --workspace-name "workspace1" --updated

Pause executing next line of CLI script until the healthcareapis workspace private-endpoint-connection is successfully deleted.

az healthcareapis workspace private-endpoint-connection wait --private-endpoint-connection-name "myConnection" --resource-group "testRG" --workspace-name "workspace1" --deleted

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

--interval

Polling interval in seconds.

Default value: 30
--name --private-endpoint-connection-name -n

The name of the private endpoint connection associated with the Azure resource.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
--workspace-name

The name of workspace resource.

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.

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