Connections - Update Connection

Bağlantıyı kimlikle güncelleştirir.
Kimlik bilgilerini şifrelemek için bkz. Kimlik bilgilerini program aracılığıyla yapılandırma.

Permissions

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

Gerekli Temsilci Kapsamları

Connection.ReadWrite.All

Microsoft Entra tarafından desteklenen kimlikler

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

Identity Support
User Yes
Hizmet sorumlusu ve yönetilen kimlikler Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/connections/{connectionId}

URI Parametreleri

Veri Akışı Adı İçinde Gerekli Tür Description
connectionId
path True

string (uuid)

Bağlantının kimliği.

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Veri Akışı Adı Description
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest

Akış sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantıyı güncelleştirir.

UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Veri Akışı Adı Gerekli Tür Description
connectivityType True string:

OnPremisesGateway

Bağlantının bağlantı türü.

credentialDetails

UpdateOnPremisesGatewayCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateOnPremisesGatewayPersonalConnectionRequest

Veri Akışı Adı Gerekli Tür Description
connectivityType True string:

OnPremisesGatewayPersonal

Bağlantının bağlantı türü.

credentialDetails

UpdateOnPremisesGatewayPersonalCredentialDetails

Bağlantının kimlik bilgileri.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdatePersonalCloudConnectionRequest

Veri Akışı Adı Gerekli Tür Description
connectivityType True string:

PersonalCloud

Bağlantının bağlantı türü.

allowConnectionUsageInGateway

boolean

Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateShareableCloudConnectionRequest

Veri Akışı Adı Gerekli Tür Description
connectivityType True string:

ShareableCloud

Bağlantının bağlantı türü.

allowConnectionUsageInGateway

boolean

Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Akış sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantıyı güncelleştirir.

Veri Akışı Adı Gerekli Tür Description
connectivityType True string:

StreamingVirtualNetworkGateway

Bağlantının bağlantı türü.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateVirtualNetworkGatewayConnectionRequest

Veri Akışı Adı Gerekli Tür Description
connectivityType True string:

VirtualNetworkGateway

Bağlantının bağlantı türü.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

Yanıtlar

Veri Akışı Adı Tür Description
200 OK Connection:

OK. İş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ı:

  • EntityNotFound - İstenen kaynak bulunamadı.

  • InsufficientPermissionsToManageConnection - Çağıranın bu bağlantıyı yönetmek için yeterli izinleri yok.

  • DuplicateConnectionName - Bağlantı adı zaten kullanımda.

  • IncorrectCredentials - Kimlik Bilgileri girişi kullanılarak bağlantı kurulamadı.

  • UpdateGatewayConnectionFailed - Ağ geçidi bağlantısı güncelleştirilemedi.

Örnekler

On-premises gateway (personal mode) example
On-premises gateway example
Personal cloud example
Shareable cloud example
Streaming virtual network gateway example
Virtual network gateway example

On-premises gateway (personal mode) example

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/connections/ef8f408d-2ab7-4a18-b662-9251febda49c

{
  "connectivityType": "OnPremisesGatewayPersonal",
  "credentialDetails": {
    "credentials": {
      "credentialType": "WindowsWithoutImpersonation",
      "encryptedCredentials": "************************************"
    }
  }
}

Örnek yanıt

