Api Gateway - Create Or Update

Tjänst:: API Management

API-version:: 2024-05-01

Skapar eller uppdaterar en API Management-gateway. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-gatewayen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Resursplats.
sku	True	ApiManagementGatewaySkuProperties	SKU-egenskaper för API Management-gatewayen.
properties.backend		BackendConfiguration	Information om hur gatewayen ska integreras med serverdelssystem.
properties.configurationApi		GatewayConfigurationApi	Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU.
properties.frontend		FrontendConfiguration	Information om hur gatewayen ska exponeras.
properties.virtualNetworkType		VirtualNetworkType	Den typ av VPN som API Management-gatewayen måste konfigureras i.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	ApiManagementGatewayResource	Gatewayen har konfigurerats.
201 Created	ApiManagementGatewayResource	Skapad
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Exempelbegäran

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

Exempelsvar

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

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

Exempelbegäran

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

Exempelsvar

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

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

Definitioner

Name	Description
ApiGatewaySkuType	Namnet på SKU:n.
ApiManagementGatewayResource	En enda API Management-gatewayresurs i Lista eller Hämta svar.
ApiManagementGatewaySkuProperties	API Management-gatewayens SKU-egenskaper för resurs.
BackendConfiguration	Information om hur gatewayen ska integreras med serverdelssystem.
BackendSubnetConfiguration	Information om hur det undernät som gatewayen ska matas in till.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FrontendConfiguration	Information om hur gatewayen ska exponeras.
GatewayConfigurationApi	Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU.
systemData	Metadata som rör skapande och senaste ändring av resursen.
VirtualNetworkType	Den typ av VPN som API Management-gatewayen måste konfigureras i.

ApiGatewaySkuType

Uppräkning

Namnet på SKU:n.

Värde	Description
Standard	Standard-SKU för API-gatewayen.
WorkspaceGatewayStandard	Standard-SKU för API-gatewayen som ska användas i arbetsytor.
WorkspaceGatewayPremium	Premium-SKU för API-gatewayen som ska användas i arbetsytor.

ApiManagementGatewayResource

Objekt

En enda API Management-gatewayresurs i Lista eller Hämta svar.

Name	Typ	Description
etag	string	ETag för resursen.
id	string	Resurs-ID.
location	string	Resursplats.
name	string	Resursnamn.
properties.backend	BackendConfiguration	Information om hur gatewayen ska integreras med serverdelssystem.
properties.configurationApi	GatewayConfigurationApi	Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU.
properties.createdAtUtc	string (date-time)	Skapande av UTC-datum för API Management-gatewayen. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.frontend	FrontendConfiguration	Information om hur gatewayen ska exponeras.
properties.provisioningState	string	Det aktuella etableringstillståndet för API Management-gatewayen som kan vara något av följande: Skapad/Aktivera/Lyckades/Uppdatera/Misslyckades/Stoppad/Avslutande/AvslutningFailed/Borttagen.
properties.targetProvisioningState	string	Etableringstillståndet för API Management-gatewayen, som är mål för den tidskrävande åtgärden som startades på gatewayen.
properties.virtualNetworkType	VirtualNetworkType	Den typ av VPN som API Management-gatewayen måste konfigureras i.
sku	ApiManagementGatewaySkuProperties	SKU-egenskaper för API Management-gatewayen.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resurstaggar.
type	string	Resurstypen för API Management-resursen är inställd på Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Objekt

API Management-gatewayens SKU-egenskaper för resurs.

Name	Typ	Description
capacity	integer (int32)	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n)
name	ApiGatewaySkuType	Namnet på SKU:n.

BackendConfiguration

Objekt

Information om hur gatewayen ska integreras med serverdelssystem.

Name	Typ	Description
subnet	BackendSubnetConfiguration	Standardvärdnamnet för den dataplansgateway som begäranden kan skickas till.

BackendSubnetConfiguration

Objekt

Information om hur det undernät som gatewayen ska matas in till.

Name	Typ	Description
id	string	ARM-ID:t för det undernät där serverdelssystemen finns.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FrontendConfiguration

Objekt

Information om hur gatewayen ska exponeras.

Name	Typ	Description
defaultHostname	string	Standardvärdnamnet för den dataplansgateway som begäranden kan skickas till. Detta gäller endast för API-gateway med Standard SKU.

GatewayConfigurationApi

Objekt

Information om API-konfigurations-API:et för API Management-gatewayen. Detta gäller endast för API-gateway med Standard SKU.

Name	Typ	Description
hostname	string	Värdnamn som agenten ansluter till för att sprida konfigurationen till molnet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

VirtualNetworkType

Uppräkning

Den typ av VPN som API Management-gatewayen måste konfigureras i.

Värde	Description
None	API Management-gatewayen är inte en del av något virtuellt nätverk.
External	API Management-gatewayen är en del av det virtuella nätverket och är tillgänglig från Internet.
Internal	API Management-gatewayen är en del av det virtuella nätverket och är endast tillgänglig inifrån det virtuella nätverket.

Dela via

Api Gateway - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementCreateStandardGateway

Exempelbegäran

Exempelsvar

ApiManagementCreateWorkspacePremiumGateway

Exempelbegäran

Exempelsvar

Definitioner

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType