az healthcareapis private-endpoint-connection

Note

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

Healthcareapis private-endpoint-connection.

Commands

Name	Description	Type	Status
az healthcareapis private-endpoint-connection create	Update the state of the specified private endpoint connection associated with the service.	Extension	GA
az healthcareapis private-endpoint-connection delete	Deletes a private endpoint connection.	Extension	GA
az healthcareapis private-endpoint-connection list	Lists all private endpoint connections for a service.	Extension	GA
az healthcareapis private-endpoint-connection show	Gets the specified private endpoint connection associated with the service.	Extension	GA
az healthcareapis private-endpoint-connection update	Update the state of the specified private endpoint connection associated with the service.	Extension	GA
az healthcareapis private-endpoint-connection wait	Place the CLI in a waiting state until a condition of the healthcareapis private-endpoint-connection is met.	Extension	GA

az healthcareapis private-endpoint-connection create

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

az healthcareapis private-endpoint-connection create --name --private-endpoint-connection-name
                                                     --resource-group
                                                     --resource-name
                                                     [--no-wait]
                                                     [--private-link-service-connection-state]
                                                     [--private-link-service-connection-state-actions-required]
                                                     [--private-link-service-connection-state-description]
                                                     [--private-link-service-connection-state-status {Approved, Pending, Rejected}]

Examples

PrivateEndpointConnection_CreateOrUpdate

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

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

--resource-name

The name of the service instance.

Optional Parameters

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

--no-wait

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

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

--private-link-service-connection-state-actions-required

Deprecated

Argument 'private_link_service_connection_state_actions_required' has been deprecated and will be removed in a future release. Use '--private-link-service-connection-state' instead.

A message indicating if changes on the service provider require any updates on the consumer.

--private-link-service-connection-state-description

Deprecated

Argument 'private_link_service_connection_state_description' has been deprecated and will be removed in a future release. Use '--private-link-service-connection-state' instead.

The reason for approval/rejection of the connection.

--private-link-service-connection-state-status

Deprecated

Argument 'private_link_service_connection_state_status' has been deprecated and will be removed in a future release. Use '--private-link-service-connection-state' instead.

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Property	Value
Accepted values:	Approved, 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

az healthcareapis private-endpoint-connection delete

Deletes a private endpoint connection.

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

Examples

PrivateEndpointConnections_Delete

az healthcareapis private-endpoint-connection delete --name "myConnection" --resource-group "rgname" --resource-name "service1"

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 associated with the Azure resource.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

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

The name of the service instance.

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

Lists all private endpoint connections for a service.

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

Examples

PrivateEndpointConnection_List

az healthcareapis private-endpoint-connection list --resource-group "rgname" --resource-name "service1"

Required Parameters

--resource-group -g

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

--resource-name

The name of the service instance.

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

Gets the specified private endpoint connection associated with the service.

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

Examples

PrivateEndpointConnection_GetConnection

az healthcareapis private-endpoint-connection show --name "myConnection" --resource-group "rgname" --resource-name "service1"

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 associated with the Azure resource.

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

--resource-name

The name of the service instance.

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

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

az healthcareapis private-endpoint-connection update [--ids]
                                                     [--name --private-endpoint-connection-name]
                                                     [--no-wait]
                                                     [--private-link-service-connection-state]
                                                     [--private-link-service-connection-state-actions-required]
                                                     [--private-link-service-connection-state-description]
                                                     [--private-link-service-connection-state-status {Approved, Pending, Rejected}]
                                                     [--resource-group]
                                                     [--resource-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 associated with the Azure resource.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

--private-link-service-connection-state-actions-required

Deprecated

Argument 'private_link_service_connection_state_actions_required' has been deprecated and will be removed in a future release. Use '--private-link-service-connection-state' instead.

A message indicating if changes on the service provider require any updates on the consumer.

--private-link-service-connection-state-description

Deprecated

Argument 'private_link_service_connection_state_description' has been deprecated and will be removed in a future release. Use '--private-link-service-connection-state' instead.

The reason for approval/rejection of the connection.

--private-link-service-connection-state-status

Deprecated

Argument 'private_link_service_connection_state_status' has been deprecated and will be removed in a future release. Use '--private-link-service-connection-state' instead.

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Property	Value
Accepted values:	Approved, Pending, Rejected

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

The name of the service instance.

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 healthcareapis private-endpoint-connection wait

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

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

Examples

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

az healthcareapis private-endpoint-connection wait --name "myConnection" --resource-group "rgname" --resource-name "service1" --created

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

az healthcareapis private-endpoint-connection wait --name "myConnection" --resource-group "rgname" --resource-name "service1" --updated

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

az healthcareapis private-endpoint-connection wait --name "myConnection" --resource-group "rgname" --resource-name "service1" --deleted

Optional Parameters

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 --private-endpoint-connection-name -n

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

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

--resource-name

The name of the service instance.

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