SubscriptionContract interface

Package:

@azure/arm-apimanagement

Subscription details.

Extends

ProxyResource

Properties

allowTracing	Determines whether tracing is enabled
createdDate	Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.
displayName	The name of the subscription, or null if the subscription has no name.
endDate	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.
expirationDate	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.
notificationDate	Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
ownerId	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.
primaryKey	Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
scope	Scope like /products/{productId} or /apis or /apis/{apiId}.
secondaryKey	Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
startDate	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.
state	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.
stateComment	Optional subscription comment added by an administrator when the state is changed to the 'rejected'.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowTracing

Determines whether tracing is enabled

allowTracing?: boolean

Property Value

boolean

createdDate

Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: Date

Property Value

Date

displayName

The name of the subscription, or null if the subscription has no name.

displayName?: string

Property Value

string

endDate

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.

endDate?: Date

Property Value

Date

expirationDate

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.

expirationDate?: Date

Property Value

Date

notificationDate

Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

notificationDate?: Date

Property Value

Date

ownerId

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.

ownerId?: string

Property Value

string

primaryKey

Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

primaryKey?: string

Property Value

string

scope

Scope like /products/{productId} or /apis or /apis/{apiId}.

scope?: string

Property Value

string

secondaryKey

Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

secondaryKey?: string

Property Value

string

startDate

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.

startDate?: Date

Property Value

Date

state

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.

state?: SubscriptionState

Property Value

SubscriptionState

stateComment

Optional subscription comment added by an administrator when the state is changed to the 'rejected'.

stateComment?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type