Serviço/subscrições Microsoft.ApiManagement 2016-07-07
- Últimas
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definição de recursos do bíceps
O tipo de recurso serviço/assinaturas pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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 Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2016-07-07' = {
parent: resourceSymbolicName
name: 'string'
primaryKey: 'string'
productId: 'string'
secondaryKey: 'string'
state: 'string'
userId: '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ínimo = 1 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 |
| 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 |
| productId | Produto (caminho de identificação do produto) para o qual a assinatura está sendo criada no formato /products/{productId} | 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' |
| userId | Usuário (caminho de ID do usuário) para o qual a assinatura está sendo criada no formato /users/{uid} | string (obrigatório) |
Definição de recurso de modelo ARM
O tipo de recurso serviço/assinaturas pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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 JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2016-07-07",
"name": "string",
"primaryKey": "string",
"productId": "string",
"secondaryKey": "string",
"state": "string",
"userId": "string"
}
Valores de propriedade
Microsoft.ApiManagement/serviço/assinaturas
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2016-07-07' |
| Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
| 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 |
| productId | Produto (caminho de identificação do produto) para o qual a assinatura está sendo criada no formato /products/{productId} | 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' |
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/serviço/assinaturas' |
| userId | Usuário (caminho de ID do usuário) para o qual a assinatura está sendo criada no formato /users/{uid} | string (obrigatório) |
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@2016-07-07"
name = "string"
primaryKey = "string"
productId = "string"
secondaryKey = "string"
state = "string"
userId = "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ínimo = 1 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 |
| 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 |
| productId | Produto (caminho de identificação do produto) para o qual a assinatura está sendo criada no formato /products/{productId} | 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' |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/subscriptions@2016-07-07" |
| userId | Usuário (caminho de ID do usuário) para o qual a assinatura está sendo criada no formato /users/{uid} | string (obrigatório) |