Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az apim product api

Manage Azure API Management Product's APIs.

Commands

Name Description Type Status
az apim product api add

Add an API to the specified product.

 Core GA
az apim product api check

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

 Core GA
az apim product api delete

Deletes the specified API from the specified product.

 Core GA
az apim product api list

Lists a collection of the APIs associated with a product.

 Core GA

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
 [--acquire-policy-token]
 [--change-reference]

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

Property Value
Parameter group: API Arguments
--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

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
 [--acquire-policy-token]
 [--change-reference]

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

Property Value
Parameter group: API Arguments
--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

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
 [--acquire-policy-token]
 [--change-reference]

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

Property Value
Parameter group: API Arguments
--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

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

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.

Feedback

Was this page helpful?