Microsoft.Sql (preview:2024-11-01)

2025/07/25 • 5 updated methods

Servers_List (updated)
Description :  Gets a list of all servers in the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "createMode",
                "Enum": {
                  "new": [
                    [
                      "Normal",
                      ""
                    ],
                    [
                      "Restore",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "Normal",
                      ""
                    ],
                    [
                      "ServerMigrationV1",
                      ""
                    ],
                    [
                      "DatabaseMigrationV1",
                      ""
                    ],
                    [
                      "ServerMigration",
                      ""
                    ],
                    [
                      "Standby",
                      ""
                    ],
                    [
                      "Restore",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers
{
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ListByResourceGroup (updated)
Description :  Gets a list of servers in a resource groups.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "createMode",
                "Enum": {
                  "new": [
                    [
                      "Normal",
                      ""
                    ],
                    [
                      "Restore",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "Normal",
                      ""
                    ],
                    [
                      "ServerMigrationV1",
                      ""
                    ],
                    [
                      "DatabaseMigrationV1",
                      ""
                    ],
                    [
                      "ServerMigration",
                      ""
                    ],
                    [
                      "Standby",
                      ""
                    ],
                    [
                      "Restore",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Get (updated)
Description :  Gets a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Normal",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ],
              "old": [
                [
                  "Normal",
                  ""
                ],
                [
                  "ServerMigrationV1",
                  ""
                ],
                [
                  "DatabaseMigrationV1",
                  ""
                ],
                [
                  "ServerMigration",
                  ""
                ],
                [
                  "Standby",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_CreateOrUpdate (updated)
Description :  Creates or updates a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Normal",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ],
              "old": [
                [
                  "Normal",
                  ""
                ],
                [
                  "ServerMigrationV1",
                  ""
                ],
                [
                  "DatabaseMigrationV1",
                  ""
                ],
                [
                  "ServerMigration",
                  ""
                ],
                [
                  "Standby",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Normal",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ],
              "old": [
                [
                  "Normal",
                  ""
                ],
                [
                  "ServerMigrationV1",
                  ""
                ],
                [
                  "DatabaseMigrationV1",
                  ""
                ],
                [
                  "ServerMigration",
                  ""
                ],
                [
                  "Standby",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Normal",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ],
              "old": [
                [
                  "Normal",
                  ""
                ],
                [
                  "ServerMigrationV1",
                  ""
                ],
                [
                  "DatabaseMigrationV1",
                  ""
                ],
                [
                  "ServerMigration",
                  ""
                ],
                [
                  "Standby",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested server resource state. ,
Required: True ,
}
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Servers_Update (updated)
Description :  Updates a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Normal",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ],
              "old": [
                [
                  "Normal",
                  ""
                ],
                [
                  "ServerMigrationV1",
                  ""
                ],
                [
                  "DatabaseMigrationV1",
                  ""
                ],
                [
                  "ServerMigration",
                  ""
                ],
                [
                  "Standby",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Normal",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ],
              "old": [
                [
                  "Normal",
                  ""
                ],
                [
                  "ServerMigrationV1",
                  ""
                ],
                [
                  "DatabaseMigrationV1",
                  ""
                ],
                [
                  "ServerMigration",
                  ""
                ],
                [
                  "Standby",
                  ""
                ],
                [
                  "Restore",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested server resource state. ,
Required: True ,
}
{
identity:
{
Description: Server identity ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator can be utilized during server creation and for server updates, except for the azureADOnlyAuthentication property. To update the azureADOnlyAuthentication property, individual API must be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
retentionDays:
{
Description: Number of days this server will stay soft-deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
createMode:
{
Description: Create mode for server, only valid values for this are Normal and Restore. ,
Enum:
{
Normal: No description available. ,
Restore: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}