Compartilhar via

SubscriptionContract interface

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

Detalhes da assinatura.

Extends
ProxyResource

Propriedades

allowTracing

Determina se o rastreamento está habilitado
createdDate

Data de criação da assinatura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
displayName

O nome da assinatura ou nulo se a assinatura não tiver nenhum nome.
endDate

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

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

Data de notificação de expiração da assinatura futura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
ownerId

O identificador de recurso de usuário do proprietário da assinatura. O valor é uma URL relativa válida no formato /users/{userId} em que {userId} é um identificador de usuário.
primaryKey

Chave primária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
scope

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

Chave secundária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
startDate

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

Estado da assinatura. 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.
stateComment

Comentário de assinatura opcional adicionado por um administrador quando o estado é alterado para 'rejeitado'.

Propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

allowTracing

Determina se o rastreamento está habilitado

allowTracing?: boolean

Valor da propriedade

boolean

createdDate

Data de criação da assinatura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

createdDate?: Date

Valor da propriedade

Date

displayName

O nome da assinatura ou nulo se a assinatura não tiver nenhum nome.

displayName?: string

Valor da propriedade

string

endDate

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

endDate?: Date

Valor da propriedade

Date

expirationDate

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

expirationDate?: Date

Valor da propriedade

Date

notificationDate

Data de notificação de expiração da assinatura futura. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

notificationDate?: Date

Valor da propriedade

Date

ownerId

O identificador de recurso de usuário do proprietário da assinatura. O valor é uma URL relativa válida no formato /users/{userId} em que {userId} é um identificador de usuário.

ownerId?: string

Valor da propriedade

string

primaryKey

Chave primária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

primaryKey?: string

Valor da propriedade

string

scope

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

scope?: string

Valor da propriedade

string

secondaryKey

Chave secundária da assinatura. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

secondaryKey?: string

Valor da propriedade

string

startDate

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

startDate?: Date

Valor da propriedade

Date

state

Estado da assinatura. 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

stateComment

Comentário de assinatura opcional adicionado por um administrador quando o estado é alterado para 'rejeitado'.

stateComment?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

Herdado deProxyResource.id

name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

Herdado deProxyResource.name

type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deProxyResource.type