Servers - Update

參考

服務:: SQL Database

API 版本:: 2021-11-01

更新伺服器。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	類型	Description
identity	ResourceIdentity	伺服器身分識別
properties.administratorLogin	string	伺服器的系統管理員用戶名稱。建立之後，就無法變更。
properties.administratorLoginPassword	string	伺服器建立) 所需的系統管理員登入密碼 (。
properties.administrators	ServerExternalAdministrator	伺服器的 Azure Active Directory 系統管理員。
properties.federatedClientId	string	用於跨租使用者 CMK 案例的用戶端標識碼
properties.keyId	string	要用於加密之金鑰的 CMK URI。
properties.minimalTlsVersion	string	最低 TLS 版本。允許的值：'1.0'、'1.1'、'1.2'
properties.primaryUserAssignedIdentityId	string	預設會使用之使用者指派身分識別的資源標識碼。
properties.publicNetworkAccess	ServerNetworkAccessFlag	是否允許此伺服器的公用端點存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	是否要限制此伺服器的輸出網路存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
properties.version	string	伺服器版本。
tags	object	資源標籤。

回應

名稱	類型	Description
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 - 使用者所提供的 PrimaryUserAssignedIdentityId 無法存取提供的 KeyId 400 MissingPrimaryIdentity - 使用者所提供的 PrimaryUserAssignedIdentityId 沒有提供的 KeyId 存取權 400 ProvisioningDisabled - 依原樣顯示來自資源作業授權者的錯誤訊息，而不需變更 400 PrimaryIdentityMissingPermissionForKeyId - 在建立期間由使用者提供 KeyId，但 API 呼叫中未提供 PrimaryUserAssignedIdentityId 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 或無效的 Unicode 字元。 400 TokenTooLong - 提供的令牌太長。 400 RegionDoesNotAllowProvisioning - 選取的位置不接受新的 Windows Azure SQL 資料庫伺服器。這可能會在稍後變更。 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 - 超出可用資源可處理之最大要求的要求。

名稱

類型

Description

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 - 使用者所提供的 PrimaryUserAssignedIdentityId 無法存取提供的 KeyId
400 MissingPrimaryIdentity - 使用者所提供的 PrimaryUserAssignedIdentityId 沒有提供的 KeyId 存取權
400 ProvisioningDisabled - 依原樣顯示來自資源作業授權者的錯誤訊息，而不需變更
400 PrimaryIdentityMissingPermissionForKeyId - 在建立期間由使用者提供 KeyId，但 API 呼叫中未提供 PrimaryUserAssignedIdentityId
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 或無效的 Unicode 字元。
400 TokenTooLong - 提供的令牌太長。
400 RegionDoesNotAllowProvisioning - 選取的位置不接受新的 Windows Azure SQL 資料庫伺服器。這可能會在稍後變更。
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"
  }
}


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

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

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 200

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

狀態碼:: 202

定義

名稱	Description
AdministratorType	伺服器管理員的類型。
IdentityType	識別類型。將此設定為『SystemAssigned』，以便自動建立並指派資源的 Azure Active Directory 主體。
PrincipalType	伺服器管理員的主體類型。
PrivateEndpointConnectionProperties	私人端點連線的屬性。
PrivateEndpointProperty
PrivateEndpointProvisioningState	私人端點連線的狀態。
PrivateLinkServiceConnectionStateActionsRequire	私人鏈接服務連線所需的動作。
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	私人鏈接服務連線狀態。
ResourceIdentity	資源的 Azure Active Directory 身分識別設定。
Server	Azure SQL 資料庫伺服器。
ServerExternalAdministrator	Active Directory 系統管理員的屬性。
ServerNetworkAccessFlag	是否允許此伺服器的公用端點存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
ServerPrivateEndpointConnection	伺服器下的私人端點連線
ServerUpdate	Azure SQL 資料庫伺服器的更新要求。
ServerWorkspaceFeature	現有伺服器是否已建立工作區，以及是否允許從工作區進行連線
UserIdentity	資源的 Azure Active Directory 身分識別設定。

AdministratorType

伺服器管理員的類型。

名稱	類型	Description
ActiveDirectory	string

IdentityType

識別類型。將此設定為『SystemAssigned』，以便自動建立並指派資源的 Azure Active Directory 主體。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

伺服器管理員的主體類型。

名稱	類型	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

私人端點連線的屬性。

名稱	類型	Description
groupIds	string[]	群組標識碼。
privateEndpoint	PrivateEndpointProperty	線上所屬的私人端點。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	私人端點連線的連接狀態。
provisioningState	PrivateEndpointProvisioningState	私人端點連線的狀態。

