az apim product api

Manage Azure API Management Product's APIs.

Commands

az apim product api add

Add an API to the specified product.

az apim product api check

Checks that API entity specified by identifier is associated with the Product entity.

az apim product api delete

Deletes the specified API from the specified product.

az apim product api list

Lists a collection of the APIs associated with a product.

az apim product api add

Add an API to the specified product.

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name
                        [--subscription]

Examples

Add an API to the specified product.

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Required Parameters

--api-id

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--product-id

Product identifier. Must be unique in the current API Management service instance.

--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 the api management service instance.

Optional Parameters

--subscription

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

az apim product api check

Checks that API entity specified by identifier is associated with the Product entity.

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name
                          [--subscription]

Examples

Check if the API is associated with the Product.

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Required Parameters

--api-id

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--product-id

Product identifier. Must be unique in the current API Management service instance.

--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 the api management service instance.

Optional Parameters

--subscription

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

az apim product api delete

Deletes the specified API from the specified product.

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name
                           [--subscription]

Examples

Deletes the specified API from the specified product.

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Required Parameters

--api-id

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

--product-id

Product identifier. Must be unique in the current API Management service instance.

--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 the api management service instance.

Optional Parameters

--subscription

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

az apim product api list

Lists a collection of the APIs associated with a product.

az apim product api list --product-id
                         --resource-group
                         --service-name
                         [--query-examples]
                         [--subscription]

Examples

List all APIs associated with a product.

az apim product api list --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID

Required Parameters

--product-id

Product identifier. Must be unique in the current API Management service instance.

--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 the api management service instance.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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