Microsoft.ContainerInstance ngroups

Bicep resource definition

The ngroups resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerInstance/ngroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerInstance/ngroups@2025-09-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    containerGroupProfiles: [
      {
        containerGroupProperties: {
          containers: [
            {
              name: 'string'
              properties: {
                volumeMounts: [
                  {
                    mountPath: 'string'
                    name: 'string'
                    readOnly: bool
                  }
                ]
              }
            }
          ]
          subnetIds: [
            {
              id: 'string'
              name: 'string'
            }
          ]
          volumes: [
            {
              azureFile: {
                readOnly: bool
                shareName: 'string'
                storageAccountKey: 'string'
                storageAccountKeyReference: 'string'
                storageAccountName: 'string'
              }
              name: 'string'
            }
          ]
        }
        networkProfile: {
          applicationGateway: {
            backendAddressPools: [
              {
                resource: 'string'
              }
            ]
            resource: 'string'
          }
          loadBalancer: {
            backendAddressPools: [
              {
                resource: 'string'
              }
            ]
          }
        }
        resource: {
          id: 'string'
        }
        revision: int
        storageProfile: {
          fileShares: [
            {
              name: 'string'
              properties: {
                shareAccessTier: 'string'
                shareAccessType: 'string'
              }
              resourceGroupName: 'string'
              storageAccountName: 'string'
            }
          ]
        }
      }
    ]
    elasticProfile: {
      containerGroupNamingPolicy: {
        guidNamingPolicy: {
          prefix: 'string'
        }
      }
      desiredCount: int
      maintainDesiredCount: bool
    }
    placementProfile: {
      faultDomainCount: int
    }
    updateProfile: {
      rollingUpdateProfile: {
        inPlaceUpdate: bool
        maxBatchPercent: int
        maxUnhealthyPercent: int
        pauseTimeBetweenBatches: 'string'
      }
      updateMode: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

Microsoft.ContainerInstance/ngroups

Name	Description	Value
identity	The identity of the NGroup, if configured.	NGroupIdentity
location	The geo-location where the resource lives	string
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	Describes the properties of the NGroups resource.	NGroupProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
zones	The availability zones.	string[]

ApiEntityReference

Name	Description	Value
id	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...	string

ApplicationGateway

Name	Description	Value
backendAddressPools	List of Application Gateway Backend Address Pools.	ApplicationGatewayBackendAddressPool[]
resource	The Application Gateway ARM resource Id.	string

ApplicationGatewayBackendAddressPool

Name	Description	Value
resource	The application gateway backend address pool ARM resource Id.	string

AzureFileVolume

Name	Description	Value
readOnly	The flag indicating whether the Azure File shared mounted as a volume is read-only.	bool
shareName	The name of the Azure File share to be mounted as a volume.	string (required)
storageAccountKey	The storage account access key used to access the Azure File share.	string Constraints: Sensitive value. Pass in as a secure parameter.
storageAccountKeyReference	The reference to the storage account access key used to access the Azure File share.	string
storageAccountName	The name of the storage account that contains the Azure File share.	string (required)

ContainerGroupProfileStub

Name	Description	Value
containerGroupProperties	Container Group properties which can be set while creating or updating the NGroups.	NGroupContainerGroupProperties
networkProfile	A network profile for network settings of a ContainerGroupProfile.	NetworkProfile
resource	A reference to the container group profile ARM resource hosted in ACI RP.	ApiEntityReference
revision	The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.	int
storageProfile	Storage profile for storage related settings of a container group profile.	StorageProfile

ContainerGroupSubnetId

Name	Description	Value
id	Resource ID of virtual network and subnet.	string (required)
name	Friendly name for the subnet.	string

ElasticProfile

Name	Description	Value
containerGroupNamingPolicy	Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.	ElasticProfileContainerGroupNamingPolicy
desiredCount		int
maintainDesiredCount	Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.	bool

ElasticProfileContainerGroupNamingPolicy

Name	Description	Value
guidNamingPolicy		ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy

ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy

Name	Description	Value
prefix	The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.	string

FileShare

Name	Description	Value
name		string
properties		FileShareProperties
resourceGroupName		string
storageAccountName		string

FileShareProperties

Name	Description	Value
shareAccessTier	Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: /rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier	'Cool' 'Hot' 'Premium' 'TransactionOptimized'
shareAccessType	Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.	'Exclusive' 'Shared'

LoadBalancer

Name	Description	Value
backendAddressPools	List of Load Balancer Backend Address Pools.	LoadBalancerBackendAddressPool[]

LoadBalancerBackendAddressPool

Name	Description	Value
resource	The Load Balancer backend address pool ARM resource Id.	string

NetworkProfile

Name	Description	Value
applicationGateway	Application Gateway the CG profile will use to interact with CGs in a backend pool	ApplicationGateway
loadBalancer	LoadBalancer the CG profile will use to interact with CGs in a backend pool	LoadBalancer

NGroupCGPropertyContainer

Name	Description	Value
name	container name	string
properties	container properties	NGroupCGPropertyContainerProperties

NGroupCGPropertyContainerProperties

Name	Description	Value
volumeMounts		VolumeMount[]

NGroupCGPropertyVolume

Name	Description	Value
azureFile	The Azure File volume.	AzureFileVolume
name	The name of the volume.	string (required)

NGroupContainerGroupProperties

Name	Description	Value
containers	Contains information about Container which can be set while creating or updating the NGroups.	NGroupCGPropertyContainer[]
subnetIds	Contains information about Virtual Network Subnet ARM Resource	ContainerGroupSubnetId[]
volumes	Contains information about the volumes that can be mounted by Containers in the Container Groups.	NGroupCGPropertyVolume[]

NGroupIdentity

Name	Description	Value
type	The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with the NGroup.	NGroupIdentityUserAssignedIdentities

NGroupIdentityUserAssignedIdentities

Name	Description	Value

NGroupProperties

Name	Description	Value
containerGroupProfiles	The Container Group Profiles that could be used in the NGroups resource.	ContainerGroupProfileStub[]
elasticProfile	The elastic profile.	ElasticProfile
placementProfile	Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains.	PlacementProfile
updateProfile	Used by the customer to specify the way to update the Container Groups in NGroup.	UpdateProfile

NGroupTags

Name	Description	Value

PlacementProfile

Name	Description	Value
faultDomainCount	The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.	int

StorageProfile

Name	Description	Value
fileShares		FileShare[]

UpdateProfile

Name	Description	Value
rollingUpdateProfile	This profile allows the customers to customize the rolling update.	UpdateProfileRollingUpdateProfile
updateMode		'Manual' 'Rolling'

UpdateProfileRollingUpdateProfile

Name	Description	Value
inPlaceUpdate	Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.	bool
maxBatchPercent	Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.	int
maxUnhealthyPercent	Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.	int
pauseTimeBetweenBatches	The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.	string

UserAssignedIdentities

Name	Description	Value

VolumeMount

Name	Description	Value
mountPath	The path within the container where the volume should be mounted. Must not contain colon (:).	string (required)
name	The name of the volume mount.	string (required)
readOnly	The flag indicating whether the volume mount is read-only.	bool

ARM template resource definition

The ngroups resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerInstance/ngroups resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerInstance/ngroups",
  "apiVersion": "2025-09-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "containerGroupProfiles": [
      {
        "containerGroupProperties": {
          "containers": [
            {
              "name": "string",
              "properties": {
                "volumeMounts": [
                  {
                    "mountPath": "string",
                    "name": "string",
                    "readOnly": "bool"
                  }
                ]
              }
            }
          ],
          "subnetIds": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "volumes": [
            {
              "azureFile": {
                "readOnly": "bool",
                "shareName": "string",
                "storageAccountKey": "string",
                "storageAccountKeyReference": "string",
                "storageAccountName": "string"
              },
              "name": "string"
            }
          ]
        },
        "networkProfile": {
          "applicationGateway": {
            "backendAddressPools": [
              {
                "resource": "string"
              }
            ],
            "resource": "string"
          },
          "loadBalancer": {
            "backendAddressPools": [
              {
                "resource": "string"
              }
            ]
          }
        },
        "resource": {
          "id": "string"
        },
        "revision": "int",
        "storageProfile": {
          "fileShares": [
            {
              "name": "string",
              "properties": {
                "shareAccessTier": "string",
                "shareAccessType": "string"
              },
              "resourceGroupName": "string",
              "storageAccountName": "string"
            }
          ]
        }
      }
    ],
    "elasticProfile": {
      "containerGroupNamingPolicy": {
        "guidNamingPolicy": {
          "prefix": "string"
        }
      },
      "desiredCount": "int",
      "maintainDesiredCount": "bool"
    },
    "placementProfile": {
      "faultDomainCount": "int"
    },
    "updateProfile": {
      "rollingUpdateProfile": {
        "inPlaceUpdate": "bool",
        "maxBatchPercent": "int",
        "maxUnhealthyPercent": "int",
        "pauseTimeBetweenBatches": "string"
      },
      "updateMode": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.ContainerInstance/ngroups

Name	Description	Value
apiVersion	The api version	'2025-09-01'
identity	The identity of the NGroup, if configured.	NGroupIdentity
location	The geo-location where the resource lives	string
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	Describes the properties of the NGroups resource.	NGroupProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.ContainerInstance/ngroups'
zones	The availability zones.	string[]

ApiEntityReference

Name	Description	Value
id	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...	string

ApplicationGateway

Name	Description	Value
backendAddressPools	List of Application Gateway Backend Address Pools.	ApplicationGatewayBackendAddressPool[]
resource	The Application Gateway ARM resource Id.	string

ApplicationGatewayBackendAddressPool

Name	Description	Value
resource	The application gateway backend address pool ARM resource Id.	string

AzureFileVolume

Name	Description	Value
readOnly	The flag indicating whether the Azure File shared mounted as a volume is read-only.	bool
shareName	The name of the Azure File share to be mounted as a volume.	string (required)
storageAccountKey	The storage account access key used to access the Azure File share.	string Constraints: Sensitive value. Pass in as a secure parameter.
storageAccountKeyReference	The reference to the storage account access key used to access the Azure File share.	string
storageAccountName	The name of the storage account that contains the Azure File share.	string (required)

ContainerGroupProfileStub

Name	Description	Value
containerGroupProperties	Container Group properties which can be set while creating or updating the NGroups.	NGroupContainerGroupProperties
networkProfile	A network profile for network settings of a ContainerGroupProfile.	NetworkProfile
resource	A reference to the container group profile ARM resource hosted in ACI RP.	ApiEntityReference
revision	The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.	int
storageProfile	Storage profile for storage related settings of a container group profile.	StorageProfile

ContainerGroupSubnetId

Name	Description	Value
id	Resource ID of virtual network and subnet.	string (required)
name	Friendly name for the subnet.	string

ElasticProfile

Name	Description	Value
containerGroupNamingPolicy	Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.	ElasticProfileContainerGroupNamingPolicy
desiredCount		int
maintainDesiredCount	Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.	bool

ElasticProfileContainerGroupNamingPolicy

Name	Description	Value
guidNamingPolicy		ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy

ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy

Name	Description	Value
prefix	The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.	string

FileShare

Name	Description	Value
name		string
properties		FileShareProperties
resourceGroupName		string
storageAccountName		string

FileShareProperties

Name	Description	Value
shareAccessTier	Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: /rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier	'Cool' 'Hot' 'Premium' 'TransactionOptimized'
shareAccessType	Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.	'Exclusive' 'Shared'

LoadBalancer

Name	Description	Value
backendAddressPools	List of Load Balancer Backend Address Pools.	LoadBalancerBackendAddressPool[]

LoadBalancerBackendAddressPool

Name	Description	Value
resource	The Load Balancer backend address pool ARM resource Id.	string

NetworkProfile

Name	Description	Value
applicationGateway	Application Gateway the CG profile will use to interact with CGs in a backend pool	ApplicationGateway
loadBalancer	LoadBalancer the CG profile will use to interact with CGs in a backend pool	LoadBalancer

NGroupCGPropertyContainer

Name	Description	Value
name	container name	string
properties	container properties	NGroupCGPropertyContainerProperties

NGroupCGPropertyContainerProperties

Name	Description	Value
volumeMounts		VolumeMount[]

NGroupCGPropertyVolume

Name	Description	Value
azureFile	The Azure File volume.	AzureFileVolume
name	The name of the volume.	string (required)

NGroupContainerGroupProperties

Name	Description	Value
containers	Contains information about Container which can be set while creating or updating the NGroups.	NGroupCGPropertyContainer[]
subnetIds	Contains information about Virtual Network Subnet ARM Resource	ContainerGroupSubnetId[]
volumes	Contains information about the volumes that can be mounted by Containers in the Container Groups.	NGroupCGPropertyVolume[]

NGroupIdentity

Name	Description	Value
type	The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with the NGroup.	NGroupIdentityUserAssignedIdentities

NGroupIdentityUserAssignedIdentities

Name	Description	Value

NGroupProperties

Name	Description	Value
containerGroupProfiles	The Container Group Profiles that could be used in the NGroups resource.	ContainerGroupProfileStub[]
elasticProfile	The elastic profile.	ElasticProfile
placementProfile	Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains.	PlacementProfile
updateProfile	Used by the customer to specify the way to update the Container Groups in NGroup.	UpdateProfile

NGroupTags

Name	Description	Value

PlacementProfile

Name	Description	Value
faultDomainCount	The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.	int

StorageProfile

Name	Description	Value
fileShares		FileShare[]

UpdateProfile

Name	Description	Value
rollingUpdateProfile	This profile allows the customers to customize the rolling update.	UpdateProfileRollingUpdateProfile
updateMode		'Manual' 'Rolling'

UpdateProfileRollingUpdateProfile

Name	Description	Value
inPlaceUpdate	Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.	bool
maxBatchPercent	Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.	int
maxUnhealthyPercent	Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.	int
pauseTimeBetweenBatches	The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.	string

UserAssignedIdentities

Name	Description	Value

VolumeMount

Name	Description	Value
mountPath	The path within the container where the volume should be mounted. Must not contain colon (:).	string (required)
name	The name of the volume mount.	string (required)
readOnly	The flag indicating whether the volume mount is read-only.	bool

Usage Examples

Terraform (AzAPI provider) resource definition

The ngroups resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerInstance/ngroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerInstance/ngroups@2025-09-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      containerGroupProfiles = [
        {
          containerGroupProperties = {
            containers = [
              {
                name = "string"
                properties = {
                  volumeMounts = [
                    {
                      mountPath = "string"
                      name = "string"
                      readOnly = bool
                    }
                  ]
                }
              }
            ]
            subnetIds = [
              {
                id = "string"
                name = "string"
              }
            ]
            volumes = [
              {
                azureFile = {
                  readOnly = bool
                  shareName = "string"
                  storageAccountKey = "string"
                  storageAccountKeyReference = "string"
                  storageAccountName = "string"
                }
                name = "string"
              }
            ]
          }
          networkProfile = {
            applicationGateway = {
              backendAddressPools = [
                {
                  resource = "string"
                }
              ]
              resource = "string"
            }
            loadBalancer = {
              backendAddressPools = [
                {
                  resource = "string"
                }
              ]
            }
          }
          resource = {
            id = "string"
          }
          revision = int
          storageProfile = {
            fileShares = [
              {
                name = "string"
                properties = {
                  shareAccessTier = "string"
                  shareAccessType = "string"
                }
                resourceGroupName = "string"
                storageAccountName = "string"
              }
            ]
          }
        }
      ]
      elasticProfile = {
        containerGroupNamingPolicy = {
          guidNamingPolicy = {
            prefix = "string"
          }
        }
        desiredCount = int
        maintainDesiredCount = bool
      }
      placementProfile = {
        faultDomainCount = int
      }
      updateProfile = {
        rollingUpdateProfile = {
          inPlaceUpdate = bool
          maxBatchPercent = int
          maxUnhealthyPercent = int
          pauseTimeBetweenBatches = "string"
        }
        updateMode = "string"
      }
    }
    zones = [
      "string"
    ]
  }
}

