Connections - Update Connection

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Päivittää yhteyden tunnuksen mukaan.
Jos haluat salata tunnistetiedot, katso Tunnistetietojen määrittäminen ohjelmallisesti.

Permissions

Soittajalla on oltava yhteyden yhdyskäytävän tai järjestelmänvalvojan oikeudet.

Vaaditut delegoidut vaikutusalueet

Connection.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identity	Support
User	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Interface

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
connectionId	path	True	string (uuid)	Yhteyden tunnus.

Pyynnön leipäteksti

Pyynnön teksti voi olla jokin seuraavista:

Nimi	Kuvaus
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Päivittää yhteyden, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Nimi	Pakollinen	Tyyppi	Kuvaus
connectivityType	True	string: OnPremisesGateway	Yhteyden yhteystyyppi.
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	Yhteyden tunnistetiedot.
displayName		string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel		PrivacyLevel	Yhteyden yksityisyystaso.

UpdateOnPremisesGatewayPersonalConnectionRequest

Nimi	Pakollinen	Tyyppi	Kuvaus
connectivityType	True	string: OnPremisesGatewayPersonal	Yhteyden yhteystyyppi.
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	Yhteyden tunnistetiedot.
privacyLevel		PrivacyLevel	Yhteyden yksityisyystaso.

UpdatePersonalCloudConnectionRequest

Nimi	Pakollinen	Tyyppi	Kuvaus
connectivityType	True	string: PersonalCloud	Yhteyden yhteystyyppi.
allowConnectionUsageInGateway		boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
credentialDetails		UpdateCredentialDetails	Yhteyden tunnistetiedot.
privacyLevel		PrivacyLevel	Yhteyden yksityisyystaso.

UpdateShareableCloudConnectionRequest

Nimi	Pakollinen	Tyyppi	Kuvaus
connectivityType	True	string: ShareableCloud	Yhteyden yhteystyyppi.
allowConnectionUsageInGateway		boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
credentialDetails		UpdateCredentialDetails	Yhteyden tunnistetiedot.
displayName		string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel		PrivacyLevel	Yhteyden yksityisyystaso.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Päivittää yhteyden, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.

Nimi	Pakollinen	Tyyppi	Kuvaus
connectivityType	True	string: StreamingVirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails		UpdateCredentialDetails	Yhteyden tunnistetiedot.
displayName		string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel		PrivacyLevel	Yhteyden yksityisyystaso.

UpdateVirtualNetworkGatewayConnectionRequest

Nimi	Pakollinen	Tyyppi	Kuvaus
connectivityType	True	string: VirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails		UpdateCredentialDetails	Yhteyden tunnistetiedot.
displayName		string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel		PrivacyLevel	Yhteyden yksityisyystaso.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Toiminto onnistui.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: EntityNotFound – Pyydettyä resurssia ei löytynyt. InsufficientPermissionsToManageConnection – Soittajalla ei ole riittäviä käyttöoikeuksia tämän yhteyden hallintaan. DuplicateConnectionName – Yhteyden nimi on jo käytössä. IncorrectCredentials – Yhteyden muodostaminen tunnistetietojen syötettä käyttämällä epäonnistui. UpdateGatewayConnectionFailed – Yhdyskäytäväyhteyden päivittäminen epäonnistui.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OK. Toiminto onnistui.

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

EntityNotFound – Pyydettyä resurssia ei löytynyt.
InsufficientPermissionsToManageConnection – Soittajalla ei ole riittäviä käyttöoikeuksia tämän yhteyden hallintaan.
DuplicateConnectionName – Yhteyden nimi on jo käytössä.
IncorrectCredentials – Yhteyden muodostaminen tunnistetietojen syötettä käyttämällä epäonnistui.
UpdateGatewayConnectionFailed – Yhdyskäytäväyhteyden päivittäminen epäonnistui.

Esimerkit

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

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 200

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

Mallipyyntö

HTTP

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": "************************************"
        }
      ]
    }
  }
}

Mallivastaus

Tilakoodi:: 200

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

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 200

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

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 200

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

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 200

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

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 200

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

Määritelmät

