次の方法で共有


Servers - Update

サーバーを更新します。

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

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。

serverName
path True

string

サーバーの名前。

subscriptionId
path True

string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True

string

要求に使用する API バージョン。

要求本文

名前 説明
identity

ResourceIdentity

サーバー ID

properties.administratorLogin

string

サーバーの管理者ユーザー名。 一度作成した後は変更できません。

properties.administratorLoginPassword

string

管理者ログイン パスワード (サーバーの作成に必要)。

properties.administrators

ServerExternalAdministrator

サーバーの Azure Active Directory 管理者。 これは、サーバー作成時にのみ使用できます。 サーバーの更新に使用すると、無視されるか、エラーが発生します。 更新プログラムの場合は、個々の API を使用する必要があります。

properties.federatedClientId

string (uuid)

テナント間 CMK シナリオに使用されるクライアント ID

properties.isIPv6Enabled

ServerNetworkAccessFlag

このサーバーの IPv6 サポートを有効にするかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

properties.keyId

string

暗号化に使用するキーの CMK URI。

properties.minimalTlsVersion

MinimalTlsVersion

最小 TLS バージョン。 使用できる値: 'None'、1.0'、'1.1'、'1.2'、'1.3'

properties.primaryUserAssignedIdentityId

string

既定で使用されるユーザー割り当て ID のリソース ID。

properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' または 'SecuredByPerimeter' である必要があります

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

このサーバーの送信ネットワーク アクセスを制限するかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

properties.version

string

サーバーのバージョン。

tags

object

リソース タグ。

応答

名前 説明
200 OK

Server

サーバーを正常に更新しました。

202 Accepted

受け入れ られる

ヘッダー

Location: string

Other Status Codes

ErrorResponse

エラー応答: ***

  • 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合

  • 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合

  • 400 NameAlreadyExistsSoftDeleted - 要求されたサーバー名は、論理的に削除された状態のサーバーによって取得されます。 サーバーを消去または復旧してブロックを解除します。

  • 400 MissingIdentityId - ID の種類が UserAssigned に設定されている場合、ユーザー割り当て ID は指定されません

  • 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 は作成時にユーザーによって提供されますが、ID の種類が '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 CMKOperationNotAllowed - サーバーに Azure Key Vault アクセスがない場合に、ユーザーがサーバーで操作を実行しようとしました。

  • 400 ServerNotFound - 要求されたサーバーが見つかりませんでした。

  • 400 RegionDoesNotAllowProvisioning - 選択した場所が新しい Windows Azure SQL Database サーバーを受け入れません。 これは後で変更される可能性があります。

  • 400 InvalidMinimalTlsVersion - 最小 TLS バージョンが無効です。

  • 400 InvalidExternalAdministratorLogin - 外部管理者のログイン名が無効または不足しています。

  • 400 InvalidExternalAdministratorSid - 外部管理者オブジェクト ID が無効または不足しています。

  • 400 InvalidExternalAdministratorTenantId - 外部管理者テナント ID が無効または不足しています。

  • 400 ExternalAdministratorPrincipalType - 外部管理者プリンシパルの種類が無効または不足しています。 ユーザー、アプリケーション、またはグループから選択してください。

  • 400 MissingExternalAdministratorWithAadOnlyAuth - Azure AD のみの認証を使用するには、外部管理者の詳細を指定してください。

  • 400 ExternalAdministratorLoginSameAsSqlAdmin - Azure Active Directory 管理者とサーバー管理者アカウントの名前は異なる必要があります。 異なる値を指定してください。

  • 400 ServerAdministratorNameAlreadyExists - ユーザーが外部管理者を設定しようとしましたが、プリンシパル名は 'master' データベースに既に存在します。

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 OperationIdNotFound - Id を持つ操作が存在しません。

  • 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

  • 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。

  • 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=2023-08-01

{
  "properties": {
    "administratorLogin": "dummylogin",
    "administratorLoginPassword": "placeholder",
    "publicNetworkAccess": "Disabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "isIPv6Enabled": "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",
    "isIPv6Enabled": "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"
          }
        }
      }
    ]
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/serverOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-05-01

定義

名前 説明
AdministratorType

管理者の種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ExternalGovernanceStatus

外部ガバナンスの状態。

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

MinimalTlsVersion

最小 TLS バージョン。 使用できる値: 'None'、1.0'、'1.1'、'1.2'、'1.3'

PrincipalType

サーバー管理者のプリンシパルの種類。

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。

PrivateEndpointProperty
PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

ResourceIdentity

リソースの Azure Active Directory ID 構成。

Server

Azure SQL Database サーバー。

ServerExternalAdministrator

Active Directory 管理者のプロパティ。

ServerNetworkAccessFlag

このサーバーの送信ネットワーク アクセスを制限するかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

ServerPrivateEndpointConnection

