az apic service
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 service command. Learn more about extensions.
Manage an Azure API Center service instance.
Commands
Name | Description | Type | Status |
---|---|---|---|
az apic service create |
Creates an instance or update an existing instance of an Azure API Center service. |
Extension | GA |
az apic service delete |
Deletes an instance of an Azure API Center service. |
Extension | GA |
az apic service import-from-apim |
Imports APIs from an Azure API Management service instance. |
Extension | GA |
az apic service list |
Lists Azure API Center services within an Azure subscription. |
Extension | GA |
az apic service show |
Show details of an Azure API Center service instance. |
Extension | GA |
az apic service update |
Update an instance of an Azure API Center service. |
Extension | GA |
az apic service create
Creates an instance or update an existing instance of an Azure API Center service.
az apic service create --name
--resource-group
[--identity]
[--location]
[--tags]
Examples
Create service Example 1
az apic service create -g contoso-resources -s contoso -l eastus
Create Service Example 2
az apic service create --resource-group contoso-resources --name contoso --location eastus
Required Parameters
The name of the API Center service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az apic service delete
Deletes an instance of an Azure API Center service.
az apic service delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete service
az apic service delete -s contoso -g contoso-resources
Optional Parameters
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.
The name of the API Center service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az apic service import-from-apim
Imports APIs from an Azure API Management service instance.
az apic service import-from-apim --source-resource-ids
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--subscription]
Examples
Import From APIM
az apic service import-from-apim -g api-center-test --service-name contosoeuap --source-resource-ids '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicegroup/providers/Microsoft.ApiManagement/service/contoso/apis/contosoapi'
Required Parameters
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of Azure API Center service.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az apic service list
Lists Azure API Center services within an Azure subscription.
az apic service list [--max-items]
[--next-token]
[--resource-group]
Examples
List services in resource group
az apic service list -g contoso-resources
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az apic service show
Show details of an Azure API Center service instance.
az apic service show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Show service details
az apic service show -g contoso-resources -s contoso
Optional Parameters
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.
The name of the API Center service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az apic service update
Update an instance of an Azure API Center service.
az apic service update [--identity]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--tags]
Examples
Update service details
az apic service update -g contoso-resources -s contoso
Optional Parameters
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
The name of Azure API Center service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for