Get-AzPrivateEndpoint
Get a private endpoint
Syntax
Get-AzPrivateEndpoint
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPrivateEndpoint
-Name <String>
-ResourceGroupName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzPrivateEndpoint cmdlet gets one or more private endpoints.
Examples
Example 1: Retrieve a private endpoint
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
Example 2: List all private endpoints in ResourceGroup
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
Parameters
-DefaultProfile
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 |
-ExpandResource
The resource reference to be expanded.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The resource name.
Type: | String |
Aliases: | ResourceName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-ResourceGroupName
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Inputs
Outputs
Related Links
Zusammenarbeit auf GitHub
Die Quelle für diesen Inhalt finden Sie auf GitHub, wo Sie auch Issues und Pull Requests erstellen und überprüfen können. Weitere Informationen finden Sie in unserem Leitfaden für Mitwirkende.
Azure PowerShell