Nimi	Kuvaus
AnonymousCredentials	Anonyymin tunnistetietotyypin tunnistetiedot.
BasicCredentials	Perustunnistetietotyypin tunnistetiedot.
ConnectionEncryption	Yhteyden salaustyyppi. Yhteyden salausarvoja voidaan lisätä ajan mittaan.
ConnectionRecency	Edustaa yhteyden suoritetietojen tietoja.
ConnectionRole	Yhteysrooli. Lisää yhteysrooleja voidaan lisätä ajan mittaan.
ConnectivityType	Yhteyden yhteystyyppi. Muita yhteystyyppejä voidaan lisätä ajan mittaan.
CredentialType	Yhteyden tunnistetietotyyppi. Muita tunnistetietotyyppejä voidaan lisätä ajan mittaan.
ErrorParameter	Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
KeyCredentials	Avaimen tunnistetietotyypin tunnistetiedot.
KeyPairCredentials	KeyPair-tunnistetietotyypin tunnistetiedot.
KeyVaultSecretReference	Viittaus Azure Key Vaultiin tallennettuun salaiseen koodiin.
ListConnectionDetails	Yhteyden tietojen tuloste luettelotoiminnoille.
ListCredentialDetails	Yhteyden noutamisen yhteydessä palautetut tunnistetietojen tiedot.
OnPremisesCredentialEntry	Yhdyskäytävän tunnus ja sen salatut sarjoitetut tunnistetiedot.
OnPremisesGatewayConnection	Yhteys, joka muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.
OnPremisesGatewayCredentials	Tunnistetiedot todentamiseen paikallisen yhdyskäytävän kautta.
OnPremisesGatewayPersonalConnection	Yhteys, joka muodostaa yhteyden henkilökohtaisen paikallisen tietoyhdyskäytävän kautta.
OnPremisesGatewayPersonalCredentials	Tunnistetiedot todentamiseen paikallisen yhdyskäytävän (henkilökohtainen tila) kautta.
PersonalCloudConnection	Yhteys, joka muodostaa yhteyden pilvipalvelun kautta eikä sitä voi jakaa.
PrivacyLevel	Yhteyden yksityisyystaso. Lisää yksityisyystasoja voidaan lisätä ajan mittaan.
ServicePrincipalCredentials	ServicePrincipal-tunnistetietotyypin tunnistetiedot.
ShareableCloudConnection	Yhteys, joka muodostaa yhteyden pilvipalvelun kautta.
SharedAccessSignatureCredentials	SharedAccessSignature-tunnistetietotyypin tunnistetiedot.
SingleSignOnType	Yhteyden kertakirjautumistyyppi. Muita kertakirjautumistyyppejä voidaan lisätä ajan mittaan.
StreamingVirtualNetworkGatewayConnection	Yhteys, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.
UpdateCredentialDetails	Tunnistetietojen syöte yhteyden päivittämistä varten.
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	Tunnistetietojen syöte paikallisen yhdyskäytäväyhteyden päivittämistä varten.
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	Tunnistetietojen syöte paikallisen yhdyskäytäväyhteyden päivittämistä varten.
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Päivittää yhteyden, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.
UpdateVirtualNetworkGatewayConnectionRequest
VirtualNetworkGatewayConnection	Yhteys, joka muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.
WindowsCredentials	Windowsin tunnistetietotyypin tunnistetiedot.
WindowsWithoutImpersonationCredentials	WindowsWithoutImpersonation-tunnistetietotyypin tunnistetiedot.
WorkspaceIdentityCredentials	WorkspaceIdentity CredentialType-asetuksen tunnistetiedot.

AnonymousCredentials

Kohde

Anonyymin tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: Anonymous	Yhteyden tunnistetietotyyppi.

BasicCredentials

Kohde

Perustunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: Basic	Yhteyden tunnistetietotyyppi.
password	string	Salasana. Käytä salasanaa tai salasanaaReference. Et voi käyttää molempia samanaikaisesti.
passwordReference	KeyVaultSecretReference	Viittaus Azure Key Vaultiin tallennettuun salasanaan. Käytä salasanaa tai salasanaaReference. Molempia ei voi käyttää samanaikaisesti.
username	string	Käyttäjänimi.

ConnectionEncryption

Luettelointi

