Serviço/apis Microsoft.ApiManagement 2016-10-10
- Ú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 service/apis 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/apis, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-10-10' = {
parent: resourceSymbolicName
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
}
description: 'string'
name: 'string'
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
}
Valores de propriedade
AuthenticationSettingsContract
| Designação | Descrição | Valor |
|---|---|---|
| oAuth2 | Detalhes das configurações de autenticação da API OAuth2. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Designação | Descrição | Valor |
|---|---|---|
| authenticationSettings | Coleção de configurações de autenticação incluídas nesta API. | AuthenticationSettingsContract |
| Descrição | Descrição da API. Pode incluir tags de formatação HTML. | string |
| Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 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 |
| caminho | URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. Ele é anexado à URL base do ponto de extremidade da API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. | string Restrições: Comprimento máximo = (obrigatório) |
| protocolos | Descreve em quais protocolos as operações nesta API podem ser invocadas. | Matriz de cadeia de caracteres contendo qualquer uma das: «Http» 'Https' (obrigatório) |
| serviceUrl | URL absoluta do serviço de back-end que implementa esta API. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (obrigatório) |
| subscriptionKeyParameterNames | Protocolos sobre os quais a API é disponibilizada. | SubscriptionKeyParameterNamesContract |
OAuth2AuthenticationSettingsContract
| Designação | Descrição | Valor |
|---|---|---|
| authorizationServerId | Identificador do servidor de autorização OAuth. | string |
| Âmbito de aplicação | âmbito das operações. | string |
SubscriptionKeyParameterNamesContract
| Designação | Descrição | Valor |
|---|---|---|
| cabeçalho | Nome do cabeçalho da chave de assinatura. | string |
| consulta | Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. | string |
Definição de recurso de modelo ARM
O tipo de recurso service/apis 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/apis, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2016-10-10",
"name": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
}
},
"description": "string",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
}
}
Valores de propriedade
AuthenticationSettingsContract
| Designação | Descrição | Valor |
|---|---|---|
| oAuth2 | Detalhes das configurações de autenticação da API OAuth2. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
OAuth2AuthenticationSettingsContract
| Designação | Descrição | Valor |
|---|---|---|
| authorizationServerId | Identificador do servidor de autorização OAuth. | string |
| Âmbito de aplicação | âmbito das operações. | string |
SubscriptionKeyParameterNamesContract
| Designação | Descrição | Valor |
|---|---|---|
| cabeçalho | Nome do cabeçalho da chave de assinatura. | string |
| consulta | Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. | string |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso service/apis 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/apis, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2016-10-10"
name = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
}
description = "string"
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
}
Valores de propriedade
AuthenticationSettingsContract
| Designação | Descrição | Valor |
|---|---|---|
| oAuth2 | Detalhes das configurações de autenticação da API OAuth2. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Designação | Descrição | Valor |
|---|---|---|
| authenticationSettings | Coleção de configurações de autenticação incluídas nesta API. | AuthenticationSettingsContract |
| Descrição | Descrição da API. Pode incluir tags de formatação HTML. | string |
| Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 Padrão = ^[^*#&+:<>?]+$ (obrigatório) |
| parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
| caminho | URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. Ele é anexado à URL base do ponto de extremidade da API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. | string Restrições: Comprimento máximo = (obrigatório) |
| protocolos | Descreve em quais protocolos as operações nesta API podem ser invocadas. | Matriz de cadeia de caracteres contendo qualquer uma das: «Http» 'Https' (obrigatório) |
| serviceUrl | URL absoluta do serviço de back-end que implementa esta API. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (obrigatório) |
| subscriptionKeyParameterNames | Protocolos sobre os quais a API é disponibilizada. | SubscriptionKeyParameterNamesContract |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/apis@2016-10-10" |
OAuth2AuthenticationSettingsContract
| Designação | Descrição | Valor |
|---|---|---|
| authorizationServerId | Identificador do servidor de autorização OAuth. | string |
| Âmbito de aplicação | âmbito das operações. | string |
SubscriptionKeyParameterNamesContract
| Designação | Descrição | Valor |
|---|---|---|
| cabeçalho | Nome do cabeçalho da chave de assinatura. | string |
| consulta | Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. | string |