Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 4.71 KB

azure_container_group.md

File metadata and controls

63 lines (48 loc) · 4.71 KB

Document: "containerInstance"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json")

ContainerGroup

A container group.

azure_container_group {
  api_version => "api_version",
  container_group => "containerGroup",
  identity => $azure_container_group_identity
  location => "location (optional)",
  properties => "properties (optional)",
  resource_group_name => "resource_group_name",
  subscription_id => "subscription_id",
  tags => "tags (optional)",
}
Name Type Required Description
api_version String true Client API version
container_group Hash true The properties of the container group to be created or updated.
identity ContainerGroupIdentity false The identity of the container group, if configured.
location String false The resource location.
properties Hash false
resource_group_name String true The name of the resource group.
subscription_id String true Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
tags Hash false The resource tags.

ContainerGroupIdentity

Identity for the container group.

$azure_container_group_identity = {
  type => "type (optional)",
  userAssignedIdentities => "userAssignedIdentities (optional)",
}
Name Type Required Description
type String false 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 Hash false The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the ContainerGroup

Operation Path Verb Description OperationID
Create /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.ContainerInstance/containerGroups/%{container_group_name} Put Create or update container groups with specified configurations. ContainerGroups_CreateOrUpdate
List - list all /subscriptions/%{subscription_id}/providers/Microsoft.ContainerInstance/containerGroups Get Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. ContainerGroups_List
List - get one /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.ContainerInstance/containerGroups/%{container_group_name} Get Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. ContainerGroups_Get
List - get list using params /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.ContainerInstance/containerGroups Get Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. ContainerGroups_ListByResourceGroup
Update /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.ContainerInstance/containerGroups/%{container_group_name} Put Create or update container groups with specified configurations. ContainerGroups_CreateOrUpdate
Delete /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.ContainerInstance/containerGroups/%{container_group_name} Delete Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes. ContainerGroups_Delete