Microsoft Azure

Azure API Management: Apimproducts

Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.

Endpoints 39

Product

  • GETProduct_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products?$filter=string&expandGroups=true&tags=stringLists a collection of products in the specified service instance.
  • GETProduct_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productIdGets the details of the product specified by its identifier.
  • PUTProduct_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productIdCreates or Updates a product.
  • DELETEProduct_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId?deleteSubscriptions=trueDelete product.
  • HEADProduct_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productIdGets the entity state (Etag) version of the product specified by its identifier.
  • PATCHProduct_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productIdUpdate existing product details.

ProductApi

  • GETProductApi_ListByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apis?$filter=stringLists a collection of the APIs associated with a product.
  • PUTProductApi_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apis/:apiIdAdds an API to the specified product.
  • DELETEProductApi_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apis/:apiIdDeletes the specified API from the specified product.
  • HEADProductApi_CheckEntityExists/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apis/:apiIdChecks that API entity specified by identifier is associated with the Product entity.

ProductGroup

  • GETProductGroup_ListByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groups?$filter=stringLists the collection of developer groups associated with the specified product.
  • PUTProductGroup_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groups/:groupIdAdds the association between the specified developer group with the specified product.
  • DELETEProductGroup_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groups/:groupIdDeletes the association between the specified group and product.
  • HEADProductGroup_CheckEntityExists/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groups/:groupIdChecks that Group entity specified by identifier is associated with the Product entity.

ProductSubscription

  • GETProductSubscriptions_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/subscriptions?$filter=stringLists the collection of subscriptions to the specified product.

ProductPolicy

  • GETProductPolicy_ListByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/policiesGet the policy configuration at the Product level.
  • GETProductPolicy_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/policies/:policyIdGet the policy configuration at the Product level.
  • PUTProductPolicy_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/policies/:policyIdCreates or updates policy configuration for the Product.
  • DELETEProductPolicy_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/policies/:policyIdDeletes the policy configuration at the Product.
  • HEADProductPolicy_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/policies/:policyIdGet the ETag of the policy configuration at the Product level.

ProductTag

  • GETTag_ListByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/tags?$filter=stringLists all Tags associated with the Product.
  • GETTag_GetByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/tags/:tagIdGet tag associated with the Product.
  • PUTTag_AssignToProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/tags/:tagIdAssign tag to the Product.
  • DELETETag_DetachFromProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/tags/:tagIdDetach the tag from the Product.
  • HEADTag_GetEntityStateByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/tags/:tagIdGets the entity state version of the tag specified by its identifier.

ProductWiki

  • GETProductWiki_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/wikis/defaultGets the details of the Wiki for a Product specified by its identifier.
  • PUTProductWiki_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/wikis/defaultCreates a new Wiki for a Product or updates an existing one.
  • DELETEProductWiki_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/wikis/defaultDeletes the specified Wiki from a Product.
  • HEADProductWiki_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/wikis/defaultGets the entity state (Etag) version of the Wiki for a Product specified by its identifier.
  • PATCHProductWiki_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/wikis/defaultUpdates the details of the Wiki for a Product specified by its identifier.
  • GETProductWikis_list/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/wikis?$filter=stringGets the details of the Wiki for a Product specified by its identifier.

ProductApiLink

  • GETProductApiLink_ListByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apiLinks?$filter=stringLists a collection of the API links associated with a product.
  • GETProductApiLink_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apiLinks/:apiLinkIdGets the API link for the product.
  • PUTProductApiLink_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apiLinks/:apiLinkIdAdds an API to the specified product via link.
  • DELETEProductApiLink_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/apiLinks/:apiLinkIdDeletes the specified API from the specified product.

ProductGroupLink

  • GETProductGroupLink_ListByProduct/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groupLinks?$filter=stringLists a collection of the group links associated with a product.
  • GETProductGroupLink_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groupLinks/:groupLinkIdGets the group link for the product.
  • PUTProductGroupLink_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groupLinks/:groupLinkIdAdds a group to the specified product via link.
  • DELETEProductGroupLink_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products/:productId/groupLinks/:groupLinkIdDeletes the specified group from the specified product.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
39 operations on 17 pathsGET 15PUT 8DELETE 8HEAD 6PATCH 2
Main resources
Product 6ProductWiki 6ProductPolicy 5ProductTag 5ProductApi 4ProductApiLink 4ProductGroup 4ProductGroupLink 4ProductSubscription 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimproducts in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimproducts collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Product_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/products?$filter=string&expandGroups=true&tags=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apimproducts?

Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product… It is listed under Developer tools and has 39 endpoints.

Who publishes the Azure API Management: Apimproducts?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure API Management: Apimproducts?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure API Management: Apimproducts?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apimproducts have?

39 operations on 17 paths (15 GET, 8 PUT, 8 DELETE, 6 HEAD, 2 PATCH). The largest groups are Product, ProductWiki, ProductPolicy, ProductTag.

Is forking the Azure API Management: Apimproducts free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.