Get-AzContainerInstanceContainerGroupProfile
Gets the properties of the specified container group profile in the specified subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.
Syntax
Get-AzContainerInstanceContainerGroupProfile
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerInstanceContainerGroupProfile
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-RevisionNumber <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerInstanceContainerGroupProfile
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerInstanceContainerGroupProfile
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerInstanceContainerGroupProfile
-InputObject <IContainerInstanceIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzContainerInstanceContainerGroupProfile
-InputObject <IContainerInstanceIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets the properties of the specified container group profile in the specified subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.
Examples
Example 1: List all container group profiles in the current subscription
Get-AzContainerInstanceContainerGroupProfile
Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cgp1 test-rg
eastus test-cgp2 test-rg
This command gets all container group profiles in the current subscription.
Example 2: Get container group profiles in a resource group
Get-AzContainerInstanceContainerGroupProfile -ResourceGroupName test-rg
Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cgp1 test-rg
eastus test-cgp2 test-rg
The command gets the container group profiles in the resource group test-rg
.
Example 3: Get a specific container group profile
Get-AzContainerInstanceContainerGroupProfile -Name test-cgp1 -ResourceGroupName test-rg | Format-List
ConfidentialComputeProperty : {}
ConfidentialComputePropertyCcePolicy :
Container : {test-container}
Diagnostic : {}
DiagnosticLogAnalytic : {}
EncryptionProperty : {}
EncryptionPropertyIdentity :
EncryptionPropertyKeyName :
EncryptionPropertyKeyVersion :
EncryptionPropertyVaultBaseUrl :
Extension :
IPAddress : {
"type": "Public"
}
IPAddressAutoGeneratedDomainNameLabelScope :
IPAddressDnsNameLabel :
IPAddressFqdn :
IPAddressIP :
IPAddressPort :
IPAddressType : Public
Id : /subscriptions/00000000-0000-0000-0000-000000000000
0/resourceGroups/test-rg/providers/Microsoft.Contai
nerInstance/containerGroupProfiles/test-cgp1
ImageRegistryCredentials :
InitContainer : {}
Location : eastus
LogAnalyticLogType :
LogAnalyticMetadata : {
}
LogAnalyticWorkspaceId :
LogAnalyticWorkspaceKey :
LogAnalyticWorkspaceResourceId :
Name : test-cgp1
NetworkProfileId :
OSType : Linux
ResourceGroupName : test-rg
RestartPolicy : Never
Revision : 1
Sku : Standard
Tag : {}
Type : Microsoft.ContainerInstance/containerGroupProfiles
Volume :
The command gets the specified container group profile.
Example 4: Get a specific revision of a container group profile in a resource group
Get-AzContainerInstanceContainerGroupProfile -Name test-cgp -ResourceGroupName test-rg -RevisionNumber 1 | Format-List
ConfidentialComputeProperty : {}
ConfidentialComputePropertyCcePolicy :
Container : {test-container}
Diagnostic : {}
DiagnosticLogAnalytic : {}
EncryptionProperty : {}
EncryptionPropertyIdentity :
EncryptionPropertyKeyName :
EncryptionPropertyKeyVersion :
EncryptionPropertyVaultBaseUrl :
Extension :
IPAddress : {
"type": "Public"
}
IPAddressAutoGeneratedDomainNameLabelScope :
IPAddressDnsNameLabel :
IPAddressFqdn :
IPAddressIP :
IPAddressPort :
IPAddressType : Public
Id : /subscriptions/00000000-0000-0000-0000-000000000000
0/resourceGroups/test-rg/providers/Microsoft.Contai
nerInstance/containerGroupProfiles/test-cgp1
ImageRegistryCredentials :
InitContainer : {}
Location : eastus
LogAnalyticLogType :
LogAnalyticMetadata : {
}
LogAnalyticWorkspaceId :
LogAnalyticWorkspaceKey :
LogAnalyticWorkspaceResourceId :
Name : test-cgp
NetworkProfileId :
OSType : Linux
ResourceGroupName : test-rg
RestartPolicy : Never
Revision : 1
Sku : Standard
Tag : {}
Type : Microsoft.ContainerInstance/containerGroupProfiles
Volume :
The command gets the first revision of the container group profile test-cgp
in the resource group test-rg
.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IContainerInstanceIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The name of the container group profile.
Type: | String |
Aliases: | ContainerGroupProfileName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RevisionNumber
The revision number of the container group profile.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Type: | String[] |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell