Servers - Update

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

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

Параметры URI

Name In Required Type Description
resourceGroupName
path True
  • string

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

serverName
path True
  • string

Имя сервера.

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

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

Name Type Description
identity

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

properties.administratorLogin
  • string

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

properties.administratorLoginPassword
  • string

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

properties.administrators

Администратор 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

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

properties.restrictOutboundNetworkAccess

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

properties.version
  • string

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

tags
  • object

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

Ответы

Name Type Description
200 OK

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

202 Accepted

Принято

Other Status Codes

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

  • 400 MissingIdentityId — удостоверение, назначаемое пользователем, не предоставляется, если для типа удостоверения задано значение UserAssigned

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

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

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

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

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

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

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

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

  • 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 ConflictingSubscriptionOperation — в настоящее время выполняется операция для подписки.

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

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

Примеры

Update a server

Sample Request

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

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

Sample Response

{
  "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

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

IdentityType

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

PrincipalType

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

PrivateEndpointConnectionProperties

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

PrivateEndpointProperty
PrivateEndpointProvisioningState

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

PrivateLinkServiceConnectionStateActionsRequire

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

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

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

ResourceIdentity

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

Server

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

ServerExternalAdministrator

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

ServerNetworkAccessFlag

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

ServerPrivateEndpointConnection

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

ServerUpdate

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

ServerWorkspaceFeature

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

UserIdentity

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

AdministratorType

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

Name Type Description
ActiveDirectory
  • string

IdentityType

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

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

PrincipalType

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

Name Type Description
Application
  • string
Group
  • string
User
  • string

PrivateEndpointConnectionProperties

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

Name Type Description
groupIds
  • string[]

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

privateEndpoint

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

privateLinkServiceConnectionState

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

provisioningState

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

PrivateEndpointProperty

Name Type Description
id
  • string

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

PrivateEndpointProvisioningState

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

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

PrivateLinkServiceConnectionStateActionsRequire

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

Name Type Description
None
  • string

PrivateLinkServiceConnectionStateProperty

Name Type Description
actionsRequired

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

description
  • string

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

status

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

PrivateLinkServiceConnectionStateStatus

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

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

ResourceIdentity

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

Name Type Description
principalId
  • string

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

tenantId
  • string

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

type

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

userAssignedIdentities

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

Server

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

Name Type Description
id
  • string

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

identity

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

kind
  • string

Тип sql server. Это метаданные, используемые для портал Azure взаимодействия.

location
  • string

Расположение ресурса.

name
  • string

Имя ресурса.

properties.administratorLogin
  • string

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

properties.administratorLoginPassword
  • string

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

properties.administrators

Администратор 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

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

properties.publicNetworkAccess

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

properties.restrictOutboundNetworkAccess

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

properties.state
  • string

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

properties.version
  • string

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

properties.workspaceFeature

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

tags
  • object

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

type
  • string

Тип ресурса.

ServerExternalAdministrator

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

Name Type Description
administratorType

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

azureADOnlyAuthentication
  • boolean

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

login
  • string

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

principalType

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

sid
  • string

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

tenantId
  • string

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

ServerNetworkAccessFlag

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

Name Type Description
Disabled
  • string
Enabled
  • string

ServerPrivateEndpointConnection

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

Name Type Description
id
  • string

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

properties

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

ServerUpdate

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

Name Type Description
identity

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

properties.administratorLogin
  • string

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

properties.administratorLoginPassword
  • string

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

properties.administrators

Администратор 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

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

properties.publicNetworkAccess

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

properties.restrictOutboundNetworkAccess

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

properties.state
  • string

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

properties.version
  • string

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

properties.workspaceFeature

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

tags
  • object

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

ServerWorkspaceFeature

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

Name Type Description
Connected
  • string
Disconnected
  • string

UserIdentity

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

Name Type Description
clientId
  • string

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

principalId
  • string

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