Gateways - Update Gateway Member

Szolgáltatás:

Core

API-verzió:

v1

Jegyzet

Ez az API előzetes verzióban érhető el.

Frissíti egy OnPremisesGateway átjárótagját azonosító alapján.

Engedélyek

A hívónak rendszergazdai engedéllyel kell rendelkeznie az átjáróhoz.

Kötelező delegált hatókörök

Gateway.ReadWrite.All

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság	Támogat
Felhasználó	Igen
szolgáltatásnév és felügyelt identitások	Igen

Interfész

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
gatewayId	path	True	string uuid	Az átjáró azonosítója.
gatewayMemberId	path	True	string uuid	Az átjárótag azonosítója.

Kérelem törzse

Name	Típus	Description
displayName	string	Az átjárótag megjelenítendő neve. A maximális hossz 200 karakter.
enabled	boolean	Azt jelzi, hogy az átjárótag engedélyezve van-e. Igaz – Engedélyezve, Hamis – Nincs engedélyezve.

Válaszok

Name	Típus	Description
200 OK	OnPremisesGatewayMember	OKÉ. A művelet sikeres volt.
Other Status Codes	ErrorResponse	Gyakori hibakódok: EntityNotFound – A kért erőforrás nem található. InsufficientPermissionsToManageGateway – A hívó nem rendelkezik elegendő engedéllyel az átjáró kezeléséhez.

Példák

Example

Mintakérelem

HTTP

PATCH https://api.fabric.microsoft.com/v1/gateways/41d198df-5fb2-4463-8157-2af5153e6503/members/1e624ffb-f74a-4dfb-9aa8-ea5056da37da

{
  "displayName": "ContosoGatewayMember1",
  "enabled": false
}

Mintaválasz

Állapotkód:

200

{
  "id": "1e624ffb-f74a-4dfb-9aa8-ea5056da37da",
  "displayName": "ContosoGatewayMember1",
  "publicKey": {
    "exponent": "AQGB",
    "modulus": "od9b...90Jp1Q=="
  },
  "version": "3000.1.1",
  "enabled": false
}

Definíciók

Name	Description
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
OnPremisesGatewayMember	Az átjárótagok adatai.
PublicKey	A helyszíni átjáró nyilvános kulcsa.
UpdateGatewayMemberRequest

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string	A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

OnPremisesGatewayMember

Objektum

Az átjárótagok adatai.

Name	Típus	Description
displayName	string	Az átjárótag megjelenítendő neve.
enabled	boolean	Azt jelzi, hogy az átjárótag engedélyezve van-e. Igaz – Engedélyezve, Hamis – Nincs engedélyezve.
id	string uuid	Az átjárótag objektumazonosítója.
publicKey	PublicKey	Az átjárótag nyilvános kulcsa. A kapcsolatok létrehozásához és frissítéséhez használt hitelesítő adatok titkosítására szolgál.
version	string	A telepített átjárótag verziója.

PublicKey

Objektum

A helyszíni átjáró nyilvános kulcsa.

Name	Típus	Description
exponent	string	A nyilvános kulcs kitevője.
modulus	string	A nyilvános kulcs modulusa.

UpdateGatewayMemberRequest

Objektum

Name	Típus	Description
displayName	string	Az átjárótag megjelenítendő neve. A maximális hossz 200 karakter.
enabled	boolean	Azt jelzi, hogy az átjárótag engedélyezve van-e. Igaz – Engedélyezve, Hamis – Nincs engedélyezve.