Microsoft.Web customApis

Artículo
10/26/2024

más reciente
2016-06-01

Definición de recursos de Bicep

El tipo de recurso customApis se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Web/customApis, agregue lo siguiente a la plantilla de Bicep.

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 propiedad

ApiOAuthSettings

Nombre	Descripción	Valor
clientId	Identificador de cliente del proveedor de recursos	cuerda
clientSecret	Secreto de cliente necesario para OAuth	cuerda
customParameters	La clave de parámetros de OAuth es el nombre del parámetro	ApiOAuthSettingsCustomParameters
identityProvider	Proveedor de identidades	cuerda
Propiedades	Solo lectura de las propiedades de esta configuración de oauth.	cualquier
redirectUrl	URL	cuerda
Ámbitos	Ámbitos de OAuth	string[]

ApiOAuthSettingsCustomParameters

Nombre	Descripción	Valor

ApiOAuthSettingsParameter

Nombre	Descripción	Valor
Opciones	Opciones disponibles para este parámetro	cualquier
uiDefinition	Definiciones de interfaz de usuario por referencia cultural, ya que el autor de la llamada puede especificar la referencia cultural	cualquier
valor	Valor de la configuración	cuerda

ApiResourceBackendService

Nombre	Descripción	Valor
serviceUrl	Dirección URL del servicio	cuerda

ApiResourceDefinitions

Nombre	Descripción	Valor
modifiedSwaggerUrl	Dirección URL de Swagger modificada	cuerda
originalSwaggerUrl	Dirección URL original de Swagger	cuerda

ConnectionParameter

Nombre	Descripción	Valor
oAuthSettings	Configuración de OAuth para el proveedor de conexiones	apiOAuthSettings
tipo	Tipo del parámetro	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' "securestring" 'string'

CustomApiPropertiesDefinition

Nombre	Descripción	Valor
apiDefinitions	Definiciones de API	ApiResourceDefinitions
apiType	El tipo de API	'NotSpecified' 'Rest' 'Soap'
backendService	El servicio back-end de API	ApiResourceBackendService
brandColor	Color de marca	cuerda
Capacidades	Funcionalidades de API personalizadas	string[]
connectionParameters	Parámetros de conexión	CustomApiPropertiesDefinitionConnectionParameters
descripción	Descripción de la API personalizada	cuerda
displayName	Nombre para mostrar	cuerda
iconUri	El URI del icono	cuerda
runtimeUrls	Direcciones URL en tiempo de ejecución	string[]
contonearse	Representación JSON de swagger	cualquier
wsdlDefinition	Definición de WSDL	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nombre	Descripción	Valor

Microsoft.Web/customApis

Nombre	Descripción	Valor
etag	ETag de recursos	cuerda
ubicación	Ubicación del recurso	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades de API personalizadas	CustomApiPropertiesDefinition
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

TagsDictionary

Nombre	Descripción	Valor

WsdlDefinition

Nombre	Descripción	Valor
contenido	Contenido de WSDL	cuerda
importMethod	El método de importación de WSDL	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
servicio	El servicio con nombres y nombres de punto de conexión	WsdlService
URL	Dirección URL de WSDL	cuerda

WsdlService

Nombre	Descripción	Valor
endpointQualifiedNames	Lista de los nombres calificados de los puntos de conexión	string[]
qualifiedName	Nombre completo del servicio	string (obligatorio)

Definición de recursos de plantilla de ARM

