Share via

az managedapp definition

  • Reference

Manage Azure Managed Applications.

Commands

Name Description Type Status
az managedapp definition create

Create a managed application definition.

 Core GA
az managedapp definition delete

Delete a managed application definition.

 Core GA
az managedapp definition list

List managed application definitions.

 Core GA
az managedapp definition show

Gets a managed application definition.

 Core GA
az managedapp definition update

Update a managed application definition.

 Core GA

az managedapp definition create

Edit

Create a managed application definition.

az managedapp definition create --authorizations
                                --description
                                --display-name
                                --lock-level {CanNotDelete, None, ReadOnly}
                                --name
                                --resource-group
                                [--create-ui-definition]
                                [--deployment-mode {Complete, Incremental}]
                                [--location]
                                [--main-template]
                                [--package-file-uri]
                                [--tags]

Examples

Create a managed application defintion.

az managedapp definition create -g MyResourceGroup -n MyManagedAppDef -l eastus --display-name "MyManagedAppDef" \
    --description "My Managed App Def description" -a "myPrincipalId:myRoleId" --lock-level None \
    --package-file-uri "https://path/to/myPackage.zip"

Create a managed application defintion with inline values for createUiDefinition and mainTemplate.

az managedapp definition create -g MyResourceGroup -n MyManagedAppDef -l eastus --display-name "MyManagedAppDef" \
    --description "My Managed App Def description" -a "myPrincipalId:myRoleId" --lock-level None \
    --create-ui-definition @myCreateUiDef.json --main-template @myMainTemplate.json

Required Parameters

--authorizations -a

Space-separated authorization pairs in a format of <principalId>:<roleDefinitionId>.

--description

The managed application definition description.

--display-name

The managed application definition display name.

--lock-level

The type of lock restriction.

Accepted values: CanNotDelete, None, ReadOnly
--name -n

The managed application definition name.

--resource-group -g

The resource group of the managed application definition.

Optional Parameters

--create-ui-definition -c

JSON formatted string or a path to a file with such content.

--deployment-mode

The managed application deployment mode.

Accepted values: Complete, Incremental
--location -l

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

--main-template -t

JSON formatted string or a path to a file with such content.

--package-file-uri

The managed application definition package file uri.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 managedapp definition delete

Edit

Delete a managed application definition.

az managedapp definition delete [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Delete a managed application definition. (autogenerated)

az managedapp definition delete --name MyManagedApplicationDefinition --resource-group MyResourceGroup

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 managed application definition to delete. Required.

--resource-group -g

The resource group of the managed application definition.

--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 managedapp definition list

Edit

List managed application definitions.

az managedapp definition list --resource-group

Examples

List managed application definitions. (autogenerated)

az managedapp definition list --resource-group MyResourceGroup

Required Parameters

--resource-group -g

The resource group of the managed application definition.

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 managedapp definition show

Edit

Gets a managed application definition.

az managedapp definition show [--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 managed application definition name.

--resource-group -g

The resource group of the managed application definition.

--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 managedapp definition update

Edit

Update a managed application definition.

az managedapp definition update --authorizations
                                --description
                                --display-name
                                --lock-level {CanNotDelete, None, ReadOnly}
                                [--create-ui-definition]
                                [--deployment-mode {Complete, Incremental}]
                                [--ids]
                                [--location]
                                [--main-template]
                                [--name]
                                [--package-file-uri]
                                [--resource-group]
                                [--subscription]
                                [--tags]

Examples

Update a managed application defintion.

az managedapp definition update -g MyResourceGroup -n MyManagedAppDef -l eastus --display-name "MyManagedAppDef" \
    --description "My Managed App Def description" -a "myPrincipalId:myRoleId" --lock-level None \
    --package-file-uri "https://path/to/myPackage.zip"

Update a managed application defintion with inline values for createUiDefinition and mainTemplate.

az managedapp definition update -g MyResourceGroup -n MyManagedAppDef -l eastus --display-name "MyManagedAppDef" \
    --description "My Managed App Def description" -a "myPrincipalId:myRoleId" --lock-level None \
    --create-ui-definition @myCreateUiDef.json --main-template @myMainTemplate.json

Required Parameters

--authorizations -a

Space-separated authorization pairs in a format of <principalId>:<roleDefinitionId>.

--description

The managed application definition description.

--display-name

The managed application definition display name.

--lock-level

The type of lock restriction.

Accepted values: CanNotDelete, None, ReadOnly

Optional Parameters

--create-ui-definition -c

JSON formatted string or a path to a file with such content.

--deployment-mode

The managed application deployment mode.

Accepted values: Complete, Incremental
--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.

--location -l

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

--main-template -t

JSON formatted string or a path to a file with such content.

--name -n

The managed application definition name.

--package-file-uri

The managed application definition package file uri.

--resource-group -g

The resource group of the managed application definition.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.