---
title: "NGroups PATCH REST API"
method: PATCH
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}"
---

# NGroups PATCH REST API

`PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}`

Update a specified NGroups resource.

## Path parameters

- `ngroupsName` string, required

## Parameters

- `../../../../../../common-types/resource-management/v5/types.json#/components/parameters/ApiVersionParameter` — unresolved $ref
- `../../../../../../common-types/resource-management/v5/types.json#/components/parameters/SubscriptionIdParameter` — unresolved $ref
- `../../../../../../common-types/resource-management/v5/types.json#/components/parameters/ResourceGroupNameParameter` — unresolved $ref

## Request body

- NGroupPatch — Describes the NGroups resource.
  - `systemData` SystemData — unresolved $ref
  - `properties` NGroupProperties — Describes the properties of the NGroups resource.
    - `elasticProfile` ElasticProfile — Describes the elastic profile of the NGroup
      - `desiredCount` integer
      - `maintainDesiredCount` boolean — 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.
      - `containerGroupNamingPolicy` ElasticProfileContainerGroupNamingPolicy — 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.
        - `guidNamingPolicy` ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy
          - `prefix` string — 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.
    - `placementProfile` PlacementProfile — Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains.
      - `faultDomainCount` integer — 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.
    - `containerGroupProfiles` ContainerGroupProfileStub[] — The Container Group Profiles that could be used in the NGroups resource.
      - `resource` ApiEntityReference — The API entity reference.
        - `id` string — The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
      - `revision` integer — 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.
      - `networkProfile` NetworkProfile — A network profile for network settings of a ContainerGroupProfile. Used to manage load balancer and application gateway backend pools, specifically updating the IP addresses of CGs within the backend pool.
        - `loadBalancer` LoadBalancer — LoadBalancer the CG profile will use to interact with CGs in a backend pool
          - `backendAddressPools` LoadBalancerBackendAddressPool[] — List of Load Balancer Backend Address Pools.
            - `resource` string — The Load Balancer backend address pool ARM resource Id.
        - `applicationGateway` ApplicationGateway — Application Gateway the CG profile will use to interact with CGs in a backend pool
          - `resource` string — The Application Gateway ARM resource Id.
          - `backendAddressPools` ApplicationGatewayBackendAddressPool[] — List of Application Gateway Backend Address Pools.
            - `resource` string — The application gateway backend address pool ARM resource Id.
      - `storageProfile` StorageProfile — Storage profile for storage related settings of a container group profile.
        - `fileShares` FileShare[]
          - `name` string
          - `resourceGroupName` string
          - `storageAccountName` string
          - `properties` FileShareProperties
            - `shareAccessType` 'Shared' | 'Exclusive' — 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.
            - `shareAccessTier` 'Cool' | 'Hot' | 'Premium' | 'TransactionOptimized' — 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
      - `containerGroupProperties` NGroupContainerGroupProperties — Container Group properties which can be set while creating or updating the NGroups.
        - `subnetIds` ContainerGroupSubnetId[] — Contains information about Virtual Network Subnet ARM Resource
          - `id` string, required — Resource ID of virtual network and subnet.
          - `name` string — Friendly name for the subnet.
        - `volumes` NGroupCGPropertyVolume[] — Contains information about the volumes that can be mounted by Containers in the Container Groups.
          - `name` string, required — The name of the volume.
          - `azureFile` AzureFileVolume — The properties of the Azure File volume. Azure File shares are mounted as volumes.
            - `shareName` string, required — The name of the Azure File share to be mounted as a volume.
            - `readOnly` boolean — The flag indicating whether the Azure File shared mounted as a volume is read-only.
            - `storageAccountName` string, required — The name of the storage account that contains the Azure File share.
            - `storageAccountKey` string, password — The storage account access key used to access the Azure File share.
            - `storageAccountKeyReference` string — The reference to the storage account access key used to access the Azure File share.
        - `containers` NGroupCGPropertyContainer[] — Contains information about Container which can be set while creating or updating the NGroups.
          - `name` string — container name
          - `properties` NGroupCGPropertyContainerProperties — container properties
            - `volumeMounts` VolumeMount[]
              - …
    - `provisioningState` 'Creating' | 'Updating' | 'Failed' | 'Succeeded' | 'Canceled' | 'Deleting' | 'Migrating' — The provisioning state, which only appears in the response.
    - `updateProfile` UpdateProfile — Used by the customer to specify the way to update the Container Groups in NGroup.
      - `updateMode` 'Manual' | 'Rolling'
      - `rollingUpdateProfile` UpdateProfileRollingUpdateProfile — This profile allows the customers to customize the rolling update.
        - `maxBatchPercent` integer — Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
        - `maxUnhealthyPercent` integer — Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
        - `pauseTimeBetweenBatches` string — 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.
        - `inPlaceUpdate` boolean — Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
  - `identity` NGroupIdentity — Identity for the NGroup.
    - `principalId` string — The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    - `tenantId` string — The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    - `type` 'SystemAssigned' | 'UserAssigned' | 'SystemAssigned, UserAssigned' | 'None' — The type of identity used for the container group. 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 container group.
    - `userAssignedIdentities` object — The list of user identities associated with the NGroup.
  - `tags` object — The resource tags.
  - `zones` string[] — The zones for the NGroup.

## Response `200`

The request has succeeded.

- NGroup — unresolved $ref

## Other responses

- `202` — Resource update request accepted.
- `default` — An unexpected error response.

## Changes

- **2026-07-13** (2017-08-01-preview) `540a7f5ef13b` — 1 info
  - endpoint added
- **2026-07-13** (2017-08-01-preview) `db7c7d88f46c` — 1 breaking
  - api path removed without deprecation
- **2026-07-13** (2017-08-01-preview) `3b95c53f2960` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/azure/apis/containerinstance-microsoft-containerinstance-containerinsta/changes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ContainerInstance/ngroups/:ngroupsName/patch.md)

---

[API](https://skmtc.dev/azure/apis/containerinstance-microsoft-containerinstance-containerinsta.md) · [All operations](https://skmtc.dev/azure/apis/containerinstance-microsoft-containerinstance-containerinsta/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/containerinstance-microsoft-containerinstance-containerinsta/revisions/0543d3a66e63/schema)