Servers - Update

Reference

Service:: SQL Database

API Version:: 2021-11-01

Updates a server.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?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.

Request Body

Name	Type	Description
identity	ResourceIdentity	Server identity
properties.administratorLogin	string	Administrator username for the server. Once created it cannot be changed.
properties.administratorLoginPassword	string	The administrator login password (required for server creation).
properties.administrators	ServerExternalAdministrator	The Azure Active Directory administrator of the server.
properties.federatedClientId	string	The Client id used for cross tenant CMK scenario
properties.keyId	string	A CMK URI of the key to use for encryption.
properties.minimalTlsVersion	string	Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	The resource id of a user assigned identity to be used by default.
properties.publicNetworkAccess	ServerNetworkAccessFlag	Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.version	string	The version of the server.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	Server	Successfully updated the server.
202 Accepted		Accepted
Other Status Codes		* Error Responses: * 400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned 400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter 400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database). 400 NameAlreadyExists - The provided name already exists. 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided 400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes 400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call 400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned' 400 InvalidLoginName - The provided login name is invalid. 400 InvalidUsername - Supplied user name contains invalid characters. 400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region. 400 PasswordTooShort - The provided password is too short 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator. 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported. 400 PasswordTooLong - The provided password is too long. 400 PasswordNotComplex - The provided password is not complex enough. 400 InvalidParameterValue - An invalid value was given to a parameter. 400 InvalidLocation - An invalid location was specified. 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 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time. 400 ServerNotFound - The requested server was not found. 400 InvalidMinimalTlsVersion - Invalid minimal TLS version. 400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name. 400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id. 400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id. 400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group. 400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator. 400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 OperationIdNotFound - The operation with Id does not exist. 404 SubscriptionNotFound - The requested subscription was not found. 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. 409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later. 409 ServerDisabled - Server is disabled. 409 ConflictingServerOperation - An operation is currently in progress for the server. 409 SubscriptionDisabled - Subscription is disabled. 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota. 409 ServerAlreadyExists - Duplicate server name. 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. 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. 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription. 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. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Name

Type

Description

200 OK

Server

Successfully updated the server.

202 Accepted

Accepted

Other Status Codes

*** Error Responses: ***

400 MissingIdentityId - No user assigned identity is provided when the identity type is set to UserAssigned
400 InvalidPrimaryIdentityId - User provides a value for PrimaryUserIdentityId but the same is not listed in the IdentityId parameter
400 PECsNotExistingToDenyPublicNetworkAccess - Unable to set Deny Public Network Access to Yes since there is no private endpoint enabled to access the server. Please set up private endpoints and retry the operation (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database).
400 NameAlreadyExists - The provided name already exists.
400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided
400 MissingPrimaryIdentity - PrimaryUserAssignedIdentityId provided by user does not have access to KeyId provided
400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes
400 PrimaryIdentityMissingPermissionForKeyId - KeyId is provided by user during create but PrimaryUserAssignedIdentityId is not provided in the API call
400 InvalidIdentityTypeForKeyId - KeyId is provided by user during create but identity type is not set to 'UserAssigned'
400 InvalidLoginName - The provided login name is invalid.
400 InvalidUsername - Supplied user name contains invalid characters.
400 Ipv6FeatureNotEnabled - User tried to turn on Ipv6 support on the server without enabling feature flag on subscription, or the feature support is currently disabled in the region.
400 PasswordTooShort - The provided password is too short
400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.
400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.
400 PasswordTooLong - The provided password is too long.
400 PasswordNotComplex - The provided password is not complex enough.
400 InvalidParameterValue - An invalid value was given to a parameter.
400 InvalidLocation - An invalid location was specified.
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 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.
400 ServerNotFound - The requested server was not found.
400 InvalidMinimalTlsVersion - Invalid minimal TLS version.
400 InvalidExternalAdministratorLogin - Invalid or missing external administrator login name.
400 InvalidExternalAdministratorSid - Invalid or missing external administrator object id.
400 InvalidExternalAdministratorTenantId - Invalid or missing external administrator tenant id.
400 ExternalAdministratorPrincipalType - Invalid or missing external administrator principal type. Please select from User, Application or Group.
400 MissingExternalAdministratorWithAadOnlyAuth - In order to use Azure AD Only Authentication, please provide details of an external administrator.
400 ExternalAdministratorLoginSameAsSqlAdmin - The names of the Azure Active Directory administrator and of the server admin account must be different. Please provide different values.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 OperationIdNotFound - The operation with Id does not exist.
404 SubscriptionNotFound - The requested subscription was not found.
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.
409 UpsertLogicalServerRequestAlreadyInProgress - An ongoing logical server request is already in progress, please try your request again later.
409 ServerDisabled - Server is disabled.
409 ConflictingServerOperation - An operation is currently in progress for the server.
409 SubscriptionDisabled - Subscription is disabled.
409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.
409 ServerAlreadyExists - Duplicate server name.
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.
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.
429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.
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.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Update a server

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2021-11-01

{
  "properties": {
    "administratorLogin": "dummylogin",
    "administratorLoginPassword": "placeholder",
    "publicNetworkAccess": "Disabled",
    "restrictOutboundNetworkAccess": "Enabled"
  }
}


import com.azure.resourcemanager.sql.models.ServerNetworkAccessFlag;
import com.azure.resourcemanager.sql.models.ServerUpdate;

