Microsoft.Web/customApis

Definição de recurso do Bicep

O tipo de recurso customApis pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo 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.Web/customApis, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiDefinitions: {
      modifiedSwaggerUrl: 'string'
      originalSwaggerUrl: 'string'
    }
    apiType: 'string'
    backendService: {
      serviceUrl: 'string'
    }
    brandColor: 'string'
    capabilities: [
      'string'
    ]
    connectionParameters: {
      {customized property}: {
        oAuthSettings: {
          clientId: 'string'
          clientSecret: 'string'
          customParameters: {
            {customized property}: {
              options: any(Azure.Bicep.Types.Concrete.AnyType)
              uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
              value: 'string'
            }
          }
          identityProvider: 'string'
          properties: any(Azure.Bicep.Types.Concrete.AnyType)
          redirectUrl: 'string'
          scopes: [
            'string'
          ]
        }
        type: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any(Azure.Bicep.Types.Concrete.AnyType)
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

ApiOAuthSettings

Nome	Descrição	Valor
clientId	ID do cliente do provedor de recursos	corda
clientSecret	Segredo do cliente necessário para OAuth	corda
customParameters	A chave de parâmetros OAuth é o nome do parâmetro	ApiOAuthSettingsCustomParameters
identityProvider	Provedor de identidade	corda
Propriedades	Ler somente as propriedades dessa configuração de oauth.	qualquer
redirectUrl	URL	corda
Escopos	Escopos do OAuth	string[]

ApiOAuthSettingsCustomParameters

Nome	Descrição	Valor

ApiOAuthSettingsParameter

Nome	Descrição	Valor
Opções	Opções disponíveis para este parâmetro	qualquer
uiDefinition	Definições de interface do usuário por cultura como chamador podem especificar a cultura	qualquer
valor	Valor da configuração	corda

ApiResourceBackendService

Nome	Descrição	Valor
serviceUrl	A URL do serviço	corda

ApiResourceDefinitions

Nome	Descrição	Valor
modifiedSwaggerUrl	A URL de swagger modificada	corda
originalSwaggerUrl	A URL de swagger original	corda

ConnectionParameter

Nome	Descrição	Valor
oAuthSettings	Configurações do OAuth para o provedor de conexão	ApiOAuthSettings
tipo	Tipo do parâmetro	'array' 'bool' 'conexão' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

Nome	Descrição	Valor
apiDefinitions	Definições de API	ApiResourceDefinitions
apiType	O tipo de API	'NotSpecified' 'Rest' 'Soap'
backendService	O serviço de back-end da API	ApiResourceBackendService
brandColor	Cor da marca	corda
Capacidades	Os recursos de API personalizados	string[]
connectionParameters	Parâmetros de conexão	CustomApiPropertiesDefinitionConnectionParameters
descrição	A descrição da API personalizada	corda
displayName	O nome de exibição	corda
iconUri	O URI do ícone	corda
runtimeUrls	Runtime URLs	string[]
Swagger	A representação JSON do swagger	qualquer
wsdlDefinition	A definição do WSDL	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nome	Descrição	Valor

Nome	Descrição	Valor
etag	ETag de recurso	corda
localização	Local do recurso	corda
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades da API personalizada	CustomApiPropertiesDefinition
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

TagsDictionary

Nome	Descrição	Valor

WsdlDefinition

Nome	Descrição	Valor
conteúdo	O conteúdo do WSDL	corda
importMethod	O método de importação do WSDL	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
serviço	O serviço com nomes de nome e ponto de extremidade	WsdlService
url	A URL do WSDL	corda

WsdlService

Nome	Descrição	Valor
endpointQualifiedNames	Lista dos nomes qualificados dos pontos de extremidade	string[]
qualifiedName	O nome qualificado do serviço	cadeia de caracteres (obrigatório)

Definição de recurso de modelo do ARM