Partilhar via

Serviço/apis Microsoft.ApiManagement 2018-06-01-preview

  • 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@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      subscriptionKeyRequired: bool
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valores de propriedade

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 para criar.
* http cria uma API SOAP para REST
* soap cria uma API de passagem SOAP.		 «http»
'Sabonete'
apiVersion Indica o identificador de versão da API se a API tiver versão string

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

Restrições:
Comprimento máximo =
apiVersionSet Um conjunto de versões de API contém a configuração comum para um conjunto de versões de API relacionadas 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
contentFormat Formato do conteúdo no qual a API está sendo importada. 'OpenAPI'
'OpenAPI+JSON'
'openapi-link'
'Swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'WSDL'
'WSDL-link'
contentValue Valor de conteúdo ao importar uma API. string
Descrição Descrição da API. Pode incluir tags de formatação HTML. string
displayName Nome da API. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
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»
serviceUrl URL absoluta do serviço de back-end que implementa esta API. string

Restrições:
Comprimento máximo =
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
tipo Tipo de API. «http»
'Sabonete'
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

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
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
subscriptionKeyRequired Especifica se a chave de assinatura é necessária durante a chamada para esta API, true - a API está incluída apenas em produtos fechados, false - a API está incluída apenas em produtos abertos, null - há uma combinação de produtos. Bool

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": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "subscriptionKeyRequired": "bool"
    },
    "contentFormat": "string",
    "contentValue": "string",
    "description": "string",
    "displayName": "string",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "type": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valores de propriedade

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 para criar.
* http cria uma API SOAP para REST
* soap cria uma API de passagem SOAP.		 «http»
'Sabonete'
apiVersion Indica o identificador de versão da API se a API tiver versão string

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

Restrições:
Comprimento máximo =
apiVersionSet Um conjunto de versões de API contém a configuração comum para um conjunto de versões de API relacionadas 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
contentFormat Formato do conteúdo no qual a API está sendo importada. 'OpenAPI'
'OpenAPI+JSON'
'openapi-link'
'Swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'WSDL'
'WSDL-link'
contentValue Valor de conteúdo ao importar uma API. string
Descrição Descrição da API. Pode incluir tags de formatação HTML. string
displayName Nome da API. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
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»
serviceUrl URL absoluta do serviço de back-end que implementa esta API. string

Restrições:
Comprimento máximo =
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
tipo Tipo de API. «http»
'Sabonete'
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

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
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
subscriptionKeyRequired Especifica se a chave de assinatura é necessária durante a chamada para esta API, true - a API está incluída apenas em produtos fechados, false - a API está incluída apenas em produtos abertos, null - há uma combinação de produtos. Bool

Microsoft.ApiManagement/service/apis

Designação Descrição Valor
apiVersion A versão api '2018-06-01-pré-visualização'
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@2018-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        subscriptionKeyRequired = bool
      }
      contentFormat = "string"
      contentValue = "string"
      description = "string"
      displayName = "string"
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      type = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valores de propriedade

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 para criar.
* http cria uma API SOAP para REST
* soap cria uma API de passagem SOAP.		 «http»
'Sabonete'
apiVersion Indica o identificador de versão da API se a API tiver versão string

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

Restrições:
Comprimento máximo =
apiVersionSet Um conjunto de versões de API contém a configuração comum para um conjunto de versões de API relacionadas 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
contentFormat Formato do conteúdo no qual a API está sendo importada. 'OpenAPI'
'OpenAPI+JSON'
'openapi-link'
'Swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'WSDL'
'WSDL-link'
contentValue Valor de conteúdo ao importar uma API. string
Descrição Descrição da API. Pode incluir tags de formatação HTML. string
displayName Nome da API. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
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»
serviceUrl URL absoluta do serviço de back-end que implementa esta API. string

Restrições:
Comprimento máximo =
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
tipo Tipo de API. «http»
'Sabonete'
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

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
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
subscriptionKeyRequired Especifica se a chave de assinatura é necessária durante a chamada para esta API, true - a API está incluída apenas em produtos fechados, false - a API está incluída apenas em produtos abertos, null - há uma combinação de produtos. Bool

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@2018-06-01-preview"

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