Servers - Update

Обновляет сервер.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

serverName
path True

string

Имя сервера.

subscriptionId
path True

string

Идентификатор подписки Azure.

api-version
query True

string

Версия API для использования в запросе.

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

Имя Тип Описание
identity

ResourceIdentity

Удостоверение сервера

properties.administratorLogin

string

Имя администратора для сервера. После создания его нельзя изменить.

properties.administratorLoginPassword

string

Пароль для входа администратора (требуется для создания сервера).

properties.administrators

ServerExternalAdministrator

Администратор сервера Azure Active Directory.

properties.federatedClientId

string

Идентификатор клиента, используемый для межтенантного сценария CMK

properties.keyId

string

URI CMK ключа, используемого для шифрования.

properties.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

Идентификатор ресурса назначенного пользователем удостоверения, используемого по умолчанию.

properties.publicNetworkAccess

ServerNetworkAccessFlag

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

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

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

properties.version

string

Версия сервера.

tags

object

Теги ресурсов.

Ответы

Имя Тип Описание
200 OK

Server

Сервер успешно обновлен.

202 Accepted

Принято

Other Status Codes

Ответы об ошибках: ***

  • 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 — PrimaryUserAssignedId, предоставленный пользователем, не имеет доступа к предоставленному идентификатору KeyId

  • 400 MissingPrimaryIdentity — PrimaryUserAssignedId, предоставленный пользователем, не имеет доступа к Идентификатору ключа.

  • 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 RegionDoesNotAllowProvisioning — выбранное расположение не принимает новые серверы Windows Azure SQL Database. Это может измениться позже.

  • 400 ServerNotFound — запрошенный сервер не найден.

  • 400 InvalidMinimalTlsVersion — недопустимая минимальная версия TLS.

  • 400 InvalidExternalAdministratorLogin — недопустимое или отсутствуют имя для входа внешнего администратора.

  • 400 InvalidExternalAdministratorSid — недопустимый или отсутствующий идентификатор объекта внешнего администратора.

  • 400 InvalidExternalAdministratorTenantId — недопустимый или отсутствующий идентификатор клиента внешнего администратора.

  • 400 ExternalAdministratorPrincipalType — недопустимый или отсутствующий тип субъекта внешнего администратора. Выберите пользователь, приложение или группу.

  • 400 MissingExternalAdministratorWithAadOnlyAuth — чтобы использовать проверку подлинности только Azure AD, укажите сведения о внешнем администраторе.

  • 400 ExternalAdministratorLoginSameAsSqlAdmin — имена администратора Azure Active Directory и учетной записи администратора сервера должны отличаться. Укажите другие значения.

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден.

  • 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

  • 404 OperationIdNotFound — операция с идентификатором не существует.

  • 404 SubscriptionNotFound — запрошенная подписка не найдена.

  • 409 OperationCancelled — операция была отменена пользователем.

  • 409 OperationInterrupted — не удалось завершить операцию с ресурсом, так как она была прервана другой операцией с тем же ресурсом.

  • 409 UpsertLogicalServerRequestAlreadyInProgress — текущий запрос логического сервера уже выполняется. Повторите запрос позже.

  • 409 ServerDisabled — сервер отключен.

  • 409 ConflictingServerOperation — в настоящее время выполняется операция для сервера.

  • 409 SubscriptionDisabled — подписка отключена.

  • 409 ServerQuotaExceeded — сервер не может быть добавлен в подписку, так как он превысит квоту.

  • 409 ServerAlreadyExists — повторяющееся имя сервера.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы сверх максимального количества запросов, которые могут быть обработаны доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы сверх максимального количества запросов, которые могут быть обработаны доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 429 ConflictingSubscriptionOperation — в настоящее время выполняется операция для подписки.

  • 500 OperationTimedOut — время ожидания операции истекло и автоматически откатывается. Повторите операцию.

  • 503 TooManyRequests — запросы сверх максимального числа запросов, которые могут быть обработаны доступными ресурсами.

  • 503 TooManyRequests — запросы сверх максимального числа запросов, которые могут быть обработаны доступными ресурсами.

Примеры

Update a server

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

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

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

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

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

Определения

Имя Описание
AdministratorType

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

IdentityType

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

PrincipalType

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

PrivateEndpointConnectionProperties

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

PrivateEndpointProperty
PrivateEndpointProvisioningState

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

