az network private-endpoint ip-config

  • Reference

Manage private endpoint ip configurations.

Commands

Name Description Type Status
az network private-endpoint ip-config add

Add a private endpoint ip configuration.

 Core GA
az network private-endpoint ip-config list

List ip configuration within a private endpoint.

 Core GA
az network private-endpoint ip-config remove

Remove a private endpoint ip configuration.

 Core GA
az network private-endpoint ip-config wait

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

 Core GA

az network private-endpoint ip-config add

Edit

Add a private endpoint ip configuration.

az network private-endpoint ip-config add --endpoint-name
                                          --name
                                          --resource-group
                                          [--group-id]
                                          [--member-name]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--private-ip-address]

Examples

Add a private endpoint ip configuration.

az network private-endpoint ip-config add --endpoint-name MyPE -g MyRG -n MyIpConfig --group-id MyGroup --member-name MyMember --private-ip-address MyPrivateIPAddress

Required Parameters

--endpoint-name

Name of the private endpoint.

--name -n

Name of the ip configuration.

--resource-group -g

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

Optional Parameters

--group-id

The ID of a group obtained from the remote resource that this private endpoint should connect to.

--member-name

The member name of a group obtained from the remote resource that this private endpoint should connect to.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-ip-address

A private ip address obtained from the private endpoint's subnet.

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.

--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 network private-endpoint ip-config list

Edit

List ip configuration within a private endpoint.

az network private-endpoint ip-config list --endpoint-name
                                           --resource-group

Examples

List ip configuration within a private endpoint.

az network private-endpoint ip-config list --endpoint-name MyPE -g MyRG

Required Parameters

--endpoint-name

Name of the private endpoint.

--resource-group -g

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

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.

--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 network private-endpoint ip-config remove

Edit

Remove a private endpoint ip configuration.

az network private-endpoint ip-config remove --endpoint-name
                                             --name
                                             --resource-group
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove a private endpoint ip configuration.

az network private-endpoint ip-config remove --endpoint-name MyPE -g MyRG -n MyIpConfig

Required Parameters

--endpoint-name

Name of the private endpoint.

--name -n

Name of the ip configuration.

--resource-group -g

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

Optional Parameters

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
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.

--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 network private-endpoint ip-config wait

Edit

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

az network private-endpoint ip-config wait [--created]
                                           [--custom]
                                           [--deleted]
                                           [--endpoint-name]
                                           [--exists]
                                           [--ids]
                                           [--interval]
                                           [--resource-group]
                                           [--subscription]
                                           [--timeout]
                                           [--updated]

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

Name of the private endpoint.

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

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