Azure API Management: Apimworkspaces
Use these REST APIs for performing operations on Workspace entity and its associated entities within your Azure API Management deployment.
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 Workspace entity and its associated entities within your Azure API Management deployment.
Endpoints 137
Workspace
- GETWorkspace_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces?$filter=stringLists all workspaces of the API Management service instance. - GETWorkspace_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceIdGets the details of the workspace specified by its identifier. - PUTWorkspace_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceIdCreates a new workspace or updates an existing one. - DELETEWorkspace_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceIdDeletes the specified workspace. - HEADWorkspace_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceIdGets the entity state (Etag) version of the workspace specified by its identifier. - PATCHWorkspace_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceIdUpdates the details of the workspace specified by its identifier.
WorkspacePolicy
- GETWorkspacePolicy_ListByApi
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policiesGet the policy configuration at the workspace level. - GETWorkspacePolicy_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policies/:policyIdGet the policy configuration at the API level. - PUTWorkspacePolicy_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policies/:policyIdCreates or updates policy configuration for the workspace. - DELETEWorkspacePolicy_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policies/:policyIdDeletes the policy configuration at the workspace. - HEADWorkspacePolicy_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policies/:policyIdGets the entity state (Etag) version of the workspace policy specified by its identifier.
NamedValue
- GETWorkspaceNamedValue_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues?$filter=string&isKeyVaultRefreshFailed=trueLists a collection of named values defined within a workspace in a service instance. - GETWorkspaceNamedValue_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueIdGets the details of the named value specified by its identifier. - PUTWorkspaceNamedValue_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueIdCreates or updates named value. - DELETEWorkspaceNamedValue_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueIdDeletes specific named value from the workspace in an API Management service instance. - HEADWorkspaceNamedValue_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueIdGets the entity state (Etag) version of the named value specified by its identifier. - PATCHWorkspaceNamedValue_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueIdUpdates the specific named value. - POSTWorkspaceNamedValue_ListValue
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueId/listValueGets the secret of the named value specified by its identifier. - POSTWorkspaceNamedValue_RefreshSecret
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/namedValues/:namedValueId/refreshSecretRefresh the secret of the named value specified by its identifier.
Schema
- GETWorkspaceGlobalSchema_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/schemas?$filter=stringLists a collection of schemas registered with workspace in a service instance. - GETWorkspaceGlobalSchema_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/schemas/:schemaIdGets the details of the Schema specified by its identifier. - PUTWorkspaceGlobalSchema_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/schemas/:schemaIdCreates new or updates existing specified Schema of the workspace in an API Management service instance. - DELETEWorkspaceGlobalSchema_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/schemas/:schemaIdDeletes specific Schema. - HEADWorkspaceGlobalSchema_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/schemas/:schemaIdGets the entity state (Etag) version of the Schema specified by its identifier.
Notification
- GETWorkspaceNotification_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notificationsLists a collection of properties defined within a service instance. - GETWorkspaceNotification_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationNameGets the details of the Notification specified by its identifier. - PUTWorkspaceNotification_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationNameCreate or Update API Management publisher notification for the workspace.
NotificationRecipientUser
- GETWorkspaceNotificationRecipientUser_ListByNotification
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientUsersGets the list of the Notification Recipient User subscribed to the notification. - PUTWorkspaceNotificationRecipientUser_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientUsers/:userIdAdds the API Management User to the list of Recipients for the Notification. - DELETEWorkspaceNotificationRecipientUser_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientUsers/:userIdRemoves the API Management user from the list of Notification. - HEADWorkspaceNotificationRecipientUser_CheckEntityExists
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientUsers/:userIdDetermine if the Notification Recipient User is subscribed to the notification.
NotificationRecipientEmail
- GETWorkspaceNotificationRecipientEmail_ListByNotification
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientEmailsGets the list of the Notification Recipient Emails subscribed to a notification. - PUTWorkspaceNotificationRecipientEmail_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientEmails/:emailAdds the Email address to the list of Recipients for the Notification. - DELETEWorkspaceNotificationRecipientEmail_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientEmails/:emailRemoves the email from the list of Notification. - HEADWorkspaceNotificationRecipientEmail_CheckEntityExists
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/notifications/:notificationName/recipientEmails/:emailDetermine if Notification Recipient Email subscribed to the notification.
PolicyFragment
- GETWorkspacePolicyFragment_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policyFragments?$filter=string&$orderby=stringGets all policy fragments defined within a workspace. - GETWorkspacePolicyFragment_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policyFragments/:idGets a policy fragment. - PUTWorkspacePolicyFragment_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policyFragments/:idCreates or updates a policy fragment. - DELETEWorkspacePolicyFragment_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policyFragments/:idDeletes a policy fragment. - HEADWorkspacePolicyFragment_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policyFragments/:idGets the entity state (Etag) version of a policy fragment. - POSTWorkspacePolicyFragment_ListReferences
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/policyFragments/:id/listReferencesLists policy resources that reference the policy fragment.
Group
- GETWorkspaceGroup_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups?$filter=stringLists a collection of groups defined within a workspace in a service instance. - GETWorkspaceGroup_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupIdGets the details of the group specified by its identifier. - PUTWorkspaceGroup_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupIdCreates or Updates a group. - DELETEWorkspaceGroup_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupIdDeletes specific group of the workspace in an API Management service instance. - HEADWorkspaceGroup_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupIdGets the entity state (Etag) version of the group specified by its identifier. - PATCHWorkspaceGroup_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupIdUpdates the details of the group specified by its identifier.
GroupUser
- GETWorkspaceGroupUser_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupId/users?$filter=stringLists a collection of user entities associated with the group. - PUTWorkspaceGroupUser_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupId/users/:userIdAdd existing user to existing group - DELETEWorkspaceGroupUser_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupId/users/:userIdRemove existing user from existing group. - HEADWorkspaceGroupUser_CheckEntityExists
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/groups/:groupId/users/:userIdChecks that user entity specified by identifier is associated with the group entity.
Subscription
- GETWorkspaceSubscription_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions?$filter=stringLists all subscriptions of the workspace in an API Management service instance. - GETWorkspaceSubscription_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sidGets the specified Subscription entity. - PUTWorkspaceSubscription_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sidCreates or updates the subscription of specified user to the specified product. - DELETEWorkspaceSubscription_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sidDeletes the specified subscription. - HEADWorkspaceSubscription_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sidGets the entity state (Etag) version of the apimanagement subscription specified by its identifier. - PATCHWorkspaceSubscription_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sidUpdates the details of a subscription specified by its identifier. - POSTWorkspaceSubscription_RegeneratePrimaryKey
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sid/regeneratePrimaryKeyRegenerates primary key of existing subscription of the workspace in an API Management service instance. - POSTWorkspaceSubscription_RegenerateSecondaryKey
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sid/regenerateSecondaryKeyRegenerates secondary key of existing subscription of the workspace in an API Management service instance. - POSTWorkspaceSubscription_ListSecrets
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/subscriptions/:sid/listSecretsGets the specified Subscription keys.
ApiVersionSet
- GETWorkspaceApiVersionSet_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apiVersionSets?$filter=stringLists a collection of API Version Sets in the specified workspace with a service instance. - GETWorkspaceApiVersionSet_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apiVersionSets/:versionSetIdGets the details of the Api Version Set specified by its identifier. - PUTWorkspaceApiVersionSet_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apiVersionSets/:versionSetIdCreates or Updates a Api Version Set. - HEADWorkspaceApiVersionSet_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apiVersionSets/:versionSetIdGets the entity state (Etag) version of the Api Version Set specified by its identifier. - PATCHWorkspaceApiVersionSet_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apiVersionSets/:versionSetIdUpdates the details of the Api VersionSet specified by its identifier.
ApiVersionSets
- DELETEWorkspaceApiVersionSet_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apiVersionSets/:versionSetIdDeletes specific Api Version Set.
Api
- GETWorkspaceApi_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis?$filter=string&tags=string&expandApiVersionSet=trueLists all APIs of the workspace in an API Management service instance. - GETWorkspaceApi_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiIdGets the details of the API specified by its identifier. - PUTWorkspaceApi_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiIdCreates new or updates existing specified API of the workspace in an API Management service instance. - DELETEWorkspaceApi_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId?deleteRevisions=trueDeletes the specified API of the workspace in an API Management service instance. - HEADWorkspaceApi_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiIdGets the entity state (Etag) version of the API specified by its identifier. - PATCHWorkspaceApi_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiIdUpdates the specified API of the workspace in an API Management service instance.
ApiRevision
- GETWorkspaceApiRevision_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/revisions?$filter=stringLists all revisions of an API.
ApiRelease
- GETWorkspaceApiRelease_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/releases?$filter=stringLists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results… - GETWorkspaceApiRelease_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/releases/:releaseIdReturns the details of an API release. - PUTWorkspaceApiRelease_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/releases/:releaseIdCreates a new Release for the API. - DELETEWorkspaceApiRelease_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/releases/:releaseIdDeletes the specified release in the API. - HEADWorkspaceApiRelease_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/releases/:releaseIdReturns the etag of an API release. - PATCHWorkspaceApiRelease_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/releases/:releaseIdUpdates the details of the release of the API specified by its identifier.
ApiOperation
- GETWorkspaceApiOperation_ListByApi
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations?$filter=string&tags=stringLists a collection of the operations for the specified API. - GETWorkspaceApiOperation_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationIdGets the details of the API Operation specified by its identifier. - PUTWorkspaceApiOperation_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationIdCreates a new operation in the API or updates an existing one. - DELETEWorkspaceApiOperation_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationIdDeletes the specified operation in the API. - HEADWorkspaceApiOperation_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationIdGets the entity state (Etag) version of the API operation specified by its identifier. - PATCHWorkspaceApiOperation_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationIdUpdates the details of the operation in the API specified by its identifier.
ApiOperationPolicy
- GETWorkspaceApiOperationPolicy_ListByOperation
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationId/policiesGet the list of policy configuration at the API Operation level. - GETWorkspaceApiOperationPolicy_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationId/policies/:policyIdGet the policy configuration at the API Operation level. - PUTWorkspaceApiOperationPolicy_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationId/policies/:policyIdCreates or updates policy configuration for the API Operation level. - DELETEWorkspaceApiOperationPolicy_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationId/policies/:policyIdDeletes the policy configuration at the Api Operation. - HEADWorkspaceApiOperationPolicy_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/operations/:operationId/policies/:policyIdGets the entity state (Etag) version of the API operation policy specified by its identifier.
ApiPolicy
- GETWorkspaceApiPolicy_ListByApi
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/policiesGet the policy configuration at the API level. - GETWorkspaceApiPolicy_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/policies/:policyIdGet the policy configuration at the API level. - PUTWorkspaceApiPolicy_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/policies/:policyIdCreates or updates policy configuration for the API. - DELETEWorkspaceApiPolicy_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/policies/:policyIdDeletes the policy configuration at the Api. - HEADWorkspaceApiPolicy_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/policies/:policyIdGets the entity state (Etag) version of the API policy specified by its identifier.
ApiSchema
- GETWorkspaceApiSchema_ListByApi
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/schemas?$filter=stringGet the schema configuration at the API level. - GETWorkspaceApiSchema_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/schemas/:schemaIdGet the schema configuration at the API level. - PUTWorkspaceApiSchema_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/schemas/:schemaIdCreates or updates schema configuration for the API. - DELETEWorkspaceApiSchema_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/schemas/:schemaId?force=trueDeletes the schema configuration at the Api. - HEADWorkspaceApiSchema_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/apis/:apiId/schemas/:schemaIdGets the entity state (Etag) version of the schema specified by its identifier.
Product
- GETWorkspaceProduct_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products?$filter=string&expandGroups=true&tags=stringLists a collection of products in the specified workspace in a service instance. - GETWorkspaceProduct_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productIdGets the details of the product specified by its identifier. - PUTWorkspaceProduct_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productIdCreates or Updates a product. - DELETEWorkspaceProduct_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId?deleteSubscriptions=trueDelete product. - HEADWorkspaceProduct_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productIdGets the entity state (Etag) version of the product specified by its identifier. - PATCHWorkspaceProduct_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productIdUpdate existing product details.
ProductApiLink
- GETWorkspaceProductApiLink_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/apiLinks?$filter=stringLists a collection of the API links associated with a product. - GETWorkspaceProductApiLink_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/apiLinks/:apiLinkIdGets the API link for the product. - PUTWorkspaceProductApiLink_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/apiLinks/:apiLinkIdAdds an API to the specified product via link. - DELETEWorkspaceProductApiLink_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/apiLinks/:apiLinkIdDeletes the specified API from the specified product.
ProductGroupLink
- GETWorkspaceProductGroupLink_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/groupLinks?$filter=stringLists a collection of the group links associated with a product. - GETWorkspaceProductGroupLink_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/groupLinks/:groupLinkIdGets the group link for the product. - PUTWorkspaceProductGroupLink_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/groupLinks/:groupLinkIdAdds a group to the specified product via link. - DELETEWorkspaceProductGroupLink_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/groupLinks/:groupLinkIdDeletes the specified group from the specified product.
ProductPolicy
- GETWorkspaceProductPolicy_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/policiesGet the policy configuration at the Product level. - GETWorkspaceProductPolicy_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/policies/:policyIdGet the policy configuration at the Product level. - PUTWorkspaceProductPolicy_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/policies/:policyIdCreates or updates policy configuration for the Product. - DELETEWorkspaceProductPolicy_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/policies/:policyIdDeletes the policy configuration at the Product. - HEADWorkspaceProductPolicy_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/products/:productId/policies/:policyIdGet the ETag of the policy configuration at the Product level.
Tag
- GETWorkspaceTag_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags?$filter=string&scope=stringLists a collection of tags defined within a workspace in a service instance. - GETWorkspaceTag_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagIdGets the details of the tag specified by its identifier. - PUTWorkspaceTag_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagIdCreates a tag. - DELETEWorkspaceTag_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagIdDeletes specific tag of the workspace in an API Management service instance. - HEADWorkspaceTag_GetEntityState
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagIdGets the entity state version of the tag specified by its identifier. - PATCHWorkspaceTag_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagIdUpdates the details of the tag specified by its identifier.
TagApiLink
- GETWorkspaceTagApiLink_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/apiLinks?$filter=stringLists a collection of the API links associated with a tag. - GETWorkspaceTagApiLink_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/apiLinks/:apiLinkIdGets the API link for the tag. - PUTWorkspaceTagApiLink_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/apiLinks/:apiLinkIdAdds an API to the specified tag via link. - DELETEWorkspaceTagApiLink_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/apiLinks/:apiLinkIdDeletes the specified API from the specified tag.
TagOperationLink
- GETWorkspaceTagOperationLink_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/operationLinks?$filter=stringLists a collection of the operation links associated with a tag. - GETWorkspaceTagOperationLink_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/operationLinks/:operationLinkIdGets the operation link for the tag. - PUTWorkspaceTagOperationLink_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/operationLinks/:operationLinkIdAdds an operation to the specified tag via link. - DELETEWorkspaceTagOperationLink_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/operationLinks/:operationLinkIdDeletes the specified operation from the specified tag.
TagProductLink
- GETWorkspaceTagProductLink_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/productLinks?$filter=stringLists a collection of the product links associated with a tag. - GETWorkspaceTagProductLink_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/productLinks/:productLinkIdGets the product link for the tag. - PUTWorkspaceTagProductLink_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/productLinks/:productLinkIdAdds a product to the specified tag via link. - DELETEWorkspaceTagProductLink_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/tags/:tagId/productLinks/:productLinkIdDeletes the specified product from the specified tag.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 137 operations on 59 pathsGET 50PUT 26DELETE 25HEAD 20PATCH 10POST 6
- Main resources
- Subscription 9NamedValue 8Api 6ApiOperation 6ApiRelease 6Group 6PolicyFragment 6Product 6Tag 6Workspace 6
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-05-01 - Links
- OpenAPI document
How to test the Azure API Management: Apimworkspaces 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: Apimworkspaces 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 “Workspace_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces?$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: Apimworkspaces?
Use these REST APIs for performing operations on Workspace entity and its associated entities within your Azure API Management deployment. It is listed under Developer tools and has 137 endpoints.
Who publishes the Azure API Management: Apimworkspaces?
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: Apimworkspaces?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure API Management: Apimworkspaces?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure API Management: Apimworkspaces have?
137 operations on 59 paths (50 GET, 26 PUT, 25 DELETE, 20 HEAD, 10 PATCH, 6 POST). The largest groups are Subscription, NamedValue, Api, ApiOperation.
Is forking the Azure API Management: Apimworkspaces free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.