Share via


az aosm publisher configuration-group-schema

Note

This reference is part of the aosm extension for the Azure CLI (version 2.54.0 or higher). The extension will automatically install the first time you run an az aosm publisher configuration-group-schema command. Learn more about extensions.

Command group 'az aosm publisher' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage configuration group schema resources.

Commands

Name Description Type Status
az aosm publisher configuration-group-schema list

List information of the configuration group schemas under a publisher.

Extension Preview
az aosm publisher configuration-group-schema show

Get information about the specified configuration group schema.

Extension Preview
az aosm publisher configuration-group-schema update-state

Update configuration group schema state.

Extension Preview

az aosm publisher configuration-group-schema list

Preview

Command group 'az aosm publisher configuration-group-schema' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List information of the configuration group schemas under a publisher.

az aosm publisher configuration-group-schema list --publisher-name
                                                  --resource-group
                                                  [--max-items]
                                                  [--next-token]

Examples

List the configuration group schemas defined under the contoso publisher

az aosm publisher configuration-group-schema list --resource-group contoso-aosm --publisher-name contoso

Required Parameters

--publisher-name

The name of the publisher.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 aosm publisher configuration-group-schema show

Preview

Command group 'az aosm publisher configuration-group-schema' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get information about the specified configuration group schema.

az aosm publisher configuration-group-schema show [--ids]
                                                  [--name]
                                                  [--publisher-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 configuration group schema.

--publisher-name

The name of the publisher.

--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 aosm publisher configuration-group-schema update-state

Preview

Command group 'az aosm publisher configuration-group-schema' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update configuration group schema state.

az aosm publisher configuration-group-schema update-state [--ids]
                                                          [--name]
                                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--publisher-name]
                                                          [--resource-group]
                                                          [--subscription]
                                                          [--version-state {Active, Deprecated, Preview, Unknown}]

Examples

Change the 'nginx-cgs' config group schema to 'Active' state

az aosm publisher configuration-group-schema update-state --resource-group contoso-aosm --publisher-name contoso --name nginx-cgs --version-state Active

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 configuration group schema.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--publisher-name

The name of the publisher.

--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.

--version-state

The configuration group schema state.

Accepted values: Active, Deprecated, Preview, Unknown
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.