Property Values

Microsoft.ContainerInstance/ngroups

Name	Description	Value
identity	The identity of the NGroup, if configured.	NGroupIdentity
location	The geo-location where the resource lives	string
name	The resource name	string Constraints: Min length = 1 Max length = 63 Pattern = `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$` (required)
properties	Describes the properties of the NGroups resource.	NGroupProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.ContainerInstance/ngroups@2025-09-01"
zones	The availability zones.	string[]

ApiEntityReference

Name	Description	Value
id	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...	string

ApplicationGateway

Name	Description	Value
backendAddressPools	List of Application Gateway Backend Address Pools.	ApplicationGatewayBackendAddressPool[]
resource	The Application Gateway ARM resource Id.	string

ApplicationGatewayBackendAddressPool

Name	Description	Value
resource	The application gateway backend address pool ARM resource Id.	string

AzureFileVolume

Name	Description	Value
readOnly	The flag indicating whether the Azure File shared mounted as a volume is read-only.	bool
shareName	The name of the Azure File share to be mounted as a volume.	string (required)
storageAccountKey	The storage account access key used to access the Azure File share.	string Constraints: Sensitive value. Pass in as a secure parameter.
storageAccountKeyReference	The reference to the storage account access key used to access the Azure File share.	string
storageAccountName	The name of the storage account that contains the Azure File share.	string (required)

