Api Gateway - Create Or Update

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Vytvoří nebo aktualizuje bránu služby API Management. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název brány služby API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění prostředku
sku	True	ApiManagementGatewaySkuProperties	Vlastnosti skladové položky brány služby API Management
properties.backend		BackendConfiguration	Informace o tom, jak by se brána měla integrovat s back-endovými systémy
properties.configurationApi		GatewayConfigurationApi	Informace týkající se rozhraní API konfigurace brány služby API Management To platí jenom pro bránu rozhraní API se skladovou jednotkou Standard.
properties.frontend		FrontendConfiguration	Informace o tom, jak má být brána vystavena.
properties.virtualNetworkType		VirtualNetworkType	Typ sítě VPN, ve které je potřeba nakonfigurovat bránu služby API Management.
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	ApiManagementGatewayResource	Brána byla úspěšně nastavena.
201 Created	ApiManagementGatewayResource	Vytvořil
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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"
  }
}

Definice

Name	Description
ApiGatewaySkuType	Název skladové položky.
ApiManagementGatewayResource	Jeden prostředek brány služby API Management v seznamu nebo získání odpovědi
ApiManagementGatewaySkuProperties	Vlastnosti skladové položky prostředku služby API Management
BackendConfiguration	Informace o tom, jak by se brána měla integrovat s back-endovými systémy
BackendSubnetConfiguration	Informace týkající se způsobu vkládání brány do podsítě.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
FrontendConfiguration	Informace o tom, jak má být brána vystavena.
GatewayConfigurationApi	Informace týkající se rozhraní API konfigurace brány služby API Management To platí jenom pro bránu rozhraní API se skladovou jednotkou Standard.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
VirtualNetworkType	Typ sítě VPN, ve které je potřeba nakonfigurovat bránu služby API Management.

ApiGatewaySkuType

Výčet

Název skladové položky.

Hodnota	Description
Standard	Standardní skladová položka brány rozhraní API.
WorkspaceGatewayStandard	Standardní skladová položka brány rozhraní API, která se má použít v pracovních prostorech.
WorkspaceGatewayPremium	Skladová položka Premium brány rozhraní API, která se má používat v pracovních prostorech.

ApiManagementGatewayResource

Objekt

Jeden prostředek brány služby API Management v seznamu nebo získání odpovědi

Name	Typ	Description
etag	string	ETag prostředku.
id	string	ID prostředku.
location	string	Umístění prostředku
name	string	Název prostředku
properties.backend	BackendConfiguration	Informace o tom, jak by se brána měla integrovat s back-endovými systémy
properties.configurationApi	GatewayConfigurationApi	Informace týkající se rozhraní API konfigurace brány služby API Management To platí jenom pro bránu rozhraní API se skladovou jednotkou Standard.
properties.createdAtUtc	string (date-time)	Datum vytvoření brány SLUŽBY API Management ve standardu UTC Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.frontend	FrontendConfiguration	Informace o tom, jak má být brána vystavena.
properties.provisioningState	string	Aktuální stav zřizování brány služby API Management, který může být jedním z následujících: Vytvoření, aktivace, úspěch, aktualizace, selhání, zastavení, ukončení, selhání nebo odstranění
properties.targetProvisioningState	string	Stav zřizování brány služby API Management, na který cílí dlouhotrvající operace spuštěná na bráně.
properties.virtualNetworkType	VirtualNetworkType	Typ sítě VPN, ve které je potřeba nakonfigurovat bránu služby API Management.
sku	ApiManagementGatewaySkuProperties	Vlastnosti skladové položky brány služby API Management
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
tags	object	Značky prostředků
type	string	Typ prostředku služby API Management je nastavený na Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Objekt

Vlastnosti skladové položky prostředku služby API Management

Name	Typ	Description
capacity	integer (int32)	Kapacita skladové položky (počet nasazených jednotek skladové položky)
name	ApiGatewaySkuType	Název skladové položky.

BackendConfiguration

Objekt

Informace o tom, jak by se brána měla integrovat s back-endovými systémy

Name	Typ	Description
subnet	BackendSubnetConfiguration	Výchozí název hostitele brány roviny dat, do které se dají odesílat požadavky.

BackendSubnetConfiguration

Objekt

Informace týkající se způsobu vkládání brány do podsítě.

Name	Typ	Description
id	string	ID ARM podsítě, ve které jsou hostované back-endové systémy.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

FrontendConfiguration

Objekt

Informace o tom, jak má být brána vystavena.

Name	Typ	Description
defaultHostname	string	Výchozí název hostitele brány roviny dat, do které se dají odesílat požadavky. To platí jenom pro bránu rozhraní API se skladovou jednotkou Standard.

GatewayConfigurationApi

Objekt

Informace týkající se rozhraní API konfigurace brány služby API Management To platí jenom pro bránu rozhraní API se skladovou jednotkou Standard.

Name	Typ	Description
hostname	string	Název hostitele, ke kterému se agent připojuje, aby rozšířil konfiguraci do cloudu.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

VirtualNetworkType

Výčet

Typ sítě VPN, ve které je potřeba nakonfigurovat bránu služby API Management.

Hodnota	Description
None	Brána SLUŽBY API Management není součástí žádné virtuální sítě.
External	Brána SLUŽBY API Management je součástí virtuální sítě a je přístupná z internetu.
Internal	Brána SLUŽBY API Management je součástí virtuální sítě a je přístupná pouze z virtuální sítě.

Sdílet prostřednictvím

Api Gateway - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementCreateStandardGateway

Ukázkový požadavek

Ukázková odpověď

ApiManagementCreateWorkspacePremiumGateway

Ukázkový požadavek

Ukázková odpověď

Definice

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType