Disaster Recovery Configs - List

Reference

Service:: Service Bus

API Version:: 2021-11-01

Získá všechny aliasy (konfigurace zotavení po havárii)

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs?api-version=2021-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string	Název oboru názvů
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného Azure.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	ArmDisasterRecoveryListResult	Seznam aliasů (konfigurací zotavení po havárii) pro obor názvů servicebus se úspěšně načetl.
Other Status Codes	ErrorResponse	Odpověď na chybu ServiceBus popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SBAliasList

Sample Request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfigs?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for DisasterRecoveryConfigs List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs
     * /SBAliasList.json
     */
    /**
     * Sample code: SBAliasList.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void sBAliasList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getDisasterRecoveryConfigs().list("ardsouzatestRG",
            "sdk-Namespace-8860", 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.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_alias_list.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 = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.disaster_recovery_configs.list(
        resource_group_name="ardsouzatestRG",
        namespace_name="sdk-Namespace-8860",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasList.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

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasList.json
func ExampleDisasterRecoveryConfigsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDisasterRecoveryConfigsClient().NewListPager("ardsouzatestRG", "sdk-Namespace-8860", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ArmDisasterRecoveryListResult = armservicebus.ArmDisasterRecoveryListResult{
		// 	Value: []*armservicebus.ArmDisasterRecovery{
		// 		{
		// 			Name: to.Ptr("sdk-DisasterRecovery-3814"),
		// 			Type: to.Ptr("Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig"),
		// 			ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814"),
		// 			Properties: &armservicebus.ArmDisasterRecoveryProperties{
		// 				PartnerNamespace: to.Ptr("sdk-Namespace-37"),
		// 				ProvisioningState: to.Ptr(armservicebus.ProvisioningStateDRSucceeded),
		// 				Role: to.Ptr(armservicebus.RoleDisasterRecoveryPrimary),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets all Alias(Disaster Recovery configurations)
 *
 * @summary Gets all Alias(Disaster Recovery configurations)
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasList.json
 */
async function sbAliasList() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ardsouzatestRG";
  const namespaceName = "sdk-Namespace-8860";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.disasterRecoveryConfigs.list(resourceGroupName, namespaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

sbAliasList().catch(console.error);

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814",
      "name": "sdk-DisasterRecovery-3814",
      "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig",
      "properties": {
        "provisioningState": "Accepted",
        "partnerNamespace": "sdk-Namespace-37",
        "role": "Primary"
      }
    }
  ]
}

Definice

Name	Description
ArmDisasterRecovery	Seznam aliasů (konfigurace zotavení po havárii)
ArmDisasterRecoveryListResult	Výsledek operace vypsat alias (konfigurace zotavení po havárii).
createdByType	Typ identity, která prostředek vytvořila.
Error	Objekt chyby.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu správy prostředků.
ProvisioningStateDR	Stav zřizování aliasu (konfigurace zotavení po havárii) – možné hodnoty Přijato, Úspěch nebo Selhání
RoleDisasterRecovery	role oboru názvů v GEO DR – možné hodnoty Primary, PrimaryNotReplicating nebo Secondary
systemData	Metadata systému vztahující se k tomuto prostředku.

ArmDisasterRecovery

Seznam aliasů (konfigurace zotavení po havárii)

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.alternateName	string	Název oboru názvů primárního a sekundárního centra událostí, který je součástí párování geografického zotavení po havárii
properties.partnerNamespace	string	ID ARM názvu primárního a sekundárního oboru názvů centra událostí, který je součástí párování geografického zotavení po havárii
properties.pendingReplicationOperationsCount	integer	Počet entit čekajících na replikaci
properties.provisioningState	ProvisioningStateDR	Stav zřizování aliasu (konfigurace zotavení po havárii) – možné hodnoty Přijato, Úspěch nebo Selhání
properties.role	RoleDisasterRecovery	role oboru názvů v GEO DR – možné hodnoty Primary, PrimaryNotReplicating nebo Secondary
systemData	systemData	Metadata systému vztahující se k tomuto prostředku.
type	string	Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

ArmDisasterRecoveryListResult

Výsledek operace vypsat alias (konfigurace zotavení po havárii).

Name	Typ	Description
nextLink	string	Odkaz na další sadu výsledků Není prázdné, pokud hodnota obsahuje neúplný seznam aliasů (konfigurace zotavení po havárii).
value	ArmDisasterRecovery[]	Seznam aliasů (konfigurace zotavení po havárii)

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Objekt chyby.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorResponse

Odpověď na chybu správy prostředků.

Name	Typ	Description
error	Error	Objekt chyby.

ProvisioningStateDR

Stav zřizování aliasu (konfigurace zotavení po havárii) – možné hodnoty Přijato, Úspěch nebo Selhání

Name	Typ	Description
Accepted	string
Failed	string
Succeeded	string

RoleDisasterRecovery

role oboru názvů v GEO DR – možné hodnoty Primary, PrimaryNotReplicating nebo Secondary

Name	Typ	Description
Primary	string
PrimaryNotReplicating	string
Secondary	string

systemData

Metadata systému vztahující se k tomuto prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Typ identity, která naposledy změnila prostředek.
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Disaster Recovery Configs - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

SBAliasList

Sample Request

Sample Response

Definice

ArmDisasterRecovery

ArmDisasterRecoveryListResult

createdByType

Error

ErrorAdditionalInfo

ErrorResponse

ProvisioningStateDR

RoleDisasterRecovery

systemData

Další materiály