SubscriptionCreateParameters interface

Pacote:

@azure/arm-apimanagement

A subscrição cria detalhes.

Propriedades

allowTracing	Determina se o rastreamento pode ser habilitado
displayName	Nome da subscrição.
ownerId	Usuário (caminho do ID do usuário) para o qual a assinatura está sendo criada no formato /users/{userId}
primaryKey	Chave de subscrição principal. Se não for especificado durante a solicitação, a chave será gerada automaticamente.
scope	Escopo como /products/{productId} ou /apis ou /apis/{apiId}.
secondaryKey	Chave de subscrição secundária. Se não for especificado durante a solicitação, a chave será gerada automaticamente.
state	Estado inicial da subscrição. Se nenhum valor for especificado, a assinatura será criada com o estado Enviado. 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.

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

ownerId

Usuário (caminho do ID do usuário) para o qual a assinatura está sendo criada no formato /users/{userId}

ownerId?: string

Valor de Propriedade

string

primaryKey

Chave de subscrição principal. Se não for especificado durante a solicitação, a chave será gerada automaticamente.

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. Se não for especificado durante a solicitação, a chave será gerada automaticamente.

secondaryKey?: string

Valor de Propriedade

string

state

Estado inicial da subscrição. Se nenhum valor for especificado, a assinatura será criada com o estado Enviado. 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