サーバーの下のプライベート エンドポイント接続

ServerPublicNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' または 'SecuredByPerimeter' である必要があります

ServerUpdate

Azure SQL Database サーバーの更新要求。

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

UserIdentity

リソースの Azure Active Directory ID 構成。

AdministratorType

管理者の種類。

説明
ActiveDirectory

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

ExternalGovernanceStatus

外部ガバナンスの状態。

説明
Disabled
Enabled

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

説明
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

プライベート エンドポイント接続のプロパティ。

名前 説明
groupIds

string[]

グループ ID。

privateEndpoint

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

provisioningState

PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

PrivateEndpointProperty

名前 説明
id

string

プライベート エンドポイントのリソース ID。

PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

説明
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

説明
None

PrivateLinkServiceConnectionStateProperty

名前 説明
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

description

string

プライベート リンク サービスの接続の説明。

status

PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

説明
Approved
Disconnected
Pending
Rejected

ResourceIdentity

リソースの Azure Active Directory ID 構成。

名前 説明
principalId

string (uuid)

Azure Active Directory プリンシパル ID。

tenantId

string (uuid)

Azure Active Directory テナント ID。

type

IdentityType

ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

userAssignedIdentities

<string,  UserIdentity>

使用するユーザー割り当て ID のリソース ID

Server

Azure SQL Database サーバー。

名前 説明
id

string

リソース ID。

identity

ResourceIdentity

サーバーの Azure Active Directory ID。

kind

string

SQL サーバーの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。

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 シナリオに使用されるクライアント ID

properties.fullyQualifiedDomainName

string

サーバーの完全修飾ドメイン名。

properties.isIPv6Enabled

ServerNetworkAccessFlag

このサーバーの IPv6 サポートを有効にするかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

properties.keyId

string

暗号化に使用するキーの CMK URI。

properties.minimalTlsVersion

MinimalTlsVersion

最小 TLS バージョン。 使用できる値: 'None'、1.0'、'1.1'、'1.2'、'1.3'

properties.primaryUserAssignedIdentityId

string

既定で使用されるユーザー割り当て ID のリソース ID。

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

サーバー上のプライベート エンドポイント接続の一覧

properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' または 'SecuredByPerimeter' である必要があります

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

このサーバーの送信ネットワーク アクセスを制限するかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

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 (uuid)

サーバー管理者の SID (オブジェクト ID)。

tenantId

string (uuid)

管理者のテナント ID。

ServerNetworkAccessFlag

このサーバーの送信ネットワーク アクセスを制限するかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

説明
Disabled
Enabled

ServerPrivateEndpointConnection

サーバーの下のプライベート エンドポイント接続

名前 説明
id

string

リソース ID。

properties

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ

ServerPublicNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' または 'SecuredByPerimeter' である必要があります

説明
Disabled
Enabled
SecuredByPerimeter

ServerUpdate

Azure SQL Database サーバーの更新要求。

名前 説明
identity

ResourceIdentity

サーバー ID

properties.administratorLogin

string

サーバーの管理者ユーザー名。 一度作成した後は変更できません。

properties.administratorLoginPassword

string

管理者ログイン パスワード (サーバーの作成に必要)。

properties.administrators

ServerExternalAdministrator

サーバーの Azure Active Directory 管理者。 これは、サーバー作成時にのみ使用できます。 サーバーの更新に使用すると、無視されるか、エラーが発生します。 更新プログラムの場合は、個々の API を使用する必要があります。

properties.externalGovernanceStatus

ExternalGovernanceStatus

外部ガバナンスの状態。

properties.federatedClientId

string (uuid)

テナント間 CMK シナリオに使用されるクライアント ID

properties.fullyQualifiedDomainName

string

サーバーの完全修飾ドメイン名。

properties.isIPv6Enabled

ServerNetworkAccessFlag

このサーバーの IPv6 サポートを有効にするかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

properties.keyId

string

暗号化に使用するキーの CMK URI。

properties.minimalTlsVersion

MinimalTlsVersion

最小 TLS バージョン。 使用できる値: 'None'、1.0'、'1.1'、'1.2'、'1.3'

properties.primaryUserAssignedIdentityId

string

既定で使用されるユーザー割り当て ID のリソース ID。

properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

サーバー上のプライベート エンドポイント接続の一覧

properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

このサーバーに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' または 'SecuredByPerimeter' である必要があります

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

このサーバーの送信ネットワーク アクセスを制限するかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

properties.state

string

サーバーの状態。

properties.version

string

サーバーのバージョン。

properties.workspaceFeature

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

tags

object

リソース タグ。

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

説明
Connected
Disconnected

UserIdentity

リソースの Azure Active Directory ID 構成。

名前 説明
clientId

string (uuid)

Azure Active Directory クライアント ID。

principalId

string (uuid)

Azure Active Directory プリンシパル ID。