Yhteyden salaustyyppi. Yhteyden salausarvoja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Encrypted	Yhteysyritys tehdään salatulla yhteydellä.
Any	Yhteysyritys tehdään ensin salatulla yhteydellä, joka sitten palaa salaamattomaan yhteyteen, jos se epäonnistuu.
NotEncrypted	Yhteysyritys tehdään salaamattomalla yhteydellä.

ConnectionRecency

Kohde

Edustaa yhteyden suoritetietojen tietoja.

Nimi	Tyyppi	Kuvaus
createdDateTime	string (date-time)	Aikaleima, kun yhteys luotiin UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Aikaleima, jolloin yhteys viimeksi sidottiin mihin tahansa UTC-kohteeseen muodossa VVVV-KK-PPTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Aikaleima, jolloin yhteyden tunnistetietoja viimeksi käytettiin UTC-muodossa VVVV-KK-PPTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Aikaleima, jolloin UTC-käyttäjä viimeksi sitoi yhteyden mihin tahansa kohteeseen muodossa VVVVV-KK-PPTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Aikaleima yhteyden tunnistetietojen viimeksi UTC-kirjautumistunnuksista käyttämällä VVVV-KK-PPTHH:mm:ssZ-muotoa.

ConnectionRole

Luettelointi

Yhteysrooli. Lisää yhteysrooleja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
User	Mahdollistaa yhteyden käytön käyttäjälle.
UserWithReshare	Sallii käyttäjälle yhteyden uudelleenjakamisoikeuden.
Owner	Mahdollistaa yhteyden omistajuuden.
PendingOwner	Yhteyden omistajuus ei ole vielä voimassa. -päänimen on päivitettävä yhteyden tunnistetiedot ( yhteyden ohjelmointirajapinnan päivityksen avulla), jotta se on tehokas.

ConnectivityType

Luettelointi

Yhteyden yhteystyyppi. Muita yhteystyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
ShareableCloud	Yhteys muodostaa yhteyden pilvipalvelun kautta ja voidaan jakaa muiden kanssa.
PersonalCloud	Yhteys muodostaa yhteyden pilvipalvelun kautta, eikä sitä voi jakaa muiden kanssa.
OnPremisesGateway	Yhteys muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.
OnPremisesGatewayPersonal	Yhteys muodostaa yhteyden henkilökohtaisen paikallisen tietoyhdyskäytävän kautta.
VirtualNetworkGateway	Yhteys muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.
StreamingVirtualNetworkGateway	Yhteys muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.
Automatic	Yhteys muodostaa yhteyden pilvipalvelun kautta implisiittisen tietoyhteyden avulla. Tämä vaihtoehto on käytettävissä vain tietyissä tilanteissa, kuten semanttisissa malleissa, joissa käytetään yksittäistä Sign-On (SSO).
None	Yhteyttä ei ole sidottu

CredentialType

Luettelointi

Yhteyden tunnistetietotyyppi. Muita tunnistetietotyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Windows	Yhteys muodostaa yhteyden Windows-todennuksen avulla. Vain paikalliset yhdyskäytävät tukevat tätä.
Anonymous	Yhteys muodostaa yhteyden anonyymin todennuksen avulla.
Basic	Yhteys muodostaa yhteyden perustodennuksen avulla.
Key	Yhteys muodostaa yhteyden avaintodennuksen avulla.
OAuth2	Yhteys käyttää OAuth 2.0 -todennusta yhteyden muodostamiseen.
WindowsWithoutImpersonation	Yhteys käyttää Windows-todennusta (ilman tekeytymisvaihtoehtoa). Vain paikalliset yhdyskäytävät (henkilökohtainen tila) tukevat tätä.
SharedAccessSignature	Yhteys käyttää SAS-todennusta yhteyden muodostamiseen.
ServicePrincipal	Yhteys muodostaa yhteyden palvelun päänimen todentamisen avulla.
WorkspaceIdentity	Yhteys muodostaa yhteyden työtilan käyttäjätietojen todennuksen avulla.
KeyPair	Yhteys muodostaa yhteyden avainparitodennuksen avulla.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi	Tyyppi	Kuvaus
message	string	Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name	string	Parametritunniste.
value	string	Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
parameters	ErrorParameter[]	Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

KeyCredentials

Kohde

Avaimen tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: Key	Yhteyden tunnistetietotyyppi.
key	string	Avain. Käytä avainta tai keyReference-näppäintä. Molempia ei voi käyttää samanaikaisesti.
keyReference	KeyVaultSecretReference	Viittaus Azure Key Vaultiin tallennettuun avaimeen. Käytä avainta tai keyReference-näppäintä. Molempia ei voi käyttää samanaikaisesti.

KeyPairCredentials

Kohde

KeyPair-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: KeyPair	Yhteyden tunnistetietotyyppi.
identifier	string	Avaimen tunnus.
passphrase	string	Yksityisen avaimen tunnuslause, jos yksityinen avain on salattu.
privateKey	string	Yksityinen avain, joka perustuu PKCS #8 -standardiin.

KeyVaultSecretReference

Kohde

Viittaus Azure Key Vaultiin tallennettuun salaiseen koodiin.

Nimi	Tyyppi	Kuvaus
connectionId	string (uuid)	Key Vault -yhteyden yhteystunnus.
secretName	string	Salaisen koodin nimi Key Vaultissa.
version	string	Salaisen koodin versio Key Vaultissa.

ListConnectionDetails

Kohde

Yhteyden tietojen tuloste luettelotoiminnoille.

Nimi	Tyyppi	Kuvaus
path	string	Yhteyden polku.
type	string	Yhteyden tyyppi.

ListCredentialDetails

Kohde

Yhteyden noutamisen yhteydessä palautetut tunnistetietojen tiedot.

Nimi	Tyyppi	Kuvaus
connectionEncryption	ConnectionEncryption	Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana.
credentialType	CredentialType	Yhteyden tunnistetietotyyppi.
singleSignOnType	SingleSignOnType	Yhteyden kertakirjautumistyyppi.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä.

OnPremisesCredentialEntry

Kohde

Yhdyskäytävän tunnus ja sen salatut sarjoitetut tunnistetiedot.

Nimi	Tyyppi	Kuvaus
encryptedCredentials	string	Salattu sarjoitettu .json nimiarvoparien luettelosta. Nimi on tunnistetietojen nimi ja arvo on tunnistetietoarvo. Salaus suoritetaan käyttämällä Rivest-Shamir-Adleman (RSA) -salausalgoritmia paikallisen yhdyskäytävän jäsenen julkisella avaimella.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus.

OnPremisesGatewayConnection

Kohde

Yhteys, joka muodostaa yhteyden paikallisen tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: OnPremisesGateway	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

OnPremisesGatewayCredentials

Kohde

Tunnistetiedot todentamiseen paikallisen yhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
credentialType	CredentialType	Yhteyden tunnistetietotyyppi.
values	OnPremisesCredentialEntry[]	Tunnistetietojen tiedot, jotka lähetetään paikalliseen yhdyskäytävään.

OnPremisesGatewayPersonalConnection

Kohde

Yhteys, joka muodostaa yhteyden henkilökohtaisen paikallisen tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: OnPremisesGatewayPersonal	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

OnPremisesGatewayPersonalCredentials

Kohde

Tunnistetiedot todentamiseen paikallisen yhdyskäytävän (henkilökohtainen tila) kautta.

Nimi	Tyyppi	Kuvaus
credentialType	CredentialType	Yhteyden tunnistetietotyyppi.
encryptedCredentials	string	Salattu sarjoitettu .json nimiarvoparien luettelosta. Nimi on tunnistetietojen nimi ja arvo on tunnistetietoarvo. Salaus suoritetaan käyttämällä Rivest-Shamir-Adleman (RSA) -salausalgoritmia paikallisen yhdyskäytävän julkisella avaimella.

PersonalCloudConnection

Kohde

Yhteys, joka muodostaa yhteyden pilvipalvelun kautta eikä sitä voi jakaa.

Nimi	Tyyppi	Kuvaus
allowConnectionUsageInGateway	boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: PersonalCloud	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

PrivacyLevel

Luettelointi

Yhteyden yksityisyystaso. Lisää yksityisyystasoja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
None	Tietosuojatason asetusta ei ole määritetty.
Private	Yksityisille yhteyksille määritetään arkaluonteisia tai luottamuksellisia tietoja. Näkyvyys voidaan rajata valtuutetuille käyttäjille. Yksityisestä yhteydestä peräisin olevia tietoja ei taiteta muihin yhteyksiin, mukaan lukien muihin yksityisyhteyksiin.
Organizational	Organisaation määrittämät yhteydet voivat taittua yksityisiin ja muihin organisaatioyhteyksiin. He eivät voi taittua julkisiin yhteyksiin. Näkyvyys on määritetty luotetuksi ryhmäksi.
Public	Tiedostot, Internet-yhteydet ja työkirjatiedot voidaan asettaa julkisiksi. Tiedot voidaan delegoida muihin yhteyksiin. Näkyvyys on kaikkien käytettävissä.

ServicePrincipalCredentials

Kohde

ServicePrincipal-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: ServicePrincipal	Yhteyden tunnistetietotyyppi.
servicePrincipalClientId	string (uuid)	Palvelun päänimen asiakastunnus.
servicePrincipalSecret	string	Palvelun päänimen salaisuus. Käytä servicePrincipalSecret- tai servicePrincipalSecretReference-ehtoa. Molempia ei voi käyttää samanaikaisesti.
servicePrincipalSecretReference	KeyVaultSecretReference	Viittaus Azure Key Vaultiin tallennettuun palvelun päänimen salauskoodiin. Käytä servicePrincipalSecret- tai servicePrincipalSecretReference-ehtoa. Molempia ei voi käyttää samanaikaisesti.
tenantId	string (uuid)	Palvelun päänimen vuokraajatunnus.

ShareableCloudConnection

Kohde

Yhteys, joka muodostaa yhteyden pilvipalvelun kautta.

Nimi	Tyyppi	Kuvaus
allowConnectionUsageInGateway	boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
allowUsageInUserControlledCode	boolean	Salli tämän yhteyden käyttö kohteissa, jotka sallivat käyttäjän hallitseman koodin, kuten Muistikirja.
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: ShareableCloud	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

SharedAccessSignatureCredentials

Kohde

SharedAccessSignature-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: SharedAccessSignature	Yhteyden tunnistetietotyyppi.
token	string	Tunnus. Käytä tunnusta tai tunnustaReference. Molempia ei voi käyttää samanaikaisesti.
tokenReference	KeyVaultSecretReference	Viittaus Azure Key Vaultiin tallennettuun tunnukseen. Käytä tunnusta tai tunnustaReference. Molempia ei voi käyttää samanaikaisesti.

SingleSignOnType

Luettelointi

Yhteyden kertakirjautumistyyppi. Muita kertakirjautumistyyppejä voidaan lisätä ajan mittaan.

Arvo	Kuvaus
None	Yhteys ei käytä kertakirjautumista yhteyden muodostamiseen.
Kerberos	Yhteys muodostaa yhteyden Kerberoksen kertakirjautumisen avulla.
MicrosoftEntraID	Yhteys muodostaa yhteyden Microsoft Entra ID -kertakirjautumisen avulla.
SecurityAssertionMarkupLanguage	Yhteys käyttää Security Assertion Markup Languagen (SAML) kertakirjautumista yhteyden muodostamiseen.
KerberosDirectQueryAndRefresh	Yhteys muodostaa yhteyden Kerberos DirectQueryn ja Päivitä-kertakirjautumisen avulla.

StreamingVirtualNetworkGatewayConnection

Kohde

Yhteys, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: StreamingVirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhteyden yhdyskäytävän objektitunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

UpdateCredentialDetails

Kohde

Tunnistetietojen syöte yhteyden päivittämistä varten.

Nimi	Tyyppi	Kuvaus
connectionEncryption	ConnectionEncryption	Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Yhteyden tunnistetiedot.
singleSignOnType	SingleSignOnType	Yhteyden kertakirjautumistyyppi.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä.

UpdateOnPremisesGatewayConnectionRequest

Kohde

Nimi	Tyyppi	Kuvaus
connectivityType	string: OnPremisesGateway	Yhteyden yhteystyyppi.
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

UpdateOnPremisesGatewayCredentialDetails

Kohde

Tunnistetietojen syöte paikallisen yhdyskäytäväyhteyden päivittämistä varten.

