Partilhar via

Serviço/subscrições Microsoft.ApiManagement 2022-08-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso serviço/assinaturas pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/subscriptions, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2022-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Valores de propriedade

Microsoft.ApiManagement/serviço/assinaturas

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: serviço
propriedades Propriedades do contrato de subscrição. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Designação Descrição Valor
allowRastreamento Determina se o rastreamento pode ser habilitado Bool
displayName Nome da subscrição. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100 (obrigatório)
ownerId Usuário (caminho do ID do usuário) para o qual a assinatura está sendo criada no formato /users/{userId} string
primárioChave Chave de subscrição principal. Se não for especificado durante a solicitação, a chave será gerada automaticamente. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Âmbito de aplicação Escopo como /products/{productId} ou /apis ou /apis/{apiId}. string (obrigatório)
secundário Chave de subscrição secundária. Se não for especificado durante a solicitação, a chave será gerada automaticamente. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Estado 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. 'ativo'
'Cancelado'
'caducou'
'rejeitado'
'submetido'
'suspenso'

Definição de recurso de modelo ARM

O tipo de recurso serviço/assinaturas pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/subscriptions, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

Valores de propriedade

Microsoft.ApiManagement/serviço/assinaturas

Designação Descrição Valor
apiVersion A versão api '2022-08-01'
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Propriedades do contrato de subscrição. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/serviço/assinaturas'

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Designação Descrição Valor
allowRastreamento Determina se o rastreamento pode ser habilitado Bool
displayName Nome da subscrição. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100 (obrigatório)
ownerId Usuário (caminho do ID do usuário) para o qual a assinatura está sendo criada no formato /users/{userId} string
primárioChave Chave de subscrição principal. Se não for especificado durante a solicitação, a chave será gerada automaticamente. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Âmbito de aplicação Escopo como /products/{productId} ou /apis ou /apis/{apiId}. string (obrigatório)
secundário Chave de subscrição secundária. Se não for especificado durante a solicitação, a chave será gerada automaticamente. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Estado 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. 'ativo'
'Cancelado'
'caducou'
'rejeitado'
'submetido'
'suspenso'

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso serviço/assinaturas pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/subscriptions, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2022-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

Valores de propriedade

Microsoft.ApiManagement/serviço/assinaturas

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades Propriedades do contrato de subscrição. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/subscriptions@2022-08-01"

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Designação Descrição Valor
allowRastreamento Determina se o rastreamento pode ser habilitado Bool
displayName Nome da subscrição. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100 (obrigatório)
ownerId Usuário (caminho do ID do usuário) para o qual a assinatura está sendo criada no formato /users/{userId} string
primárioChave Chave de subscrição principal. Se não for especificado durante a solicitação, a chave será gerada automaticamente. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Âmbito de aplicação Escopo como /products/{productId} ou /apis ou /apis/{apiId}. string (obrigatório)
secundário Chave de subscrição secundária. Se não for especificado durante a solicitação, a chave será gerada automaticamente. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Estado 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. 'ativo'
'Cancelado'
'caducou'
'rejeitado'
'submetido'
'suspenso'