Api Gateway - Create Or Update

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Tworzy lub aktualizuje bramę usługi API Management. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa bramy usługi API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
sku	True	ApiManagementGatewaySkuProperties	Właściwości jednostki SKU bramy usługi API Management.
properties.backend		BackendConfiguration	Informacje dotyczące sposobu integracji bramy z systemami zaplecza.
properties.configurationApi		GatewayConfigurationApi	Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa.
properties.frontend		FrontendConfiguration	Informacje dotyczące sposobu uwidocznienia bramy.
properties.virtualNetworkType		VirtualNetworkType	Typ sieci VPN, w której należy skonfigurować bramę usługi API Management.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiManagementGatewayResource	Brama została pomyślnie skonfigurowana.
201 Created	ApiManagementGatewayResource	Utworzono
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
ApiGatewaySkuType	Nazwa jednostki SKU.
ApiManagementGatewayResource	Pojedynczy zasób bramy usługi API Management w obszarze Lista lub Pobierz odpowiedź.
ApiManagementGatewaySkuProperties	Właściwości jednostki SKU zasobu bramy usługi API Management.
BackendConfiguration	Informacje dotyczące sposobu integracji bramy z systemami zaplecza.
BackendSubnetConfiguration	Informacje dotyczące sposobu wstrzykiwania podsieci, do której należy wprowadzić bramę.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FrontendConfiguration	Informacje dotyczące sposobu uwidocznienia bramy.
GatewayConfigurationApi	Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
VirtualNetworkType	Typ sieci VPN, w której należy skonfigurować bramę usługi API Management.

ApiGatewaySkuType

Wyliczanie

Nazwa jednostki SKU.

Wartość	Opis
Standard	Standardowa jednostka SKU bramy interfejsu API.
WorkspaceGatewayStandard	Standardowa jednostka SKU bramy interfejsu API do użycia w obszarach roboczych.
WorkspaceGatewayPremium	Jednostka SKU Premium bramy interfejsu API do użycia w obszarach roboczych.

ApiManagementGatewayResource

Objekt

Pojedynczy zasób bramy usługi API Management w obszarze Lista lub Pobierz odpowiedź.

Nazwa	Typ	Opis
etag	string	Element ETag zasobu.
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.backend	BackendConfiguration	Informacje dotyczące sposobu integracji bramy z systemami zaplecza.
properties.configurationApi	GatewayConfigurationApi	Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa.
properties.createdAtUtc	string (date-time)	Data UTC utworzenia bramy usługi API Management. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` określony przez standard ISO 8601.
properties.frontend	FrontendConfiguration	Informacje dotyczące sposobu uwidocznienia bramy.
properties.provisioningState	string	Bieżący stan aprowizacji bramy usługi API Management, który może być jednym z następujących: Utworzono/Aktywowanie/Powodzenie/Aktualizowanie/Niepowodzenie/Zatrzymano/Zakończenie/ZakończenieFailed/Deleted.
properties.targetProvisioningState	string	Stan aprowizacji bramy usługi API Management, który jest kierowany przez długotrwałą operację uruchomioną w bramie.
properties.virtualNetworkType	VirtualNetworkType	Typ sieci VPN, w której należy skonfigurować bramę usługi API Management.
sku	ApiManagementGatewaySkuProperties	Właściwości jednostki SKU bramy usługi API Management.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu usługi API Management jest ustawiony na Wartość Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Objekt

Właściwości jednostki SKU zasobu bramy usługi API Management.

Nazwa	Typ	Opis
capacity	integer (int32)	Pojemność jednostki SKU (liczba wdrożonych jednostek SKU)
name	ApiGatewaySkuType	Nazwa jednostki SKU.

BackendConfiguration

Objekt

Informacje dotyczące sposobu integracji bramy z systemami zaplecza.

Nazwa	Typ	Opis
subnet	BackendSubnetConfiguration	Domyślna nazwa hosta bramy płaszczyzny danych, do której można wysyłać żądania.

BackendSubnetConfiguration

Objekt

Informacje dotyczące sposobu wstrzykiwania podsieci, do której należy wprowadzić bramę.

Nazwa	Typ	Opis
id	string	Identyfikator arm podsieci, w której są hostowane systemy zaplecza.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

FrontendConfiguration

Objekt

Informacje dotyczące sposobu uwidocznienia bramy.

Nazwa	Typ	Opis
defaultHostname	string	Domyślna nazwa hosta bramy płaszczyzny danych, do której można wysyłać żądania. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa.

GatewayConfigurationApi

Objekt

Informacje dotyczące interfejsu API konfiguracji bramy usługi API Management. Dotyczy to tylko bramy interfejsu API z jednostkami SKU w warstwie Standardowa.

Nazwa	Typ	Opis
hostname	string	Nazwa hosta, z którą agent nawiązuje połączenie, aby propagować konfigurację do chmury.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

VirtualNetworkType

Wyliczanie

Typ sieci VPN, w której należy skonfigurować bramę usługi API Management.

Wartość	Opis
None	Brama usługi API Management nie jest częścią żadnej sieci wirtualnej.
External	Brama usługi API Management jest częścią sieci wirtualnej i jest dostępna z Internetu.
Internal	Brama usługi API Management jest częścią sieci wirtualnej i jest dostępna tylko z poziomu sieci wirtualnej.

Udostępnij za pośrednictwem

Api Gateway - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementCreateStandardGateway

Przykładowe żądanie

Przykładowa odpowiedź

ApiManagementCreateWorkspacePremiumGateway

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType