Gateways - Delete Gateway Member

Service:

Core

API Version:

v1

Delete 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

DELETE 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.

Responses

Name	Type	Description
200 OK		Request completed successfully.
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. CannotDeletePrimaryGatewayIfClusterMemberExists - Cannot delete the primary gateway while another member gateway exists.

Examples

Example

Sample request

HTTP

DELETE https://api.fabric.microsoft.com/v1/gateways/ad457a0a-1fc4-4218-9867-1d84661ca4b8/members/f921ee6b-8feb-4595-8aa7-3ed34338e8b6

Sample response

Status code:

200

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

ErrorRelatedResource

Object

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

Object

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

Object

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.