Azure API Management: Apimsubscriptions
Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents…
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 Subscription entity associated with your Azure API Management deployment. The Subscription entity represents the association between a user and a product in API Management. Products contain one or more APIs, and once a product is published, developers can subscribe to the product and begin to use the product’s APIs.
Endpoints 9
Subscription
- GETSubscription_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions?$filter=stringLists all subscriptions of the API Management service instance. - GETSubscription_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sidGets the specified Subscription entity. - PUTSubscription_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sidCreates or updates the subscription of specified user to the specified product. - DELETESubscription_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sidDeletes the specified subscription. - HEADSubscription_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sidGets the entity state (Etag) version of the apimanagement subscription specified by its identifier. - PATCHSubscription_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sidUpdates the details of a subscription specified by its identifier. - POSTSubscription_RegeneratePrimaryKey
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sid/regeneratePrimaryKeyRegenerates primary key of existing subscription of the API Management service instance. - POSTSubscription_RegenerateSecondaryKey
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sid/regenerateSecondaryKeyRegenerates secondary key of existing subscription of the API Management service instance. - POSTSubscription_ListSecrets
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions/:sid/listSecretsGets the specified Subscription keys.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 9 operations on 5 pathsPOST 3GET 2PUT 1HEAD 1PATCH 1DELETE 1
- Main resources
- Subscription 9
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-05-01 - Links
- OpenAPI document
How to test the Azure API Management: Apimsubscriptions in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimsubscriptions collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Subscription_List” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/subscriptions?$filter=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: Apimsubscriptions?
Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents… It is listed under Developer tools and has 9 endpoints.
Who publishes the Azure API Management: Apimsubscriptions?
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: Apimsubscriptions?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure API Management: Apimsubscriptions?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure API Management: Apimsubscriptions have?
9 operations on 5 paths (3 POST, 2 GET, 1 PUT, 1 HEAD, 1 PATCH, 1 DELETE). The largest groups are Subscription.
Is forking the Azure API Management: Apimsubscriptions free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.