New-AzContainerGroup

Module:

Az.ContainerInstance Module

Create or update container groups with specified configurations.

New-AzContainerGroup
 -Name <String>
 -ResourceGroupName <String>
 -Container <IContainer[]>
 -Location <String>
 [-SubscriptionId <String>]
 [-OSType <String>]
 [-ConfidentialComputePropertyCcePolicy <String>]
 [-ContainerGroupProfileId <String>]
 [-ContainerGroupProfileRevision <Int32>]
 [-DnsConfigNameServer <String[]>]
 [-DnsConfigOption <String>]
 [-DnsConfigSearchDomain <String>]
 [-EnableSystemAssignedIdentity]
 [-EncryptionPropertyIdentity <String>]
 [-EncryptionPropertyKeyName <String>]
 [-EncryptionPropertyKeyVersion <String>]
 [-EncryptionPropertyVaultBaseUrl <String>]
 [-Extension <IDeploymentExtensionSpec[]>]
 [-IPAddressAutoGeneratedDomainNameLabelScope <String>]
 [-IPAddressDnsNameLabel <String>]
 [-IPAddressIP <String>]
 [-IPAddressPort <IPort[]>]
 [-IPAddressType <String>]
 [-ImageRegistryCredential <IImageRegistryCredential[]>]
 [-InitContainer <IInitContainerDefinition[]>]
 [-LogAnalyticLogType <String>]
 [-LogAnalyticMetadata <Hashtable>]
 [-LogAnalyticWorkspaceId <String>]
 [-LogAnalyticWorkspaceKey <String>]
 [-LogAnalyticWorkspaceResourceId <String>]
 [-RestartPolicy <String>]
 [-Sku <String>]
 [-StandbyPoolProfileFailContainerGroupCreateOnReuseFailure]
 [-StandbyPoolProfileId <String>]
 [-SubnetId <IContainerGroupSubnetId[]>]
 [-Tag <Hashtable>]
 [-UserAssignedIdentity <String[]>]
 [-Volume <IVolume[]>]
 [-Zone <String[]>]
 [-Priority <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

New-AzContainerGroup
 -Name <String>
 -ResourceGroupName <String>
 -JsonFilePath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

New-AzContainerGroup
 -Name <String>
 -ResourceGroupName <String>
 -JsonString <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Create or update container groups with specified configurations.

$port1 = New-AzContainerInstancePortObject -Port 8000 -Protocol TCP
$port2 = New-AzContainerInstancePortObject -Port 8001 -Protocol TCP
$container = New-AzContainerInstanceObject -Name test-container -Image nginx -RequestCpu 1 -RequestMemoryInGb 1.5 -Port @($port1, $port2)
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux -RestartPolicy "Never" -IpAddressType Public

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group with a container instance, whose image is latest nginx, and requests a public IP address with opening port 8000 and 8001.

$pwd = ConvertTo-SecureString -String "****" -AsPlainText -Force
$env1 = New-AzContainerInstanceEnvironmentVariableObject -Name "env1" -Value "value1"
$env2 = New-AzContainerInstanceEnvironmentVariableObject -Name "env2" -SecureValue $pwd
$container = New-AzContainerInstanceObject -Name test-container -Image alpine -Command "/bin/sh -c myscript.sh" -EnvironmentVariable @($env1, $env2)
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group and runs a custom script inside the container.

$container = New-AzContainerInstanceObject -Name test-container -Image alpine -Command "echo hello"
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group which prints out 'hello' and stops.

$pwd = ConvertTo-SecureString -String "****" -AsPlainText -Force
$container = New-AzContainerInstanceObject -Name test-container -Image myacr.azurecr.io/nginx:latest
$imageRegistryCredential = New-AzContainerGroupImageRegistryCredentialObject -Server "myacr.azurecr.io" -Username "username" -Password $pwd
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -ImageRegistryCredential $imageRegistryCredential

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group with a container instance, whose image is nginx in Azure Container Registry.

$pwd = ConvertTo-SecureString -String "****" -AsPlainText -Force
$container = New-AzContainerInstanceObject -Name test-container -Image myserver.com/nginx:latest
$imageRegistryCredential = New-AzContainerGroupImageRegistryCredentialObject -Server "myserver.com" -Username "username" -Password $pwd
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -ImageRegistryCredential $imageRegistryCredential

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry.

$pwd = ConvertTo-SecureString -String "****" -AsPlainText -Force
$volume = New-AzContainerGroupVolumeObject -Name "myvolume" -AzureFileShareName "myshare" -AzureFileStorageAccountName "username" -AzureFileStorageAccountKey $pwd
$mount = New-AzContainerInstanceVolumeMountObject -MountPath "/aci/logs" -Name "myvolume"
$container = New-AzContainerInstanceObject -Name test-container -Image alpine -VolumeMount $mount
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -Volume $volume

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group with a container instance, whose image is a custom image from a custom container image registry.

$container = New-AzContainerInstanceObject -Name test-container -Image alpine
$containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -EnableSystemAssignedIdentity -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}"

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This commands creates a container group with system assigned and user assigned identity.

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.