Servers - Create Or Update

Ссылка

Служба:: SQL Database

Версия API:: 2023-08-01

Создает или обновляет сервер.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2023-08-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API, используемая для запроса.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Расположение ресурса.
identity		ResourceIdentity	Удостоверение Azure Active Directory сервера.
properties.administratorLogin		string	Имя администратора сервера. После создания его нельзя изменить.
properties.administratorLoginPassword		string	Пароль для входа администратора (требуется для создания сервера).
properties.administrators		ServerExternalAdministrator	Администратор Azure Active Directory сервера. Это можно использовать только во время создания сервера. Если оно используется для обновления сервера, оно будет игнорироваться или это приведет к ошибке. Для обновлений потребуется использовать отдельные API.
properties.federatedClientId		string (uuid)	Идентификатор клиента, используемый для сценария CMK между клиентами
properties.isIPv6Enabled		ServerNetworkAccessFlag	Следует ли включить поддержку IPv6 для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.keyId		string	Универсальный код ресурса (URI) ключа для шифрования.
properties.minimalTlsVersion		MinimalTlsVersion	Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId		string	Идентификатор ресурса назначаемого пользователем удостоверения, используемого по умолчанию.
properties.publicNetworkAccess		ServerPublicNetworkAccessFlag	Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess		ServerNetworkAccessFlag	Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.version		string	Версия сервера.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	Server	Успешно обновлен сервер.
201 Created	Server	Успешно создан сервер.
202 Accepted		Принятый Заголовки Location: string
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра 400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра 400 NameAlreadyExistsSoftDeleted — запрашиваемое имя сервера принимается сервером в обратимом удаленном состоянии. Очистка или восстановление сервера для разблокировки. 400 MissingIdentityId — удостоверение, назначенное пользователем, не предоставляется, если для типа удостоверения задано значение UserAssigned. 400 InvalidPrimaryIdentityId . Пользователь предоставляет значение primaryUserIdentityId, но то же самое не указано в параметре IdentityId 400 PECsNotExistingToDenyPublicNetworkAccess — не удается задать для доступа к общедоступной сети значение "Да", так как для доступа к серверу не включена частная конечная точка. Настройте частные конечные точки и повторите операцию (https://docs.microsoft.com/azure/sql-database/sql-database-private-endpoint-overview#how-to-set-up-private-link-for-azure-sql-database). 400 NameAlreadyExists — предоставленное имя уже существует. 400 UmiMissingAkvPermissions — PrimaryUserAssignedIdentityId, предоставленный пользователем, не имеет доступа к KeyId, предоставленным 400 MissingPrimaryIdentity — PrimaryUserAssignedIdentityId, предоставленный пользователем, не имеет доступа к KeyId, предоставленному пользователем. 400 ProvisioningDisabled — отображает сообщение об ошибке от авторизации операции ресурсов без изменений. 400 PrimaryIdentityMissingPermissionForKeyId — KeyId предоставляется пользователем во время создания, но PrimaryUserAssignedIdentityId не предоставляется в вызове API 400 InvalidIdentityTypeForKeyId — KeyId предоставляется пользователем во время создания, но тип удостоверения не имеет значения UserAssigned. 400 InvalidLoginName — указано недопустимое имя входа. 400 InvalidUsername — предоставленное имя пользователя содержит недопустимые символы. 400 Ipv6FeatureNotEnabled — пользователь пытался включить поддержку Ipv6 на сервере без включения флага компонентов в подписке, или поддержка функций в настоящее время отключена в регионе. 400 PasswordTooShort — предоставленный пароль слишком короткий 400 AadOnlyAuthenticationIsEnabled — включена только проверка подлинности Azure Active Directory. Обратитесь к системному администратору. 400 RegionDoesNotSupportVersion — пользователь попытался создать сервер указанной версии в расположении, где эта версия сервера не поддерживается. 400 PasswordTooLong — указанный пароль слишком длинный. 400 PasswordNotComplex — указанный пароль недостаточно сложный. 400 InvalidParameterValue — недопустимое значение было присвоено параметру. 400 InvalidLocation — указано недопустимое расположение. 400 InvalidServerName — указано недопустимое имя сервера. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода. 400 TokenTooLong — предоставленный маркер слишком длинный. 400 CMKOperationNotAllowed — пользователь пытался выполнить операцию на сервере, когда у сервера нет доступа к Azure Key Vault. 400 ServerNotFound — запрошенный сервер не найден. 400 RegionDoesNotAllowProvisioning — выбранное расположение не принимает новые серверы базы данных SQL Windows Azure. Это может измениться позже. 400 InvalidMinimalTlsVersion — недопустимая минимальная версия TLS. 400 InvalidExternalAdministratorLogin — недопустимое или отсутствует имя входа внешнего администратора. 400 InvalidExternalAdministratorSid — недопустимый или отсутствующий идентификатор объекта внешнего администратора. 400 InvalidExternalAdministratorTenantId — недопустимый или отсутствующий идентификатор клиента внешнего администратора. 400 ExternalAdministratorPrincipalType — недопустимый или отсутствующий тип внешнего субъекта-администратора. Выберите пользователя, приложение или группу. 400 MissingExternalAdministratorWithAadOnlyAuth — чтобы использовать только проверку подлинности Azure AD, укажите сведения о внешнем администраторе. 400 ExternalAdministratorLoginSameAsSqlAdmin — имена администратора Azure Active Directory и учетной записи администратора сервера должны отличаться. Укажите разные значения. 400 ServerAdministratorNameAlreadyExists — пользователь пытался задать внешнего администратора и имя субъекта уже существует в базе данных master. 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 OperationIdNotFound — операция с идентификатором не существует. 404 SubscriptionNotFound — запрошенная подписка не найдена. 409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено. 409 OperationCancelled — операция отменена пользователем. 409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе. 409 UpsertLogicalServerRequestAlreadyInProgress — текущий логический запрос сервера уже выполняется, повторите запрос позже. 409 ServerDisabled — сервер отключен. 409 ConflictingServerOperation — операция в настоящее время выполняется для сервера. 409 SubscriptionDisabled — подписка отключена. 409 ServerQuotaExceed. Сервер нельзя добавить в подписку, так как он превысит квоту. 409 ServerAlreadyExists — повторяющееся имя сервера. 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 ConflictingSubscriptionOperation — операция в настоящее время выполняется для подписки. 500 OperationTimedOut — время ожидания операции истекло и автоматически откатился. Повторите операцию. 503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Примеры

Create server

Образец запроса

HTTP

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

{
  "properties": {
    "administratorLogin": "dummylogin",
    "administratorLoginPassword": "PLACEHOLDER",
    "administrators": {
      "principalType": "User",
      "login": "bob@contoso.com",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    },
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "isIPv6Enabled": "Enabled"
  },
  "location": "Japan East"
}

Пример ответа

Код состояния:: 200

{
  "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": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "isIPv6Enabled": "Enabled",
    "administrators": {
      "principalType": "User",
      "login": "bob@contoso.com",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    },
    "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"
          }
        }
      }
    ]
  }
}