ContainerGroupProfileStub

Name	Description	Value
containerGroupProperties	Container Group properties which can be set while creating or updating the NGroups.	NGroupContainerGroupProperties
networkProfile	A network profile for network settings of a ContainerGroupProfile.	NetworkProfile
resource	A reference to the container group profile ARM resource hosted in ACI RP.	ApiEntityReference
revision	The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.	int
storageProfile	Storage profile for storage related settings of a container group profile.	StorageProfile

ContainerGroupSubnetId

Name	Description	Value
id	Resource ID of virtual network and subnet.	string (required)
name	Friendly name for the subnet.	string

ElasticProfile

Name	Description	Value
containerGroupNamingPolicy	Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.	ElasticProfileContainerGroupNamingPolicy
desiredCount		int
maintainDesiredCount	Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.	bool

ElasticProfileContainerGroupNamingPolicy

Name	Description	Value
guidNamingPolicy		ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy

ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy

Name	Description	Value
prefix	The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.	string

FileShare

Name	Description	Value
name		string
properties		FileShareProperties
resourceGroupName		string
storageAccountName		string

FileShareProperties

Name	Description	Value
shareAccessTier	Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: /rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier	'Cool' 'Hot' 'Premium' 'TransactionOptimized'
shareAccessType	Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.	'Exclusive' 'Shared'

