Compartilhar via

Microsoft.ApiManagement service/apis 2019-01-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

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/apis, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2019-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valores de propriedade

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome Descrição Valor
apiRevision Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
apiRevisionDescription Descrição da Revisão de API. corda

Restrições:
Comprimento máximo =
apiType Tipo de API a ser criada.
* http cria uma API SOAP para REST
* soap cria uma API de passagem SOAP.		 'http'
'soap'
apiVersion Indica o identificador de versão da API se a API for versão corda

Restrições:
Comprimento máximo =
apiVersionDescription Descrição da Versão da API. corda

Restrições:
Comprimento máximo =
apiVersionSet Detalhes do conjunto de versão ApiVersionSetContractDetails
apiVersionSetId Um identificador de recurso para o ApiVersionSet relacionado. corda
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
descrição Descrição da API. Pode incluir marcas de formatação HTML. corda
displayName Nome da API. Deve ter de 1 a 300 caracteres. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
formato Formato do conteúdo no qual a API está sendo importada. 'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent Indica se a revisão da API é a revisão de API atual. Bool
caminho URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. corda

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 que contém qualquer um dos:
'http'
'https'
serviceUrl URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres. corda

Restrições:
Comprimento máximo =
sourceApiId Identificador de API da API de origem. corda
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
subscriptionRequired Especifica se uma assinatura de API ou produto é necessária para acessar a API. Bool
tipo Tipo de API. 'http'
'soap'
valor Valor de conteúdo ao importar uma API. corda
wsdlSelector Critérios para limitar a importação de WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Nome Descrição Valor
wsdlEndpointName Nome do ponto de extremidade(porta) a ser importado do WSDL corda
wsdlServiceName Nome do serviço a ser importado do WSDL corda

ApiVersionSetContractDetails

Nome Descrição Valor
descrição Descrição do Conjunto de Versões da API. corda
id Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões. corda
nome O nome de exibição do conjunto de versões da API. corda
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como header. corda
versioningScheme Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP. 'Cabeçalho'
'Consulta'
'Segment'
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. corda

AuthenticationSettingsContract

Nome Descrição Valor
oAuth2 Configurações de Autenticação OAuth2 OAuth2AuthenticationSettingsContract
openid Configurações de autenticação do OpenID Connect OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

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

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 do recurso do tipo: de serviço
Propriedades Criação de propriedades de atualização da entidade de API. ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

Nome Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
âmbito escopo de operações. corda

OpenIdAuthenticationSettingsContract

Nome Descrição Valor
bearerTokenSendingMethods Como enviar token para o servidor. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationHeader'
'consulta'
openidProviderId Identificador do servidor de autorização OAuth. corda

SubscriptionKeyParameterNamesContract

Nome Descrição Valor
cabeçalho Nome do cabeçalho da chave de assinatura. corda
consulta Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. corda

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

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/apis, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      }
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valores de propriedade

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome Descrição Valor
apiRevision Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
apiRevisionDescription Descrição da Revisão de API. corda

Restrições:
Comprimento máximo =
apiType Tipo de API a ser criada.
* http cria uma API SOAP para REST
* soap cria uma API de passagem SOAP.		 'http'
'soap'
apiVersion Indica o identificador de versão da API se a API for versão corda

Restrições:
Comprimento máximo =
apiVersionDescription Descrição da Versão da API. corda

Restrições:
Comprimento máximo =
apiVersionSet Detalhes do conjunto de versão ApiVersionSetContractDetails
apiVersionSetId Um identificador de recurso para o ApiVersionSet relacionado. corda
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
descrição Descrição da API. Pode incluir marcas de formatação HTML. corda
displayName Nome da API. Deve ter de 1 a 300 caracteres. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
formato Formato do conteúdo no qual a API está sendo importada. 'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent Indica se a revisão da API é a revisão de API atual. Bool
caminho URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. corda

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 que contém qualquer um dos:
'http'
'https'
serviceUrl URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres. corda

