WorkspaceSubscription interface
Interface representing a WorkspaceSubscription.
Methods
Method Details
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
Creates or updates the subscription of specified user to the specified product.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- parameters
- SubscriptionCreateParameters
Create parameters.
The options parameters.
Returns
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
Deletes the specified subscription.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
Gets the specified Subscription entity.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
The options parameters.
Returns
Promise<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
The options parameters.
Returns
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
Lists all subscriptions of the workspace in an API Management service instance.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
Gets the specified Subscription keys.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
The options parameters.
Returns
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
Regenerates primary key of existing subscription of the workspace in an API Management service instance.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
The options parameters.
Returns
Promise<void>
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
Regenerates secondary key of existing subscription of the workspace in an API Management service instance.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
The options parameters.
Returns
Promise<void>
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
Updates the details of a subscription specified by its identifier.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- sid
-
string
Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters
- SubscriptionUpdateParameters
Update parameters.
The options parameters.
Returns
Promise<WorkspaceSubscriptionUpdateResponse>