Share via

az container container-group-profile

  • Reference

Manage Azure Container Instance Container Group Profile.

Commands

Name Description Type Status
az container container-group-profile create

Create a container group profile.

 Core GA
az container container-group-profile delete

Delete a container group profile.

 Core GA
az container container-group-profile list

List all container group profiles in a resource group.

 Core GA
az container container-group-profile list-revisions

List all revisions for a container group profile.

 Core GA
az container container-group-profile show

Get a container group profile.

 Core GA
az container container-group-profile show-revision

Show a container group profile revision.

 Core GA

az container container-group-profile create

Edit

Create a container group profile.

az container container-group-profile create --resource-group
                                            [--acr-identity]
                                            [--add-capabilities]
                                            [--allow-escalation]
                                            [--azure-file-volume-account-key]
                                            [--azure-file-volume-account-name]
                                            [--azure-file-volume-mount-path]
                                            [--azure-file-volume-share-name]
                                            [--cce-policy]
                                            [--command-line]
                                            [--config-map]
                                            [--cpu]
                                            [--drop-capabilities]
                                            [--environment-variables]
                                            [--file]
                                            [--gitrepo-dir]
                                            [--gitrepo-mount-path]
                                            [--gitrepo-revision]
                                            [--gitrepo-url]
                                            [--image]
                                            [--ip-address {Private, Public}]
                                            [--location]
                                            [--log-analytics-workspace]
                                            [--log-analytics-workspace-key]
                                            [--memory]
                                            [--name]
                                            [--no-wait]
                                            [--os-type {Linux, Windows}]
                                            [--ports]
                                            [--priority]
                                            [--privileged]
                                            [--protocol {TCP, UDP}]
                                            [--registry-login-server]
                                            [--registry-password]
                                            [--registry-username]
                                            [--restart-policy {Always, Never, OnFailure}]
                                            [--run-as-group]
                                            [--run-as-user]
                                            [--seccomp-profile]
                                            [--secrets]
                                            [--secrets-mount-path]
                                            [--secure-environment-variables]
                                            [--sku]
                                            [--zone]

Examples

Create a container group profile.

az container container-group-profile create --resource-group MyResourceGroup --name myapp --image myimage:latest --cpu 1 --memory 1

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--acr-identity

The identity with access to the container registry.

--add-capabilities

A List of security context capabilities to be added.

--allow-escalation

Allow whether a process can gain more privileges than its parent process.

Default value: False
--azure-file-volume-account-key

The storage account access key used to access the Azure File share.

--azure-file-volume-account-name

The name of the storage account that contains the Azure File share.

--azure-file-volume-mount-path

The path within the container where the azure file volume should be mounted. Must not contain colon ':'.

--azure-file-volume-share-name

The name of the Azure File share to be mounted as a volume.

--cce-policy

The CCE policy for the confidential container group.

--command-line

The command line to run when the container is started, e.g. '/bin/bash -c myscript.sh'.

--config-map

A list of config map key-value pairs for the container. Space-separated values in 'key=value' format.

--cpu

The required number of CPU cores of the containers, accurate to one decimal place.

Default value: 1
--drop-capabilities

A List of security context capabilities to be dropped.

--environment-variables -e

A list of environment variable for the container. Space-separated values in 'key=value' format.

--file -f

The path to the input file.

--gitrepo-dir

The target directory path in the git repository. Must not contain '..'.

Default value: .
--gitrepo-mount-path

The path within the container where the git repo volume should be mounted. Must not contain colon ':'.

--gitrepo-revision

The commit hash for the specified revision.

--gitrepo-url

The URL of a git repository to be mounted as a volume.

--image

The container image name.

--ip-address

The IP address type of the container group.

Accepted values: Private, Public
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--log-analytics-workspace

The Log Analytics workspace name or id. Use the current subscription or use --subscription flag to set the desired subscription.

--log-analytics-workspace-key

The Log Analytics workspace key.

--memory

The required memory of the containers in GB, accurate to one decimal place.

Default value: 1.5
--name -n

The name of the container group.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--os-type

The OS type of the containers.

Accepted values: Linux, Windows
Default value: Linux
--ports

A list of ports to open. Space-separated list of ports.

Default value: [80]
--priority

The priority of the container group.

--privileged

The flag to determine if the container permissions is elevated to Privileged.

Default value: False
--protocol

The network protocol to use.

Accepted values: TCP, UDP
--registry-login-server

The container image registry login server.

--registry-password

The password to log in container image registry server.

--registry-username

The username to log in container image registry server.

--restart-policy

Restart policy for all containers within the container group.

Accepted values: Always, Never, OnFailure
--run-as-group

Set the User UID for the container.

--run-as-user

Set the User GID for the container.

--seccomp-profile

A base64 encoded string containing the contents of the JSON in the seccomp profile.

--secrets

Space-separated secrets in 'key=value' format.

--secrets-mount-path

The path within the container where the secrets volume should be mounted. Must not contain colon ':'.

--secure-environment-variables

A list of secure environment variable for the container. Space-separated values in 'key=value' format.

--sku

The SKU of the container group.

--zone

The zone to place the container group.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az container container-group-profile delete

Edit

Delete a container group profile.

az container container-group-profile delete [--ids]
                                            [--name]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

Examples

Delete a container group profile.

az container container-group-profile delete --resource-group MyResourceGroup --name mycgprofile

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the container group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az container container-group-profile list

Edit

List all container group profiles in a resource group.

az container container-group-profile list [--resource-group]

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az container container-group-profile list-revisions

Edit

List all revisions for a container group profile.

az container container-group-profile list-revisions [--ids]
                                                    [--name]
                                                    [--resource-group]
                                                    [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the container group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az container container-group-profile show

Edit

Get a container group profile.

az container container-group-profile show [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Examples

Get a container group profile.

az container container-group-profile show --resource-group MyResourceGroup --name mycgprofile

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the container group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az container container-group-profile show-revision

Edit

Show a container group profile revision.

az container container-group-profile show-revision -r
                                                   [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Show a container group profile.

az container container-group-profile show-revision --resource-group MyResourceGroup --name mycgprofile -r 1

Required Parameters

-r

The revision of the container group profile.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the container group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.