LoadBalancer

Name	Description	Value
backendAddressPools	List of Load Balancer Backend Address Pools.	LoadBalancerBackendAddressPool[]

LoadBalancerBackendAddressPool

Name	Description	Value
resource	The Load Balancer backend address pool ARM resource Id.	string

NetworkProfile

Name	Description	Value
applicationGateway	Application Gateway the CG profile will use to interact with CGs in a backend pool	ApplicationGateway
loadBalancer	LoadBalancer the CG profile will use to interact with CGs in a backend pool	LoadBalancer

NGroupCGPropertyContainer

Name	Description	Value
name	container name	string
properties	container properties	NGroupCGPropertyContainerProperties

NGroupCGPropertyContainerProperties

Name	Description	Value
volumeMounts		VolumeMount[]

NGroupCGPropertyVolume

Name	Description	Value
azureFile	The Azure File volume.	AzureFileVolume
name	The name of the volume.	string (required)

NGroupContainerGroupProperties

Name	Description	Value
containers	Contains information about Container which can be set while creating or updating the NGroups.	NGroupCGPropertyContainer[]
subnetIds	Contains information about Virtual Network Subnet ARM Resource	ContainerGroupSubnetId[]
volumes	Contains information about the volumes that can be mounted by Containers in the Container Groups.	NGroupCGPropertyVolume[]

