Server Connection Policies - List By Server

Service:

SQL Database

API Version:

2021-11-01

Lists connection policy

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

URI Parameters

Name	In	Required	Type	Description
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.
serverName	path	True	string	The name of the server.
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	ServerConnectionPolicyListResult	Successfully retrieved the server connection policy list
Other Status Codes		*** Error Responses: *** 400 InvalidConnectionPolicyName - Invalid connection policy name. 400 ConnectionPolicyParamsNull - The request body cannot be null. 400 InvalidConnectionPolicyType - Connection type is invalid 404 OperationIdNotFound - The operation with Id does not exist. 404 OperationIdNotFound - The operation with Id does not exist. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Lists a servers connection policies

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rgtest-12/providers/Microsoft.Sql/servers/servertest-6285/connectionPolicies?api-version=2021-11-01

Java

/**
 * Samples for ServerConnectionPolicies ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerConnectionPoliciesList.json
     */
    /**
     * Sample code: Lists a servers connection policies.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listsAServersConnectionPolicies(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerConnectionPolicies().listByServer("rgtest-12",
            "servertest-6285", 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/rgtest-12/providers/Microsoft.Sql/servers/servertest-6285/connectionPolicies/default",
      "name": "default",
      "kind": null,
      "location": "eastus",
      "type": "Microsoft.Sql/servers/connectionPolicies",
      "properties": {
        "connectionType": "Redirect"
      }
    }
  ]
}

Definitions

Name	Description
ServerConnectionPolicy	A server connection policy
ServerConnectionPolicyListResult	A list of server connection policy objects.
ServerConnectionType	The server connection type.

ServerConnectionPolicy

A server connection policy

Name	Type	Description
id	string	Resource ID.
kind	string	Metadata used for the Azure portal experience.
location	string	Resource location.
name	string	Resource name.
properties.connectionType	ServerConnectionType	The server connection type.
type	string	Resource type.

ServerConnectionPolicyListResult

A list of server connection policy objects.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ServerConnectionPolicy[]	Array of results.

ServerConnectionType

The server connection type.

Name	Type	Description
Default	string
Proxy	string
Redirect	string