Gateways - Update Gateway

Hizmet:: Core

API Sürümü:: v1

Ağ geçidini kimliğine göre güncelleştirir.

İzinler

Çağıranın ağ geçidi için yönetici izni olmalıdır.

Gerekli Temsilci Kapsamları

Gateway.ReadWrite.All

Microsoft Entra tarafından desteklenen kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Evet

Arayüz

PATCH https://api.fabric.microsoft.com/v1/gateways/{gatewayId}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
gatewayId	path	True	string (uuid)	Ağ geçidinin kimliği.

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Name	Description
UpdateOnPremisesGatewayRequest
UpdateVirtualNetworkGatewayRequest

UpdateOnPremisesGatewayRequest

Name	Gerekli	Tür	Description
type	True	string: OnPremises	Ağ geçidinin türü.
allowCloudConnectionRefresh		boolean	Bulut bağlantılarının bu şirket içi ağ geçidi aracılığıyla yenilenmesine izin verilip verilmeyeceği. True - İzin Ver, Yanlış - İzin verme.
allowCustomConnectors		boolean	Özel bağlayıcıların bu şirket içi ağ geçidiyle kullanılmasına izin verilip verilmeyeceği. True - İzin Ver, Yanlış - İzin verme.
displayName		string	Ağ geçidinin adı. Uzunluk üst sınırı 200 karakterdir.
loadBalancingSetting		LoadBalancingSetting	Şirket içi ağ geçidinin yük dengeleme ayarı.

UpdateVirtualNetworkGatewayRequest

Name	Gerekli	Tür	Description
type	True	string: VirtualNetwork	Ağ geçidinin türü.
capacityId		string (uuid)	Doku lisans kapasitesinin nesne kimliği.
displayName		string	Ağ geçidinin adı. Uzunluk üst sınırı 200 karakterdir.
inactivityMinutesBeforeSleep		integer	Sanal ağ geçidi otomatik uyku moduna geçmeden önce geçen işlem yapılmadan geçen dakika sayısı. Şu değerlerden biri olmalıdır: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways		integer	Üye ağ geçitlerinin sayısı. 1 ile 9 arasında bir sayı.

Yanıtlar

Name Tür Description

200 OK

Name	Tür	Description
200 OK	Gateway: OnPremisesGateway OnPremisesGatewayPersonal VirtualNetworkGateway	TAMAM. İşlem başarılı oldu.
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: UnknownError - Bir hata oluştu.

Gateway:

OnPremisesGateway
OnPremisesGatewayPersonal
VirtualNetworkGateway

TAMAM. İşlem başarılı oldu.

429 Too Many Requests

ErrorResponse

Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Retry-After üst bilgi döndürür.

Üst Bilgiler

Retry-After: integer

Other Status Codes

ErrorResponse

Yaygın hata kodları:

UnknownError - Bir hata oluştu.

Örnekler

On-premises gateway example

Virtual network gateway example

On-premises gateway example

Örnek isteği

HTTP

PATCH https://api.fabric.microsoft.com/v1/gateways/3d1290e1-e3ed-4bd6-93bc-2bbd5b49a789

{
  "type": "OnPremises",
  "displayName": "ContosoGatewayCluster1",
  "loadBalancingSetting": "Failover",
  "allowCloudConnectionRefresh": false,
  "allowCustomConnectors": false
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "3d1290e1-e3ed-4bd6-93bc-2bbd5b49a789",
  "type": "OnPremises",
  "displayName": "ContosoGatewayCluster1",
  "publicKey": {
    "exponent": "AQGB",
    "modulus": "od9b...90Jp1Q=="
  },
  "version": "3000.1.2",
  "numberOfMemberGateways": 2,
  "loadBalancingSetting": "Failover",
  "allowCloudConnectionRefresh": false,
  "allowCustomConnectors": false
}

Virtual network gateway example

Örnek isteği

HTTP

PATCH https://api.fabric.microsoft.com/v1/gateways/7015263e-885f-455b-80f7-bbf862899176

{
  "type": "VirtualNetwork",
  "capacityId": "7cf7181f-9457-4178-b488-e7472b02faf4",
  "displayName": "ContosoVirtualNetworkGateway1",
  "inactivityMinutesBeforeSleep": 720,
  "numberOfMemberGateways": 5
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "7015263e-885f-455b-80f7-bbf862899176",
  "type": "VirtualNetwork",
  "displayName": "ContosoVirtualNetworkGateway1",
  "capacityId": "7cf7181f-9457-4178-b488-e7472b02faf4",
  "virtualNetworkAzureResource": {
    "subscriptionId": "879b4ba0-ed17-4ff2-851e-4a2228e00b70",
    "resourceGroupName": "ContosoResourceGroup",
    "virtualNetworkName": "ContosoVirtualNetwork",
    "subnetName": "ContosoSubnet"
  },
  "inactivityMinutesBeforeSleep": 720,
  "numberOfMemberGateways": 5
}

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
GatewayType	Ağ geçidinin türü. Zaman içinde ek ağ geçidi türleri eklenebilir.
LoadBalancingSetting	Ağ geçidi kümesinin yük dengeleme ayarı. Zaman içinde ek yük dengeleme ayarları eklenebilir.
OnPremisesGateway
OnPremisesGatewayPersonal
PublicKey	Şirket içi ağ geçidinin ortak anahtarı.
UpdateOnPremisesGatewayRequest
UpdateVirtualNetworkGatewayRequest
VirtualNetworkAzureResource	Sanal Ağ Azure kaynağının özellikleri
VirtualNetworkGateway

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

