Distributed Availability Groups - Create Or Update

サービス:: SQL Database

API バージョン:: 2025-01-01

SQL On-PremとSQL Managed Instanceの間で分散型可用性グループを作成します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
distributedAvailabilityGroupName	path	True	string	分散型可用性グループ名。
managedInstanceName	path	True	string	マネージドインスタンスの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.databases	DistributedAvailabilityGroupDatabase[]	分散型可用性グループ内のデータベース
properties.failoverMode	FailoverModeType	リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。
properties.instanceAvailabilityGroupName	string	マネージドインスタンス側の可用性グループ名
properties.instanceLinkRole	LinkRole	マネージドインスタンス側のリンクロール
properties.partnerAvailabilityGroupName	string	SQL サーバー側の可用性グループ名
properties.partnerEndpoint	string	SQL サーバー側のエンドポイント - IP または DNS 解決可能な名前
properties.replicationMode	ReplicationModeType	リンクのレプリケーションモード
properties.seedingMode	SeedingModeType	データベースシードモード – サポートされているシナリオでは、自動 (既定)、または手動にすることができます。

応答

名前	型	説明
200 OK	DistributedAvailabilityGroup	リソース「DistributedAvailabilityGroup」更新操作が成功しました
201 Created	DistributedAvailabilityGroup	リソース「DistributedAvailabilityGroup」作成操作成功ヘッダー 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 distributed availability group with all properties.

Create a distributed availability group with minimal properties.

Create a distributed availability group with all properties.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag?api-version=2025-01-01

{
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}


import com.azure.resourcemanager.sql.fluent.models.DistributedAvailabilityGroupInner;
import com.azure.resourcemanager.sql.models.DistributedAvailabilityGroupDatabase;
import com.azure.resourcemanager.sql.models.FailoverModeType;
import com.azure.resourcemanager.sql.models.LinkRole;
import com.azure.resourcemanager.sql.models.SeedingModeType;
import java.util.Arrays;

/**
 * Samples for DistributedAvailabilityGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsCreateMax.json
     */
    /**
     * Sample code: Create a distributed availability group with all properties.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createADistributedAvailabilityGroupWithAllProperties(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDistributedAvailabilityGroups().createOrUpdate("testrg", "testcl", "dag",
            new DistributedAvailabilityGroupInner().withPartnerAvailabilityGroupName("BoxLocalAg1")
                .withPartnerEndpoint("TCP://SERVER:7022").withInstanceLinkRole(LinkRole.PRIMARY)
                .withInstanceAvailabilityGroupName("testcl").withFailoverMode(FailoverModeType.NONE)
                .withSeedingMode(SeedingModeType.AUTOMATIC)
                .withDatabases(Arrays.asList(new DistributedAvailabilityGroupDatabase().withDatabaseName("testdb"))),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python distributed_availability_groups_create_max.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.distributed_availability_groups.begin_create_or_update(
        resource_group_name="testrg",
        managed_instance_name="testcl",
        distributed_availability_group_name="dag",
        parameters={
            "properties": {
                "databases": [{"databaseName": "testdb"}],
                "failoverMode": "None",
                "instanceAvailabilityGroupName": "testcl",
                "instanceLinkRole": "Primary",
                "partnerAvailabilityGroupName": "BoxLocalAg1",
                "partnerEndpoint": "TCP://SERVER:7022",
                "seedingMode": "Automatic",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsCreateMax.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
 *
 * @summary creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
 * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsCreateMax.json
 */
async function createADistributedAvailabilityGroupWithAllProperties() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.distributedAvailabilityGroups.createOrUpdate(
    "testrg",
    "testcl",
    "dag",
    {
      databases: [{ databaseName: "testdb" }],
      failoverMode: "None",
      instanceAvailabilityGroupName: "testcl",
      instanceLinkRole: "Primary",
      partnerAvailabilityGroupName: "BoxLocalAg1",
      partnerEndpoint: "TCP://SERVER:7022",
      seedingMode: "Automatic",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/DistributedAvailabilityGroupsCreateMax.json
// this example is just showing the usage of "DistributedAvailabilityGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testcl";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this SqlDistributedAvailabilityGroupResource
SqlDistributedAvailabilityGroupCollection collection = managedInstance.GetSqlDistributedAvailabilityGroups();

// invoke the operation
string distributedAvailabilityGroupName = "dag";
SqlDistributedAvailabilityGroupData data = new SqlDistributedAvailabilityGroupData
{
    PartnerAvailabilityGroupName = "BoxLocalAg1",
    PartnerEndpoint = "TCP://SERVER:7022",
    InstanceLinkRole = SqlServerSideLinkRole.Primary,
    InstanceAvailabilityGroupName = "testcl",
    FailoverMode = SqlServerFailoverModeType.None,
    SeedingMode = SeedingModeType.Automatic,
    Databases = {new DistributedAvailabilityGroupDatabase
    {
    DatabaseName = "testdb",
    }},
};
ArmOperation<SqlDistributedAvailabilityGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, distributedAvailabilityGroupName, data);
SqlDistributedAvailabilityGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDistributedAvailabilityGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

状態コード:: 201

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

状態コード:: 202

Create a distributed availability group with minimal properties.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag?api-version=2025-01-01

{
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "instanceAvailabilityGroupName": "testcl",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022"
  }
}


