Share via

Server Connection Policies - Get

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

Gets a server connection policy

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

URI Parameters

Name In Required Type Description
connectionPolicyName
 path True

ConnectionPolicyName

The name of the connection policy.
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

ServerConnectionPolicy

Successfully retrieved the server connection policy.
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

Gets a server connection policy

Sample request

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

Sample response

Status code:
200 
{
  "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
ConnectionPolicyName

The name of the connection policy.
ServerConnectionPolicy

A server connection policy
ServerConnectionType

The server connection type.

ConnectionPolicyName

The name of the connection policy.

Name Type Description
default

string

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.

ServerConnectionType

The server connection type.

Name Type Description
Default

string

Proxy

string

Redirect

string