次の方法で共有


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

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー 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 管理者。

properties.federatedClientId

string

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

properties.keyId

string

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

properties.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

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

properties.publicNetworkAccess

ServerNetworkAccessFlag

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

properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

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

properties.version

string

サーバーのバージョンです。

tags

object

リソース タグ。

応答

名前 説明
200 OK

Server

サーバーが正常に更新されました。

202 Accepted

同意

Other Status Codes

エラー応答: ***

  • 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 RegionDoesNotAllowProvisioning - 選択した場所が新しい Windows Azure SQL データベース サーバーを受け入れません。 これは後で変更される場合があります。

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

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

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

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

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

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

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

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

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

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

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

  • 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

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

PrincipalType

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

PrivateEndpointConnectionProperties

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

PrivateEndpointProperty
PrivateEndpointProvisioningState

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

PrivateLinkServiceConnectionStateActionsRequire

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

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

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

ResourceIdentity

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

Server

Azure SQL データベース サーバー。

ServerExternalAdministrator

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

ServerNetworkAccessFlag

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

ServerPrivateEndpointConnection

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

ServerUpdate

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

ServerWorkspaceFeature

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

UserIdentity

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

AdministratorType

管理者の種類。

名前 説明
ActiveDirectory

string

IdentityType

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

名前 説明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

PrincipalType

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

名前 説明
Application

string

Group

string

User

string

PrivateEndpointConnectionProperties

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

名前 説明
groupIds

string[]

グループ ID。

privateEndpoint

PrivateEndpointProperty

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

privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

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

provisioningState

PrivateEndpointProvisioningState

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

PrivateEndpointProperty

名前 説明
id

string

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

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 ID 構成。

名前 説明
principalId

string

Azure Active Directory プリンシパル ID。

tenantId

string

Azure Active Directory テナント ID。

type

IdentityType

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

userAssignedIdentities

<string,  UserIdentity>

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

Server

Azure SQL データベース サーバー。

名前 説明
id

string

リソースの ID

identity

ResourceIdentity

サーバーの Azure Active Directory ID。

kind

string

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

location

string

リソースの場所。

name

string

リソース名。

properties.administratorLogin

string

サーバーの管理者ユーザー名。 一度作成すると、変更できません。

properties.administratorLoginPassword

string

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

properties.administrators

ServerExternalAdministrator

サーバーの Azure Active Directory 管理者。

properties.federatedClientId

string

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

properties.fullyQualifiedDomainName

string

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

properties.keyId

string

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

properties.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

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

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 管理者のプロパティ。

名前 説明
administratorType

AdministratorType

管理者の種類。

azureADOnlyAuthentication

boolean

Azure Active Directory のみ認証が有効になっています。

login

string

サーバー管理者のログイン名。

principalType

PrincipalType

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

sid

string

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

tenantId

string

管理者のテナント ID。

ServerNetworkAccessFlag

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

名前 説明
Disabled

string

Enabled

string

ServerPrivateEndpointConnection

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

名前 説明
id

string

リソースの ID

properties

PrivateEndpointConnectionProperties

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

ServerUpdate

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

名前 説明
identity

ResourceIdentity

サーバー ID

properties.administratorLogin

string

サーバーの管理者ユーザー名。 一度作成すると、変更できません。

properties.administratorLoginPassword

string

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

properties.administrators

ServerExternalAdministrator

サーバーの Azure Active Directory 管理者。

properties.federatedClientId

string

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

properties.fullyQualifiedDomainName

string

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

properties.keyId

string

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

properties.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

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

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

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

名前 説明
Connected

string

Disconnected

string

UserIdentity

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

名前 説明
clientId

string

Azure Active Directory クライアント ID。

principalId

string

Azure Active Directory プリンシパル ID。