NGroupIdentity

Name	Description	Value
type	The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with the NGroup.	NGroupIdentityUserAssignedIdentities

NGroupIdentityUserAssignedIdentities

Name	Description	Value

NGroupProperties

Name	Description	Value
containerGroupProfiles	The Container Group Profiles that could be used in the NGroups resource.	ContainerGroupProfileStub[]
elasticProfile	The elastic profile.	ElasticProfile
placementProfile	Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains.	PlacementProfile
updateProfile	Used by the customer to specify the way to update the Container Groups in NGroup.	UpdateProfile

NGroupTags

Name	Description	Value

PlacementProfile

Name	Description	Value
faultDomainCount	The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.	int

StorageProfile

Name	Description	Value
fileShares		FileShare[]

UpdateProfile

Name	Description	Value
rollingUpdateProfile	This profile allows the customers to customize the rolling update.	UpdateProfileRollingUpdateProfile
updateMode		'Manual' 'Rolling'

UpdateProfileRollingUpdateProfile

Name	Description	Value
inPlaceUpdate	Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.	bool
maxBatchPercent	Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.	int
maxUnhealthyPercent	Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.	int
pauseTimeBetweenBatches	The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.	string

UserAssignedIdentities

Name	Description	Value

VolumeMount

Name	Description	Value
mountPath	The path within the container where the volume should be mounted. Must not contain colon (:).	string (required)
name	The name of the volume mount.	string (required)
readOnly	The flag indicating whether the volume mount is read-only.	bool

Feedback

Was this page helpful?

Last updated on 2024-12-09