cg_profiles

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

Overview

Name	cg_profiles
Type	Resource
Id	azure.container_instance.cg_profiles

Fields

The following fields are returned by SELECT queries:

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.
confidentialComputeProperties	object	The properties for confidential container group.
containers	array	The containers within the container group. Required.
diagnostics	object	The diagnostic information for a container group.
encryptionProperties	object	The encryption properties for a container group.
extensions	array	extensions used by virtual kubelet.
imageRegistryCredentials	array	The image registry credentials by which the container group is created from.
initContainers	array	The init containers for a container group.
ipAddress	object	The IP address type of the container group.
location	string	The geo-location where the resource lives.
osType	string	The operating system type required by the containers in the container group. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
priority	string	The priority of the container group. Known values are: "Regular" and "Spot". (Regular, Spot)
registeredRevisions	array	Registered revisions are calculated at request time based off the records in the table logs.
restartPolicy	string	Restart policy for all containers within the container group. * Always Always restart * OnFailure Restart on failure * Never Never restart. Known values are: "Always", "OnFailure", and "Never". (Always, OnFailure, Never)
revision	integer	Container group profile current revision number.
securityContext	object	The container security properties.
shutdownGracePeriod	string (date-time)	Shutdown grace period for containers in a container group.
sku	string	The SKU for a container group. Known values are: "NotSpecified", "Standard", "Dedicated", and "Confidential". (NotSpecified, Standard, Dedicated, Confidential)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeToLive	string (date-time)	Post completion time to live for containers of a CG.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useKrypton	boolean	Gets or sets Krypton use property.
volumes	array	The list of volumes that can be mounted by containers in this container group.
zones	array	The availability zones.

list_by_subscription

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.
confidentialComputeProperties	object	The properties for confidential container group.
containers	array	The containers within the container group. Required.
diagnostics	object	The diagnostic information for a container group.
encryptionProperties	object	The encryption properties for a container group.
extensions	array	extensions used by virtual kubelet.
imageRegistryCredentials	array	The image registry credentials by which the container group is created from.
initContainers	array	The init containers for a container group.
ipAddress	object	The IP address type of the container group.
location	string	The geo-location where the resource lives.
osType	string	The operating system type required by the containers in the container group. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
priority	string	The priority of the container group. Known values are: "Regular" and "Spot". (Regular, Spot)
registeredRevisions	array	Registered revisions are calculated at request time based off the records in the table logs.
restartPolicy	string	Restart policy for all containers within the container group. * Always Always restart * OnFailure Restart on failure * Never Never restart. Known values are: "Always", "OnFailure", and "Never". (Always, OnFailure, Never)
revision	integer	Container group profile current revision number.
securityContext	object	The container security properties.
shutdownGracePeriod	string (date-time)	Shutdown grace period for containers in a container group.
sku	string	The SKU for a container group. Known values are: "NotSpecified", "Standard", "Dedicated", and "Confidential". (NotSpecified, Standard, Dedicated, Confidential)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeToLive	string (date-time)	Post completion time to live for containers of a CG.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useKrypton	boolean	Gets or sets Krypton use property.
volumes	array	The list of volumes that can be mounted by containers in this container group.
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	resource_group_name, subscription_id		List container group profiles in a resource group. Gets a list of all container group profiles under a resource group.
list_by_subscription	select	subscription_id		List container group profiles in a subscription. Gets a list of all container group profiles under a subscription.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_by_resource_group

List container group profiles in a resource group. Gets a list of all container group profiles under a resource group.

SELECT
id,
name,
confidentialComputeProperties,
containers,
diagnostics,
encryptionProperties,
extensions,
imageRegistryCredentials,
initContainers,
ipAddress,
location,
osType,
priority,
registeredRevisions,
restartPolicy,
revision,
securityContext,
shutdownGracePeriod,
sku,
systemData,
tags,
timeToLive,
type,
useKrypton,
volumes,
zones
FROM azure.container_instance.cg_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List container group profiles in a subscription. Gets a list of all container group profiles under a subscription.

SELECT
id,
name,
confidentialComputeProperties,
containers,
diagnostics,
encryptionProperties,
extensions,
imageRegistryCredentials,
initContainers,
ipAddress,
location,
osType,
priority,
registeredRevisions,
restartPolicy,
revision,
securityContext,
shutdownGracePeriod,
sku,
systemData,
tags,
timeToLive,
type,
useKrypton,
volumes,
zones
FROM azure.container_instance.cg_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;