Код состояния:: 201

{
  "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",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "isIPv6Enabled": "Enabled",
    "version": "12.0",
    "state": "Ready",
    "administrators": {
      "principalType": "User",
      "login": "bob@contoso.com",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    },
    "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"
          }
        }
      }
    ]
  }
}

Код состояния:: 202

Определения

Имя	Описание
AdministratorType	Тип администратора развера.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ExternalGovernanceStatus	Состояние внешнего управления.
IdentityType	Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
MinimalTlsVersion	Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"
PrincipalType	Тип субъекта-администратора.
PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Состояние подключения частной конечной точки.
PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.
ResourceIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.
Server	Сервер базы данных SQL Azure.
ServerExternalAdministrator	Свойства администратора Active Directory.
ServerNetworkAccessFlag	Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
ServerPrivateEndpointConnection	Подключение частной конечной точки под сервером
ServerPublicNetworkAccessFlag	Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"
ServerWorkspaceFeature	Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области
UserIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.

AdministratorType

Перечисление

Тип администратора развера.

Значение	Описание
ActiveDirectory

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExternalGovernanceStatus

Перечисление

Состояние внешнего управления.

Значение	Описание
Disabled
Enabled

IdentityType

Перечисление

Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

Значение	Описание
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Перечисление

Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"

Значение	Описание
1.0
1.1
1.2
1.3
None

