Custom Apis - Create Or Update

Servicio:

App Service

Versión de la API:

2016-06-01

Reemplaza una API personalizada existente.
Crea o actualiza una API personalizada existente

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}?api-version=2016-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiName	path	True	string	Nombre de LA API
resourceGroupName	path	True	string	El grupo de recursos
subscriptionId	path	True	string	Identificador de suscripción
api-version	query	True	string	Versión de API

Cuerpo de la solicitud

Nombre	Tipo	Description
etag	string	ETag de recursos
location	string	Ubicación del recurso
properties	CustomApiPropertiesDefinition	Propiedades de API personalizadas
tags	object	Etiquetas de recursos

Respuestas

Nombre	Tipo	Description
200 OK	CustomApiDefinition	La API personalizada de reemplazo

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar una cuenta de usuario

Ejemplos

Replace a custom API

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/customApis/testCustomApi?api-version=2016-06-01

{
  "properties": {
    "capabilities": [],
    "description": "",
    "displayName": "testCustomApi",
    "iconUri": "/testIcon.svg",
    "apiDefinitions": {
      "originalSwaggerUrl": "https://tempuri.org/swagger.json",
      "swagger": {}
    },
    "apiType": "Rest"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/customApis/testCustomApi"
}

Respuesta de muestra

status code:

200

{
  "properties": {
    "runtimeUrls": [
      "https://tempuri.org",
      "http://tempuri.org"
    ],
    "capabilities": [],
    "description": "",
    "displayName": "testCustomApi",
    "iconUri": "/testIcon.svg",
    "apiDefinitions": {
      "originalSwaggerUrl": "https://tempuri.org/swagger.json",
      "modifiedSwaggerUrl": "https://tempuri.org/modified.json"
    },
    "apiType": "Rest",
    "wsdlDefinition": {}
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/customApis/testCustomApi",
  "name": "testCustomApi",
  "type": "Microsoft.Web/customApis",
  "location": "northcentralus"
}

Definiciones

Nombre	Description
ApiOAuthSettings	Configuración de OAuth para el proveedor de conexiones
ApiOAuthSettingsParameter	Configuración de OAuth para la API
ApiResourceBackendService	El servicio back-end de API
ApiResourceDefinitions	Definiciones de API
ApiType	El tipo de API
ConnectionParameter	Parámetros del proveedor de conexión
ConnectionParameterType	Tipo del parámetro
CustomApiDefinition	Una API personalizada
CustomApiPropertiesDefinition	Propiedades de API personalizadas
WsdlDefinition	Definición de WSDL
WsdlImportMethod	El método de importación de WSDL
WsdlService	El servicio con nombres y nombres de punto de conexión

ApiOAuthSettings

Object

Configuración de OAuth para el proveedor de conexiones

Nombre	Tipo	Description
clientId	string	Identificador de cliente del proveedor de recursos
clientSecret	string	Secreto de cliente necesario para OAuth
customParameters	<string,  ApiOAuthSettingsParameter>	La clave de parámetros de OAuth es el nombre del parámetro
identityProvider	string	Proveedor de identidades
properties	object	Solo lectura de las propiedades de esta configuración de oauth.
redirectUrl	string	Dirección URL
scopes	string[]	Ámbitos de OAuth

ApiOAuthSettingsParameter

Object

Configuración de OAuth para la API

Nombre	Tipo	Description
options	object	Opciones disponibles para este parámetro
uiDefinition	object	Definiciones de interfaz de usuario por referencia cultural, ya que el autor de la llamada puede especificar la referencia cultural
value	string	Valor de la configuración

ApiResourceBackendService

Object

El servicio back-end de API

Nombre	Tipo	Description
serviceUrl	string	Dirección URL del servicio

ApiResourceDefinitions

Object

Definiciones de API

Nombre	Tipo	Description
modifiedSwaggerUrl	string	Dirección URL de Swagger modificada
originalSwaggerUrl	string	Dirección URL original de Swagger

ApiType

Enumeración

El tipo de API

Valor	Description
NotSpecified
Rest
Soap

ConnectionParameter

Object

Parámetros del proveedor de conexión

Nombre	Tipo	Description
oAuthSettings	ApiOAuthSettings	Configuración de OAuth para el proveedor de conexiones
type	ConnectionParameterType	Tipo del parámetro

ConnectionParameterType

Enumeración

Tipo del parámetro

Valor	Description
array
bool
connection
int
oauthSetting
object
secureobject
securestring
string

CustomApiDefinition

Object

Una API personalizada

Nombre	Tipo	Description
etag	string	ETag de recursos
id	string	Identificador de recurso
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties	CustomApiPropertiesDefinition	Propiedades de API personalizadas
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

CustomApiPropertiesDefinition

Object

Propiedades de API personalizadas

Nombre	Tipo	Description
apiDefinitions	ApiResourceDefinitions	Definiciones de API
apiType	ApiType	El tipo de API
backendService	ApiResourceBackendService	El servicio back-end de API
brandColor	string	Color de marca
capabilities	string[]	Funcionalidades de API personalizadas
connectionParameters	<string,  ConnectionParameter>	Parámetros de conexión
description	string	Descripción de la API personalizada
displayName	string	Nombre para mostrar
iconUri	string	El URI del icono
runtimeUrls	string[]	Direcciones URL en tiempo de ejecución
swagger	object	Representación JSON de swagger
wsdlDefinition	WsdlDefinition	Definición de WSDL

WsdlDefinition

Object

Definición de WSDL

Nombre	Tipo	Description
content	string	Contenido de WSDL
importMethod	WsdlImportMethod	El método de importación de WSDL
service	WsdlService	El servicio con nombres y nombres de punto de conexión
url	string	Dirección URL de WSDL

WsdlImportMethod

Enumeración

El método de importación de WSDL

Valor	Description
NotSpecified
SoapPassThrough
SoapToRest

WsdlService

Object

El servicio con nombres y nombres de punto de conexión

Nombre	Tipo	Description
endpointQualifiedNames	string[]	Lista de los nombres calificados de los puntos de conexión
qualifiedName	string	Nombre completo del servicio