同期エージェント キーを生成します。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/generateKey?api-version=2021-11-01
URI パラメーター
| 名前 |
/ |
必須 |
型 |
説明 |
|
resourceGroupName
|
path |
True
|
string
|
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
|
|
serverName
|
path |
True
|
string
|
同期エージェントがホストされているサーバーの名前。
|
|
subscriptionId
|
path |
True
|
string
|
Azure サブスクリプションを識別するサブスクリプション ID。
|
|
syncAgentName
|
path |
True
|
string
|
同期エージェントの名前。
|
|
api-version
|
query |
True
|
string
|
要求で使用する API のバージョン。
|
応答
| 名前 |
型 |
説明 |
|
200 OK
|
SyncAgentKeyProperties
|
同期エージェント キーが正常に生成されました。
|
|
Other Status Codes
|
|
エラー応答: ***
400 InvalidSyncGroupCreateOrUpdateRequest - 同期グループの作成または更新要求本文が空です。
400 InvalidSyncMemberCreateOrUpdateRequest - 同期メンバーの作成または更新要求本文が空です。
400 InvalidSyncAgentCreateOrUpdateRequest - 同期エージェントの作成または更新要求本文が空です。
400 InvalidDatabaseResourceId - データベース リソース識別子が無効です。
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 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。
409 SyncOperation_AgentAlreadyExists - 同じ名前の同期エージェントが既に存在します。
409 SyncOperation_AgentIdAlreadyExists - 同じ ID の同期エージェントが既に存在します。
|
例
Generate a sync agent key
要求のサンプル
POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/generateKey?api-version=2021-11-01
/**
* Samples for SyncAgents GenerateKey.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGenerateKey.json
*/
/**
* Sample code: Generate a sync agent key.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void generateASyncAgentKey(com.azure.resourcemanager.AzureResourceManager azure) {
azure.sqlServers().manager().serviceClient().getSyncAgents().generateKeyWithResponse("syncagentcrud-65440",
"syncagentcrud-8475", "syncagentcrud-3187", 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
応答のサンプル
{
"syncAgentKey": "865f9998-6dae-4214-bbb1-4796b7c76ca0:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX="
}
定義
SyncAgentKeyProperties
Azure SQL データベース同期エージェント キーのプロパティ。
| 名前 |
型 |
説明 |
|
syncAgentKey
|
string
|
同期エージェントのキー。
|