Get-AzureRmContainerGroup
Gets container groups.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmContainerGroup
[[-ResourceGroupName] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmContainerGroup
[-ResourceGroupName] <String>
[-Name] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmContainerGroup
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzureRmContainerGroup cmdlet gets a specified container group or all the container groups in a resource group or the subscription.
Examples
Example 1: Gets a specified container group
PS C:\> Get-AzureRmContainerGroup -ResourceGroupName demo -Name mycontainer
ResourceGroupName : demo
Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
Name : mycontainer
Type : Microsoft.ContainerInstance/containerGroups
Location : westus
Tags :
ProvisioningState : Succeeded
Containers : {mycontainer}
ImageRegistryCredentials :
RestartPolicy :
IpAddress : 13.88.10.240
Ports : {8000}
OsType : Linux
Volumes :
State : Running
Events : {}The command gets the specified container group.
Example 2: Gets container groups in a resource group
PS C:\> Get-AzureRmContainerGroup -ResourceGroupName demo
ResourceGroupName Name Location OsType Image IP Resources ProvisioningState
----------------- ---- -------- ------ ----- -- --------- -----------------
demo container1 west us Linux alpine:latest 40.83.144.50:8002 1 cores/1 gb Succeeded
demo container2 west us Linux alpine:latest 104.42.228.253:8001 1 cores/1 gb SucceededThe command gets the container groups in the resource group demo.
Example 3: Gets container groups in the current subscription
PS C:\> Get-AzureRmContainerGroup
ResourceGroupName Name Location OsType Image IP Resources ProvisioningState
----------------- ---- -------- ------ ----- -- --------- -----------------
demo1 container1 west us Linux alpine:latest 40.83.144.50:8002 1 cores/1 gb Succeeded
demo2 container2 west us Linux alpine:latest 104.42.228.253:8001 1 cores/1 gb SucceededThe command gets the container groups in the current subscription.
Example 4: Gets container groups using resource Id.
PS C:\> Find-AzureRmResource -ResourceGroupEquals demo -ResourceNameEquals mycontainer | Get-AzureRmContainerGroup
ResourceGroupName : demo
Id : /subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
Name : mycontainer
Type : Microsoft.ContainerInstance/containerGroups
Location : westus
Tags :
ProvisioningState : Succeeded
Containers : {mycontainer}
ImageRegistryCredentials :
RestartPolicy :
IpAddress : 13.88.10.240
Ports : {8000}
OsType : Linux
Volumes :
State : Running
Events : {}The command gets the container group with the resource Id.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The container group Name.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource Group Name.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
The resource id.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |