Serviço Microsoft.ApiManagement/áreas de trabalho/subscrições

• Mais recente
• 2023-03-01-preview
• 2022-09-01-preview

Definição de recurso do Bicep

O tipo de recurso serviço/áreas de trabalho/subscrições pode ser implementado com operações que visam:

• Grupos de recursos – veja os comandos de implementação do grupo de recursos

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

Formato do 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' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Valores de propriedade

serviço/áreas de trabalho/subscrições

Nome	Descrição	Valor
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados no Bicep.	cadeia (obrigatório)
principal	No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal.	Nome simbólico para recurso do tipo: áreas de trabalho
propriedades	Propriedades do contrato de subscrição.	SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Nome	Descrição	Valor
permitirTracing	Determina se o rastreio pode ser ativado	bool
displayName	Nome da subscrição.	cadeia (obrigatório)
ownerId	Utilizador (caminho do ID do utilizador) para o qual a subscrição está a ser criada no formulário /users/{userId}	string
primaryKey	Chave de subscrição primária. Se não for especificado durante o pedido, a chave será gerada automaticamente.	string
scope	Âmbito como /products/{productId} ou /apis ou /apis/{apiId}.	cadeia (obrigatório)
secondaryKey	Chave de subscrição secundária. Se não for especificado durante o pedido, a chave será gerada automaticamente.	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.	"ativo" "cancelado" "expirado" "rejeitado" "submetido" "suspenso"

Definição de recurso do modelo arm

O tipo de recurso serviço/áreas de trabalho/subscrições pode ser implementado com operações que visam:

• Grupos de recursos – veja os comandos de implementação do grupo de recursos

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/workspaces/subscriptions, adicione o seguinte JSON 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

serviço/áreas de trabalho/subscrições

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/workspaces/subscriptions"
apiVersion	A versão da API de recursos	'2023-03-01-preview'
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.	cadeia (obrigatório)
propriedades	Propriedades do contrato de subscrição.	SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Nome	Descrição	Valor
permitirTracing	Determina se o rastreio pode ser ativado	bool
displayName	Nome da subscrição.	cadeia (obrigatório)
ownerId	Utilizador (caminho do ID do utilizador) para o qual a subscrição está a ser criada no formulário /users/{userId}	string
primaryKey	Chave de subscrição primária. Se não for especificado durante o pedido, a chave será gerada automaticamente.	string
scope	Âmbito como /products/{productId} ou /apis ou /apis/{apiId}.	cadeia (obrigatório)
secondaryKey	Chave de subscrição secundária. Se não for especificado durante o pedido, a chave será gerada automaticamente.	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.	"ativo" "cancelado" "expirado" "rejeitado" "submetido" "suspenso"

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso serviço/áreas de trabalho/subscrições pode ser implementado com operações que visam:

• Grupos de recursos

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

Formato do recurso

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

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

Valores de propriedade

serviço/áreas de trabalho/subscrições

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/workspaces/subscriptions@2023-03-01-preview"
name	O nome do recurso	cadeia (obrigatório)
parent_id	O ID do recurso que é o principal para este recurso.	ID do recurso do tipo: áreas de trabalho
propriedades	Propriedades do contrato de subscrição.	SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Nome	Descrição	Valor
permitirTracing	Determina se o rastreio pode ser ativado	bool
displayName	Nome da subscrição.	cadeia (obrigatório)
ownerId	Utilizador (caminho do ID do utilizador) para o qual a subscrição está a ser criada no formulário /users/{userId}	string
primaryKey	Chave de subscrição primária. Se não for especificado durante o pedido, a chave será gerada automaticamente.	string
scope	Âmbito como /products/{productId} ou /apis ou /apis/{apiId}.	cadeia (obrigatório)
secondaryKey	Chave de subscrição secundária. Se não for especificado durante o pedido, a chave será gerada automaticamente.	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.	"ativo" "cancelado" "expirado" "rejeitado" "submetido" "suspenso"