Share via

az apic integration

  • Preview
  • Reference

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 integration command. Learn more about extensions.

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

Manages integrations in Azure API Center.

Commands

Name Description Type Status
az apic integration create Extension Preview
az apic integration create apim

Add Azure APIM as an API source.

 Extension Preview
az apic integration create aws

Add Amazon API Gateway as an API source.

 Extension Preview
az apic integration delete

Delete specified API source.

 Extension Preview
az apic integration list

List a collection of API sources.

 Extension Preview
az apic integration show

Get details of the API source.

 Extension Preview

az apic integration delete

Preview

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

Delete specified API source.

az apic integration delete [--ids]
                           [--integration-name]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--yes]

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.

--integration-name -i

The name of the integration.

--resource-group -g

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

--service-name -n

The name of Azure API Center service.

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 apic integration list

Preview

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

List a collection of API sources.

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

Required Parameters

--resource-group -g

Name of Azure API Center 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

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

--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 apic integration show

Preview

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

Get details of the API source.

az apic integration show [--ids]
                         [--integration-name]
                         [--resource-group]
                         [--service-name]
                         [--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.

--integration-name -i

The name of the integration.

--resource-group -g

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

--service-name -n

The name of Azure API Center service.

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