user_subscriptions

Creates, updates, deletes, gets or lists a user_subscriptions resource.

Overview

Name	user_subscriptions
Type	Resource
Id	azure.api_management.user_subscriptions

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Subscription entity.

Name	Datatype	Description
properties	object	Subscription contract properties.

list

Lists a collection of Subscription entities.

Name	Datatype	Description
properties	object	Subscription contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, userId, sid, subscriptionId		Gets the specified Subscription entity associated with a particular user.
list	select	resourceGroupName, serviceName, userId, subscriptionId	$filter, $top, $skip	Lists the collection of subscriptions of the specified user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
sid	string	Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
subscriptionId	string	The ID of the target subscription.
userId	string	User identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|------------------------|-----------------------------------|</br>|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

get

Gets the specified Subscription entity associated with a particular user.

SELECT
properties
FROM azure.api_management.user_subscriptions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND userId = '{{ userId }}' -- required
AND sid = '{{ sid }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists the collection of subscriptions of the specified user.

SELECT
properties
FROM azure.api_management.user_subscriptions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND userId = '{{ userId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;