Share via

Server Trust Groups - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a server trust group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups/{serverTrustGroupName}?api-version=2021-11-01

URI Parameters

Name In Required Type Description
locationName
 path True

string

The name of the region where the resource is located.
resourceGroupName
 path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverTrustGroupName
 path True

string

The name of the server trust group.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

ServerTrustGroup

Successfully retrieved the the specified server trust group.
Other Status Codes

*** Error Responses: ***

  • 404 ServerTrustGroupNotFound - Server trust group with specified name does not exist.

  • 404 ResourceNotFound - The requested resource was not found.

  • 406 ServerTrustGroupMemberIsBusy - Group member '{0}' is not in a valid state and cannot perform Server trust group operation.

  • 406 ServerTrustGroupInInvalidState - SQL trust group '{0}' is busy and cannot perform requested operation.

  • 406 ServerTrustGroupMemberNotFound - Group member '{0}' is not found, therefore we cannot perform Server trust group operation.

Examples

Get server trust group

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test?api-version=2021-11-01

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test",
  "name": "server-trust-group-test",
  "properties": {
    "groupMembers": [
      {
        "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1"
      },
      {
        "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2"
      }
    ],
    "trustScopes": [
      "GlobalTransactions",
      "ServiceBroker"
    ]
  },
  "type": "Microsoft.Sql/locations/serverTrustGroups"
}

Definitions

Name Description
ServerInfo

Server info for the server trust group.
ServerTrustGroup

A server trust group.
TrustScopes

Trust scope of the server trust group.

ServerInfo

Server info for the server trust group.

Name Type Description
serverId

string

Server Id.

ServerTrustGroup

A server trust group.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.groupMembers

ServerInfo[]

Group members information for the server trust group.
properties.trustScopes

TrustScopes[]

Trust scope of the server trust group.
type

string

Resource type.

TrustScopes

Trust scope of the server trust group.

Name Type Description
GlobalTransactions

string

ServiceBroker

string