Workspace Subscription - Create Or Update

Reference

Service:: API Management

API Version:: 2024-05-01

Creates or updates the subscription of specified user to the specified product.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?api-version=2024-05-01

With optional parameters:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?notify={notify}&api-version=2024-05-01&appType={appType}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
sid	path	True	string	Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Regex pattern: `^[^*#&+:<>?]+$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
workspaceId	path	True	string	Workspace identifier. Must be unique in the current API Management service instance. Regex pattern: `^[^*#&+:<>?]+$`
api-version	query	True	string	The API version to use for this operation.
appType	query		AppType	Determines the type of application which send the create user request. Default is legacy publisher portal.
notify	query		boolean	Notify change in Subscription State. If false, do not send any email notification for change of state of subscription If true, send email notification of change of state of subscription

Request Header

Name	Required	Type	Description
If-Match		string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name	Required	Type	Description
properties.displayName	True	string	Subscription name.
properties.scope	True	string	Scope like /products/{productId} or /apis or /apis/{apiId}.
properties.allowTracing		boolean	Determines whether tracing can be enabled
properties.ownerId		string	User (user id path) for whom subscription is being created in form /users/{userId}
properties.primaryKey		string	Primary subscription key. If not specified during request key will be generated automatically.
properties.secondaryKey		string	Secondary subscription key. If not specified during request key will be generated automatically.
properties.state		SubscriptionState	Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

Responses

Name	Type	Description
200 OK	SubscriptionContract	The user already subscribed to the product. Headers ETag: string
201 Created	SubscriptionContract	The user was successfully subscribed to the product. Headers ETag: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Name

Type

Description

200 OK

SubscriptionContract

The user already subscribed to the product.

Headers

ETag: string

201 Created

SubscriptionContract

The user was successfully subscribed to the product.

Headers

ETag: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementCreateWorkspaceSubscription

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub?api-version=2024-05-01

{
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Sample response

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces.subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces.subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definitions

Name	Description
AppType	Determines the type of application which send the create user request. Default is legacy portal.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SubscriptionContract	Subscription details.
SubscriptionCreateParameters	Subscription create details.
SubscriptionState	Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

AppType

Determines the type of application which send the create user request. Default is legacy portal.

Name	Type	Description
developerPortal	string	User create request was sent by new developer portal.
portal	string	User create request was sent by legacy developer portal.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SubscriptionContract

Subscription details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.allowTracing	boolean	Determines whether tracing is enabled
properties.createdDate	string	Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.displayName	string	The name of the subscription, or null if the subscription has no name.
properties.endDate	string	Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.expirationDate	string	Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.notificationDate	string	Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.ownerId	string	The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
properties.primaryKey	string	Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
properties.scope	string	Scope like /products/{productId} or /apis or /apis/{apiId}.
properties.secondaryKey	string	Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
properties.startDate	string	Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
properties.state	SubscriptionState	Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
properties.stateComment	string	Optional subscription comment added by an administrator when the state is changed to the 'rejected'.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Subscription create details.

Name	Type	Description
properties.allowTracing	boolean	Determines whether tracing can be enabled
properties.displayName	string	Subscription name.
properties.ownerId	string	User (user id path) for whom subscription is being created in form /users/{userId}
properties.primaryKey	string	Primary subscription key. If not specified during request key will be generated automatically.
properties.scope	string	Scope like /products/{productId} or /apis or /apis/{apiId}.
properties.secondaryKey	string	Secondary subscription key. If not specified during request key will be generated automatically.
properties.state	SubscriptionState	Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

SubscriptionState

Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

Name	Type	Description
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string

Partager via

Workspace Subscription - Create Or Update

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

ApiManagementCreateWorkspaceSubscription

Sample request

Sample response

Definitions

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState

Ressources supplémentaires