Share via

az monitor private-link-scope private-endpoint-connection

  • Preview

Command group 'az monitor private-link-scope' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage private endpoint connection of a private link scope resource.

Commands

Name Description Type Status
az monitor private-link-scope private-endpoint-connection approve

Approve a private endpoint connection of a private link scope resource.

 Core Preview
az monitor private-link-scope private-endpoint-connection delete

Delete a private endpoint connection of a private link scope resource.

 Core Preview
az monitor private-link-scope private-endpoint-connection list

List all private endpoint connections on a private link scope.

 Core Preview
az monitor private-link-scope private-endpoint-connection reject

Reject a private endpoint connection of a private link scope resource.

 Core Preview
az monitor private-link-scope private-endpoint-connection show

Show a private endpoint connection of a private link scope resource.

 Core Preview
az monitor private-link-scope private-endpoint-connection wait

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

 Core Preview
Edit
Preview

Command group 'az monitor private-link-scope private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Approve a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection approve [--add]
                                                                  [--description]
                                                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                                  [--id]
                                                                  [--ids]
                                                                  [--name]
                                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                  [--remove]
                                                                  [--resource-group]
                                                                  [--scope-name]
                                                                  [--set]
                                                                  [--subscription]

Approve a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection approve --name MyPrivateEndpointConnection --resource-group MyResourceGroup --scope-name MyScope

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

Description of private link service connection.

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

ID of the private endpoint connection associated with the private link scope. Values from az monitor private-link-scope show.

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

Name of the private endpoint connection associated with the private link scope.

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

Name of the Azure Monitor Private Link Scope.

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

Command group 'az monitor private-link-scope private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection delete [--id]
                                                                 [--ids]
                                                                 [--name]
                                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                 [--resource-group]
                                                                 [--scope-name]
                                                                 [--subscription]
                                                                 [--yes]

Delete a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection delete -n MyName -g MyResourceGroup --scope-name MyScope

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

--id

ID of the private endpoint connection associated with the private link scope. Values from az monitor private-link-scope show.

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

Name of the private endpoint connection associated with the private link scope.

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

Name of the Azure Monitor Private Link Scope.

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
Preview

Command group 'az monitor private-link-scope private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all private endpoint connections on a private link scope.

az monitor private-link-scope private-endpoint-connection list --resource-group
                                                               --scope-name
                                                               [--max-items]
                                                               [--next-token]

List all private endpoint connections on a private link scope.

az monitor private-link-scope private-endpoint-connection list -g MyResourceGroup --scope-name MyScope
--resource-group -g

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

--scope-name

Name of the Azure Monitor Private Link Scope.

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
Preview

Command group 'az monitor private-link-scope private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Reject a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection reject [--add]
                                                                 [--description]
                                                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                                 [--id]
                                                                 [--ids]
                                                                 [--name]
                                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                 [--remove]
                                                                 [--resource-group]
                                                                 [--scope-name]
                                                                 [--set]
                                                                 [--subscription]

Reject a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection reject --name MyPrivateEndpointConnection --resource-group MyResourceGroup --scope-name MyScope

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

Description of private link service connection.

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

ID of the private endpoint connection associated with the private link scope. Values from az monitor private-link-scope show.

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

Name of the private endpoint connection associated with the private link scope.

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

Name of the Azure Monitor Private Link Scope.

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

Command group 'az monitor private-link-scope private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection show [--id]
                                                               [--ids]
                                                               [--name]
                                                               [--resource-group]
                                                               [--scope-name]
                                                               [--subscription]

Show a private endpoint connection of a private link scope resource.

az monitor private-link-scope private-endpoint-connection show -n MyName -g MyResourceGroup --scope-name MyScope

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

--id

ID of the private endpoint connection associated with the private link scope. Values from az monitor private-link-scope show.

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

Name of the private endpoint connection associated with the private link scope.

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

Name of the Azure Monitor Private Link Scope.

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
Preview

Command group 'az monitor private-link-scope private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az monitor private-link-scope private-endpoint-connection wait [--created]
                                                               [--custom]
                                                               [--deleted]
                                                               [--exists]
                                                               [--ids]
                                                               [--interval]
                                                               [--name]
                                                               [--resource-group]
                                                               [--scope-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 -n

Name of the private endpoint connection associated with the private link scope.

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

Name of the Azure Monitor Private Link Scope.

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