El tipo de recurso customApis se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Web/customApis, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Web/customApis",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "location": "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": {},
              "uiDefinition": {},
              "value": "string"
            }
          },
          "identityProvider": "string",
          "properties": {},
          "redirectUrl": "string",
          "scopes": [ "string" ]
        },
        "type": "string"
      }
    },
    "description": "string",
    "displayName": "string",
    "iconUri": "string",
    "runtimeUrls": [ "string" ],
    "swagger": {},
    "wsdlDefinition": {
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

ApiOAuthSettings

Nombre	Descripción	Valor
clientId	Identificador de cliente del proveedor de recursos	cuerda
clientSecret	Secreto de cliente necesario para OAuth	cuerda
customParameters	La clave de parámetros de OAuth es el nombre del parámetro	ApiOAuthSettingsCustomParameters
identityProvider	Proveedor de identidades	cuerda
Propiedades	Solo lectura de las propiedades de esta configuración de oauth.	cualquier
redirectUrl	URL	cuerda
Ámbitos	Ámbitos de OAuth	string[]

ApiOAuthSettingsCustomParameters

Nombre	Descripción	Valor

ApiOAuthSettingsParameter

Nombre	Descripción	Valor
Opciones	Opciones disponibles para este parámetro	cualquier
uiDefinition	Definiciones de interfaz de usuario por referencia cultural, ya que el autor de la llamada puede especificar la referencia cultural	cualquier
valor	Valor de la configuración	cuerda

ApiResourceBackendService

Nombre	Descripción	Valor
serviceUrl	Dirección URL del servicio	cuerda

ApiResourceDefinitions

Nombre	Descripción	Valor
modifiedSwaggerUrl	Dirección URL de Swagger modificada	cuerda
originalSwaggerUrl	Dirección URL original de Swagger	cuerda

ConnectionParameter

Nombre	Descripción	Valor
oAuthSettings	Configuración de OAuth para el proveedor de conexiones	apiOAuthSettings
tipo	Tipo del parámetro	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' "securestring" 'string'

CustomApiPropertiesDefinition

Nombre	Descripción	Valor
apiDefinitions	Definiciones de API	ApiResourceDefinitions
apiType	El tipo de API	'NotSpecified' 'Rest' 'Soap'
backendService	El servicio back-end de API	ApiResourceBackendService
brandColor	Color de marca	cuerda
Capacidades	Funcionalidades de API personalizadas	string[]
connectionParameters	Parámetros de conexión	CustomApiPropertiesDefinitionConnectionParameters
descripción	Descripción de la API personalizada	cuerda
displayName	Nombre para mostrar	cuerda
iconUri	El URI del icono	cuerda
runtimeUrls	Direcciones URL en tiempo de ejecución	string[]
contonearse	Representación JSON de swagger	cualquier
wsdlDefinition	Definición de WSDL	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nombre	Descripción	Valor

Microsoft.Web/customApis

Nombre	Descripción	Valor
apiVersion	La versión de api	'2016-06-01'
etag	ETag de recursos	cuerda
ubicación	Ubicación del recurso	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades de API personalizadas	CustomApiPropertiesDefinition
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.Web/customApis"

TagsDictionary

Nombre	Descripción	Valor

WsdlDefinition

Nombre	Descripción	Valor
contenido	Contenido de WSDL	cuerda
importMethod	El método de importación de WSDL	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
servicio	El servicio con nombres y nombres de punto de conexión	WsdlService
URL	Dirección URL de WSDL	cuerda

WsdlService

Nombre	Descripción	Valor
endpointQualifiedNames	Lista de los nombres calificados de los puntos de conexión	string[]
qualifiedName	Nombre completo del servicio	string (obligatorio)

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso customApis se puede implementar con operaciones destinadas a:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Web/customApis, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/customApis@2016-06-01"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    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 = ?
                uiDefinition = ?
                value = "string"
              }
            }
            identityProvider = "string"
            properties = ?
            redirectUrl = "string"
            scopes = [
              "string"
            ]
          }
          type = "string"
        }
      }
      description = "string"
      displayName = "string"
      iconUri = "string"
      runtimeUrls = [
        "string"
      ]
      swagger = ?
      wsdlDefinition = {
        content = "string"
        importMethod = "string"
        service = {
          endpointQualifiedNames = [
            "string"
          ]
          qualifiedName = "string"
        }
        url = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Valores de propiedad

ApiOAuthSettings

Nombre	Descripción	Valor
clientId	Identificador de cliente del proveedor de recursos	cuerda
clientSecret	Secreto de cliente necesario para OAuth	cuerda
customParameters	La clave de parámetros de OAuth es el nombre del parámetro	ApiOAuthSettingsCustomParameters
identityProvider	Proveedor de identidades	cuerda
Propiedades	Solo lectura de las propiedades de esta configuración de oauth.	cualquier
redirectUrl	URL	cuerda
Ámbitos	Ámbitos de OAuth	string[]

ApiOAuthSettingsCustomParameters

Nombre	Descripción	Valor

ApiOAuthSettingsParameter

Nombre	Descripción	Valor
Opciones	Opciones disponibles para este parámetro	cualquier
uiDefinition	Definiciones de interfaz de usuario por referencia cultural, ya que el autor de la llamada puede especificar la referencia cultural	cualquier
valor	Valor de la configuración	cuerda

ApiResourceBackendService

Nombre	Descripción	Valor
serviceUrl	Dirección URL del servicio	cuerda

ApiResourceDefinitions

Nombre	Descripción	Valor
modifiedSwaggerUrl	Dirección URL de Swagger modificada	cuerda
originalSwaggerUrl	Dirección URL original de Swagger	cuerda

ConnectionParameter

Nombre	Descripción	Valor
oAuthSettings	Configuración de OAuth para el proveedor de conexiones	apiOAuthSettings
tipo	Tipo del parámetro	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' "securestring" 'string'

CustomApiPropertiesDefinition

Nombre	Descripción	Valor
apiDefinitions	Definiciones de API	ApiResourceDefinitions
apiType	El tipo de API	'NotSpecified' 'Rest' 'Soap'
backendService	El servicio back-end de API	ApiResourceBackendService
brandColor	Color de marca	cuerda
Capacidades	Funcionalidades de API personalizadas	string[]
connectionParameters	Parámetros de conexión	CustomApiPropertiesDefinitionConnectionParameters
descripción	Descripción de la API personalizada	cuerda
displayName	Nombre para mostrar	cuerda
iconUri	El URI del icono	cuerda
runtimeUrls	Direcciones URL en tiempo de ejecución	string[]
contonearse	Representación JSON de swagger	cualquier
wsdlDefinition	Definición de WSDL	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nombre	Descripción	Valor

Microsoft.Web/customApis

Nombre	Descripción	Valor
etag	ETag de recursos	cuerda
ubicación	Ubicación del recurso	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades de API personalizadas	CustomApiPropertiesDefinition
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.Web/customApis@2016-06-01"

TagsDictionary

Nombre	Descripción	Valor

WsdlDefinition

Nombre	Descripción	Valor
contenido	Contenido de WSDL	cuerda
importMethod	El método de importación de WSDL	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
servicio	El servicio con nombres y nombres de punto de conexión	WsdlService
URL	Dirección URL de WSDL	cuerda

WsdlService

Nombre	Descripción	Valor
endpointQualifiedNames	Lista de los nombres calificados de los puntos de conexión	string[]
qualifiedName	Nombre completo del servicio	string (obligatorio)

Compartir a través de

Microsoft.Web customApis

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

Comentarios

Recursos adicionales