PrincipalType

Перечисление

Тип субъекта-администратора.

Значение	Описание
Application
Group
User

PrivateEndpointConnectionProperties

Object

Свойства подключения частной конечной точки.

Имя	Тип	Описание
groupIds	string[]	Идентификаторы групп.
privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Состояние подключения частной конечной точки.
provisioningState	PrivateEndpointProvisioningState	Состояние подключения частной конечной точки.

PrivateEndpointProperty

Object

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

PrivateEndpointProvisioningState

Перечисление

Состояние подключения частной конечной точки.

Значение	Описание
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Перечисление

Действия, необходимые для подключения службы приватного канала.

Значение	Описание
None

PrivateLinkServiceConnectionStateProperty

Object

Имя	Тип	Описание
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
description	string	Описание подключения службы приватного канала.
status	PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.

PrivateLinkServiceConnectionStateStatus

Перечисление

Состояние подключения службы приватного канала.

Значение	Описание
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта Azure Active Directory.
tenantId	string (uuid)	Идентификатор клиента Azure Active Directory.
type	IdentityType	Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
userAssignedIdentities	<string, UserIdentity>	Идентификаторы ресурса назначенных пользователем удостоверений для использования

Server

Object

Сервер базы данных SQL Azure.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
identity	ResourceIdentity	Удостоверение Azure Active Directory сервера.
kind	string	Тип SQL Server. Это метаданные, используемые для интерфейса портала Azure.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.administratorLogin	string	Имя администратора сервера. После создания его нельзя изменить.
properties.administratorLoginPassword	string	Пароль для входа администратора (требуется для создания сервера).
properties.administrators	ServerExternalAdministrator	Администратор Azure Active Directory сервера. Это можно использовать только во время создания сервера. Если оно используется для обновления сервера, оно будет игнорироваться или это приведет к ошибке. Для обновлений потребуется использовать отдельные API.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Состояние внешнего управления.
properties.federatedClientId	string (uuid)	Идентификатор клиента, используемый для сценария CMK между клиентами
properties.fullyQualifiedDomainName	string	Полное доменное имя сервера.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Следует ли включить поддержку IPv6 для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.keyId	string	Универсальный код ресурса (URI) ключа для шифрования.
properties.minimalTlsVersion	MinimalTlsVersion	Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId	string	Идентификатор ресурса назначаемого пользователем удостоверения, используемого по умолчанию.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Список подключений к частной конечной точке на сервере
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.state	string	Состояние сервера.
properties.version	string	Версия сервера.
properties.workspaceFeature	ServerWorkspaceFeature	Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ServerExternalAdministrator

Object

Свойства администратора Active Directory.

Имя	Тип	Описание
administratorType	AdministratorType	Тип администратора развера.
azureADOnlyAuthentication	boolean	Включена только проверка подлинности Azure Active Directory.
login	string	Имя входа администратора сервера.
principalType	PrincipalType	Тип субъекта-администратора.
sid	string (uuid)	ИДЕНТИФИКАТОР безопасности (идентификатор объекта) администратора сервера.
tenantId	string (uuid)	Идентификатор клиента администратора.

ServerNetworkAccessFlag

Перечисление

Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.

Значение	Описание
Disabled
Enabled

ServerPrivateEndpointConnection

Object

Подключение частной конечной точки под сервером

Имя	Тип	Описание
id	string	Идентификатор ресурса.
properties	PrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке

ServerPublicNetworkAccessFlag

Перечисление

Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"

Значение	Описание
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Перечисление

Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области

Значение	Описание
Connected
Disconnected

UserIdentity

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента Azure Active Directory.
principalId	string (uuid)	Идентификатор субъекта Azure Active Directory.

Поделиться через

Servers - Create Or Update

Параметры URI

Текст запроса

Ответы

Примеры

Create server

Образец запроса

Пример ответа

Определения

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity

Дополнительные ресурсы