Get-AzPrivateEndpoint
Get a private endpoint
Syntax
NoExpand (Default)
Get-AzPrivateEndpoint
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Expand
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.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExpandResource
The resource reference to be expanded.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Expand
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
The resource name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
NoExpand
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
NoExpand
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
