Server Trust Groups - List By Location

Service:

SQL Database

API Version:

2021-11-01

Lists a server trust group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups?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.
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 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

List server trust groups

Sample request

HTTP

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

Java

/**
 * Samples for ServerTrustGroups ListByLocation.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerTrustGroupList.json
     */
    /**
     * Sample code: List server trust groups.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServerTrustGroups(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerTrustGroups().listByLocation("Default", "Japan East",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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