/**
 * Samples for Servers Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerUpdate.json
     */
    /**
     * Sample code: Update a server.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().update("sqlcrudtest-7398", "sqlcrudtest-4645",
            new ServerUpdate().withAdministratorLogin("dummylogin")
                .withAdministratorLoginPassword("fakeTokenPlaceholder")
                .withPublicNetworkAccess(ServerNetworkAccessFlag.DISABLED)
                .withRestrictOutboundNetworkAccess(ServerNetworkAccessFlag.ENABLED),
            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

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "location": "japaneast",
  "kind": "v12.0",
  "properties": {
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "administratorLogin": "dummylogin",
    "version": "12.0",
    "state": "Ready",
    "publicNetworkAccess": "Disabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "provisioningState": "Ready",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Status code:: 202

Definitions

Name	Description
AdministratorType	Type of the sever administrator.
IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
PrincipalType	Principal Type of the sever administrator.
PrivateEndpointConnectionProperties	Properties of a private endpoint connection.
PrivateEndpointProperty
PrivateEndpointProvisioningState	State of the private endpoint connection.
PrivateLinkServiceConnectionStateActionsRequire	The actions required for private link service connection.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	The private link service connection status.
ResourceIdentity	Azure Active Directory identity configuration for a resource.
Server	An Azure SQL Database server.
ServerExternalAdministrator	Properties of a active directory administrator.
ServerNetworkAccessFlag	Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
ServerPrivateEndpointConnection	A private endpoint connection under a server
ServerUpdate	An update request for an Azure SQL Database server.
ServerWorkspaceFeature	Whether or not existing server has a workspace created and if it allows connection from workspace
UserIdentity	Azure Active Directory identity configuration for a resource.

AdministratorType

Type of the sever administrator.

Name	Type	Description
ActiveDirectory	string

IdentityType

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Principal Type of the sever administrator.

Name	Type	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Properties of a private endpoint connection.

Name	Type	Description
groupIds	string[]	Group IDs.
privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection state of the private endpoint connection.
provisioningState	PrivateEndpointProvisioningState	State of the private endpoint connection.

PrivateEndpointProperty

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateEndpointProvisioningState

State of the private endpoint connection.

Name	Type	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.

Name	Type	Description
None	string

PrivateLinkServiceConnectionStateProperty

Name	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	The actions required for private link service connection.
description	string	The private link service connection description.
status	PrivateLinkServiceConnectionStateStatus	The private link service connection status.

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Name	Type	Description
principalId	string	The Azure Active Directory principal id.
tenantId	string	The Azure Active Directory tenant id.
type	IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
userAssignedIdentities	<string, UserIdentity>	The resource ids of the user assigned identities to use

Server

An Azure SQL Database server.

Name	Type	Description
id	string	Resource ID.
identity	ResourceIdentity	The Azure Active Directory identity of the server.
kind	string	Kind of sql server. This is metadata used for the Azure portal experience.
location	string	Resource location.
name	string	Resource name.
properties.administratorLogin	string	Administrator username for the server. Once created it cannot be changed.
properties.administratorLoginPassword	string	The administrator login password (required for server creation).
properties.administrators	ServerExternalAdministrator	The Azure Active Directory administrator of the server.
properties.federatedClientId	string	The Client id used for cross tenant CMK scenario
properties.fullyQualifiedDomainName	string	The fully qualified domain name of the server.
properties.keyId	string	A CMK URI of the key to use for encryption.
properties.minimalTlsVersion	string	Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	The resource id of a user assigned identity to be used by default.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	List of private endpoint connections on a server
properties.publicNetworkAccess	ServerNetworkAccessFlag	Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.state	string	The state of the server.
properties.version	string	The version of the server.
properties.workspaceFeature	ServerWorkspaceFeature	Whether or not existing server has a workspace created and if it allows connection from workspace
tags	object	Resource tags.
type	string	Resource type.

ServerExternalAdministrator

Properties of a active directory administrator.

Name	Type	Description
administratorType	AdministratorType	Type of the sever administrator.
azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
login	string	Login name of the server administrator.
principalType	PrincipalType	Principal Type of the sever administrator.
sid	string	SID (object ID) of the server administrator.
tenantId	string	Tenant ID of the administrator.

ServerNetworkAccessFlag

Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

Name	Type	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

A private endpoint connection under a server

Name	Type	Description
id	string	Resource ID.
properties	PrivateEndpointConnectionProperties	Private endpoint connection properties

ServerUpdate

An update request for an Azure SQL Database server.

Name	Type	Description
identity	ResourceIdentity	Server identity
properties.administratorLogin	string	Administrator username for the server. Once created it cannot be changed.
properties.administratorLoginPassword	string	The administrator login password (required for server creation).
properties.administrators	ServerExternalAdministrator	The Azure Active Directory administrator of the server.
properties.federatedClientId	string	The Client id used for cross tenant CMK scenario
properties.fullyQualifiedDomainName	string	The fully qualified domain name of the server.
properties.keyId	string	A CMK URI of the key to use for encryption.
properties.minimalTlsVersion	string	Minimal TLS version. Allowed values: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	The resource id of a user assigned identity to be used by default.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	List of private endpoint connections on a server
properties.publicNetworkAccess	ServerNetworkAccessFlag	Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.state	string	The state of the server.
properties.version	string	The version of the server.
properties.workspaceFeature	ServerWorkspaceFeature	Whether or not existing server has a workspace created and if it allows connection from workspace
tags	object	Resource tags.

ServerWorkspaceFeature

Whether or not existing server has a workspace created and if it allows connection from workspace

Name	Type	Description
Connected	string
Disconnected	string

UserIdentity

Azure Active Directory identity configuration for a resource.

Name	Type	Description
clientId	string	The Azure Active Directory client id.
principalId	string	The Azure Active Directory principal id.

Share via

Servers - Update

URI Parameters

Request Body

Responses

Examples

Update a server

Sample request

Sample response

Definitions

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerUpdate

ServerWorkspaceFeature

UserIdentity

Additional resources