次の方法で共有

Sync Agents - Get

  • リファレンス
サービス:
SQL Database
API バージョン:
2023-08-01

同期エージェントを取得します。

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

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

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

string

同期エージェントがホストされているサーバーの名前。
subscriptionId
 path True

string

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

string

同期エージェントの名前。
api-version
 query True

string

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

応答

名前 型 説明
200 OK

SyncAgent

指定した同期エージェントを正常に取得しました。
Other Status Codes

ErrorResponse

エラー応答: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest - 同期グループの作成または更新要求本文が空です。

  • 400 InvalidSyncMemberCreateOrUpdateRequest - 同期メンバーの作成または更新要求本文が空です。

  • 400 InvalidSyncAgentCreateOrUpdateRequest - 同期エージェントの作成または更新要求本文が空です。

  • 400 InvalidDatabaseResourceId - データベース リソース識別子が無効です。

  • 400 InvalidSyncGroupName - 同期グループ名が無効です。 このフィールドには、文字、数字、ダッシュ、アンダースコアを含めることができます。

  • 400 InvalidSyncMemberName - 同期メンバー名が無効です。 このフィールドには、文字、数字、ダッシュ、アンダースコアを含めることができます。

  • 400 MissingSyncMemberName - 同期メンバー名がありません

  • 400 InvalidSyncGroupInterval - 同期間隔は 5 秒以上にする必要があります。

  • 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL のサブスクリプションと一致しませんでした。

  • 400 InvalidSyncAgentResourceId - 同期エージェントのリソース識別子が無効です。

  • 400 MismatchingResourceGroupNameWithUrl - 指定されたリソース グループ名が URL 内の名前と一致しませんでした。

  • 400 MismatchingServerNameWithUrl - 指定されたサーバー名が URL 内の名前と一致しませんでした。

  • 400 InvalidParameterValue - パラメーターに無効な値が指定されました。

  • 400 MissingServerName - サーバー名がありません

  • 400 MissingDatabaseName - データベース名がありません

  • 400 MissingSyncGroupName - 同期グループ名がありません

  • 400 MissingConflictResolutionPolicy - 競合解決ポリシーがありません

  • 400 MissingSyncAgentName - 同期エージェント名がありません

  • 400 SyncOperation_GenericFailure - データ同期操作を実行できませんでした。

  • 400 SyncOperation_WrongSyncDatabase - 指定された同期データベースが既存のデータベースと一致しません。

  • 400 SyncOperation_DwInSyncGroup - データ同期で datawarehouse エディションを使用できません。

  • 400 SyncOperation_MasterDbInSyncGroup - データ同期で論理マスターを使用できません。

  • 400 CannotDeleteInUseSyncAgent - 同期メンバーによって使用されるため、同期エージェントを削除できません。

  • 400 InvalidSyncAgent - 同期エージェントが無効です。

  • 400 InvalidSyncMetadataDatabase - 同期メタデータ データベースが無効です。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

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

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

  • 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。

  • 409 SyncOperation_AgentAlreadyExists - 同じ名前の同期エージェントが既に存在します。

  • 409 SyncOperation_AgentIdAlreadyExists - 同じ ID の同期エージェントが既に存在します。

  • 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Get a sync agent

要求のサンプル

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187?api-version=2023-08-01

応答のサンプル

状態コード:
200 
{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
SyncAgent

Azure SQL Database 同期エージェント。
SyncAgentState

同期エージェントの状態。

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

SyncAgent

Object

Azure SQL Database 同期エージェント。

名前 型 説明
id

string

リソース ID。
name

string

リソース名。
properties.expiryTime

string (date-time)

同期エージェントのバージョンの有効期限。
properties.isUpToDate

boolean

同期エージェントのバージョンが最新の場合。
properties.lastAliveTime

string (date-time)

同期エージェントの最後の有効期間。
properties.name

string

同期エージェントの名前。
properties.state

SyncAgentState

同期エージェントの状態。
properties.syncDatabaseId

string

同期エージェント内の同期データベースの ARM リソース ID。
properties.version

string

同期エージェントのバージョン。
type

string

リソースの種類。

SyncAgentState

列挙

同期エージェントの状態。

値 説明
NeverConnected
Offline
Online