Get-AzPrivateEndpoint
Get a private endpoint
PowerShell
Get-AzPrivateEndpoint
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
PowerShell
Get-AzPrivateEndpoint
-Name <String>
-ResourceGroupName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
The Get-AzPrivateEndpoint cmdlet gets one or more private endpoints.
PowerShell
Get-AzPrivateEndpoint -Name MyPrivateEndpoint1 -ResourceGroupName TestResourceGroup
Name : MyPrivateEndpoint1
ResourceGroupName : TestResourceGroup
Location : eastus2euap
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/provi
ders/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1
Etag : W/"00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
Subnet : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1/subnets/backendSubnet",
}
NetworkInterfaces : [
{
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/networkInterfaces/MyNic1",
}
]
PrivateLinkServiceConnections : []
ManualPrivateLinkServiceConnections : [
{
"Name": "MyPrivateLinkServiceConnection",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1/manualPrivateLinkServi
ceConnections/MyPrivateLinkServiceConnection",
"PrivateLinkServiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/
resourceGroups/TestResourceGroup/providers/Microsoft.Network/priv
ateLinkServices/MyPrivateLinkService",
"PrivateLinkServiceConnectionState": {
"Status": "Pending",
"Description": "Awaiting approval"
}
}
]
This command gets the private endpoint named MyPrivateEndpoint1 in the resource group TestResourceGroup
PowerShell
Get-AzPrivateEndpoint -ResourceGroupName TestResourceGroup
Name : MyPrivateEndpoint1
ResourceGroupName : TestResourceGroup
Location : eastus2euap
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/provi
ders/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1
Etag : W/"00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
Subnet : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1/subnets/backendSubnet",
}
NetworkInterfaces : [
{
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/networkInterfaces/MyNic1",
}
]
PrivateLinkServiceConnections : []
ManualPrivateLinkServiceConnections : [
{
"Name": "MyPrivateLinkServiceConnection",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateEndpoints/MyPrivateEndpoint1/manualPrivateLinkServi
ceConnections/MyPrivateLinkServiceConnection",
"PrivateLinkServiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/
resourceGroups/TestResourceGroup/providers/Microsoft.Network/priv
ateLinkServices/MyPrivateLinkService",
"PrivateLinkServiceConnectionState": {
"Status": "Pending",
"Description": "Awaiting approval"
}
}
]
This command gets all of private end points in the resource group TestResourceGroup
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The resource reference to be expanded.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The resource name.
Type: | String |
Aliases: | ResourceName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell feedback
Azure PowerShell is an open source project. Select a link to provide feedback: