azure-cli-container 0.1.7

Microsoft Azure CLI 'container' Command Module
==============================================

Commands to manage Azure container instances
+++++++++++++++++++++++++++++++++++++++++++++
::

Group
az container: Manage Azure Container Instances.

Commands:
create: Create a container group.
delete: Delete a container group.
list : List container groups.
logs : Tail the log of a container group.
show : Show the details of a container group.

Commands to create an Azure container group
+++++++++++++++++++++++++++++++++++++++++++++
::

Command
az container create: Create a container group.

Arguments
--image [Required]: The container image name.
--name -n [Required]: The name of the container group.
--resource-group -g [Required]: Name of resource group. You can configure the default group
using `az configure --defaults group=<name>`.
--command-line : The command line to run when the container is started, e.g.
'/bin/bash -c myscript.sh'.
--cpu : The required number of CPU cores of the containers. Default: 1.
--environment-variables -e : A list of environment variable for the container. Space
separated values in 'key=value' format.
--ip-address : The IP address type of the container group. Allowed values:
Public.
--location -l : Location. You can configure the default location using `az
configure --defaults location=<location>`.
--memory : The required memory of the containers in GB. Default: 1.5.
--os-type : The OS type of the containers. Allowed values: Linux, Windows.
Default: Linux.
--port : Default: 80.

Image Registry Arguments
--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.

Global Arguments
--debug : Increase logging verbosity to show all debug logs.
--help -h : Show this help message and exit.
--output -o : Output format. Allowed values: json, jsonc, table, tsv.
Default: json.
--query : JMESPath query string. See http://jmespath.org/ for more
information and examples.
--verbose : Increase logging verbosity. Use --debug for full debug logs.

Examples
Create a container group and specify resources required.
az container create -g MyResourceGroup --name MyAlpine --image alpine:latest --cpu 1
--memory 1

Create a container group with OS type.
az container create -g MyResourceGroup --name MyWinApp --image winappimage:latest --os-type
Windows

Create a container group with public IP address.
az container create -g MyResourceGroup --name MyAlpine --image alpine:latest --ip-address
public

Create a container group with starting command line.
az container create -g MyResourceGroup --name MyAlpine --image alpine:latest --command-line
"/bin/sh -c '/path to/myscript.sh'"

Create a container group with envrionment variables.
az contanier create -g MyResourceGroup --name MyAlpine --image alpine:latest -e key1=value1
key2=value2

Create a container group using container image from Azure Container Registry.
az container create -g MyResourceGroup --name MyAlpine --image
myAcrRegistry.azurecr.io/alpine:latest --registry-password password

Create a container group using container image from other private container image registry.
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

Commands to get an Azure container group
+++++++++++++++++++++++++++++++++++++++++++++
::

Command
az container show: Show the details of a container group.

Arguments

Resource Id Arguments
--ids : One or more resource IDs (space delimited). If provided, no other 'Resource
Id' arguments should be specified.
--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>`.

Global Arguments
--debug : Increase logging verbosity to show all debug logs.
--help -h : Show this help message and exit.
--output -o : Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query : JMESPath query string. See http://jmespath.org/ for more information and
examples.
--verbose : Increase logging verbosity. Use --debug for full debug logs.

Commands to tail the logs of a Azure container group
+++++++++++++++++++++++++++++++++++++++++++++
::

Command
az container logs: Tail the log of a container group.

Arguments
--container-name : The container name to tail the logs.

Resource Id Arguments
--ids : One or more resource IDs (space delimited). If provided, no other 'Resource
Id' arguments should be specified.
--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>`.

Global Arguments
--debug : Increase logging verbosity to show all debug logs.
--help -h : Show this help message and exit.
--output -o : Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query : JMESPath query string. See http://jmespath.org/ for more information and
examples.
--verbose : Increase logging verbosity. Use --debug for full debug logs.

Commands to delete an Azure container group
+++++++++++++++++++++++++++++++++++++++++++++
::

Command
az container delete: Delete a container group.

Arguments
--yes -y : Do not prompt for confirmation.

Resource Id Arguments
--ids : One or more resource IDs (space delimited). If provided, no other 'Resource
Id' arguments should be specified.
--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>`.

Global Arguments
--debug : Increase logging verbosity to show all debug logs.
--help -h : Show this help message and exit.
--output -o : Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query : JMESPath query string. See http://jmespath.org/ for more information and
examples.
--verbose : Increase logging verbosity. Use --debug for full debug logs.

Commands to list Azure container groups by resource group
+++++++++++++++++++++++++++++++++++++++++++++
::

Command
az container list: List container groups.

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

Global Arguments
--debug : Increase logging verbosity to show all debug logs.
--help -h : Show this help message and exit.
--output -o : Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query : JMESPath query string. See http://jmespath.org/ for more information and
examples.
--verbose : Increase logging verbosity. Use --debug for full debug logs.


.. :changelog:

Release History
===============

0.1.7 (2017-07-27)
++++++++++++++++++

* Preview release.