Api Gateway - Create Or Update

Service:: API Management

API-versie:: 2024-05-01

Hiermee maakt of werkt u een API Management-gateway bij. Dit duurt lang en kan enkele minuten duren.

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

URI-parameters

Name	In	Vereist	Type	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-gateway.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	Resourcelocatie.
sku	True	ApiManagementGatewaySkuProperties	SKU-eigenschappen van de API Management-gateway.
properties.backend		BackendConfiguration	Informatie over hoe de gateway moet worden geïntegreerd met back-endsystemen.
properties.configurationApi		GatewayConfigurationApi	Informatie over de configuratie-API van de API Management-gateway. Dit is alleen van toepassing op API-gateway met Standard-SKU.
properties.frontend		FrontendConfiguration	Informatie over hoe de gateway moet worden weergegeven.
properties.virtualNetworkType		VirtualNetworkType	Het type VPN waarin de API Management-gateway moet worden geconfigureerd.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	ApiManagementGatewayResource	De gateway is ingesteld.
201 Created	ApiManagementGatewayResource	Geschapen
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ApiGatewaySkuType	Naam van de SKU.
ApiManagementGatewayResource	Eén API Management-gatewayresource in Lijst of Antwoord ophalen.
ApiManagementGatewaySkuProperties	SKU-eigenschappen van API Management-gatewayresources.
BackendConfiguration	Informatie over hoe de gateway moet worden geïntegreerd met back-endsystemen.
BackendSubnetConfiguration	Informatie over hoe het subnet waarnaar de gateway moet worden geïnjecteerd.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FrontendConfiguration	Informatie over hoe de gateway moet worden weergegeven.
GatewayConfigurationApi	Informatie over de configuratie-API van de API Management-gateway. Dit is alleen van toepassing op API-gateway met Standard-SKU.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
VirtualNetworkType	Het type VPN waarin de API Management-gateway moet worden geconfigureerd.

ApiGatewaySkuType

Inventarisatie

Naam van de SKU.

Waarde	Description
Standard	Standaard-SKU van de API-gateway.
WorkspaceGatewayStandard	Standaard-SKU van de API-gateway die moet worden gebruikt in werkruimten.
WorkspaceGatewayPremium	Premium-SKU van de API-gateway die moet worden gebruikt in werkruimten.

ApiManagementGatewayResource

Object

Eén API Management-gatewayresource in Lijst of Antwoord ophalen.

Name	Type	Description
etag	string	ETag van de resource.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.backend	BackendConfiguration	Informatie over hoe de gateway moet worden geïntegreerd met back-endsystemen.
properties.configurationApi	GatewayConfigurationApi	Informatie over de configuratie-API van de API Management-gateway. Dit is alleen van toepassing op API-gateway met Standard-SKU.
properties.createdAtUtc	string (date-time)	De UTC-datum van de API Management-gateway maken. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.frontend	FrontendConfiguration	Informatie over hoe de gateway moet worden weergegeven.
properties.provisioningState	string	De huidige inrichtingsstatus van de API Management-gateway, die een van de volgende opties kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/Beëindigen/BeëindigingFailed/Verwijderd.
properties.targetProvisioningState	string	De inrichtingsstatus van de API Management-gateway, waarop de langdurige bewerking is gestart op de gateway.
properties.virtualNetworkType	VirtualNetworkType	Het type VPN waarin de API Management-gateway moet worden geconfigureerd.
sku	ApiManagementGatewaySkuProperties	SKU-eigenschappen van de API Management-gateway.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object	Resourcetags.
type	string	Resourcetype voor API Management-resource is ingesteld op Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Object

SKU-eigenschappen van API Management-gatewayresources.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU)
name	ApiGatewaySkuType	Naam van de SKU.

BackendConfiguration

Object

Informatie over hoe de gateway moet worden geïntegreerd met back-endsystemen.

Name	Type	Description
subnet	BackendSubnetConfiguration	De standaardhostnaam van de gegevensvlakgateway waarnaar aanvragen kunnen worden verzonden.

BackendSubnetConfiguration

Object

Informatie over hoe het subnet waarnaar de gateway moet worden geïnjecteerd.

Name	Type	Description
id	string	De ARM-id van het subnet waarin de back-endsystemen worden gehost.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FrontendConfiguration

Object

Informatie over hoe de gateway moet worden weergegeven.

Name	Type	Description
defaultHostname	string	De standaardhostnaam van de gegevensvlakgateway waarnaar aanvragen kunnen worden verzonden. Dit is alleen van toepassing op API-gateway met Standard-SKU.

GatewayConfigurationApi

Object

Informatie over de configuratie-API van de API Management-gateway. Dit is alleen van toepassing op API-gateway met Standard-SKU.

Name	Type	Description
hostname	string	Hostnaam waarmee de agent verbinding maakt om de configuratie door te geven aan de cloud.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

VirtualNetworkType

Inventarisatie

Het type VPN waarin de API Management-gateway moet worden geconfigureerd.

Waarde	Description
None	De API Management-gateway maakt geen deel uit van een virtueel netwerk.
External	De API Management-gateway maakt deel uit van virtual network en is toegankelijk via internet.
Internal	De API Management-gateway maakt deel uit van virtual network en is alleen toegankelijk vanuit het virtuele netwerk.

Delen via

Api Gateway - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementCreateStandardGateway

Voorbeeldaanvraag

Voorbeeldrespons

ApiManagementCreateWorkspacePremiumGateway

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType