Edit

Share via


Gateways - Update Gateway Member

Updates gateway member of an OnPremisesGateway by ID.

Permissions

The caller must have admin permission for the gateway.

Required Delegated Scopes

Gateway.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
gatewayId
path True

string (uuid)

The ID of the gateway.

gatewayMemberId
path True

string (uuid)

The ID of the gateway member.

Request Body

Name Type Description
displayName

string

The display name of the gateway member. Maximum length is 200 characters.

enabled

boolean

Whether the gateway member is enabled. True - Enabled, False - Not enabled.

Responses

Name Type Description
200 OK

OnPremisesGatewayMember

OK. The operation was successful.

Other Status Codes

ErrorResponse

Common error codes:

  • EntityNotFound - The requested resource could not be found.

  • InsufficientPermissionsToManageGateway - The caller has insufficient permissions to manage this gateway.

Examples

Example

Sample request

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

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

Sample response

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

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.

ErrorResponse

The error response.

ErrorResponseDetails

The error response details.

OnPremisesGatewayMember

The gateway member information.

PublicKey

The public key of the on-premises gateway.

UpdateGatewayMemberRequest

ErrorRelatedResource

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.

resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.

message

string

A human readable representation of the error.

moreDetails

ErrorResponseDetails[]

List of additional error details.

relatedResource

ErrorRelatedResource

The error related resource details.

requestId

string

ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.

message

string

A human readable representation of the error.

relatedResource

ErrorRelatedResource

The error related resource details.

OnPremisesGatewayMember

The gateway member information.

Name Type Description
displayName

string

The display name of the gateway member.

enabled

boolean

Whether the gateway member is enabled. True - Enabled, False - Not enabled.

id

string (uuid)

The object ID of the gateway member.

publicKey

PublicKey

The public key of the gateway member. Used to encrypt the credentials for creating and updating connections.

version

string

The version of the installed gateway member.

PublicKey

The public key of the on-premises gateway.

Name Type Description
exponent

string

The exponent of the public key.

modulus

string

The modulus of the public key.

UpdateGatewayMemberRequest

Name Type Description
displayName

string

The display name of the gateway member. Maximum length is 200 characters.

enabled

boolean

Whether the gateway member is enabled. True - Enabled, False - Not enabled.