az network private-endpoint-connection
Manage private endpoint connections.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network private-endpoint-connection approve |
Approve a private endpoint connection. |
Core | GA |
az network private-endpoint-connection delete |
Delete a private endpoint connection. |
Core | GA |
az network private-endpoint-connection list |
List all private endpoint connections. |
Core | GA |
az network private-endpoint-connection reject |
Reject a private endpoint connection. |
Core | GA |
az network private-endpoint-connection show |
Show a private endpoint connection. |
Core | GA |
az network private-endpoint-connection approve
Approve a private endpoint connection.
az network private-endpoint-connection approve [--description]
[--id]
[--name]
[--resource-group]
[--resource-name]
[--type {Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.App/managedEnvironments, Microsoft.AppConfiguration/configurationStores, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.BotService/botServices, Microsoft.Cache/Redis, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/flexibleServers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/flexibleServers, Microsoft.DBforPostgreSQL/serverGroupsv2, Microsoft.DBforPostgreSQL/servers, Microsoft.Dashboard/grafana, Microsoft.DataFactory/factories, Microsoft.Databricks/workspaces, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.DeviceUpdate/accounts, Microsoft.Devices/IotHubs, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.DocumentDB/mongoClusters, Microsoft.ElasticSan/elasticSans, Microsoft.EventGrid/domains, Microsoft.EventGrid/namespaces, Microsoft.EventGrid/partnerNamespaces, Microsoft.EventGrid/topics, Microsoft.EventHub/namespaces, Microsoft.HDInsight/clusters, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HybridCompute/privateLinkScopes, Microsoft.KeyVault/managedHSMs, Microsoft.Keyvault/vaults, Microsoft.KubernetesConfiguration/privateLinkScopes, Microsoft.Kusto/clusters, Microsoft.MachineLearningServices/registries, Microsoft.MachineLearningServices/workspaces, Microsoft.Media/mediaservices, Microsoft.Monitor/accounts, Microsoft.Network/applicationGateways, Microsoft.Network/privateLinkServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/signalr, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/workspaces, Microsoft.Web/hostingEnvironments, Microsoft.Web/sites, microsoft.insights/privateLinkScopes}]
Examples
Approve a private endpoint connection for a storage account.
az network private-endpoint-connection approve -g MyResourceGroup -n MyPrivateEndpoint --resource-name MySA --type Microsoft.Storage/storageAccounts --description "Approved"
Approve a private endpoint connection for a keyvault.
az network private-endpoint-connection approve -g MyResourceGroup -n MyPrivateEndpoint --resource-name MyKV --type Microsoft.Keyvault/vaults --description "Approved"
Approve a private endpoint connection for an ACR.
az network private-endpoint-connection approve --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.ContainerRegistry/registries/testreg000002/privateEndpointConnections/testreg000002.6e6bf72bc59d41cc89c698d4cc5ee79d --description "Approved"
Optional Parameters
Comments for the approval.
ID of the private endpoint connection.
Name of the private endpoint connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the resource.
Type of the resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network private-endpoint-connection delete
Delete a private endpoint connection.
az network private-endpoint-connection delete [--id]
[--name]
[--resource-group]
[--resource-name]
[--type {Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.App/managedEnvironments, Microsoft.AppConfiguration/configurationStores, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.BotService/botServices, Microsoft.Cache/Redis, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/flexibleServers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/flexibleServers, Microsoft.DBforPostgreSQL/serverGroupsv2, Microsoft.DBforPostgreSQL/servers, Microsoft.Dashboard/grafana, Microsoft.DataFactory/factories, Microsoft.Databricks/workspaces, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.DeviceUpdate/accounts, Microsoft.Devices/IotHubs, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.DocumentDB/mongoClusters, Microsoft.ElasticSan/elasticSans, Microsoft.EventGrid/domains, Microsoft.EventGrid/namespaces, Microsoft.EventGrid/partnerNamespaces, Microsoft.EventGrid/topics, Microsoft.EventHub/namespaces, Microsoft.HDInsight/clusters, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HybridCompute/privateLinkScopes, Microsoft.KeyVault/managedHSMs, Microsoft.Keyvault/vaults, Microsoft.KubernetesConfiguration/privateLinkScopes, Microsoft.Kusto/clusters, Microsoft.MachineLearningServices/registries, Microsoft.MachineLearningServices/workspaces, Microsoft.Media/mediaservices, Microsoft.Monitor/accounts, Microsoft.Network/applicationGateways, Microsoft.Network/privateLinkServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/signalr, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/workspaces, Microsoft.Web/hostingEnvironments, Microsoft.Web/sites, microsoft.insights/privateLinkScopes}]
[--yes]
Examples
Delete a private endpoint connection for a storage account.
az network private-endpoint-connection delete -g MyResourceGroup -n MyPrivateEndpoint --resource-name MySA --type Microsoft.Storage/storageAccounts
Delete a private endpoint connection for a keyvault.
az network private-endpoint-connection delete -g MyResourceGroup -n MyPrivateEndpoint --resource-name MyKV --type Microsoft.Keyvault/vaults
Delete a private endpoint connection for an ACR.
az network private-endpoint-connection delete --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.ContainerRegistry/registries/testreg000002/privateEndpointConnections/testreg000002.6e6bf72bc59d41cc89c698d4cc5ee79d
Optional Parameters
ID of the private endpoint connection.
Name of the private endpoint connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the resource.
Type of the resource.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network private-endpoint-connection list
List all private endpoint connections.
az network private-endpoint-connection list [--id]
[--name]
[--resource-group]
[--type {Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.App/managedEnvironments, Microsoft.AppConfiguration/configurationStores, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.BotService/botServices, Microsoft.Cache/Redis, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/flexibleServers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/flexibleServers, Microsoft.DBforPostgreSQL/serverGroupsv2, Microsoft.DBforPostgreSQL/servers, Microsoft.Dashboard/grafana, Microsoft.DataFactory/factories, Microsoft.Databricks/workspaces, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.DeviceUpdate/accounts, Microsoft.Devices/IotHubs, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.DocumentDB/mongoClusters, Microsoft.ElasticSan/elasticSans, Microsoft.EventGrid/domains, Microsoft.EventGrid/namespaces, Microsoft.EventGrid/partnerNamespaces, Microsoft.EventGrid/topics, Microsoft.EventHub/namespaces, Microsoft.HDInsight/clusters, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HybridCompute/privateLinkScopes, Microsoft.KeyVault/managedHSMs, Microsoft.Keyvault/vaults, Microsoft.KubernetesConfiguration/privateLinkScopes, Microsoft.Kusto/clusters, Microsoft.MachineLearningServices/registries, Microsoft.MachineLearningServices/workspaces, Microsoft.Media/mediaservices, Microsoft.Monitor/accounts, Microsoft.Network/applicationGateways, Microsoft.Network/privateLinkServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/signalr, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/workspaces, Microsoft.Web/hostingEnvironments, Microsoft.Web/sites, microsoft.insights/privateLinkScopes}]
Examples
List all private endpoint connections for a storage account.
az network private-endpoint-connection list -g MyResourceGroup -n MySA --type Microsoft.Storage/storageAccounts
List all private endpoint connections for a keyvault.
az network private-endpoint-connection list -g MyResourceGroup -n MyKV --type Microsoft.Keyvault/vaults
List all private endpoint connections for an ACR.
az network private-endpoint-connection list --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.ContainerRegistry/registries/testreg000002
Optional Parameters
ID of the resource.
Name of the resource. If provided, --type and --resource-group must be provided too.
Name of resource group. If provided, --name and --type must be provided too.
Type of the resource. If provided, --name and --resource-group must be provided too.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network private-endpoint-connection reject
Reject a private endpoint connection.
az network private-endpoint-connection reject [--description]
[--id]
[--name]
[--resource-group]
[--resource-name]
[--type {Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.App/managedEnvironments, Microsoft.AppConfiguration/configurationStores, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.BotService/botServices, Microsoft.Cache/Redis, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/flexibleServers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/flexibleServers, Microsoft.DBforPostgreSQL/serverGroupsv2, Microsoft.DBforPostgreSQL/servers, Microsoft.Dashboard/grafana, Microsoft.DataFactory/factories, Microsoft.Databricks/workspaces, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.DeviceUpdate/accounts, Microsoft.Devices/IotHubs, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.DocumentDB/mongoClusters, Microsoft.ElasticSan/elasticSans, Microsoft.EventGrid/domains, Microsoft.EventGrid/namespaces, Microsoft.EventGrid/partnerNamespaces, Microsoft.EventGrid/topics, Microsoft.EventHub/namespaces, Microsoft.HDInsight/clusters, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HybridCompute/privateLinkScopes, Microsoft.KeyVault/managedHSMs, Microsoft.Keyvault/vaults, Microsoft.KubernetesConfiguration/privateLinkScopes, Microsoft.Kusto/clusters, Microsoft.MachineLearningServices/registries, Microsoft.MachineLearningServices/workspaces, Microsoft.Media/mediaservices, Microsoft.Monitor/accounts, Microsoft.Network/applicationGateways, Microsoft.Network/privateLinkServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/signalr, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/workspaces, Microsoft.Web/hostingEnvironments, Microsoft.Web/sites, microsoft.insights/privateLinkScopes}]
Examples
Reject a private endpoint connection for a storage account.
az network private-endpoint-connection reject -g MyResourceGroup -n MyPrivateEndpoint --resource-name MySA --type Microsoft.Storage/storageAccounts --description "Rejected"
Reject a private endpoint connection for a keyvault.
az network private-endpoint-connection reject -g MyResourceGroup -n MyPrivateEndpoint --resource-name MyKV --type Microsoft.Keyvault/vaults --description "Rejected"
Reject a private endpoint connection for an ACR.
az network private-endpoint-connection reject --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.ContainerRegistry/registries/testreg000002/privateEndpointConnections/testreg000002.6e6bf72bc59d41cc89c698d4cc5ee79d --description "Rejected"
Optional Parameters
Comments for the rejection.
ID of the private endpoint connection.
Name of the private endpoint connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the resource.
Type of the resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network private-endpoint-connection show
Show a private endpoint connection.
az network private-endpoint-connection show [--id]
[--name]
[--resource-group]
[--resource-name]
[--type {Microsoft.AgFoodPlatform/farmBeats, Microsoft.ApiManagement/service, Microsoft.App/managedEnvironments, Microsoft.AppConfiguration/configurationStores, Microsoft.Authorization/resourceManagementPrivateLinks, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.BotService/botServices, Microsoft.Cache/Redis, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/flexibleServers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/flexibleServers, Microsoft.DBforPostgreSQL/serverGroupsv2, Microsoft.DBforPostgreSQL/servers, Microsoft.Dashboard/grafana, Microsoft.DataFactory/factories, Microsoft.Databricks/workspaces, Microsoft.DesktopVirtualization/hostpools, Microsoft.DesktopVirtualization/workspaces, Microsoft.DeviceUpdate/accounts, Microsoft.Devices/IotHubs, Microsoft.DigitalTwins/digitalTwinsInstances, Microsoft.DocumentDB/databaseAccounts, Microsoft.DocumentDB/mongoClusters, Microsoft.ElasticSan/elasticSans, Microsoft.EventGrid/domains, Microsoft.EventGrid/namespaces, Microsoft.EventGrid/partnerNamespaces, Microsoft.EventGrid/topics, Microsoft.EventHub/namespaces, Microsoft.HDInsight/clusters, Microsoft.HardwareSecurityModules/cloudHsmClusters, Microsoft.HealthcareApis/services, Microsoft.HybridCompute/privateLinkScopes, Microsoft.KeyVault/managedHSMs, Microsoft.Keyvault/vaults, Microsoft.KubernetesConfiguration/privateLinkScopes, Microsoft.Kusto/clusters, Microsoft.MachineLearningServices/registries, Microsoft.MachineLearningServices/workspaces, Microsoft.Media/mediaservices, Microsoft.Monitor/accounts, Microsoft.Network/applicationGateways, Microsoft.Network/privateLinkServices, Microsoft.OpenEnergyPlatform/energyServices, Microsoft.PowerBI/privateLinkServicesForPowerBI, Microsoft.Purview/accounts, Microsoft.RecoveryServices/vaults, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/WebPubSub, Microsoft.SignalRService/signalr, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/workspaces, Microsoft.Web/hostingEnvironments, Microsoft.Web/sites, microsoft.insights/privateLinkScopes}]
Examples
Show a private endpoint connection for a storage account.
az network private-endpoint-connection show -g MyResourceGroup -n MyPrivateEndpoint --resource-name MySA --type Microsoft.Storage/storageAccounts
Show a private endpoint connection for a keyvault.
az network private-endpoint-connection show -g MyResourceGroup -n MyPrivateEndpoint --resource-name MyKV --type Microsoft.Keyvault/vaults
Show a private endpoint connection for an ACR.
az network private-endpoint-connection show --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.ContainerRegistry/registries/testreg000002/privateEndpointConnections/testreg000002.6e6bf72bc59d41cc89c698d4cc5ee79d
Optional Parameters
ID of the private endpoint connection.
Name of the private endpoint connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the resource.
Type of the resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.