Get-AzBastion
Gets a Bastion resource or Bastion resources.
Syntax
Get-AzBastion
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzBastion
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzBastion
-ResourceGroupName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzBastion
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Get-Bastion cmdlet gets one or more bastions in a resource group or subscritption.
Examples
Example 1
Get-AzBastion
ResourceGroupName : abagarwaProd-PPTest
Location : westcentralus
ResourceGuid :
Type : Microsoft.Network/bastionHosts
Tag : {}
TagsTable :
Name : abagarwaProd-PPTest-vnet-bastion
Etag : W/"55702e34-348f-4b79-bf44-9c306623b7c7"
Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/abagarwaProd-PPTest/providers/Microsoft.Network/bastionHosts/abagarwaProd-PPTest-vnet-bastion
IpConfigurations : {IpConf}
DnsName : bst-f594cc74-c21e-44c3-ad5e-5bb93933965f.bastion.azure.com
ProvisioningState : Succeeded
IpConfigurationsText : [
{
"Name": "IpConf",
"Etag": "W/\"7ae27d14-9260-4e2d-8c48-47e9628a3e3b\"",
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/bastionHosts/BastionTest-vnet-bastion/bastionHostIpConfigurations/IpConf",
"Subnet": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/virtualNetworks/BastionTest-vnet/subnets/default"
},
"PublicIpAddress": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/publicIPAddresses/BastionTest-vnet-ip"
},
"ProvisioningState": "Succeeded",
"PrivateIpAllocationMethod": "Dynamic"
}
]
Sku : {
"Name": "Basic"
}
Scale Units : 2
Kerberos : False
Copy/Paste : False
Native Client : False
IP Connect : False
Shareable Link : False
ResourceGroupName : BastionTest
Location : westcentralus
ResourceGuid :
Type : Microsoft.Network/bastionHosts
Tag : {}
TagsTable :
Name : BastionTest-vnet-bastion
Etag : W/"7ae27d14-9260-4e2d-8c48-47e9628a3e3b"
Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionTest/providers/Microsoft.Network/bastionHosts/BastionTest-vnet-bastion
IpConfigurations : {IpConf}
DnsName : bst-32359e0c-d6a5-45f1-b196-2f9a4b4b77e8.bastion.azure.com
ProvisioningState : Succeeded
IpConfigurationsText : [
{
"Name": "IpConf",
"Etag": "W/\"bd537319-3379-4caf-a8dc-be4506f9dd3a\"",
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/bastionHosts/ps5581/bastionHostIpConfigurations/IpConf",
"Subnet": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/virtualNetworks/ps7070/subnets/AzureBastionSubnet"
},
"PublicIpAddress": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/publicIPAddresses/ps2217"
},
"ProvisioningState": "Succeeded",
"PrivateIpAllocationMethod": "Dynamic"
}
]
Sku : {
"Name": "Standard"
}
Scale Units : 50
Kerberos : True
Copy/Paste : True
Native Client : True
IP Connect : True
Shareable Link : True
ResourceGroupName : ps1621
Location : westcentralus
ResourceGuid :
Type : Microsoft.Network/bastionHosts
Tag :
TagsTable :
Name : ps5581
Etag : W/"bd537319-3379-4caf-a8dc-be4506f9dd3a"
Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps1621/providers/Microsoft.Network/bastionHosts/ps5581
IpConfigurations : {IpConf}
DnsName : bst-aee29973-3b60-44c1-a1de-bd8636e79127.bastion.azure.com
ProvisioningState : Succeeded
IpConfigurationsText : [
{
"Name": "IpConf",
"Etag": "W/\"42f723dd-f1de-4fd0-b307-3fe82f0b50f7\"",
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/bastionHosts/ps8815/bastionHostIpConfigurations/IpConf",
"Subnet": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/virtualNetworks/ps5766/subnets/AzureBastionSubnet"
},
"PublicIpAddress": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/publicIPAddresses/ps2773"
},
"ProvisioningState": "Succeeded",
"PrivateIpAllocationMethod": "Dynamic"
}
]
Sku : {
"Name": "Standard"
}
Scale Units : 2
Kerberos : False
Copy/Paste : False
Native Client : False
IP Connect : False
Shareable Link : False
ResourceGroupName : ps3151
Location : westcentralus
ResourceGuid :
Type : Microsoft.Network/bastionHosts
Tag :
TagsTable :
Name : ps8815
Etag : W/"42f723dd-f1de-4fd0-b307-3fe82f0b50f7"
Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3151/providers/Microsoft.Network/bastionHosts/ps8815
IpConfigurations : {IpConf}
DnsName : bst-746c229d-f144-4699-a7ea-303a15a70457.bastion.azure.com
ProvisioningState : Succeeded
IpConfigurationsText : [
{
"Name": "IpConf",
"Etag": "W/\"0b11e3e7-330b-4727-b073-dfe458429fcf\"",
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3429/providers/Microsoft.Network/bastionHosts/ps7790/bastionHostIpConfigurations/IpConf",
"Subnet": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3429/providers/Microsoft.Network/virtualNetworks/ps7582/subnets/AzureBastionSubnet"
},
"PublicIpAddress": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/ps3429/providers/Microsoft.Network/publicIPAddresses/ps8199"
},
"ProvisioningState": "Succeeded",
"PrivateIpAllocationMethod": "Dynamic"
}
]
Sku : {
"Name": "Basic"
}
Scale Units : 2
Kerberos : False
Copy/Paste : False
Native Client : False
IP Connect : False
Shareable Link : FalseExample 2
Get-AzBastion -ResourceGroupName "BastionPowershellTest" -Name "testBastion"
IpConfigurations : {IpConf}
DnsName : bst-0597f607-ab71-46c2-ab2a-777bfa887aff.bastion.azure.com
ProvisioningState : Succeeded
IpConfigurationsText : [
{
"Name": "IpConf",
"Etag": "W/\"4d023823-3ea8-439a-ac00-20f16fb0c9b2\"",
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion/bastionHostIpConfigurations/IpConf",
"Subnet": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/virtualNetworks/TestVnet/subnets/AzureBastionSubnet"
},
"PublicIpAddress": {
"Id": "/subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/publicIPAddresses/Test-Ip"
},
"ProvisioningState": "Succeeded",
"PrivateIpAllocationMethod": "Dynamic"
}
]
ResourceGroupName : BastionPowershellTest
Location : westeurope
ResourceGuid :
Type : Microsoft.Network/bastionHosts
Tag :
TagsTable :
Name : testBastion
Etag : W/"4d023823-3ea8-439a-ac00-20f16fb0c9b2"
Id : /subscriptions/359a08a9-ff1b-463c-92d7-6df8d946f25c/resourceGroups/BastionPowershellTest/providers/Microsoft.Network/bastionHosts/testBastion
Sku : {
"Name": "Basic"
}
Scale Units : 2
Kerberos : False
Copy/Paste : False
Native Client : False
IP Connect : False
Shareable Link : FalseParameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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 |
-Name
The bastion resource name.
| Type: | String |
| Aliases: | ResourceName, BastionName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ResourceId
The bastion Azure resource Id
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
IEnumerable<T>[[Microsoft.Azure.Commands.Network.Models.PSBastion, Microsoft.Azure.PowerShell.Cmdlets.Network, Version=6.2.0.0, Culture=neutral, PublicKeyToken=null]]
Related Links
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
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for