Microsoft.ContainerInstance (preview:2024-11-01)

2025/05/28 • 5 updated methods

NGroups_Get (updated)
Description :  Get the properties of the specified NGroups resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NGroups_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_1087edc9e8d34eb198242204136f4e51": {
          "#name": "zones",
          "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_e30a7cec8e784468ba30a0a175b44763": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NGroups_CreateOrUpdate (updated)
Description :  Create or update a NGroups resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NGroups_CreateOrUpdate",
  "$parameters": {
    "NGroup": {
      "$properties": {
        "@removed_2dd65acdf50c46b2b988e9892778c945": {
          "#name": "zones",
          "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_0a8f19eaa0bd47b48cdff8e4181d1229": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_44f0a1549df344939564a85a9c3c592c": {
          "#name": "zones",
          "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_e04cec00b5424a329e27b0754fc766e5": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_42c7c181378d4d6f8bb5b74c10b4ac12": {
          "#name": "zones",
          "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_49e2f4f0478549a584a85757f34d77c0": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
NGroup:
{
Description: The NGroup object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_Update (updated)
Description :  Update a specified NGroups resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NGroups_Update",
  "$parameters": {
    "NGroup": {
      "$properties": [
        {
          "@added_491749f476244b96b1ffb94e113b502c": {
            "#name": "tags",
            "Description": "The resource tags.",
            "Required": false,
            "Type": "object"
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The zones for the NGroup.",
            "old": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set"
          }
        },
        {
          "@removed_7badf34e9fd24f10962306d6bcea6da6": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_422ae6e8caff4bf88c034925bf22a533": {
          "#name": "zones",
          "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_5a74a26bbbcc4098adb7e9990a39737d": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ngroupsName:
{
Description: The NGroups name. ,
Required: True ,
}
string ,
NGroup:
{
Description: The NGroup object. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
zones:
{
Description: The zones for the NGroup. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Describes the NGroups resource. ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NGroups_ListByResourceGroup (updated)
Description :  Gets a list of all NGroups resources under a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NGroups_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@removed_f716e594c6eb49359a93713c847de31b": {
              "#name": "zones",
              "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@removed_76b9000408364ca0a8a50659e591a7bc": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of NGroups. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of NGroups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NGroups_List (updated)
Description :  Gets a list of all NGroups resources under a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NGroups_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@removed_2ba29459e4a542299ff22c9a970b8896": {
              "#name": "zones",
              "Description": "The NGroups zones. NOTE: Availability zones can only be set when you create the scale set",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@removed_1204d1a0cbe84734afeabb4a652beeeb": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/ngroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of NGroups. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes the properties of the NGroups resource. ,
Required: False ,
}
{
elasticProfile:
{
Description: The elastic profile. ,
Required: False ,
}
{
desiredCount:
{
Format: int32 ,
Required: False ,
}
integer ,
maintainDesiredCount:
{
Description: 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. ,
Required: False ,
}
boolean ,
containerGroupNamingPolicy:
{
Description: 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. ,
Required: False ,
}
{
guidNamingPolicy:
{
Required: False ,
}
{
prefix:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}
,
}
,
placementProfile:
{
Description: 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. ,
Required: False ,
}
{
faultDomainCount:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
containerGroupProfiles:
{
Description: The Container Group Profiles that could be used in the NGroups resource. ,
Required: False ,
}
[
{
resource:
{
Description: A reference to the container group profile ARM resource hosted in ACI RP. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... ,
Required: False ,
}
string ,
}
,
revision:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
networkProfile:
{
Description: A network profile for network settings of a ContainerGroupProfile. ,
Required: False ,
}
{
loadBalancer:
{
Description: LoadBalancer the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
backendAddressPools:
{
Description: List of Load Balancer Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The Load Balancer backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
applicationGateway:
{
Description: Application Gateway the CG profile will use to interact with CGs in a backend pool ,
Required: False ,
}
{
resource:
{
Description: The Application Gateway ARM resource Id. ,
Required: False ,
}
string ,
backendAddressPools:
{
Description: List of Application Gateway Backend Address Pools. ,
Required: False ,
}
[
{
resource:
{
Description: The application gateway backend address pool ARM resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
storageProfile:
{
Description: Storage profile for storage related settings of a container group profile. ,
Required: False ,
}
{
fileShares:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
storageAccountName:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
shareAccessType:
{
Description: 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. ,
Enum:
{
Shared: No description available. ,
Exclusive: No description available. ,
}
,
Required: False ,
}
enum ,
shareAccessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier ,
Enum:
{
Cool: No description available. ,
Hot: No description available. ,
Premium: No description available. ,
TransactionOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
containerGroupProperties:
{
Description: Container Group properties which can be set while creating or updating the NGroups. ,
Required: False ,
}
{
subnetIds:
{
Description: Contains information about Virtual Network Subnet ARM Resource ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of virtual network and subnet. ,
Required: True ,
}
string ,
name:
{
Description: Friendly name for the subnet. ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Contains information about the volumes that can be mounted by Containers in the Container Groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
azureFile:
{
Description: The Azure File volume. ,
Required: False ,
}
{
shareName:
{
Description: The name of the Azure File share to be mounted as a volume. ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the Azure File shared mounted as a volume is read-only. ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: The name of the storage account that contains the Azure File share. ,
Required: True ,
}
string ,
storageAccountKey:
{
Description: The storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
storageAccountKeyReference:
{
Description: The reference to the storage account access key used to access the Azure File share. ,
Required: False ,
}
string ,
}
,
}
,
]
,
containers:
{
Description: Contains information about Container which can be set while creating or updating the NGroups. ,
Required: False ,
}
[
{
name:
{
Description: container name ,
Required: False ,
}
string ,
properties:
{
Description: container properties ,
Required: False ,
}
{
volumeMounts:
{
Required: False ,
}
[
{
name:
{
Description: The name of the volume mount. ,
Required: True ,
}
string ,
mountPath:
{
Description: The path within the container where the volume should be mounted. Must not contain colon (:). ,
Required: True ,
}
string ,
readOnly:
{
Description: The flag indicating whether the volume mount is read-only. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
updateProfile:
{
Description: Used by the customer to specify the way to update the Container Groups in NGroup. ,
Required: False ,
}
{
updateMode:
{
Enum:
{
Manual: No description available. ,
Rolling: No description available. ,
}
,
Required: False ,
}
enum ,
rollingUpdateProfile:
{
Description: This profile allows the customers to customize the rolling update. ,
Required: False ,
}
{
maxBatchPercent:
{
Description: Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyPercent:
{
Description: Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: 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. ,
Required: False ,
}
string ,
inPlaceUpdate:
{
Description: Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The identity of the NGroup, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the NGroup identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the NGroup. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of NGroups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Container Instance service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}