Api Gateway - Create Or Update

Hizmet:: API Management

API Sürümü:: 2024-05-01

API Management ağ geçidi oluşturur veya güncelleştirir. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management ağ geçidinin adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynak konumu.
sku	True	ApiManagementGatewaySkuProperties	API Management ağ geçidinin SKU özellikleri.
properties.backend		BackendConfiguration	Ağ geçidinin arka uç sistemleriyle nasıl tümleştirilmesi gerektiğiyle ilgili bilgiler.
properties.configurationApi		GatewayConfigurationApi	API Management ağ geçidinin Yapılandırma API'sine ilişkin bilgiler. Bu yalnızca Standart SKU'ya sahip API ağ geçidi için geçerlidir.
properties.frontend		FrontendConfiguration	Ağ geçidinin nasıl kullanıma sunulma şekliyle ilgili bilgiler.
properties.virtualNetworkType		VirtualNetworkType	API Management ağ geçidinin yapılandırılması gereken VPN türü.
tags		object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	ApiManagementGatewayResource	Ağ geçidi başarıyla ayarlandı.
201 Created	ApiManagementGatewayResource	Oluşturulan
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Durum kodu:: 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

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
ApiGatewaySkuType	Sku'nun adı.
ApiManagementGatewayResource	Liste veya Yanıt al'da tek bir API Management ağ geçidi kaynağı.
ApiManagementGatewaySkuProperties	API Management ağ geçidi kaynak SKU özellikleri.
BackendConfiguration	Ağ geçidinin arka uç sistemleriyle nasıl tümleştirilmesi gerektiğiyle ilgili bilgiler.
BackendSubnetConfiguration	Ağ geçidinin nasıl eklenecek olduğuyla ilgili bilgiler.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
FrontendConfiguration	Ağ geçidinin nasıl kullanıma sunulma şekliyle ilgili bilgiler.
GatewayConfigurationApi	API Management ağ geçidinin Yapılandırma API'sine ilişkin bilgiler. Bu yalnızca Standart SKU'ya sahip API ağ geçidi için geçerlidir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
VirtualNetworkType	API Management ağ geçidinin yapılandırılması gereken VPN türü.

ApiGatewaySkuType

Listeleme

Sku'nun adı.

Değer	Description
Standard	API ağ geçidinin standart SKU'su.
WorkspaceGatewayStandard	Çalışma Alanlarında kullanılacak API ağ geçidinin standart SKU'su.
WorkspaceGatewayPremium	Çalışma Alanlarında kullanılacak API ağ geçidinin Premium SKU'su.

ApiManagementGatewayResource

Object

Liste veya Yanıt al'da tek bir API Management ağ geçidi kaynağı.

Name	Tür	Description
etag	string	Kaynağın ETag'i.
id	string	Kaynak Kimliği.
location	string	Kaynak konumu.
name	string	Kaynak adı.
properties.backend	BackendConfiguration	Ağ geçidinin arka uç sistemleriyle nasıl tümleştirilmesi gerektiğiyle ilgili bilgiler.
properties.configurationApi	GatewayConfigurationApi	API Management ağ geçidinin Yapılandırma API'sine ilişkin bilgiler. Bu yalnızca Standart SKU'ya sahip API ağ geçidi için geçerlidir.
properties.createdAtUtc	string (date-time)	API Management ağ geçidi oluşturma UTC tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.
properties.frontend	FrontendConfiguration	Ağ geçidinin nasıl kullanıma sunulma şekliyle ilgili bilgiler.
properties.provisioningState	string	API Management ağ geçidinin aşağıdakilerden biri olabilecek geçerli sağlama durumu: Oluşturuldu/Etkinleştirildi/Başarılı/Güncelleştirildi/Başarısız/Durduruldu/Sonlandırılıyor/SonlandırmaHatalandı/Silindi.
properties.targetProvisioningState	string	Ağ geçidinde başlatılan uzun süre çalışan işlem tarafından hedeflenen API Management ağ geçidinin sağlama durumu.
properties.virtualNetworkType	VirtualNetworkType	API Management ağ geçidinin yapılandırılması gereken VPN türü.
sku	ApiManagementGatewaySkuProperties	API Management ağ geçidinin SKU özellikleri.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri.
type	string	API Management kaynağının kaynak türü Microsoft.ApiManagement olarak ayarlanır.

ApiManagementGatewaySkuProperties

Object

API Management ağ geçidi kaynak SKU özellikleri.

Name	Tür	Description
capacity	integer (int32)	SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı)
name	ApiGatewaySkuType	Sku'nun adı.

BackendConfiguration

Object

Ağ geçidinin arka uç sistemleriyle nasıl tümleştirilmesi gerektiğiyle ilgili bilgiler.

Name	Tür	Description
subnet	BackendSubnetConfiguration	İsteklerin gönderilebileceği veri düzlemi ağ geçidinin varsayılan ana bilgisayar adı.

BackendSubnetConfiguration

Object

Ağ geçidinin nasıl eklenecek olduğuyla ilgili bilgiler.

Name	Tür	Description
id	string	Arka uç sistemlerinin barındırıldığı alt ağın ARM kimliği.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

FrontendConfiguration

Object

Ağ geçidinin nasıl kullanıma sunulma şekliyle ilgili bilgiler.

Name	Tür	Description
defaultHostname	string	İsteklerin gönderilebileceği veri düzlemi ağ geçidinin varsayılan ana bilgisayar adı. Bu yalnızca Standart SKU'ya sahip API ağ geçidi için geçerlidir.

GatewayConfigurationApi

Object

API Management ağ geçidinin Yapılandırma API'sine ilişkin bilgiler. Bu yalnızca Standart SKU'ya sahip API ağ geçidi için geçerlidir.

Name	Tür	Description
hostname	string	Aracının yapılandırmayı buluta yaymak için bağlandığı ana bilgisayar adı.

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

VirtualNetworkType

Listeleme

API Management ağ geçidinin yapılandırılması gereken VPN türü.

Değer	Description
None	API Management ağ geçidi herhangi bir Sanal Ağın parçası değildir.
External	API Management ağ geçidi Sanal Ağ'ın bir parçasıdır ve İnternet'ten erişilebilir.
Internal	API Management ağ geçidi Sanal Ağ'ın bir parçasıdır ve yalnızca sanal ağ içinden erişilebilir.

Aracılığıyla paylaş

Api Gateway - Create Or Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementCreateStandardGateway

Örnek isteği

Örnek yanıt

ApiManagementCreateWorkspacePremiumGateway

Örnek isteği

Örnek yanıt

Tanımlar

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType