Api Gateway - Create Or Update

Dienst:: API Management

API-Version:: 2024-05-01

Erstellt oder aktualisiert ein API-Verwaltungsgateway. Dies ist ein lang ausgeführter Vorgang und kann mehrere Minuten dauern.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsgateways.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Ressourcenspeicherort.
sku	True	ApiManagementGatewaySkuProperties	SKU-Eigenschaften des API-Verwaltungsgateways.
properties.backend		BackendConfiguration	Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll.
properties.configurationApi		GatewayConfigurationApi	Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU.
properties.frontend		FrontendConfiguration	Informationen dazu, wie das Gateway verfügbar gemacht werden soll.
properties.virtualNetworkType		VirtualNetworkType	Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	ApiManagementGatewayResource	Das Gateway wurde erfolgreich eingerichtet.
201 Created	ApiManagementGatewayResource	Erstellt
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 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

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
ApiGatewaySkuType	Name der Sku.
ApiManagementGatewayResource	Eine einzelne API-Verwaltungsgatewayressource in "List" oder "Get response".
ApiManagementGatewaySkuProperties	SKU-Eigenschaften der API-Verwaltungsgatewayressource.
BackendConfiguration	Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll.
BackendSubnetConfiguration	Informationen dazu, wie das Subnetz, in das das Gateway eingefügt werden soll.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
FrontendConfiguration	Informationen dazu, wie das Gateway verfügbar gemacht werden soll.
GatewayConfigurationApi	Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
VirtualNetworkType	Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss.

ApiGatewaySkuType

Enumeration

Name der Sku.

Wert	Beschreibung
Standard	Standard-SKU des API-Gateways.
WorkspaceGatewayStandard	Standard-SKU des API-Gateways, das in Arbeitsbereichen verwendet werden soll.
WorkspaceGatewayPremium	Premium-SKU des API-Gateways, das in Arbeitsbereichen verwendet werden soll.

ApiManagementGatewayResource

Objekt

Eine einzelne API-Verwaltungsgatewayressource in "List" oder "Get response".

Name	Typ	Beschreibung
etag	string	ETag der Ressource.
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.backend	BackendConfiguration	Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll.
properties.configurationApi	GatewayConfigurationApi	Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU.
properties.createdAtUtc	string (date-time)	Erstellungsdatum des API-Verwaltungsgateways. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.frontend	FrontendConfiguration	Informationen dazu, wie das Gateway verfügbar gemacht werden soll.
properties.provisioningState	string	Der aktuelle Bereitstellungsstatus des API-Verwaltungsgateways, das eine der folgenden Sein kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.targetProvisioningState	string	Der Bereitstellungsstatus des API-Verwaltungsgateways, das auf den lange ausgeführten Vorgang ausgerichtet ist, der auf dem Gateway gestartet wurde.
properties.virtualNetworkType	VirtualNetworkType	Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss.
sku	ApiManagementGatewaySkuProperties	SKU-Eigenschaften des API-Verwaltungsgateways.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Ressourcentyp für die API-Verwaltungsressource ist auf "Microsoft.ApiManagement" festgelegt.

ApiManagementGatewaySkuProperties

Objekt

SKU-Eigenschaften der API-Verwaltungsgatewayressource.

Name	Typ	Beschreibung
capacity	integer (int32)	Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU)
name	ApiGatewaySkuType	Name der Sku.

BackendConfiguration

Objekt

Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll.

Name	Typ	Beschreibung
subnet	BackendSubnetConfiguration	Der Standardhostname des Datenebenengateways, an das Anforderungen gesendet werden können.

BackendSubnetConfiguration

Objekt

Informationen dazu, wie das Subnetz, in das das Gateway eingefügt werden soll.

Name	Typ	Beschreibung
id	string	Die ARM-ID des Subnetzes, in dem die Back-End-Systeme gehostet werden.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FrontendConfiguration

Objekt

Informationen dazu, wie das Gateway verfügbar gemacht werden soll.

Name	Typ	Beschreibung
defaultHostname	string	Der Standardhostname des Datenebenengateways, an das Anforderungen gesendet werden können. Dies gilt nur für API-Gateways mit Standard-SKU.

GatewayConfigurationApi

Objekt

Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU.

Name	Typ	Beschreibung
hostname	string	Hostname, mit dem der Agent eine Verbindung herstellt, um die Konfiguration an die Cloud weiterzuverbreiten.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

VirtualNetworkType

Enumeration

Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss.

Wert	Beschreibung
None	Das API-Verwaltungsgateway ist nicht Teil eines virtuellen Netzwerks.
External	Das API-Verwaltungsgateway ist Teil des virtuellen Netzwerks und kann über das Internet zugänglich sein.
Internal	Das API-Verwaltungsgateway ist Teil des virtuellen Netzwerks und kann nur über das virtuelle Netzwerk zugänglich sein.

Freigeben über

Api Gateway - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementCreateStandardGateway

Beispielanforderung

Beispiel für eine Antwort

ApiManagementCreateWorkspacePremiumGateway

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType