Api Gateway - Create Or Update

Servicio:: API Management

Versión de la API:: 2024-05-01

Crea o actualiza una puerta de enlace de API Management. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre de la puerta de enlace de API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación del recurso.
sku	True	ApiManagementGatewaySkuProperties	Propiedades de SKU de la puerta de enlace de API Management.
properties.backend		BackendConfiguration	Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end.
properties.configurationApi		GatewayConfigurationApi	Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar.
properties.frontend		FrontendConfiguration	Información sobre cómo se debe exponer la puerta de enlace.
properties.virtualNetworkType		VirtualNetworkType	Tipo de VPN en el que se debe configurar API Management Gateway.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	ApiManagementGatewayResource	La puerta de enlace se configuró correctamente.
201 Created	ApiManagementGatewayResource	Creado
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

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 la cuenta de usuario

Ejemplos

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1?api-version=2024-05-01

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Respuesta de muestra

status code:: 201

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "frontend": {
      "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net"
    },
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "configurationApi": {
      "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net"
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

ApiManagementCreateWorkspacePremiumGateway

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1?api-version=2024-05-01

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Respuesta de muestra

status code:: 201

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Definiciones

Nombre	Description
ApiGatewaySkuType	Nombre de la SKU.
ApiManagementGatewayResource	Un único recurso de puerta de enlace de API Management en Lista o Obtención de respuesta.
ApiManagementGatewaySkuProperties	Propiedades de SKU de recursos de puerta de enlace de API Management.
BackendConfiguration	Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end.
BackendSubnetConfiguration	Información sobre cómo se debe insertar la subred a la que se debe insertar la puerta de enlace.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FrontendConfiguration	Información sobre cómo se debe exponer la puerta de enlace.
GatewayConfigurationApi	Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar.
systemData	Metadatos relativos a la creación y última modificación del recurso.
VirtualNetworkType	Tipo de VPN en el que se debe configurar API Management Gateway.

ApiGatewaySkuType

Enumeración

Nombre de la SKU.

Valor	Description
Standard	SKU estándar de la puerta de enlace de API.
WorkspaceGatewayStandard	SKU estándar de la puerta de enlace de API que se usará en áreas de trabajo.
WorkspaceGatewayPremium	SKU Premium de la puerta de enlace de API que se va a usar en áreas de trabajo.

ApiManagementGatewayResource

Object

Un único recurso de puerta de enlace de API Management en Lista o Obtención de respuesta.

Nombre	Tipo	Description
etag	string	ETag del recurso.
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.backend	BackendConfiguration	Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end.
properties.configurationApi	GatewayConfigurationApi	Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar.
properties.createdAtUtc	string (date-time)	Fecha UTC de creación de la puerta de enlace de API Management. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.
properties.frontend	FrontendConfiguration	Información sobre cómo se debe exponer la puerta de enlace.
properties.provisioningState	string	El estado de aprovisionamiento actual de la puerta de enlace de API Management que puede ser uno de los siguientes: Created/Activating/Succeeded/Update/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.targetProvisioningState	string	El estado de aprovisionamiento de la puerta de enlace de API Management, que está destinada a la operación de ejecución prolongada iniciada en la puerta de enlace.
properties.virtualNetworkType	VirtualNetworkType	Tipo de VPN en el que se debe configurar API Management Gateway.
sku	ApiManagementGatewaySkuProperties	Propiedades de SKU de la puerta de enlace de API Management.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	El tipo de recurso de API Management se establece en Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Object

Propiedades de SKU de recursos de puerta de enlace de API Management.

Nombre	Tipo	Description
capacity	integer (int32)	Capacidad de la SKU (número de unidades implementadas de la SKU)
name	ApiGatewaySkuType	Nombre de la SKU.

BackendConfiguration

Object

Información sobre cómo se debe integrar la puerta de enlace con los sistemas back-end.

Nombre	Tipo	Description
subnet	BackendSubnetConfiguration	Nombre de host predeterminado de la puerta de enlace del plano de datos a la que se pueden enviar las solicitudes.

BackendSubnetConfiguration

Object

Información sobre cómo se debe insertar la subred a la que se debe insertar la puerta de enlace.

Nombre	Tipo	Description
id	string	Identificador de ARM de la subred en la que se hospedan los sistemas back-end.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FrontendConfiguration

Object

Información sobre cómo se debe exponer la puerta de enlace.

Nombre	Tipo	Description
defaultHostname	string	Nombre de host predeterminado de la puerta de enlace del plano de datos a la que se pueden enviar las solicitudes. Esto solo es aplicable a la puerta de enlace de API con SKU estándar.

GatewayConfigurationApi

Object

Información sobre la API de configuración de la puerta de enlace de API Management. Esto solo es aplicable a la puerta de enlace de API con SKU estándar.

Nombre	Tipo	Description
hostname	string	Nombre de host al que se conecta el agente para propagar la configuración a la nube.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

VirtualNetworkType

Enumeración

Tipo de VPN en el que se debe configurar API Management Gateway.

Valor	Description
None	La puerta de enlace de API Management no forma parte de ninguna red virtual.
External	La puerta de enlace de API Management forma parte de Virtual Network y es accesible desde Internet.
Internal	La puerta de enlace de API Management forma parte de Virtual Network y solo es accesible desde dentro de la red virtual.

Compartir a través de

Api Gateway - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementCreateStandardGateway

Solicitud de ejemplo

Respuesta de muestra

ApiManagementCreateWorkspacePremiumGateway

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType