Partilhar via

Serviço/apis Microsoft.ApiManagement 2021-08-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/apis pode ser implantado com operações que visam:

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@2021-08-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'
      }
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valores de propriedade

ApiContactInformation

Designação Descrição Valor
Email O endereço de e-mail da pessoa/organização de contato. DEVE estar no formato de um endereço de e-mail string
Designação O nome de identificação da pessoa/organização de contacto string
URL O URL apontando para as informações de contato. DEVE estar no formato de um URL string

ApiCreateOrUpdatePropertiesOrApiContractProperties

Designação Descrição Valor
apiRevisão Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada string

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

Restrições:
Comprimento máximo =
apiType Tipo de API a ser criada.
* http cria uma API REST
* soap cria uma API de passagem SOAP
* websocket cria a API websocket
* graphql cria a API do GraphQL.		 'GraphQL'
«http»
'Sabonete'
'Websocket'
apiVersion Indica o identificador de versão da API se a API estiver versionada string

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

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Formato Formato do conteúdo no qual a API está sendo importada. 'graphql-link'
'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 atual da api. Bool
licença Informações de licença para a API. ApiLicenseInformation
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»
'WS'
'WSS'
serviceUrl URL absoluta do serviço de back-end que implementa esta API. Não pode ter mais de 2000 caracteres. string

Restrições:
Comprimento máximo =
fonteApiId Identificador de API da API de origem. string
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
assinaturaObrigatório Especifica se uma API ou assinatura de Produto é necessária para acessar a API. Bool
termosOfServiceUrl Um URL para os Termos de Serviço da API. DEVE estar no formato de um URL. string
tipo Tipo de API. 'GraphQL'
«http»
'Sabonete'
'Websocket'
valor Valor de conteúdo ao importar uma API. string
wsdlSelector Critérios para limitar a importação de WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

Designação Descrição Valor
Designação O nome da licença usado para a API string
URL Um URL para a licença usada para a API. DEVE estar no formato de um URL string

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

Designação 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

Designação Descrição Valor
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
propriedades Criação de entidade de API de propriedades de atualização. ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

Designação Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. string
Âmbito de aplicação âmbito das operações. string

OpenIdAuthenticationSettingsContract

Designação Descrição Valor
bearerTokenSendingMethods Como enviar token para o servidor. Matriz de cadeia de caracteres contendo qualquer uma das:
'authorizationHeader'
'consulta'
openidProviderId Identificador do servidor de autorização OAuth. 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:

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": "2021-08-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"
      }
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valores de propriedade

ApiContactInformation

Designação Descrição Valor
Email O endereço de e-mail da pessoa/organização de contato. DEVE estar no formato de um endereço de e-mail string
Designação O nome de identificação da pessoa/organização de contacto string
URL O URL apontando para as informações de contato. DEVE estar no formato de um URL string

ApiCreateOrUpdatePropertiesOrApiContractProperties

Designação Descrição Valor
apiRevisão Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada string

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

Restrições:
Comprimento máximo =
apiType Tipo de API a ser criada.
* http cria uma API REST
* soap cria uma API de passagem SOAP
* websocket cria a API websocket
* graphql cria a API do GraphQL.		 'GraphQL'
«http»
'Sabonete'
'Websocket'
apiVersion Indica o identificador de versão da API se a API estiver versionada string

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

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Formato Formato do conteúdo no qual a API está sendo importada. 'graphql-link'
'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 atual da api. Bool
licença Informações de licença para a API. ApiLicenseInformation
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»
'WS'
'WSS'
serviceUrl URL absoluta do serviço de back-end que implementa esta API. Não pode ter mais de 2000 caracteres. string

Restrições:
Comprimento máximo =
fonteApiId Identificador de API da API de origem. string
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
assinaturaObrigatório Especifica se uma API ou assinatura de Produto é necessária para acessar a API. Bool
termosOfServiceUrl Um URL para os Termos de Serviço da API. DEVE estar no formato de um URL. string
tipo Tipo de API. 'GraphQL'
«http»
'Sabonete'
'Websocket'
valor Valor de conteúdo ao importar uma API. string
wsdlSelector Critérios para limitar a importação de WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

Designação Descrição Valor
Designação O nome da licença usado para a API string
URL Um URL para a licença usada para a API. DEVE estar no formato de um URL string

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

Designação 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

Designação Descrição Valor
apiVersion A versão api '2021-08-01'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Criação de entidade de API de propriedades de atualização. ApiCreateOrUpdatePropertiesOrApiContractProperties
tipo O tipo de recurso '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

OpenIdAuthenticationSettingsContract

Designação Descrição Valor
bearerTokenSendingMethods Como enviar token para o servidor. Matriz de cadeia de caracteres contendo qualquer uma das:
'authorizationHeader'
'consulta'
openidProviderId Identificador do servidor de autorização OAuth. 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@2021-08-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"
        }
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valores de propriedade

ApiContactInformation

Designação Descrição Valor
Email O endereço de e-mail da pessoa/organização de contato. DEVE estar no formato de um endereço de e-mail string
Designação O nome de identificação da pessoa/organização de contacto string
URL O URL apontando para as informações de contato. DEVE estar no formato de um URL string

ApiCreateOrUpdatePropertiesOrApiContractProperties

Designação Descrição Valor
apiRevisão Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada string

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

Restrições:
Comprimento máximo =
apiType Tipo de API a ser criada.
* http cria uma API REST
* soap cria uma API de passagem SOAP
* websocket cria a API websocket
* graphql cria a API do GraphQL.		 'GraphQL'
«http»
'Sabonete'
'Websocket'
apiVersion Indica o identificador de versão da API se a API estiver versionada string

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

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Formato Formato do conteúdo no qual a API está sendo importada. 'graphql-link'
'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 atual da api. Bool
licença Informações de licença para a API. ApiLicenseInformation
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»
'WS'
'WSS'
serviceUrl URL absoluta do serviço de back-end que implementa esta API. Não pode ter mais de 2000 caracteres. string

Restrições:
Comprimento máximo =
fonteApiId Identificador de API da API de origem. string
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
assinaturaObrigatório Especifica se uma API ou assinatura de Produto é necessária para acessar a API. Bool
termosOfServiceUrl Um URL para os Termos de Serviço da API. DEVE estar no formato de um URL. string
tipo Tipo de API. 'GraphQL'
«http»
'Sabonete'
'Websocket'
valor Valor de conteúdo ao importar uma API. string
wsdlSelector Critérios para limitar a importação de WSDL a um subconjunto do documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

Designação Descrição Valor
Designação O nome da licença usado para a API string
URL Um URL para a licença usada para a API. DEVE estar no formato de um URL string

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

Designação 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

Designação Descrição Valor
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
propriedades Criação de entidade de API de propriedades de atualização. ApiCreateOrUpdatePropertiesOrApiContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis@2021-08-01"

OAuth2AuthenticationSettingsContract

Designação Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. string
Âmbito de aplicação âmbito das operações. string

OpenIdAuthenticationSettingsContract

Designação Descrição Valor
bearerTokenSendingMethods Como enviar token para o servidor. Matriz de cadeia de caracteres contendo qualquer uma das:
'authorizationHeader'
'consulta'
openidProviderId Identificador do servidor de autorização OAuth. 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