Compartilhar via

Microsoft.ApiManagement service/workspaces/subscriptions 2023-03-01-preview

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

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

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

Valores de propriedade

Microsoft.ApiManagement/service/workspaces/subscriptions

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento máximo =
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 o recurso do tipo: serviço/workspaces
Propriedades Propriedades do contrato de assinatura. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Nome Descrição Valor
allowTracing Determina se o rastreamento pode ser habilitado Bool
displayName Nome da assinatura. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
ownerId Usuário (caminho da ID do usuário) para quem a assinatura está sendo criada no formulário /users/{userId} corda
primaryKey Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
âmbito Escopo como /products/{productId} ou /apis ou /apis/{apiId}. cadeia de caracteres (obrigatório)
secondaryKey Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
estado 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, * enviada – 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. 'ativo'
'cancelado'
'expirado'
'rejeitado'
'enviado'
'suspenso'

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

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

Valores de propriedade

Microsoft.ApiManagement/service/workspaces/subscriptions

Nome Descrição Valor
apiVersion A versão da API '2023-03-01-preview'
nome O nome do recurso corda

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

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Nome Descrição Valor
allowTracing Determina se o rastreamento pode ser habilitado Bool
displayName Nome da assinatura. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
ownerId Usuário (caminho da ID do usuário) para quem a assinatura está sendo criada no formulário /users/{userId} corda
primaryKey Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
âmbito Escopo como /products/{productId} ou /apis ou /apis/{apiId}. cadeia de caracteres (obrigatório)
secondaryKey Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
estado 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, * enviada – 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. 'ativo'
'cancelado'
'expirado'
'rejeitado'
'enviado'
'suspenso'

Definição de recurso do Terraform (provedor de AzAPI)

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

  • grupos de recursos

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

Formato de recurso

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

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

Valores de propriedade

Microsoft.ApiManagement/service/workspaces/subscriptions

Nome Descrição Valor
nome O nome do recurso corda

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

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Nome Descrição Valor
allowTracing Determina se o rastreamento pode ser habilitado Bool
displayName Nome da assinatura. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
ownerId Usuário (caminho da ID do usuário) para quem a assinatura está sendo criada no formulário /users/{userId} corda
primaryKey Chave de assinatura primária. Se não for especificado durante a chave de solicitação, será gerado automaticamente. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
âmbito Escopo como /products/{productId} ou /apis ou /apis/{apiId}. cadeia de caracteres (obrigatório)
secondaryKey Chave de assinatura secundária. Se não for especificado durante a chave de solicitação, será gerado automaticamente. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
estado 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, * enviada – 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. 'ativo'
'cancelado'
'expirado'
'rejeitado'
'enviado'
'suspenso'