import com.azure.resourcemanager.sql.fluent.models.DistributedAvailabilityGroupInner;
import com.azure.resourcemanager.sql.models.DistributedAvailabilityGroupDatabase;
import java.util.Arrays;

/**
 * Samples for DistributedAvailabilityGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsCreateMin.json
     */
    /**
     * Sample code: Create a distributed availability group with minimal properties.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void createADistributedAvailabilityGroupWithMinimalProperties(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDistributedAvailabilityGroups().createOrUpdate("testrg", "testcl", "dag",
            new DistributedAvailabilityGroupInner().withPartnerAvailabilityGroupName("BoxLocalAg1")
                .withPartnerEndpoint("TCP://SERVER:7022").withInstanceAvailabilityGroupName("testcl")
                .withDatabases(Arrays.asList(new DistributedAvailabilityGroupDatabase().withDatabaseName("testdb"))),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python distributed_availability_groups_create_min.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.distributed_availability_groups.begin_create_or_update(
        resource_group_name="testrg",
        managed_instance_name="testcl",
        distributed_availability_group_name="dag",
        parameters={
            "properties": {
                "databases": [{"databaseName": "testdb"}],
                "instanceAvailabilityGroupName": "testcl",
                "partnerAvailabilityGroupName": "BoxLocalAg1",
                "partnerEndpoint": "TCP://SERVER:7022",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsCreateMin.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
 *
 * @summary creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
 * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsCreateMin.json
 */
async function createADistributedAvailabilityGroupWithMinimalProperties() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.distributedAvailabilityGroups.createOrUpdate(
    "testrg",
    "testcl",
    "dag",
    {
      databases: [{ databaseName: "testdb" }],
      instanceAvailabilityGroupName: "testcl",
      partnerAvailabilityGroupName: "BoxLocalAg1",
      partnerEndpoint: "TCP://SERVER:7022",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/DistributedAvailabilityGroupsCreateMin.json
// this example is just showing the usage of "DistributedAvailabilityGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testcl";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this SqlDistributedAvailabilityGroupResource
SqlDistributedAvailabilityGroupCollection collection = managedInstance.GetSqlDistributedAvailabilityGroups();

// invoke the operation
string distributedAvailabilityGroupName = "dag";
SqlDistributedAvailabilityGroupData data = new SqlDistributedAvailabilityGroupData
{
    PartnerAvailabilityGroupName = "BoxLocalAg1",
    PartnerEndpoint = "TCP://SERVER:7022",
    InstanceAvailabilityGroupName = "testcl",
    Databases = {new DistributedAvailabilityGroupDatabase
    {
    DatabaseName = "testdb",
    }},
};
ArmOperation<SqlDistributedAvailabilityGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, distributedAvailabilityGroupName, data);
SqlDistributedAvailabilityGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDistributedAvailabilityGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Secondary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

状態コード:: 201

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Secondary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

状態コード:: 202

定義

名前	説明
CertificateInfo	証明書情報
createdByType	リソースを作成した ID の種類。
DistributedAvailabilityGroup	BoxとSQL Managed Instance間の分散可用性グループ。
DistributedAvailabilityGroupDatabase	データベース固有の情報
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FailoverModeType	リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。
LinkRole	SQL サーバー側のリンクの役割
ReplicaConnectedState	リンク接続状態
ReplicaSynchronizationHealth	リンクの正常性状態
ReplicationModeType	リンクのレプリケーションモード
SeedingModeType	データベースシードモード – サポートされているシナリオでは、自動 (既定)、または手動にすることができます。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CertificateInfo

Object

証明書情報

名前	型	説明
certificateName	string	証明書名
expiryDate	string (date-time)	証明書の有効期限

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key