Restrições:
Comprimento máximo =
sourceApiId Identificador de API da API de origem. corda
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
subscriptionRequired Especifica se uma assinatura de API ou produto é necessária para acessar a API. Bool
tipo Tipo de API. 'http'
'soap'
valor Valor de conteúdo ao importar uma API. corda
wsdlSelector Critérios para limitar a importação de WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Nome Descrição Valor
wsdlEndpointName Nome do ponto de extremidade(porta) a ser importado do WSDL corda
wsdlServiceName Nome do serviço a ser importado do WSDL corda

ApiVersionSetContractDetails

Nome Descrição Valor
descrição Descrição do Conjunto de Versões da API. corda
id Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões. corda
nome O nome de exibição do conjunto de versões da API. corda
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como header. corda
versioningScheme Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP. 'Cabeçalho'
'Consulta'
'Segment'
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. corda

AuthenticationSettingsContract

Nome Descrição Valor
oAuth2 Configurações de Autenticação OAuth2 OAuth2AuthenticationSettingsContract
openid Configurações de autenticação do OpenID Connect OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
Propriedades Criação de propriedades de atualização da entidade de API. ApiCreateOrUpdatePropertiesOrApiContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

Nome Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
âmbito escopo de operações. corda

OpenIdAuthenticationSettingsContract

Nome Descrição Valor
bearerTokenSendingMethods Como enviar token para o servidor. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationHeader'
'consulta'
openidProviderId Identificador do servidor de autorização OAuth. corda

SubscriptionKeyParameterNamesContract

Nome Descrição Valor
cabeçalho Nome do cabeçalho da chave de assinatura. corda
consulta Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. corda

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

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

  • 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/apis, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2019-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valores de propriedade

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome Descrição Valor
apiRevision Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
apiRevisionDescription Descrição da Revisão de API. corda

Restrições:
Comprimento máximo =
apiType Tipo de API a ser criada.
* http cria uma API SOAP para REST
* soap cria uma API de passagem SOAP.		 'http'
'soap'
apiVersion Indica o identificador de versão da API se a API for versão corda

Restrições:
Comprimento máximo =
apiVersionDescription Descrição da Versão da API. corda

Restrições:
Comprimento máximo =
apiVersionSet Detalhes do conjunto de versão ApiVersionSetContractDetails
apiVersionSetId Um identificador de recurso para o ApiVersionSet relacionado. corda
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
descrição Descrição da API. Pode incluir marcas de formatação HTML. corda
displayName Nome da API. Deve ter de 1 a 300 caracteres. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
formato Formato do conteúdo no qual a API está sendo importada. 'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent Indica se a revisão da API é a revisão de API atual. Bool
caminho URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. corda

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 que contém qualquer um dos:
'http'
'https'
serviceUrl URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres. corda

Restrições:
Comprimento máximo =
sourceApiId Identificador de API da API de origem. corda
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
subscriptionRequired Especifica se uma assinatura de API ou produto é necessária para acessar a API. Bool
tipo Tipo de API. 'http'
'soap'
valor Valor de conteúdo ao importar uma API. corda
wsdlSelector Critérios para limitar a importação de WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Nome Descrição Valor
wsdlEndpointName Nome do ponto de extremidade(porta) a ser importado do WSDL corda
wsdlServiceName Nome do serviço a ser importado do WSDL corda

ApiVersionSetContractDetails

Nome Descrição Valor
descrição Descrição do Conjunto de Versões da API. corda
id Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões. corda
nome O nome de exibição do conjunto de versões da API. corda
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como header. corda
versioningScheme Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP. 'Cabeçalho'
'Consulta'
'Segment'
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. corda

AuthenticationSettingsContract

Nome Descrição Valor
oAuth2 Configurações de Autenticação OAuth2 OAuth2AuthenticationSettingsContract
openid Configurações de autenticação do OpenID Connect OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
Propriedades Criação de propriedades de atualização da entidade de API. ApiCreateOrUpdatePropertiesOrApiContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis@2019-01-01"

OAuth2AuthenticationSettingsContract

Nome Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
âmbito escopo de operações. corda

OpenIdAuthenticationSettingsContract

Nome Descrição Valor
bearerTokenSendingMethods Como enviar token para o servidor. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationHeader'
'consulta'
openidProviderId Identificador do servidor de autorização OAuth. corda

SubscriptionKeyParameterNamesContract

Nome Descrição Valor
cabeçalho Nome do cabeçalho da chave de assinatura. corda
consulta Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. corda