Partilhar via


SubscriptionCreateParameters interface

Detalhes da criação da subscrição.

Propriedades

allowTracing

Determina se o rastreio pode ser ativado

displayName

Nome da subscrição.

ownerId

Utilizador (caminho do ID do utilizador) para o qual a subscrição está a ser criada no formulário /users/{userId}

primaryKey

Chave de subscrição primária. Se não for especificado durante o pedido, a chave será gerada automaticamente.

scope

Âmbito como /products/{productId} ou /apis ou /apis/{apiId}.

secondaryKey

Chave de subscrição secundária. Se não for especificado durante o pedido, a chave será gerada automaticamente.

state

Estado inicial da subscrição. Se não for especificado nenhum valor, a subscrição é criada com o estado Submetido. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.

Detalhes de Propriedade

allowTracing

Determina se o rastreio pode ser ativado

allowTracing?: boolean

Valor de Propriedade

boolean

displayName

Nome da subscrição.

displayName?: string

Valor de Propriedade

string

ownerId

Utilizador (caminho do ID do utilizador) para o qual a subscrição está a ser criada no formulário /users/{userId}

ownerId?: string

Valor de Propriedade

string

primaryKey

Chave de subscrição primária. Se não for especificado durante o pedido, a chave será gerada automaticamente.

primaryKey?: string

Valor de Propriedade

string

scope

Âmbito 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 o pedido, a chave será gerada automaticamente.

secondaryKey?: string

Valor de Propriedade

string

state

Estado inicial da subscrição. Se não for especificado nenhum valor, a subscrição é criada com o estado Submetido. Os estados possíveis estão * ativos – a subscrição está ativa, * suspensa – a subscrição está bloqueada e o subscritor não pode chamar as APIs do produto, * submetidas – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado, * rejeitado – o pedido de subscrição foi negado por um administrador, * cancelado – a subscrição foi cancelada pelo programador ou administrador, * expirou – a subscrição atingiu a data de expiração e foi desativada.

state?: SubscriptionState

Valor de Propriedade