az webapp sitecontainers

Reference

Manage linux web apps sitecontainers.

Commands

Name	Description	Type	Status
az webapp sitecontainers create	Create sitecontainers for a linux webapp.	Core	GA
az webapp sitecontainers delete	Delete a sitecontainer for a linux webapp.	Core	GA
az webapp sitecontainers list	List all the sitecontainers for a linux webapp.	Core	GA
az webapp sitecontainers log	Get the logs of a sitecontainer for a linux webapp.	Core	GA
az webapp sitecontainers show	List the details of a sitecontainer for a linux webapp.	Core	GA
az webapp sitecontainers status	Get the status of a sitecontainer for a linux webapp.	Core	GA
az webapp sitecontainers update	Update an existing sitecontainer for a linux webapp.	Core	GA

az webapp sitecontainers create

Create sitecontainers for a linux webapp.

Multiple sitecontainers can be added or updated at once by passing arg --sitecontainers-spec-file, which is the path to a json file containing an array of sitecontainer specs. Example json file: [ { "name": "firstcontainer", "properties": { "image": "myregistry.io/firstimage:latest", "targetPort": "80", "isMain": true, "environmentVariables": [ { "name": "VARIABLE_1", "value": "APPSETTING_NAME1" } ], "volumeMounts": [ { "containerMountPath": "mountPath", "readOnly": true, "volumeSubPath": "subPath" } ] } }, { "name": "secondcontainer", "properties": { "image": "myregistry.io/secondimage:latest", "targetPort": "3000", "isMain": false, "authType": "SystemIdentity", "startUpCommand": "MyStartupCmd" } }, { "name": "thirdcontainer", "properties": { "image": "myregistry.io/thirdimage:latest", "targetPort": "3001", "isMain": false, "authType": "UserAssigned", "userManagedIdentityClientId": "ClientID" } }, { "name": "fourthcontainer", "properties": { "image": "myregistry.io/fourthimage:latest", "targetPort": "3002", "isMain": false, "authType": "UserCredentials", "userName": "Username", "passwordSecret": "Password" } } ].

az webapp sitecontainers create --name
                                --resource-group
                                [--container-name]
                                [--image]
                                [--is-main {false, true}]
                                [--registry-password]
                                [--registry-username]
                                [--si {false, true}]
                                [--sitecontainers-spec-file]
                                [--slot]
                                [--startup-cmd]
                                [--target-port]
                                [--ui]

Examples

Create a main sitecontainer for a linux webapp

az webapp sitecontainers create --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer --image MyImageRegistry.io/MyImage:latest --target-port 80 --is-main

Create or update multiple sitecontainers for a linux webapp using a json sitecontainer-spec file

az webapp sitecontainers create --name MyWebApp --resource-group MyResourceGroup --sitecontainers-spec-file ./sitecontainersspec.json

Required Parameters

--name -n

Name of the linux webapp.

--resource-group -g

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

Optional Parameters

--container-name

Name of the SiteContainer.

--image

Image Name.

--is-main

True if the container is the main SiteContainer; false otherwise.

Accepted values: false, true

--registry-password

Password used for image registry auth.

--registry-username

Username used for image registry auth.

--si --system-assigned-identity

If true, the system-assigned identity will be used for auth while pulling image.

Accepted values: false, true

--sitecontainers-spec-file --ssf

Path to a json sitecontainer spec file containing a list of sitecontainers, other sitecontainer input args will be ignored if this arg is provided.

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

--startup-cmd

Startup Command for the SiteContainer.

--target-port

Target port for SiteContainer.

--ui --user-assigned-identity

ClientID for the user-maganed identity which will be used for auth while pulling image.

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 webapp sitecontainers delete

Delete a sitecontainer for a linux webapp.

az webapp sitecontainers delete --container-name
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--slot]
                                [--subscription]

Examples

Delete a sitecontainer for a linux webapp

az webapp sitecontainers delete --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer

Required Parameters

--container-name

Name of the SiteContainer.

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

Name of the linux webapp.

--resource-group -g

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

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

--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 webapp sitecontainers list

List all the sitecontainers for a linux webapp.

az webapp sitecontainers list --name
                              --resource-group
                              [--slot]

Examples

List all the sitecontainers for a linux webapp

az webapp sitecontainers list --name MyWebApp --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the linux webapp.

--resource-group -g

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

Optional Parameters

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

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 webapp sitecontainers log

Get the logs of a sitecontainer for a linux webapp.

az webapp sitecontainers log --container-name
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--slot]
                             [--subscription]

Examples

Get the logs of a sitecontainer for a linux webapp

az webapp sitecontainers log --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer

Required Parameters

--container-name

Name of the SiteContainer.

Optional Parameters

--ids

--name -n

Name of the linux webapp.

--resource-group -g

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

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

--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 webapp sitecontainers show

List the details of a sitecontainer for a linux webapp.

az webapp sitecontainers show --container-name
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--slot]
                              [--subscription]

Examples

List the details of a sitecontainer for a linux webapp

az webapp sitecontainers show --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer

Required Parameters

--container-name

Name of the SiteContainer.

Optional Parameters

--ids

--name -n

Name of the linux webapp.

--resource-group -g

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

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

--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 webapp sitecontainers status

Get the status of a sitecontainer for a linux webapp.

az webapp sitecontainers status [--container-name]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--slot]
                                [--subscription]

Examples

Get the status of a sitecontainer for a linux webapp

az webapp sitecontainers status --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer

Optional Parameters

--container-name

Name of the SiteContainer.

--ids

--name -n

Name of the linux webapp.

--resource-group -g

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

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

--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 webapp sitecontainers update

Update an existing sitecontainer for a linux webapp.

az webapp sitecontainers update --container-name
                                [--ids]
                                [--image]
                                [--is-main {false, true}]
                                [--name]
                                [--registry-password]
                                [--registry-username]
                                [--resource-group]
                                [--si {false, true}]
                                [--slot]
                                [--startup-cmd]
                                [--subscription]
                                [--target-port]
                                [--ui]

Examples

Update a sitecontainer for a linux webapp

az webapp sitecontainers update --name MyWebApp --resource-group MyResourceGroup --container-name MyContainer --image MyImageRegistry.io/MyImage:latest --target-port 3000 --is-main false

Required Parameters

--container-name

Name of the SiteContainer.

Optional Parameters

--ids

--image

Image Name.

--is-main

True if the container is the main site container; false otherwise.

Accepted values: false, true

--name -n

Name of the linux webapp.

--registry-password

Password used for image registry auth.

--registry-username

Username used for image registry auth.

--resource-group -g

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

--si --system-assigned-identity

If true, the system-assigned identity will be used for auth while pulling image.

Accepted values: false, true

--slot -s

Name of the web app slot. Default to the productions slot if not specified.

--startup-cmd

Startup Command for the SiteContainer.

--subscription

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

--target-port

Target port for SiteContainer.

--ui --user-assigned-identity

ClientID for the user-maganed identity which will be used for auth while pulling image.

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.

Bendrinti naudojant

az webapp sitecontainers

Commands

az webapp sitecontainers create

Examples

Required Parameters

Optional Parameters

az webapp sitecontainers delete

Examples

Required Parameters

Optional Parameters

az webapp sitecontainers list

Examples

Required Parameters

Optional Parameters

az webapp sitecontainers log

Examples

Required Parameters

Optional Parameters

az webapp sitecontainers show

Examples

Required Parameters

Optional Parameters

az webapp sitecontainers status

Examples

Optional Parameters

az webapp sitecontainers update

Examples

Required Parameters

Optional Parameters

Papildomi ištekliai