GatewayType

Numaralandırma

Ağ geçidinin türü. Zaman içinde ek ağ geçidi türleri eklenebilir.

Değer	Description
OnPremises	Şirket içi ağ geçidi.
OnPremisesPersonal	Şirket içi ağ geçidi (kişisel mod).
VirtualNetwork	Sanal ağ geçidi.

LoadBalancingSetting

Numaralandırma

Ağ geçidi kümesinin yük dengeleme ayarı. Zaman içinde ek yük dengeleme ayarları eklenebilir.

Değer	Description
Failover	İstekler kullanılabilir ilk ağ geçidi kümesi üyesine gönderilir.
DistributeEvenly	İstekler, etkinleştirilen tüm ağ geçidi kümesi üyeleri arasında eşit olarak dağıtılır.

OnPremisesGateway

Nesne

Name	Tür	Description
allowCloudConnectionRefresh	boolean	Bulut bağlantılarının bu şirket içi ağ geçidi aracılığıyla yenilenmesine izin verilip verilmeyeceği. True - İzin Ver, Yanlış - İzin verme.
allowCustomConnectors	boolean	Özel bağlayıcıların bu şirket içi ağ geçidiyle kullanılmasına izin verilip verilmeyeceği. True - İzin Ver, Yanlış - İzin verme.
displayName	string	Şirket içi ağ geçidinin görünen adı.
id	string (uuid)	Ağ geçidinin nesne kimliği.
loadBalancingSetting	LoadBalancingSetting	Şirket içi ağ geçidinin yük dengeleme ayarı.
numberOfMemberGateways	integer	Şirket içi ağ geçidindeki ağ geçidi üyelerinin sayısı.
publicKey	PublicKey	Birincil ağ geçidi üyesinin ortak anahtarı. Bağlantıları oluşturmak ve güncelleştirmek için kimlik bilgilerini şifrelemek için kullanılır.
type	string: OnPremises	Ağ geçidinin türü.
version	string	Yüklü birincil ağ geçidi üyesinin sürümü.

OnPremisesGatewayPersonal

Nesne

Name	Tür	Description
id	string (uuid)	Ağ geçidinin nesne kimliği.
publicKey	PublicKey	Ağ geçidinin ortak anahtarı. Bağlantıları oluşturmak ve güncelleştirmek için kimlik bilgilerini şifrelemek için kullanılır.
type	string: OnPremisesPersonal	Ağ geçidinin türü.
version	string	Ağ geçidinin sürümü.

PublicKey

Nesne

Şirket içi ağ geçidinin ortak anahtarı.

Name	Tür	Description
exponent	string	Ortak anahtarın üssü.
modulus	string	Ortak anahtarın modulus.

UpdateOnPremisesGatewayRequest

Nesne

Name	Tür	Description
allowCloudConnectionRefresh	boolean	Bulut bağlantılarının bu şirket içi ağ geçidi aracılığıyla yenilenmesine izin verilip verilmeyeceği. True - İzin Ver, Yanlış - İzin verme.
allowCustomConnectors	boolean	Özel bağlayıcıların bu şirket içi ağ geçidiyle kullanılmasına izin verilip verilmeyeceği. True - İzin Ver, Yanlış - İzin verme.
displayName	string	Ağ geçidinin adı. Uzunluk üst sınırı 200 karakterdir.
loadBalancingSetting	LoadBalancingSetting	Şirket içi ağ geçidinin yük dengeleme ayarı.
type	string: OnPremises	Ağ geçidinin türü.

UpdateVirtualNetworkGatewayRequest

Nesne

Name	Tür	Description
capacityId	string (uuid)	Doku lisans kapasitesinin nesne kimliği.
displayName	string	Ağ geçidinin adı. Uzunluk üst sınırı 200 karakterdir.
inactivityMinutesBeforeSleep	integer	Sanal ağ geçidi otomatik uyku moduna geçmeden önce geçen işlem yapılmadan geçen dakika sayısı. Şu değerlerden biri olmalıdır: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
numberOfMemberGateways	integer	Üye ağ geçitlerinin sayısı. 1 ile 9 arasında bir sayı.
type	string: VirtualNetwork	Ağ geçidinin türü.

VirtualNetworkAzureResource

Nesne

Sanal Ağ Azure kaynağının özellikleri

Name	Tür	Description
resourceGroupName	string	Kaynak grubunun adı
subnetName	string	Alt ağın adı
subscriptionId	string (uuid)	Abonelik kimliği
virtualNetworkName	string	Sanal ağın adı

VirtualNetworkGateway

Nesne

Name	Tür	Description
capacityId	string (uuid)	Doku lisans kapasitesinin nesne kimliği.
displayName	string	Sanal ağ geçidinin görünen adı.
id	string (uuid)	Ağ geçidinin nesne kimliği.
inactivityMinutesBeforeSleep	integer	Sanal ağ geçidi otomatik uyku moduna geçmeden önce geçen işlem yapılmadan geçen dakika sayısı.
numberOfMemberGateways	integer	Üye ağ geçitlerinin sayısı.
type	string: VirtualNetwork	Ağ geçidinin türü.
virtualNetworkAzureResource	VirtualNetworkAzureResource	Azure sanal ağ kaynağı.