Subscription | @azure/arm-apimanagement

Interface representing a Subscription.

Hierarchy

Subscription

Implemented by

SubscriptionImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>

- Defined in operationsInterfaces/subscription.ts:81
Creates or updates the subscription of specified user to the specified product.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- parameters: SubscriptionCreateParameters
  
  Create parameters.
- Optional options: SubscriptionCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SubscriptionCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/subscription.ts:117
Deletes the specified subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- 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.
- Optional options: SubscriptionDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>

- Defined in operationsInterfaces/subscription.ts:66
Gets the specified Subscription entity.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: SubscriptionGetOptionalParams
  
  The options parameters.
Returns Promise<SubscriptionGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagResponse>

- Defined in operationsInterfaces/subscription.ts:52
Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: SubscriptionGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<SubscriptionGetEntityTagResponse>

list

list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract>

- Defined in operationsInterfaces/subscription.ts:39
Lists all subscriptions of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: SubscriptionListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SubscriptionContract>

listSecrets

listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>

- Defined in operationsInterfaces/subscription.ts:160
Gets the specified Subscription keys.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: SubscriptionListSecretsOptionalParams
  
  The options parameters.
Returns Promise<SubscriptionListSecretsResponse>

regeneratePrimaryKey

regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>

- Defined in operationsInterfaces/subscription.ts:132
Regenerates primary key of existing subscription of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: SubscriptionRegeneratePrimaryKeyOptionalParams
  
  The options parameters.
Returns Promise<void>

regenerateSecondaryKey

regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>

- Defined in operationsInterfaces/subscription.ts:146
Regenerates secondary key of existing subscription of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: SubscriptionRegenerateSecondaryKeyOptionalParams
  
  The options parameters.
Returns Promise<void>

update

update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>

- Defined in operationsInterfaces/subscription.ts:99
Updates the details of a subscription specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- 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.
- Optional options: SubscriptionUpdateOptionalParams
  
  The options parameters.
Returns Promise<SubscriptionUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

sid: string

parameters: SubscriptionCreateParameters

Optional options: SubscriptionCreateOrUpdateOptionalParams

Returns Promise<SubscriptionCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

sid: string

ifMatch: string

Optional options: SubscriptionDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

sid: string

Optional options: SubscriptionGetOptionalParams

Returns Promise<SubscriptionGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

sid: string

Optional options: SubscriptionGetEntityTagOptionalParams

Returns Promise<SubscriptionGetEntityTagResponse>

list

Parameters

resourceGroupName: string

serviceName: string

Optional options: SubscriptionListOptionalParams

Returns PagedAsyncIterableIterator<SubscriptionContract>

listSecrets

Parameters

resourceGroupName: string

serviceName: string

sid: string

Optional options: SubscriptionListSecretsOptionalParams

Returns Promise<SubscriptionListSecretsResponse>

regeneratePrimaryKey

Parameters

resourceGroupName: string

serviceName: string

sid: string

Optional options: SubscriptionRegeneratePrimaryKeyOptionalParams

Returns Promise<void>

regenerateSecondaryKey

Parameters

resourceGroupName: string

serviceName: string

sid: string

Optional options: SubscriptionRegenerateSecondaryKeyOptionalParams

Returns Promise<void>

update

Parameters

resourceGroupName: string

serviceName: string

sid: string

ifMatch: string

parameters: SubscriptionUpdateParameters

Optional options: SubscriptionUpdateOptionalParams

Returns Promise<SubscriptionUpdateResponse>