Partilhar via

SubscriptionContract interface

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

Detalhes da subscrição.

Extends
ProxyResource

Propriedades

allowTracing

Determina se o rastreamento está habilitado
createdDate

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

Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
displayName

O nome da assinatura, ou null se a assinatura não tiver nome.
endDate

Data em que a subscrição 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 propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
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.
notificationDate

Próxima data de notificação de expiração da subscrição. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
ownerId

O identificador de recurso do usuário do proprietário da assinatura. O valor é um URL relativo válido no formato /users/{userId} onde {userId} é um identificador de usuário.
primaryKey

Chave primária da subscrição. Esta 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 de subscrição. Esta 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 subscrição. A configuração é apenas para fins de auditoria e a assinatura não é ativada 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.
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ário de subscrição opcional adicionado por um administrador quando o estado é alterado para 'rejeitado'.

Propriedades Herdadas

id

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes de Propriedade

allowTracing

Determina se o rastreamento está habilitado

allowTracing?: boolean

Valor de Propriedade

boolean

createdDate

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

Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

createdDate?: Date

Valor de Propriedade

Date

displayName

O nome da assinatura, ou null se a assinatura não tiver nome.

displayName?: string

Valor de Propriedade

string

endDate

Data em que a subscrição 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 propriedade state. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.

endDate?: Date

Valor de Propriedade

Date

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

notificationDate

Próxima data de notificação de expiração da subscrição. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.

notificationDate?: Date

Valor de Propriedade

Date

ownerId

O identificador de recurso do usuário do proprietário da assinatura. O valor é um URL relativo válido no formato /users/{userId} onde {userId} é um identificador de usuário.

ownerId?: string

Valor de Propriedade

string

primaryKey

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

primaryKey?: string

Valor de Propriedade

string

scope

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

scope?: string

Valor de Propriedade

string

secondaryKey

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

secondaryKey?: string

Valor de Propriedade

string

startDate

Data de ativação da subscrição. A configuração é apenas para fins de auditoria e a assinatura não é ativada 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.

startDate?: Date

Valor de Propriedade

Date

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ário de subscrição opcional adicionado por um administrador quando o estado é alterado para 'rejeitado'.

stateComment?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

id

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor de Propriedade

string

herdado deProxyResource.id

name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor de Propriedade

string

herdada deProxyResource.name

type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor de Propriedade

string

herdado de ProxyResource.type