Share via


Server Connection Policies - Create Or Update

Updates a server connection policy

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/connectionPolicies/default?api-version=2023-08-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.

Request Body

Name Required Type Description
properties.connectionType True

ServerConnectionType

The server connection type.

Responses

Name Type Description
200 OK

ServerConnectionPolicy

Successfully updated the connection policy

202 Accepted

Updating the server connection policy is in progress.

Headers

Location: string

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

Updates a server connection policy

Sample request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/servers/testserver/connectionPolicies/default?api-version=2023-08-01

{
  "properties": {
    "connectionType": "Redirect"
  }
}

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/servers/testserver/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.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ServerConnectionPolicy

A server connection policy

ServerConnectionType

The server connection type.

ConnectionPolicyName

The name of the connection policy.

Value Description
default

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

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.

Value Description
Default
Redirect
Proxy