PrivateEndpointProperty

名稱	類型	Description
id	string	私人端點的資源標識碼。

PrivateEndpointProvisioningState

私人端點連線的狀態。

名稱	類型	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

名稱	類型	Description
None	string

PrivateLinkServiceConnectionStateProperty

名稱	類型	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	私人鏈接服務連線所需的動作。
description	string	私人鏈接服務連線描述。
status	PrivateLinkServiceConnectionStateStatus	私人鏈接服務連線狀態。

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

資源的 Azure Active Directory 身分識別設定。

名稱	類型	Description
principalId	string	Azure Active Directory 主體標識符。
tenantId	string	Azure Active Directory 租用戶標識符。
type	IdentityType	識別類型。將此設定為『SystemAssigned』，以便自動建立並指派資源的 Azure Active Directory 主體。
userAssignedIdentities	<string, UserIdentity>	要使用的使用者指派身分識別的資源標識碼

Server

Azure SQL 資料庫伺服器。

名稱	類型	Description
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	要用於加密之金鑰的 CMK URI。
properties.minimalTlsVersion	string	最低 TLS 版本。允許的值：'1.0'、'1.1'、'1.2'
properties.primaryUserAssignedIdentityId	string	預設會使用之使用者指派身分識別的資源標識碼。
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	伺服器上的私人端點連線清單
properties.publicNetworkAccess	ServerNetworkAccessFlag	是否允許此伺服器的公用端點存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	是否要限制此伺服器的輸出網路存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
properties.state	string	伺服器的狀態。
properties.version	string	伺服器版本。
properties.workspaceFeature	ServerWorkspaceFeature	現有伺服器是否已建立工作區，以及是否允許從工作區進行連線
tags	object	資源標籤。
type	string	資源類型。

ServerExternalAdministrator

Active Directory 系統管理員的屬性。

名稱	類型	Description
administratorType	AdministratorType	伺服器管理員的類型。
azureADOnlyAuthentication	boolean	僅啟用 Azure Active Directory 驗證。
login	string	伺服器管理員的登入名稱。
principalType	PrincipalType	伺服器管理員的主體類型。
sid	string	伺服器管理員) SID (物件識別碼。
tenantId	string	系統管理員的租用戶標識碼。

ServerNetworkAccessFlag

是否允許此伺服器的公用端點存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'

名稱	類型	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

伺服器下的私人端點連線

名稱	類型	Description
id	string	資源識別碼。
properties	PrivateEndpointConnectionProperties	私人端點連線屬性

ServerUpdate

Azure SQL 資料庫伺服器的更新要求。

名稱	類型	Description
identity	ResourceIdentity	伺服器身分識別
properties.administratorLogin	string	伺服器的系統管理員用戶名稱。建立之後，就無法變更。
properties.administratorLoginPassword	string	伺服器建立) 所需的系統管理員登入密碼 (。
properties.administrators	ServerExternalAdministrator	伺服器的 Azure Active Directory 系統管理員。
properties.federatedClientId	string	用於跨租使用者 CMK 案例的用戶端標識碼
properties.fullyQualifiedDomainName	string	伺服器的完整功能變數名稱。
properties.keyId	string	要用於加密之金鑰的 CMK URI。
properties.minimalTlsVersion	string	最低 TLS 版本。允許的值：'1.0'、'1.1'、'1.2'
properties.primaryUserAssignedIdentityId	string	預設會使用之使用者指派身分識別的資源標識碼。
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	伺服器上的私人端點連線清單
properties.publicNetworkAccess	ServerNetworkAccessFlag	是否允許此伺服器的公用端點存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	是否要限制此伺服器的輸出網路存取。值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'
properties.state	string	伺服器的狀態。
properties.version	string	伺服器版本。
properties.workspaceFeature	ServerWorkspaceFeature	現有伺服器是否已建立工作區，以及是否允許從工作區進行連線
tags	object	資源標籤。

ServerWorkspaceFeature

現有伺服器是否已建立工作區，以及是否允許從工作區進行連線

名稱	類型	Description
Connected	string
Disconnected	string

UserIdentity

資源的 Azure Active Directory 身分識別設定。

名稱	類型	Description
clientId	string	Azure Active Directory 用戶端標識符。
principalId	string	Azure Active Directory 主體標識符。

共用方式為

Servers - Update

URI 參數

要求本文

回應

範例

Update a server

範例要求

範例回覆

定義

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerUpdate

ServerWorkspaceFeature

UserIdentity

其他資源