SubscriptionUpdateParameters interface

Pacote:

@azure/arm-apimanagement

Detalhes da atualização da subscrição.

Propriedades

allowTracing	Determina se o rastreamento pode ser habilitado
displayName	Nome da subscrição.
expirationDate	Data de expiração da subscrição. A configuração é apenas para fins de auditoria e a assinatura não expirou automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
ownerId	Caminho do identificador do usuário: /users/{userId}
primaryKey	Chave de subscrição principal.
scope	Escopo como /products/{productId} ou /apis ou /apis/{apiId}
secondaryKey	Chave de subscrição secundária.
state	Estado da subscrição. Os estados possíveis são * ativo – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma API do produto, * enviado – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirou – a subscrição atingiu a sua data de expiração e foi desativada.
stateComment	Comentários que descrevem a alteração do estado da subscrição pelo administrador quando o estado é alterado para «rejeitado».

Detalhes de Propriedade

allowTracing

Determina se o rastreamento pode ser habilitado

allowTracing?: boolean

Valor de Propriedade

boolean

displayName

Nome da subscrição.

displayName?: string

Valor de Propriedade

string

expirationDate

Data de expiração da subscrição. A configuração é apenas para fins de auditoria e a assinatura não expirou automaticamente. O ciclo de vida da assinatura pode ser gerenciado usando a propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.

expirationDate?: Date

Valor de Propriedade

Date

ownerId

Caminho do identificador do usuário: /users/{userId}

ownerId?: string

Valor de Propriedade

string

primaryKey

Chave de subscrição principal.

primaryKey?: string

Valor de Propriedade

string

scope

Escopo como /products/{productId} ou /apis ou /apis/{apiId}

scope?: string

Valor de Propriedade

string

secondaryKey

Chave de subscrição secundária.

secondaryKey?: string

Valor de Propriedade

string

state

Estado da subscrição. Os estados possíveis são * ativo – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma API do produto, * enviado – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada, * rejeitada – a solicitação de assinatura foi negada por um administrador, * cancelada – a assinatura foi cancelada pelo desenvolvedor ou administrador, * expirou – a subscrição atingiu a sua data de expiração e foi desativada.

state?: SubscriptionState

Valor de Propriedade

SubscriptionState

stateComment

Comentários que descrevem a alteração do estado da subscrição pelo administrador quando o estado é alterado para «rejeitado».

stateComment?: string

Valor de Propriedade

string