{
  "id": "ef8f408d-2ab7-4a18-b662-9251febda49c",
  "gatewayId": "429a773e-5633-45ee-8584-a192bd79c16a",
  "connectivityType": "OnPremisesGatewayPersonal",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;reporting"
  },
  "privacyLevel": "Private",
  "credentialDetails": {
    "credentialType": "WindowsWithoutImpersonation",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

On-premises gateway example

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/connections/70b17680-48f1-4729-9df6-02576647dc3a

{
  "connectivityType": "OnPremisesGateway",
  "displayName": "ContosoSalesOnPremisesConnection",
  "credentialDetails": {
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "c6961028-1309-4183-9799-a0b0fa28a235",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Örnek yanıt

{
  "id": "70b17680-48f1-4729-9df6-02576647dc3a",
  "displayName": "ContosoSalesOnPremisesConnection",
  "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Windows",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Personal cloud example

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/connections/7a0369b2-58c4-4b67-b3f3-92156a95f1cd

{
  "connectivityType": "PersonalCloud",
  "privacyLevel": "Organizational"
}

Örnek yanıt

{
  "id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "PersonalCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;finances"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "OAuth2",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Shareable cloud example

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/connections/fa968eee-8075-48f6-8c6d-41260ee1396d

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection"
}

Örnek yanıt

{
  "id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
  "displayName": "ContosoCloudConnection",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;networks"
  },
  "privacyLevel": "Public",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": true
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Streaming virtual network gateway example

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "StreamingVirtualNetworkGateway",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

Örnek yanıt

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "StreamingVirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  },
  "myRole": "Owner"
}

Virtual network gateway example

Örnek isteği

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "VirtualNetworkGateway",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

Örnek yanıt

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Tanımlar

Veri Akışı Adı Description
AnonymousCredentials

Anonim CredentialType için kimlik bilgileri.

BasicCredentials

Temel CredentialType için kimlik bilgileri.

ConnectionEncryption

Bağlantının bağlantı şifreleme türü. Zaman içinde ek bağlantı şifreleme değerleri eklenebilir.

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntılarını temsil eder.

ConnectionRole

Bağlantı rolü. Zaman içinde ek bağlantı rolleri eklenebilir.

ConnectivityType

Bağlantının bağlantı türü. Zaman içinde ek bağlantı türleri eklenebilir.

CredentialType

Bağlantının kimlik bilgisi türü. Zaman içinde ek kimlik bilgisi türleri eklenebilir.

ErrorParameter

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.

ErrorResponse

Hata yanıtı.

ErrorResponseDetails

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

KeyCredentials

Key CredentialType için kimlik bilgileri.

KeyPairCredentials

KeyPair CredentialType için kimlik bilgileri.

KeyVaultSecretReference

Azure Key Vault'ta depolanan bir gizli diziye başvuru.

ListConnectionDetails

Liste işlemleri için bağlantı ayrıntıları çıktısı.

ListCredentialDetails

Bağlantı getirilirken döndürülen kimlik bilgisi ayrıntıları.

OnPremisesCredentialEntry

Ağ geçidi kimliği ve şifrelenmiş serileştirilmiş kimlik bilgileri.

OnPremisesGatewayConnection

Şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.

OnPremisesGatewayCredentials

Şirket içi ağ geçidinde kimlik doğrulaması için kimlik bilgileri.

OnPremisesGatewayPersonalConnection

Kişisel şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.

OnPremisesGatewayPersonalCredentials

Şirket içi ağ geçidi (kişisel mod) aracılığıyla kimlik doğrulaması için kimlik bilgileri.

PersonalCloudConnection

Bulut üzerinden bağlanan ve paylaşılamayan bir bağlantı.

PrivacyLevel

Bağlantının gizlilik düzeyi ayarı. Zaman içinde ek gizlilik düzeyleri eklenebilir.

ServicePrincipalCredentials

ServicePrincipal CredentialType kimlik bilgileri.

ShareableCloudConnection

Bulut üzerinden bağlanan bir bağlantı.

SharedAccessSignatureCredentials

SharedAccessSignature CredentialType kimlik bilgileri.

SingleSignOnType

Bağlantının çoklu oturum açma türü. Zaman içinde ek çoklu oturum açma türleri eklenebilir.

StreamingVirtualNetworkGatewayConnection

Akış sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantı.

UpdateCredentialDetails

Kimlik bilgisi, bir bağlantıyı güncelleştirmek için giriş bilgilerini gösterir.

UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails

Şirket içi ağ geçidi bağlantısını güncelleştirmek için kimlik bilgisi ayrıntıları girişi.

UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails

Şirket içi ağ geçidi bağlantısını güncelleştirmek için kimlik bilgisi ayrıntıları girişi.

UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest

Akış sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantıyı güncelleştirir.

UpdateVirtualNetworkGatewayConnectionRequest
VirtualNetworkGatewayConnection

Sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantı.

WindowsCredentials

Windows CredentialType için kimlik bilgileri.

WindowsWithoutImpersonationCredentials

WindowsWithoutImpersonation CredentialType kimlik bilgileri.

WorkspaceIdentityCredentials

WorkspaceIdentity CredentialType kimlik bilgileri.

AnonymousCredentials

Anonim CredentialType için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

Anonymous

Bağlantının kimlik bilgisi türü.

BasicCredentials

Temel CredentialType için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

Basic

Bağlantının kimlik bilgisi türü.

password

string

Parola. Password veya passwordReference kullanın. Her ikisini aynı anda kullanamazsınız

passwordReference

KeyVaultSecretReference

Azure Key Vault'ta depolanan parola başvurusu. Password veya passwordReference kullanın. İkisini de aynı anda kullanamazsınız.

username

string

Kullanıcı adı.

ConnectionEncryption

Bağlantının bağlantı şifreleme türü. Zaman içinde ek bağlantı şifreleme değerleri eklenebilir.

Değer Description
Encrypted

Bağlantı girişimi şifreli bir bağlantı kullanılarak yapılır.

Any

Bağlantı girişimi önce şifreli bir bağlantı kullanılarak yapılır, ardından başarısız olursa şifrelenmemiş bağlantıya geri döner.

NotEncrypted

Bağlantı girişimi şifrelenmemiş bir bağlantı kullanılarak yapılır.

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntılarını temsil eder.

Veri Akışı Adı Tür Description
createdDateTime

string (date-time)

YYYY-MM-DDTHH:mm:ssZ biçimi kullanılarak utc'de bağlantının oluşturulduğu zaman damgası.

lastBoundDateTime

string (date-time)

YYYY-AA-GGTHH:mm:ssZ biçimini kullanarak, bağlantının UTC'deki herhangi bir öğeye en son bağlı olduğu zaman damgası.

lastCredentialUsedDateTime

string (date-time)

YYYY-MM-DDTHH:mm:ssZ biçimi kullanılarak, bağlantı kimlik bilgilerinin en son UTC'de kullanıldığı zaman damgası.

myLastBoundDateTime

string (date-time)

YYYY-AA-GGTHH:mm:ssZ biçimini kullanarak utc'de çağıran kullanıcı tarafından bağlantının en son herhangi bir öğeye bağlı olduğu zaman damgası.

myLastCredentialUsedDateTime

string (date-time)

YYYY-MM-DDTHH:mm:ssZ biçimi kullanılarak, utc'de çağıran kullanıcı tarafından bağlantı kimlik bilgilerinin en son kullanıldığı zaman damgası.

ConnectionRole

Bağlantı rolü. Zaman içinde ek bağlantı rolleri eklenebilir.

Değer Description
User

Bağlantı için kullanıcı erişimini etkinleştirir.

UserWithReshare

Bağlantı için yeniden paylaşma erişimi olan kullanıcıyı etkinleştirir.

Owner

Bağlantı için sahiplik erişimini etkinleştirir.

PendingOwner

Bağlantının sahipliği henüz etkili değildir; sorumlunun etkili olması için bağlantı kimlik bilgilerini ( Güncelleştirme Bağlantısı API'sini kullanarak) güncelleştirmesi gerekir.

ConnectivityType

Bağlantının bağlantı türü. Zaman içinde ek bağlantı türleri eklenebilir.

Değer Description
ShareableCloud

Bağlantı bulut üzerinden bağlanır ve başkalarıyla paylaşılabilir.

PersonalCloud

Bağlantı bulut üzerinden bağlanır ve başkalarıyla paylaşılamaz.

OnPremisesGateway

Bağlantı, şirket içi veri ağ geçidi üzerinden bağlanır.

OnPremisesGatewayPersonal

Bağlantı, kişisel bir şirket içi veri ağ geçidi üzerinden bağlanır.

VirtualNetworkGateway

Bağlantı bir sanal ağ veri ağ geçidi üzerinden bağlanır.

StreamingVirtualNetworkGateway

Bağlantı, akış sanal ağ veri ağ geçidi üzerinden bağlanır.

Automatic

Bağlantı, örtük bir veri bağlantısı kullanarak bulut üzerinden bağlanır. Bu seçenek yalnızca Tek Sign-On (SSO) kullanan anlamsal modeller gibi belirli senaryolarda kullanılabilir."

None

Bağlantı bağlı değil

CredentialType

Bağlantının kimlik bilgisi türü. Zaman içinde ek kimlik bilgisi türleri eklenebilir.

Değer Description
Windows

Bağlantı, bağlanmak için Windows kimlik doğrulamasını kullanır. Yalnızca şirket içi ağ geçitleri için desteklenir.

Anonymous

Bağlantı, bağlanmak için anonim kimlik doğrulaması kullanır.

Basic

Bağlantı, bağlanmak için temel kimlik doğrulamasını kullanır.

Key

Bağlantı, bağlanmak için anahtar kimlik doğrulamasını kullanır.

OAuth2

Bağlantı, bağlanmak için OAuth 2.0 kimlik doğrulamasını kullanır.

WindowsWithoutImpersonation

Bağlantı, bağlanmak için Windows (kimliğe bürünme seçeneği olmadan) kimlik doğrulamasını kullanır. Yalnızca şirket içi ağ geçitleri (kişisel mod) için desteklenir.

SharedAccessSignature

Bağlantı, bağlanmak için paylaşılan erişim imzası (SAS) kimlik doğrulamasını kullanır.

ServicePrincipal

Bağlantı, bağlanmak için hizmet sorumlusu kimlik doğrulamasını kullanır.

WorkspaceIdentity

Bağlantı, bağlanmak için çalışma alanı kimliği kimlik doğrulamasını kullanır.

KeyPair

Bağlantı, bağlanmak için anahtar çifti kimlik doğrulamasını kullanır.

ErrorParameter

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

Veri Akışı Adı Tür Description
message

string

Parametrenin anlamının insan tarafından okunabilen açıklaması.

name

string

Parametre tanımlayıcısı.

value

string

Parametre değeridir.

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.

Veri Akışı Adı Tür Description
resourceId

string

Hataya dahil olan kaynak kimliği.

resourceType

string

Hataya dahil olan kaynağın türü.

ErrorResponse

Hata yanıtı.

Veri Akışı Adı 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.

parameters

ErrorParameter[]

Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.

relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

requestId

string (uuid)

Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

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

Veri Akışı Adı 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.

parameters

ErrorParameter[]

Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.

relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

KeyCredentials

Key CredentialType için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

Key

Bağlantının kimlik bilgisi türü.

key

string

Anahtar. key veya keyReference kullanın. İkisini de aynı anda kullanamazsınız.

keyReference

KeyVaultSecretReference

Azure Key Vault'ta depolanan bir anahtara başvuru. key veya keyReference kullanın. İkisini de aynı anda kullanamazsınız.

KeyPairCredentials

KeyPair CredentialType için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

KeyPair

Bağlantının kimlik bilgisi türü.

identifier

string

Anahtarın tanımlayıcısı.

passphrase

string

Özel anahtar şifrelenirse özel anahtarın parolası.

privateKey

string

PKCS #8 standardını temel alan özel anahtar.

KeyVaultSecretReference

Azure Key Vault'ta depolanan bir gizli diziye başvuru.

Veri Akışı Adı Tür Description
connectionId

string (uuid)

Key Vault bağlantısının bağlantı kimliği.

secretName

string

Key Vault'taki gizli dizinin adı.

version

string

Key Vault'taki gizli dizi sürümü.

ListConnectionDetails

Liste işlemleri için bağlantı ayrıntıları çıktısı.

Veri Akışı Adı Tür Description
path

string

Bağlantının yolu.

type

string

Bağlantının türü.

ListCredentialDetails

Bağlantı getirilirken döndürülen kimlik bilgisi ayrıntıları.

Veri Akışı Adı Tür Description
connectionEncryption

ConnectionEncryption

Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı.

credentialType

CredentialType

Bağlantının kimlik bilgisi türü.

singleSignOnType

SingleSignOnType

Bağlantının çoklu oturum açma türü.

skipTestConnection

boolean

Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın.

OnPremisesCredentialEntry

Ağ geçidi kimliği ve şifrelenmiş serileştirilmiş kimlik bilgileri.

Veri Akışı Adı Tür Description
encryptedCredentials

string

Ad değer çiftleri listesinin şifrelenmiş serileştirilmiş .json. Ad bir kimlik bilgisi adı ve değer bir kimlik bilgisi değeridir. Şifreleme, şirket içi ağ geçidi üyesinin ortak anahtarıyla Rivest-Shamir-Adleman (RSA) şifreleme algoritması kullanılarak gerçekleştirilir.

gatewayId

string (uuid)

Ağ geçidinin nesne kimliği.

OnPremisesGatewayConnection

Şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.

Veri Akışı Adı Tür Description
connectionDetails

ListConnectionDetails

Bağlantının bağlantı ayrıntıları.

connectionRecency

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntıları.

connectivityType string:

OnPremisesGateway

Bağlantının bağlantı türü.

credentialDetails

ListCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı.

gatewayId

string (uuid)

Bağlantının yapıldığı ağ geçidi nesne kimliği. Bulut bağlantıları için bu sanal ağ geçidi kimliğidir.

id

string (uuid)

Bağlantının nesne kimliği.

myRole

ConnectionRole

Çağrı sorumlusunun bağlantıdaki etkin rolü. Sorumlu farklı rollere sahip birden çok güvenlik grubunun parçası olduğunda, en yüksek rol döndürülür. Sorumlunun bağlantıda rolü yoksa, bu özellik döndürülmedi.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

OnPremisesGatewayCredentials

Şirket içi ağ geçidinde kimlik doğrulaması için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType

CredentialType

Bağlantının kimlik bilgisi türü.

values

OnPremisesCredentialEntry[]

Şirket içi ağ geçidine gönderilecek kimlik bilgisi yükü.

OnPremisesGatewayPersonalConnection

Kişisel şirket içi veri ağ geçidi üzerinden bağlanan bir bağlantı.

Veri Akışı Adı Tür Description
connectionDetails

ListConnectionDetails

Bağlantının bağlantı ayrıntıları.

connectionRecency

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntıları.

connectivityType string:

OnPremisesGatewayPersonal

Bağlantının bağlantı türü.

credentialDetails

ListCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı.

gatewayId

string (uuid)

Bağlantının yapıldığı ağ geçidi nesne kimliği. Bulut bağlantıları için bu sanal ağ geçidi kimliğidir.

id

string (uuid)

Bağlantının nesne kimliği.

myRole

ConnectionRole

Çağrı sorumlusunun bağlantıdaki etkin rolü. Sorumlu farklı rollere sahip birden çok güvenlik grubunun parçası olduğunda, en yüksek rol döndürülür. Sorumlunun bağlantıda rolü yoksa, bu özellik döndürülmedi.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

OnPremisesGatewayPersonalCredentials

Şirket içi ağ geçidi (kişisel mod) aracılığıyla kimlik doğrulaması için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType

CredentialType

Bağlantının kimlik bilgisi türü.

encryptedCredentials

string

Ad değer çiftleri listesinin şifrelenmiş serileştirilmiş .json. Ad bir kimlik bilgisi adı ve değer bir kimlik bilgisi değeridir. Şifreleme, şirket içi ağ geçidinin ortak anahtarıyla Rivest-Shamir-Adleman (RSA) şifreleme algoritması kullanılarak gerçekleştirilir.

PersonalCloudConnection

Bulut üzerinden bağlanan ve paylaşılamayan bir bağlantı.

Veri Akışı Adı Tür Description
allowConnectionUsageInGateway

boolean

Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.

connectionDetails

ListConnectionDetails

Bağlantının bağlantı ayrıntıları.

connectionRecency

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntıları.

connectivityType string:

PersonalCloud

Bağlantının bağlantı türü.

credentialDetails

ListCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı.

gatewayId

string (uuid)

Bağlantının yapıldığı ağ geçidi nesne kimliği. Bulut bağlantıları için bu sanal ağ geçidi kimliğidir.

id

string (uuid)

Bağlantının nesne kimliği.

myRole

ConnectionRole

Çağrı sorumlusunun bağlantıdaki etkin rolü. Sorumlu farklı rollere sahip birden çok güvenlik grubunun parçası olduğunda, en yüksek rol döndürülür. Sorumlunun bağlantıda rolü yoksa, bu özellik döndürülmedi.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

PrivacyLevel

Bağlantının gizlilik düzeyi ayarı. Zaman içinde ek gizlilik düzeyleri eklenebilir.

Değer Description
None

Hiçbir gizlilik düzeyi ayarı yapılandırılmadı.

Private

Özel olarak ayarlanan bağlantılar hassas veya gizli bilgiler içerir. Görünürlük yetkili kullanıcılarla sınırlandırılabilir. Özel bağlantıdaki veriler, diğer özel bağlantılar da dahil olmak üzere diğer bağlantılara katlanamaz.

Organizational

Kuruluşa ayarlanan bağlantılar, özel ve diğer kuruluş bağlantılarına katlanabilir. Ortak bağlantılara katlayamazlar. Görünürlük güvenilir bir gruba ayarlanır.

Public

Dosyalar, internet bağlantıları ve çalışma kitabı verileri genel olarak ayarlanabilir. Veriler diğer bağlantılara katlanabilir. Görünürlük herkes tarafından kullanılabilir.

ServicePrincipalCredentials

ServicePrincipal CredentialType kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

ServicePrincipal

Bağlantının kimlik bilgisi türü.

servicePrincipalClientId

string (uuid)

Hizmet sorumlusunun istemci kimliği.

servicePrincipalSecret

string

Hizmet sorumlusunun gizli dizisi. servicePrincipalSecret veya servicePrincipalSecretReference kullanın. İkisini de aynı anda kullanamazsınız.

servicePrincipalSecretReference

KeyVaultSecretReference

Azure Key Vault'ta depolanan bir hizmet sorumlusu gizli dizisine başvuru. servicePrincipalSecret veya servicePrincipalSecretReference kullanın. İkisini de aynı anda kullanamazsınız.

tenantId

string (uuid)

Hizmet sorumlusunun kiracı kimliği.

ShareableCloudConnection

Bulut üzerinden bağlanan bir bağlantı.

Veri Akışı Adı Tür Description
allowConnectionUsageInGateway

boolean

Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.

allowUsageInUserControlledCode

boolean

Bu bağlantının Not Defteri gibi kullanıcı tarafından denetlenen koda izin veren öğelerle kullanılmasına izin verin.

connectionDetails

ListConnectionDetails

Bağlantının bağlantı ayrıntıları.

connectionRecency

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntıları.

connectivityType string:

ShareableCloud

Bağlantının bağlantı türü.

credentialDetails

ListCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı.

gatewayId

string (uuid)

Bağlantının yapıldığı ağ geçidi nesne kimliği. Bulut bağlantıları için bu sanal ağ geçidi kimliğidir.

id

string (uuid)

Bağlantının nesne kimliği.

myRole

ConnectionRole

Çağrı sorumlusunun bağlantıdaki etkin rolü. Sorumlu farklı rollere sahip birden çok güvenlik grubunun parçası olduğunda, en yüksek rol döndürülür. Sorumlunun bağlantıda rolü yoksa, bu özellik döndürülmedi.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

SharedAccessSignatureCredentials

SharedAccessSignature CredentialType kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

SharedAccessSignature

Bağlantının kimlik bilgisi türü.

token

string

Belirteç. Token veya tokenReference kullanın. İkisini de aynı anda kullanamazsınız.

tokenReference

KeyVaultSecretReference

Azure Key Vault'ta depolanan bir belirtecin başvurusu. Token veya tokenReference kullanın. İkisini de aynı anda kullanamazsınız.

SingleSignOnType

Bağlantının çoklu oturum açma türü. Zaman içinde ek çoklu oturum açma türleri eklenebilir.

Değer Description
None

Bağlantı, bağlanmak için çoklu oturum açma kullanmaz.

Kerberos

Bağlantı, bağlanmak için Kerberos çoklu oturum açma kullanır.

MicrosoftEntraID

Bağlantı, bağlanmak için Microsoft Entra ID çoklu oturum açmayı kullanır.

SecurityAssertionMarkupLanguage

Bağlantı, bağlanmak için Güvenlik Onaylama İşaretleme Dili (SAML) çoklu oturum açma kullanır.

KerberosDirectQueryAndRefresh

Bağlantı, bağlanmak için Kerberos DirectQuery ve Refresh çoklu oturum açmayı kullanır.

StreamingVirtualNetworkGatewayConnection

Akış sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantı.

Veri Akışı Adı Tür Description
connectionDetails

ListConnectionDetails

Bağlantının bağlantı ayrıntıları.

connectionRecency

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntıları.

connectivityType string:

StreamingVirtualNetworkGateway

Bağlantının bağlantı türü.

credentialDetails

ListCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı.

gatewayId

string (uuid)

Bağlantının ağ geçidi nesne kimliği.

id

string (uuid)

Bağlantının nesne kimliği.

myRole

ConnectionRole

Çağrı sorumlusunun bağlantıdaki etkin rolü. Sorumlu farklı rollere sahip birden çok güvenlik grubunun parçası olduğunda, en yüksek rol döndürülür. Sorumlunun bağlantıda rolü yoksa, bu özellik döndürülmedi.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateCredentialDetails

Kimlik bilgisi, bir bağlantıyı güncelleştirmek için giriş bilgilerini gösterir.

Veri Akışı Adı Tür Description
connectionEncryption

ConnectionEncryption

Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı.

credentials Credentials:

Bağlantının kimlik bilgileri.

singleSignOnType

SingleSignOnType

Bağlantının çoklu oturum açma türü.

skipTestConnection

boolean

Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın.

UpdateOnPremisesGatewayConnectionRequest

Veri Akışı Adı Tür Description
connectivityType string:

OnPremisesGateway

Bağlantının bağlantı türü.

credentialDetails

UpdateOnPremisesGatewayCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateOnPremisesGatewayCredentialDetails

Şirket içi ağ geçidi bağlantısını güncelleştirmek için kimlik bilgisi ayrıntıları girişi.

Veri Akışı Adı Tür Description
connectionEncryption

ConnectionEncryption

Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı.

credentials

OnPremisesGatewayCredentials

Bağlantının kimlik bilgileri.

singleSignOnType

SingleSignOnType

Bağlantının çoklu oturum açma türü.

skipTestConnection

boolean

Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın.

UpdateOnPremisesGatewayPersonalConnectionRequest

Veri Akışı Adı Tür Description
connectivityType string:

OnPremisesGatewayPersonal

Bağlantının bağlantı türü.

credentialDetails

UpdateOnPremisesGatewayPersonalCredentialDetails

Bağlantının kimlik bilgileri.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateOnPremisesGatewayPersonalCredentialDetails

Şirket içi ağ geçidi bağlantısını güncelleştirmek için kimlik bilgisi ayrıntıları girişi.

Veri Akışı Adı Tür Description
connectionEncryption

ConnectionEncryption

Test bağlantısı sırasında kullanılan bağlantı şifreleme ayarı.

credentials

OnPremisesGatewayPersonalCredentials

Bağlantının kimlik bilgileri.

singleSignOnType

SingleSignOnType

Bağlantının çoklu oturum açma türü.

skipTestConnection

boolean

Oluşturma ve güncelleştirme sırasında bağlantının test bağlantısını atlayıp atlamaması. True - Test bağlantısını atla, False - Test bağlantısını atlamayın.

UpdatePersonalCloudConnectionRequest

Veri Akışı Adı Tür Description
allowConnectionUsageInGateway

boolean

Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.

connectivityType string:

PersonalCloud

Bağlantının bağlantı türü.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateShareableCloudConnectionRequest

Veri Akışı Adı Tür Description
allowConnectionUsageInGateway

boolean

Bu bağlantının şirket içi veri ağ geçitleriyle veya sanal ağ veri ağ geçitleriyle kullanılmasına izin verin.

connectivityType string:

ShareableCloud

Bağlantının bağlantı türü.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Akış sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantıyı güncelleştirir.

Veri Akışı Adı Tür Description
connectivityType string:

StreamingVirtualNetworkGateway

Bağlantının bağlantı türü.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

UpdateVirtualNetworkGatewayConnectionRequest

Veri Akışı Adı Tür Description
connectivityType string:

VirtualNetworkGateway

Bağlantının bağlantı türü.

credentialDetails

UpdateCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı. Uzunluk üst sınırı 200 karakterdir.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

VirtualNetworkGatewayConnection

Sanal ağ veri ağ geçidi üzerinden bağlanan bir bağlantı.

Veri Akışı Adı Tür Description
connectionDetails

ListConnectionDetails

Bağlantının bağlantı ayrıntıları.

connectionRecency

ConnectionRecency

Bağlantı hakkındaki geri kazanma ayrıntıları.

connectivityType string:

VirtualNetworkGateway

Bağlantının bağlantı türü.

credentialDetails

ListCredentialDetails

Bağlantının kimlik bilgileri.

displayName

string

Bağlantının görünen adı.

gatewayId

string (uuid)

Bağlantının yapıldığı ağ geçidi nesne kimliği. Bulut bağlantıları için bu sanal ağ geçidi kimliğidir.

id

string (uuid)

Bağlantının nesne kimliği.

myRole

ConnectionRole

Çağrı sorumlusunun bağlantıdaki etkin rolü. Sorumlu farklı rollere sahip birden çok güvenlik grubunun parçası olduğunda, en yüksek rol döndürülür. Sorumlunun bağlantıda rolü yoksa, bu özellik döndürülmedi.

privacyLevel

PrivacyLevel

Bağlantının gizlilik düzeyi.

WindowsCredentials

Windows CredentialType için kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

Windows

Bağlantının kimlik bilgisi türü.

password

string

Parola.

username

string

Kullanıcı adı.

WindowsWithoutImpersonationCredentials

WindowsWithoutImpersonation CredentialType kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

WindowsWithoutImpersonation

Bağlantının kimlik bilgisi türü.

WorkspaceIdentityCredentials

WorkspaceIdentity CredentialType kimlik bilgileri.

Veri Akışı Adı Tür Description
credentialType string:

WorkspaceIdentity

Bağlantının kimlik bilgisi türü.