Server Trust Groups - List By Instance

Gets a server trust groups by instance name.

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

URI Parameters

Name In Required Type Description
managedInstanceName
path True

string

The name of the managed instance.

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.

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

ServerTrustGroupListResult

Successfully retrieved the server trust groups.

Other Status Codes

*** Error Responses: ***

  • 404 ResourceNotFound - The requested resource was not found.

Examples

List server trust groups by managed instance

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance-1/serverTrustGroups?api-version=2021-11-01

Sample response

{
  "value": [
    {
      "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"
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test-2",
      "name": "server-trust-group-test-2",
      "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-3"
          }
        ],
        "trustScopes": [
          "GlobalTransactions",
          "ServiceBroker"
        ]
      },
      "type": "Microsoft.Sql/locations/serverTrustGroups"
    }
  ]
}

Definitions

Name Description
ServerInfo

Server info for the server trust group.

ServerTrustGroup

A server trust group.

ServerTrustGroupListResult

A list of server trust groups.

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.

ServerTrustGroupListResult

A list of server trust groups.

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

ServerTrustGroup[]

Array of results.

TrustScopes

Trust scope of the server trust group.

Name Type Description
GlobalTransactions

string

ServiceBroker

string