Server Connection Policies - List By Server

Service:: SQL Database

API Version:: 2023-08-01

Lists connection policy

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/connectionPolicies?api-version=2023-08-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	ErrorResponse	* Error Responses: * 400 InvalidServerName - Invalid server name specified. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 TokenTooLong - The provided token is too long. 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 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 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled. 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.

Name

Type

Description

200 OK

ServerConnectionPolicyListResult

Successfully retrieved the server connection policy list

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 InvalidServerName - Invalid server name specified.
400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.
400 TokenTooLong - The provided token is too long.
400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
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 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found
409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.
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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerConnectionPoliciesList.json
// this example is just showing the usage of "ServerConnectionPolicies_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "rgtest-12";
string serverName = "servertest-6285";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerConnectionPolicyResource
SqlServerConnectionPolicyCollection collection = sqlServer.GetSqlServerConnectionPolicies();

// invoke the operation and iterate over the result
await foreach (SqlServerConnectionPolicyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerConnectionPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ServerConnectionPolicy	A server connection policy
ServerConnectionPolicyListResult	A list of server connection policy objects.
ServerConnectionType	The server connection type.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ServerConnectionPolicy

Object

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

Object

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

Enumeration

The server connection type.

Value	Description
Default
Redirect
Proxy

Share via

Server Connection Policies - List By Server

URI Parameters

Responses

Examples

Lists a servers connection policies

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerConnectionPolicy

ServerConnectionPolicyListResult

ServerConnectionType