Nimi	Tyyppi	Kuvaus
connectionEncryption	ConnectionEncryption	Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana.
credentials	OnPremisesGatewayCredentials	Yhteyden tunnistetiedot.
singleSignOnType	SingleSignOnType	Yhteyden kertakirjautumistyyppi.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä.

UpdateOnPremisesGatewayPersonalConnectionRequest

Kohde

Nimi	Tyyppi	Kuvaus
connectivityType	string: OnPremisesGatewayPersonal	Yhteyden yhteystyyppi.
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	Yhteyden tunnistetiedot.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

UpdateOnPremisesGatewayPersonalCredentialDetails

Kohde

Tunnistetietojen syöte paikallisen yhdyskäytäväyhteyden päivittämistä varten.

Nimi	Tyyppi	Kuvaus
connectionEncryption	ConnectionEncryption	Tämä on yhteyden salausasetus, jota käytetään testiyhteyden aikana.
credentials	OnPremisesGatewayPersonalCredentials	Yhteyden tunnistetiedot.
singleSignOnType	SingleSignOnType	Yhteyden kertakirjautumistyyppi.
skipTestConnection	boolean	Määrittää, ohitetaanko yhteyden testiyhteys luomisen ja päivityksen aikana. True – Ohita testiyhteys, False – Älä ohita testiyhteyttä.

UpdatePersonalCloudConnectionRequest

Kohde

Nimi	Tyyppi	Kuvaus
allowConnectionUsageInGateway	boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
connectivityType	string: PersonalCloud	Yhteyden yhteystyyppi.
credentialDetails	UpdateCredentialDetails	Yhteyden tunnistetiedot.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

UpdateShareableCloudConnectionRequest

Kohde

Nimi	Tyyppi	Kuvaus
allowConnectionUsageInGateway	boolean	Salli tämän yhteyden käyttö joko paikallisten tietoyhdyskäytäviä tai VNet-tietoyhdyskäytäviä käyttämällä.
connectivityType	string: ShareableCloud	Yhteyden yhteystyyppi.
credentialDetails	UpdateCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Kohde

Päivittää yhteyden, joka muodostaa yhteyden suoratoistettavan näennäisverkon tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectivityType	string: StreamingVirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	UpdateCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

UpdateVirtualNetworkGatewayConnectionRequest

Kohde

Nimi	Tyyppi	Kuvaus
connectivityType	string: VirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	UpdateCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi. Enimmäispituus on 200 merkkiä.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

VirtualNetworkGatewayConnection

Kohde

Yhteys, joka muodostaa yhteyden näennäisverkon tietoyhdyskäytävän kautta.

Nimi	Tyyppi	Kuvaus
connectionDetails	ListConnectionDetails	Yhteyden tiedot.
connectionRecency	ConnectionRecency	Yhteyden tarkemmat tiedot.
connectivityType	string: VirtualNetworkGateway	Yhteyden yhteystyyppi.
credentialDetails	ListCredentialDetails	Yhteyden tunnistetiedot.
displayName	string	Yhteyden näyttönimi.
gatewayId	string (uuid)	Yhdyskäytävän objektitunnus, jonka kautta yhteys muodostetaan. Pilviyhteyksissä tämä on virtuaalinen yhdyskäytävän tunnus.
id	string (uuid)	Yhteyden objektitunnus.
myRole	ConnectionRole	Kutsuvan päänimen tehokas rooli yhteydellä. Kun päänimi on osa useita käyttöoikeusryhmiä, joilla on eri rooleja, palautetaan suurin rooli. Jos päänimellä ei ole roolia yhteydessä, tätä ominaisuutta ei palauteta.
privacyLevel	PrivacyLevel	Yhteyden yksityisyystaso.

WindowsCredentials

Kohde

Windowsin tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: Windows	Yhteyden tunnistetietotyyppi.
password	string	Salasana.
username	string	Käyttäjänimi.

WindowsWithoutImpersonationCredentials

Kohde

WindowsWithoutImpersonation-tunnistetietotyypin tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: WindowsWithoutImpersonation	Yhteyden tunnistetietotyyppi.

WorkspaceIdentityCredentials

Kohde

WorkspaceIdentity CredentialType-asetuksen tunnistetiedot.

Nimi	Tyyppi	Kuvaus
credentialType	string: WorkspaceIdentity	Yhteyden tunnistetietotyyppi.