Microsoft.Web/customApis

Definição de recursos do bíceps

O tipo de recurso customApis 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.Web/customApis, adicione o seguinte Bicep ao seu 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

Designação	Descrição	Valor
ID do cliente	ID do cliente do provedor de recursos	string
clientSecret	Segredo do cliente necessário para OAuth	string
customParameters	A chave de parâmetros OAuth é o nome do parâmetro	ApiOAuthSettingsCustomParameters
identityProvider	Provedor de identidade	string
propriedades	Propriedades somente leitura para esta configuração oauth.	qualquer
redirectUrl	Url	string
Âmbitos de aplicação	Escopos OAuth	string[]

ApiOAuthSettingsCustomParameters

Designação	Descrição	Valor

ApiOAuthSettingsParameter

Designação	Descrição	Valor
Opções	Opções disponíveis para este parâmetro	qualquer
uiDefinition	Definições de interface do usuário por cultura, pois o chamador pode especificar a cultura	qualquer
valor	Valor da configuração	string

ApiResourceBackendService

Designação	Descrição	Valor
serviceUrl	O URL do serviço	string

ApiResourceDefinitions

Designação	Descrição	Valor
modificadoSwaggerUrl	O URL do swagger modificado	string
originalSwaggerUrl	O URL original do swagger	string

ConnectionParameter

Designação	Descrição	Valor
oAuthSettings	Configurações OAuth para o provedor de conexão	ApiOAuthSettings
tipo	Tipo do parâmetro	'matriz' 'Bool' 'conexão' «int» 'oauthSetting' 'objeto' 'SecureObject' 'SecureString' 'String'

CustomApiPropertiesDefinition

Designação	Descrição	Valor
apiDefinitions	Definições de API	ApiResourceDefinitions
apiType	O tipo de API	'Não especificado' 'Descanso' 'Sabonete'
backendService	O serviço de back-end da API	ApiResourceBackendService
marcaCor	Cor da marca	string
Capacidades	Os recursos personalizados da API	string[]
connectionParameters	Parâmetros de conexão	CustomApiPropertiesDefinitionConnectionParameters
Descrição	A descrição personalizada da API	string
displayName	O nome para exibição	string
iconUri	O ícone URI	string
runtimeUrls	URLs de tempo de execução	string[]
Gingado	A representação JSON do swagger	qualquer
wsdlDefinição	A definição de WSDL	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Designação	Descrição	Valor

Designação	Descrição	Valor
etag	Recurso ETag	string
Localização	Localização do recurso	string
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades personalizadas da API	CustomApiPropertiesDefinition
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

TagsDicionário:

Designação	Descrição	Valor

WsdlDefinição

Designação	Descrição	Valor
Conteúdo	O conteúdo WSDL	string
importMethod	O método de importação WSDL	'Não especificado' 'SoapPassThrough' 'SoapToRest'
serviço	O serviço com nomes e nomes de ponto de extremidade	WsdlService
URL	O URL WSDL	string

WsdlService

Designação	Descrição	Valor
endpointQualifiedNames	Lista dos nomes qualificados dos pontos finais	string[]
qualifiedName	O nome qualificado do serviço	string (obrigatório)

Definição de recurso de modelo ARM