Sync Members - Create Or Update

サービス:
SQL Database
API バージョン:
2025-01-01

同期メンバーを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}?api-version=2025-01-01

URI パラメーター

名前 / 必須 型 説明
databaseName
 path True

string

データベースの名前。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前の大文字と小文字は区別されません。
serverName
 path True

string

サーバーの名前。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
syncGroupName
 path True

string

同期グループの名前。
syncMemberName
 path True

string

同期メンバーの名前。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 型 説明
properties.databaseName

string

同期メンバー内のメンバー データベースのデータベース名。
properties.databaseType

SyncMemberDbType

同期メンバーのデータベースの種類。
properties.password

string

同期メンバー内のメンバー データベースのパスワード。
properties.serverName

string

同期メンバー内のメンバー データベースのサーバー名
properties.sqlServerDatabaseId

string (uuid)

SQL Server の同期メンバーのデータベースIDです。
properties.syncAgentId

string

同期メンバー内の同期エージェントの ARM リソース ID。
properties.syncDirection

SyncDirection

同期メンバーの同期の方向。
properties.syncMemberAzureDatabaseResourceId

string

Azureの同期メンバー用、Sync メンバーの論理データベースのARMリソースID。
properties.usePrivateLinkConnection

boolean

プライベート リンク接続を使用するかどうか。
properties.userName

string

同期メンバー内のメンバー データベースのユーザー名。

応答

名前 型 説明
200 OK

SyncMember

リソース「SyncMember」更新操作が成功しました
201 Created

SyncMember

リソース「SyncMember」作成操作が成功しました

ヘッダー

  • Location: string
  • Retry-After: integer
202 Accepted

リソース操作が受け入れられます。

ヘッダー

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

Create a new sync member
Update a sync member

Create a new sync member

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879?api-version=2025-01-01

{
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

応答のサンプル

状態コード:
200 
{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}
状態コード:
201 
{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}
状態コード:
202

Update a sync member

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879?api-version=2025-01-01

{
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

応答のサンプル

状態コード:
200 
{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}
状態コード:
201 
{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}
状態コード:
202

定義

名前 説明
createdByType

リソースを作成した ID の種類。
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
SyncDirection

同期メンバーの同期の方向。
SyncMember

Azure SQL Databaseの同期メンバーです。
SyncMemberDbType

同期エージェントのリンク されたデータベースの種類。
SyncMemberState

同期メンバーの同期状態。
systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

SyncDirection

列挙

同期メンバーの同期の方向。

値 説明
Bidirectional

双方向
OneWayMemberToHub

ワンウェイメンバートゥハブ
OneWayHubToMember

ワンウェイハブメンバー

SyncMember

Object

Azure SQL Databaseの同期メンバーです。

名前 型 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

リソースの名前
properties.databaseName

string

同期メンバー内のメンバー データベースのデータベース名。
properties.databaseType

SyncMemberDbType

同期メンバーのデータベースの種類。
properties.password

string

同期メンバー内のメンバー データベースのパスワード。
properties.privateEndpointName

string

Azureの同期メンバーの場合、プライベートリンク接続が有効の場合、同期メンバーのプライベートエンドポイント名が表示されます。
properties.serverName

string

同期メンバー内のメンバー データベースのサーバー名
properties.sqlServerDatabaseId

string (uuid)

SQL Server の同期メンバーのデータベースIDです。
properties.syncAgentId

string

同期メンバー内の同期エージェントの ARM リソース ID。
properties.syncDirection

SyncDirection

同期メンバーの同期の方向。
properties.syncMemberAzureDatabaseResourceId

string

Azureの同期メンバー用、Sync メンバーの論理データベースのARMリソースID。
properties.syncState

SyncMemberState

同期メンバーの同期状態。
properties.usePrivateLinkConnection

boolean

プライベート リンク接続を使用するかどうか。
properties.userName

string

同期メンバー内のメンバー データベースのユーザー名。
systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

SyncMemberDbType

列挙

同期エージェントのリンク されたデータベースの種類。

値 説明
AzureSqlDatabase

AzureSqlDatabase
SqlServerDatabase

SqlServerDatabase

SyncMemberState

列挙

同期メンバーの同期状態。

値 説明
SyncInProgress

SyncInProgress(進行中のSyncInProgress)
SyncSucceeded

SyncSucceeded
SyncFailed

同期失敗
DisabledTombstoneCleanup

DisabledTombstoneCleanup
DisabledBackupRestore

DisabledBackupRestore
SyncSucceededWithWarnings

同期成功警告
SyncCancelling

同期キャンセリング
SyncCancelled

同期キャンセル
UnProvisioned

アンプロビッショニング
Provisioning

プロビジョニング
Provisioned

プロビジョニング済み
ProvisionFailed

プロビジョーション失敗
DeProvisioning

デプロビジョニング
DeProvisioned

デプロビジョーテッド
DeProvisionFailed

DeProvisionFailed
Reprovisioning

再プロビジョニング
ReprovisionFailed

再提供失敗
UnReprovisioned

再配置解除

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。