n_groups

Creates, updates, deletes, gets or lists a n_groups resource.

Overview

Name	n_groups
Type	Resource
Id	azure.container_instance.n_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
containerGroupProfiles	array	The Container Group Profiles that could be used in the NGroups resource.
elasticProfile	object	The elastic profile.
identity	object	The identity of the NGroup, if configured.
location	string	The geo-location where the resource lives.
placementProfile	object	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.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Canceled", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Canceled, Deleting, Migrating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateProfile	object	Used by the customer to specify the way to update the Container Groups in NGroup.
zones	array	The availability zones.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
containerGroupProfiles	array	The Container Group Profiles that could be used in the NGroups resource.
elasticProfile	object	The elastic profile.
identity	object	The identity of the NGroup, if configured.
location	string	The geo-location where the resource lives.
placementProfile	object	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.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Canceled", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Canceled, Deleting, Migrating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateProfile	object	Used by the customer to specify the way to update the Container Groups in NGroup.
zones	array	The availability zones.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
containerGroupProfiles	array	The Container Group Profiles that could be used in the NGroups resource.
elasticProfile	object	The elastic profile.
identity	object	The identity of the NGroup, if configured.
location	string	The geo-location where the resource lives.
placementProfile	object	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.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Canceled", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Canceled, Deleting, Migrating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateProfile	object	Used by the customer to specify the way to update the Container Groups in NGroup.
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, ngroups_name, subscription_id		NGroups GET REST API. Get the properties of the specified NGroups resource.
list_by_resource_group	select	resource_group_name, subscription_id		GET NGroups under a resource group REST API. Gets a list of all NGroups resources under a resource group.
list	select	subscription_id		List NGroups in a subscription. Gets a list of all NGroups resources under a subscription.
create_or_update	insert	resource_group_name, ngroups_name, subscription_id		NGroup PUT REST API. Create or update a NGroups resource.
update	update	resource_group_name, ngroups_name, subscription_id		NGroups PATCH REST API. Update a specified NGroups resource.
create_or_update	replace	resource_group_name, ngroups_name, subscription_id		NGroup PUT REST API. Create or update a NGroups resource.
delete	delete	resource_group_name, ngroups_name, subscription_id		NGroups Delete REST API. Deletes the NGroups resource.
start	exec	resource_group_name, ngroups_name, subscription_id		Starts all container groups in the specified NGroups resource. Starts all container groups in the specified NGroups resource. Compute resources will be allocated and billing will start.
stop	exec	resource_group_name, ngroups_name, subscription_id		Stops all container groups in the specified NGroups resource. Stops all container groups in the specified NGroups resource. Compute resources will be deallocated and billing will stop.
restart	exec	resource_group_name, ngroups_name, subscription_id		Restarts all container groups in the specified NGroups resource. Restarts all container groups in the specified NGroups resource in place. If container image has updates, new image will be downloaded.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ngroups_name	string	The NGroups name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

NGroups GET REST API. Get the properties of the specified NGroups resource.

SELECT
id,
name,
containerGroupProfiles,
elasticProfile,
identity,
location,
placementProfile,
provisioningState,
systemData,
tags,
type,
updateProfile,
zones
FROM azure.container_instance.n_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND ngroups_name = '{{ ngroups_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

GET NGroups under a resource group REST API. Gets a list of all NGroups resources under a resource group.

SELECT
id,
name,
containerGroupProfiles,
elasticProfile,
identity,
location,
placementProfile,
provisioningState,
systemData,
tags,
type,
updateProfile,
zones
FROM azure.container_instance.n_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List NGroups in a subscription. Gets a list of all NGroups resources under a subscription.

SELECT
id,
name,
containerGroupProfiles,
elasticProfile,
identity,
location,
placementProfile,
provisioningState,
systemData,
tags,
type,
updateProfile,
zones
FROM azure.container_instance.n_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

NGroup PUT REST API. Create or update a NGroups resource.

INSERT INTO azure.container_instance.n_groups (
properties,
tags,
location,
zones,
identity,
resource_group_name,
ngroups_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ zones }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ ngroups_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: n_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the n_groups resource.
  - name: ngroups_name
    value: "{{ ngroups_name }}"
    description: Required parameter for the n_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the n_groups resource.
  - name: properties
    description: |
      Describes the properties of the NGroups resource.
    value:
      elasticProfile:
        desiredCount: {{ desiredCount }}
        maintainDesiredCount: {{ maintainDesiredCount }}
        containerGroupNamingPolicy:
          guidNamingPolicy:
            prefix: "{{ prefix }}"
      placementProfile:
        faultDomainCount: {{ faultDomainCount }}
      containerGroupProfiles:
        - resource:
            id: "{{ id }}"
          revision: {{ revision }}
          networkProfile:
            loadBalancer:
              backendAddressPools:
                - resource: "{{ resource }}"
            applicationGateway:
              resource: "{{ resource }}"
              backendAddressPools:
                - resource: "{{ resource }}"
          storageProfile:
            fileShares:
              - name: "{{ name }}"
                resourceGroupName: "{{ resourceGroupName }}"
                storageAccountName: "{{ storageAccountName }}"
                properties:
                  shareAccessType: "{{ shareAccessType }}"
                  shareAccessTier: "{{ shareAccessTier }}"
          containerGroupProperties:
            subnetIds:
              - id: "{{ id }}"
                name: "{{ name }}"
            volumes:
              - name: "{{ name }}"
                azureFile:
                  shareName: "{{ shareName }}"
                  readOnly: {{ readOnly }}
                  storageAccountName: "{{ storageAccountName }}"
                  storageAccountKey: "{{ storageAccountKey }}"
                  storageAccountKeyReference: "{{ storageAccountKeyReference }}"
            containers:
              - name: "{{ name }}"
                properties:
                  volumeMounts: "{{ volumeMounts }}"
      provisioningState: "{{ provisioningState }}"
      updateProfile:
        updateMode: "{{ updateMode }}"
        rollingUpdateProfile:
          maxBatchPercent: {{ maxBatchPercent }}
          maxUnhealthyPercent: {{ maxUnhealthyPercent }}
          pauseTimeBetweenBatches: "{{ pauseTimeBetweenBatches }}"
          inPlaceUpdate: {{ inPlaceUpdate }}
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.
  - name: identity
    description: |
      The identity of the NGroup, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

NGroups PATCH REST API. Update a specified NGroups resource.

UPDATE azure.container_instance.n_groups
SET 
properties = '{{ properties }}',
identity = '{{ identity }}',
tags = '{{ tags }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND ngroups_name = '{{ ngroups_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

NGroup PUT REST API. Create or update a NGroups resource.

REPLACE azure.container_instance.n_groups
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
zones = '{{ zones }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND ngroups_name = '{{ ngroups_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples

delete

NGroups Delete REST API. Deletes the NGroups resource.

DELETE FROM azure.container_instance.n_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND ngroups_name = '{{ ngroups_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts all container groups in the specified NGroups resource. Starts all container groups in the specified NGroups resource. Compute resources will be allocated and billing will start.

EXEC azure.container_instance.n_groups.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@ngroups_name='{{ ngroups_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops all container groups in the specified NGroups resource. Stops all container groups in the specified NGroups resource. Compute resources will be deallocated and billing will stop.

EXEC azure.container_instance.n_groups.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@ngroups_name='{{ ngroups_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restart

Restarts all container groups in the specified NGroups resource. Restarts all container groups in the specified NGroups resource in place. If container image has updates, new image will be downloaded.

EXEC azure.container_instance.n_groups.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@ngroups_name='{{ ngroups_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;