Compartilhar via

SubscriptionCreateParameters interface

  • Referência
Pacote:
@azure/arm-apimanagement

Detalhes de criação de assinatura.

Propriedades

allowTracing

Determina se o rastreamento pode ser habilitado
displayName

Nome da assinatura.
ownerId

Usuário (caminho da ID de usuário) para quem a assinatura está sendo criada no formato /users/{userId}
primaryKey

Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.
scope

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

Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.
state

Estado inicial da assinatura. Se nenhum valor for especificado, a assinatura será criada com o estado Enviado. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs 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, * expirado – a assinatura atingiu a data de validade e foi desativada.

Detalhes da propriedade

allowTracing

Determina se o rastreamento pode ser habilitado

allowTracing?: boolean

Valor da propriedade

boolean

displayName

Nome da assinatura.

displayName?: string

Valor da propriedade

string

ownerId

Usuário (caminho da ID de usuário) para quem a assinatura está sendo criada no formato /users/{userId}

ownerId?: string

Valor da propriedade

string

primaryKey

Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.

primaryKey?: string

Valor da propriedade

string

scope

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

scope?: string

Valor da propriedade

string

secondaryKey

Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente.

secondaryKey?: string

Valor da propriedade

string

state

Estado inicial da assinatura. Se nenhum valor for especificado, a assinatura será criada com o estado Enviado. Os estados possíveis estão * ativos – a assinatura está ativa, * suspensa – a assinatura está bloqueada e o assinante não pode chamar nenhuma APIs 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, * expirado – a assinatura atingiu a data de validade e foi desativada.

state?: SubscriptionState

Valor da propriedade

SubscriptionState