PrivateLinkServiceConnectionStateActionsRequire

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

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

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

ResourceIdentity

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

Server

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

ServerExternalAdministrator

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

ServerNetworkAccessFlag

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

ServerPrivateEndpointConnection

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

ServerUpdate

Запрос на обновление для сервера базы данных Azure SQL.

ServerWorkspaceFeature

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

UserIdentity

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

AdministratorType

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

Имя Тип Описание
ActiveDirectory

string

IdentityType

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

Имя Тип Описание
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

PrincipalType

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

Имя Тип Описание
Application

string

Group

string

User

string

PrivateEndpointConnectionProperties

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

Имя Тип Описание
groupIds

string[]

Идентификаторы групп.

privateEndpoint

PrivateEndpointProperty

Частная конечная точка, к которой принадлежит подключение.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

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

provisioningState

PrivateEndpointProvisioningState

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

PrivateEndpointProperty

Имя Тип Описание
id

string

Идентификатор ресурса частной конечной точки.

PrivateEndpointProvisioningState

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

Имя Тип Описание
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

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

Имя Тип Описание
None

string

PrivateLinkServiceConnectionStateProperty

Имя Тип Описание
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

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

description

string

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

status

PrivateLinkServiceConnectionStateStatus

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

PrivateLinkServiceConnectionStateStatus

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

Имя Тип Описание
Approved

string

Disconnected

string

Pending

string

Rejected

string

ResourceIdentity

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

Имя Тип Описание
principalId

string

Идентификатор субъекта Azure Active Directory.

tenantId

string

Идентификатор клиента Azure Active Directory.

type

IdentityType

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

userAssignedIdentities

<string,  UserIdentity>

Идентификаторы ресурсов удостоверений, назначаемых пользователем для использования

Server

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

Имя Тип Описание
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.

properties.federatedClientId

string

Идентификатор клиента, используемый для межтенантного сценария CMK

properties.fullyQualifiedDomainName

string

Полное доменное имя сервера.

properties.keyId

string

URI CMK ключа, используемого для шифрования.

properties.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

Идентификатор ресурса назначенного пользователем удостоверения, используемого по умолчанию.

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

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

properties.publicNetworkAccess

ServerNetworkAccessFlag

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

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

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

properties.state

string

Состояние сервера.

properties.version

string

Версия сервера.

properties.workspaceFeature

ServerWorkspaceFeature

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

tags

object

Теги ресурсов.

type

string

Тип ресурса.

ServerExternalAdministrator

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

Имя Тип Описание
administratorType

AdministratorType

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

azureADOnlyAuthentication

boolean

Включена только проверка подлинности Azure Active Directory.

login

string

Имя входа администратора сервера.

principalType

PrincipalType

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

sid

string

SID (идентификатор объекта) администратора сервера.

tenantId

string

Идентификатор клиента администратора.

ServerNetworkAccessFlag

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

Имя Тип Описание
Disabled

string

Enabled

string

ServerPrivateEndpointConnection

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

Имя Тип Описание
id

string

Идентификатор ресурса.

properties

PrivateEndpointConnectionProperties

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

ServerUpdate

Запрос на обновление для сервера базы данных Azure SQL.

Имя Тип Описание
identity

ResourceIdentity

Удостоверение сервера

properties.administratorLogin

string

Имя администратора для сервера. После создания его нельзя изменить.

properties.administratorLoginPassword

string

Пароль для входа администратора (требуется для создания сервера).

properties.administrators

ServerExternalAdministrator

Администратор сервера Azure Active Directory.

properties.federatedClientId

string

Идентификатор клиента, используемый для межтенантного сценария CMK

properties.fullyQualifiedDomainName

string

Полное доменное имя сервера.

properties.keyId

string

URI CMK ключа, используемого для шифрования.

properties.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

Идентификатор ресурса назначенного пользователем удостоверения, используемого по умолчанию.

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

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

properties.publicNetworkAccess

ServerNetworkAccessFlag

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

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

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

properties.state

string

Состояние сервера.

properties.version

string

Версия сервера.

properties.workspaceFeature

ServerWorkspaceFeature

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

tags

object

Теги ресурсов.

ServerWorkspaceFeature

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

Имя Тип Описание
Connected

string

Disconnected

string

UserIdentity

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

Имя Тип Описание
clientId

string

Идентификатор клиента Azure Active Directory.

principalId

string

Идентификатор субъекта Azure Active Directory.