container.yml

### YamlMime:UniversalReference
items:
- uid: az_container
  name: az container
  summary: (PREVIEW) Manage Azure Container Instances.
  description: ''
  langs:
  - azurecli
  children:
  - az_container_create
  - az_container_delete
  - az_container_list
  - az_container_logs
  - az_container_show
- uid: az_container_create
  name: az container create
  summary: Create a container group.
  description: ''
  langs:
  - azurecli
  examples:
  - summary: Create a container in a container group with 1 core and 1Gb of memory.
    syntax:
      content: az container create -g MyResourceGroup --name myalpine --image alpine:latest --cpu 1 --memory 1
  - summary: Create a container in a container group that runs Windows, with 2 cores and 3.5Gb of memory.
    syntax:
      content: az container create -g MyResourceGroup --name mywinapp --image winappimage:latest --os-type Windows --cpu 2 --memory 3.5
  - summary: Create a container in a container group with public IP address and ports.
    syntax:
      content: az container create -g MyResourceGroup --name myalpine --image alpine:latest --ip-address public --ports 80 443
  - summary: Create a container in a container group that invokes a script upon start.
    syntax:
      content: az container create -g MyResourceGroup --name myalpine --image alpine:latest --command-line "/bin/sh -c '/path to/myscript.sh'"
  - summary: Create a container in a container group that runs a command and stop the container afterwards.
    syntax:
      content: az container create -g MyResourceGroup --name myalpine --image alpine:latest --command-line "echo hello" --restart-policy Never
  - summary: Create a container in a container group with environment variables.
    syntax:
      content: az container create -g MyResourceGroup --name myalpine --image alpine:latest -e key1=value1 key2=value2
  - summary: Create a container in a container group using container image from Azure Container Registry.
    syntax:
      content: az container create -g MyResourceGroup --name myalpine --image myAcrRegistry.azurecr.io/alpine:latest --registry-password password
  - summary: Create a container in a container group using container image from another private container image registry.
    syntax:
      content: az container create -g MyResourceGroup --name myapp --image myimage:latest --cpu 1 --memory 1.5 --registry-login-server myregistry.com --registry-username username --registry-password password
  - summary: Create a container in a container group that mounts an Azure File share as volume.
    syntax:
      content: az container create -g MyResourceGroup --name myapp --image alpine:latest --command-line "cat /mnt/azfile/myfile" --azure-file-volume-share-name myshare --azure-file-volume-account-name mystorageaccount --azure-file-volume-account-key mystoragekey --azure-file-volume-mount-path /mnt/azfile
  parameters:
  - isRequired: true
    name: --image
    summary: The container image name.
    description: ''
  - isRequired: true
    name: --name -n
    summary: The name of the container group.
    description: ''
  - isRequired: true
    name: --resource-group -g
    summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
    description: ''
  - name: --command-line
    summary: The command line to run when the container is started, e.g. '/bin/bash -c myscript.sh'.
    description: ''
  - name: --cpu
    defaultValue: "1"
    summary: The required number of CPU cores of the containers.
    description: ''
  - name: --environment-variables -e
    summary: A list of environment variable for the container. Space separated values in 'key=value' format.
    description: ''
  - name: --ip-address
    parameterValueGroup: Public
    summary: The IP address type of the container group.
    description: ''
  - name: --location -l
    summary: Location. You can configure the default location using `az configure --defaults location=<location>`.
    description: ''
  - name: --memory
    defaultValue: "1.5"
    summary: The required memory of the containers in GB.
    description: ''
  - name: --os-type
    defaultValue: Linux
    parameterValueGroup: Linux, Windows
    summary: The OS type of the containers.
    description: ''
  - name: --ports
    defaultValue: '[80]'
    summary: The ports to open.
    description: ''
  - name: --restart-policy
    defaultValue: Always
    parameterValueGroup: Always, Never, OnFailure
    summary: Restart policy for all containers within the container group.
    description: ''
  - name: --azure-file-volume-account-key
    summary: The storage account access key used to access the Azure File share.
    description: ''
  - name: --azure-file-volume-account-name
    summary: The name of the storage account that contains the Azure File share.
    description: ''
  - name: --azure-file-volume-mount-path
    summary: The path within the container where the volume should be mounted. Must not contain colon (:).
    description: ''
  - name: --azure-file-volume-share-name
    summary: The name of the Azure File share to be mounted as a volume.
    description: ''
  - name: --registry-login-server
    summary: The container image registry login server.
    description: ''
  - name: --registry-password
    summary: The password to log in container image registry server.
    description: ''
  - name: --registry-username
    summary: The username to log in container image registry server.
    description: ''
  source:
    path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
    remote:
      branch: KnackConversion
      path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
      repo: https://github.com/Azure/azure-cli.git
- uid: az_container_delete
  name: az container delete
  summary: Delete a container group.
  description: ''
  langs:
  - azurecli
  parameters:
  - isRequired: true
    name: --name -n
    summary: The name of the container group.
    description: ''
  - isRequired: true
    name: --resource-group -g
    summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
    description: ''
  - name: --yes -y
    summary: Do not prompt for confirmation.
    description: ''
  source:
    path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
    remote:
      branch: KnackConversion
      path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
      repo: https://github.com/Azure/azure-cli.git
- uid: az_container_list
  name: az container list
  summary: List container groups.
  description: ''
  langs:
  - azurecli
  parameters:
  - name: --resource-group -g
    summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
    description: ''
  source:
    path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
    remote:
      branch: KnackConversion
      path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
      repo: https://github.com/Azure/azure-cli.git
- uid: az_container_logs
  name: az container logs
  summary: Examine the logs for a container group.
  description: ''
  langs:
  - azurecli
  parameters:
  - isRequired: true
    name: --name -n
    summary: The name of the container group.
    description: ''
  - isRequired: true
    name: --resource-group -g
    summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
    description: ''
  - name: --container-name
    summary: The container name to tail the logs.
    description: ''
  source:
    path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
    remote:
      branch: KnackConversion
      path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
      repo: https://github.com/Azure/azure-cli.git
- uid: az_container_show
  name: az container show
  summary: Get the details of a container group.
  description: ''
  langs:
  - azurecli
  parameters:
  - isRequired: true
    name: --name -n
    summary: The name of the container group.
    description: ''
  - isRequired: true
    name: --resource-group -g
    summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
    description: ''
  source:
    path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
    remote:
      branch: KnackConversion
      path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
      repo: https://github.com/Azure/azure-cli.git
commands:
- uid: az_container_create
  name: az container create
  summary: Create a container group.
- uid: az_container_delete
  name: az container delete
  summary: Delete a container group.
- uid: az_container_list
  name: az container list
  summary: List container groups.
- uid: az_container_logs
  name: az container logs
  summary: Examine the logs for a container group.
- uid: az_container_show
  name: az container show
  summary: Get the details of a container group.
globalParameters:
- name: --debug
  summary: Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: Show this help message and exit.
- name: --output -o
  defaultValue: json
  parameterValueGroup: json, jsonc, table, tsv
  summary: Output format.
- name: --query
  summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --verbose
  summary: Increase logging verbosity. Use --debug for full debug logs.
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/KnackConversion/
doc_source_url_path: src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
original_content_git_url: https://github.com/Azure/azure-cli/blob/KnackConversion/src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
gitcommit: https://github.com/Azure/azure-cli/blob/8346147d0da04063bd9000d1b370b2d65204cda8/src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py
updated_at: 11/13/2017 7:42:14 PM
ms.date: 11/13/2017