Share via

az apic api-analysis

  • Preview

Note

This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az apic api-analysis command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure API Center service api analysis features.

Commands

Name Description Type Status
az apic api-analysis create

Create new or updates existing API analyzer configuration.

 Extension Preview
az apic api-analysis delete

Delete deletes API analyzer configuration.

 Extension Preview
az apic api-analysis export-ruleset

Exports the API analyzer ruleset.

 Extension Preview
az apic api-analysis import-ruleset

Imports the API analyzer ruleset.

 Extension Preview
az apic api-analysis list

List API analyzer configurations.

 Extension Preview
az apic api-analysis show

Get details of the API analyzer configuration.

 Extension Preview
az apic api-analysis update

Update new or updates existing API analyzer configuration.

 Extension Preview

az apic api-analysis create

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create new or updates existing API analyzer configuration.

az apic api-analysis create --analyzer-config-name --config-name
                            --resource-group
                            --service-name
                            [--description]
                            [--filter]
                            [--title]

Examples

Create an API Analysis rule config

az apic api-analysis create -g contoso-resources -n contoso -c spectral-openapi

Required Parameters

--analyzer-config-name --config-name -c

The name of the configuration.

--resource-group -g

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

--service-name -n

The name of Azure API Center service.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

The description of the analyzer configuration.

Property Value
Parameter group: Properties Arguments
--filter

The API analyzer filter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--title

The title of the analyzer configuration, e.g. "Spectral (OpenAPI)".

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az apic api-analysis delete

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete deletes API analyzer configuration.

az apic api-analysis delete [--analyzer-config-name --config-name]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--yes]

Examples

Delete an API Analysis rule config

az apic api-analysis delete -g contoso-resources -n contoso -c spectral-openapi

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analyzer-config-name --config-name -c

The name of the configuration.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az apic api-analysis export-ruleset

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Exports the API analyzer ruleset.

az apic api-analysis export-ruleset --path
                                    [--analyzer-config-name --config-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--service-name]
                                    [--subscription]

Examples

Export an API Analysis ruleset

az apic api-analysis export-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\path\for\output\files'

Required Parameters

--path

The folder path to extract the ruleset files.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analyzer-config-name --config-name -c

The name of the configuration.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az apic api-analysis import-ruleset

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Imports the API analyzer ruleset.

az apic api-analysis import-ruleset --path
                                    [--analyzer-config-name --config-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--service-name]
                                    [--subscription]

Examples

Import an API Analysis ruleset

az apic api-analysis import-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\path\to\ruleset\folder'

Required Parameters

--path

The folder path containing the ruleset files.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analyzer-config-name --config-name -c

The name of the configuration.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az apic api-analysis list

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List API analyzer configurations.

az apic api-analysis list --resource-group
                          --service-name
                          [--filter]
                          [--max-items]
                          [--next-token]

Examples

List all API Analysis rule configs for the service

az apic api-analysis list -g contoso-resources -n contoso

Required Parameters

--resource-group -g

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

--service-name -n

The name of Azure API Center service.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

OData filter parameter.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az apic api-analysis show

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get details of the API analyzer configuration.

az apic api-analysis show [--analyzer-config-name --config-name]
                          [--ids]
                          [--resource-group]
                          [--service-name]
                          [--subscription]

Examples

Show details of an API Analysis rule config

az apic api-analysis show -g contoso-resources -n contoso -c spectral-openapi

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analyzer-config-name --config-name -c

The name of the configuration.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az apic api-analysis update

Preview

Command group 'az apic api-analysis' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update new or updates existing API analyzer configuration.

az apic api-analysis update [--add]
                            [--analyzer-config-name --config-name]
                            [--description]
                            [--filter]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--remove]
                            [--resource-group]
                            [--service-name]
                            [--set]
                            [--subscription]
                            [--title]

Examples

Update an API Analysis rule config

az apic api-analysis update -g contoso-resources -n contoso -c spectral-openapi

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--analyzer-config-name --config-name -c

The name of the configuration.

Property Value
Parameter group: Resource Id Arguments
--description

The description of the analyzer configuration.

Property Value
Parameter group: Properties Arguments
--filter

The API analyzer filter. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--service-name -n

The name of Azure API Center service.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--title

The title of the analyzer configuration, e.g. "Spectral (OpenAPI)".

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False