Disaster Recovery Configs - List

Odwołanie

Service:: Service Bus

API Version:: 2021-11-01

Pobiera wszystkie aliasy (konfiguracje odzyskiwania po awarii)

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string	Nazwa przestrzeni nazw
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ArmDisasterRecoveryListResult	Pomyślnie pobrano listę aliasów (konfiguracje odzyskiwania po awarii) dla przestrzeni nazw usługi ServiceBus
Other Status Codes	ErrorResponse	Odpowiedź błędu usługi ServiceBus opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
ArmDisasterRecovery	Lista aliasów (konfiguracje odzyskiwania po awarii)
ArmDisasterRecoveryListResult	Wynik operacji Alias listy (konfiguracja odzyskiwania po awarii).
createdByType	Typ tożsamości, która utworzyła zasób.
Error	Obiekt błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd zarządzania zasobami.
ProvisioningStateDR	Stan aprowizacji aliasu (konfiguracja odzyskiwania po awarii) — możliwe wartości "Zaakceptowane" lub "Powodzenie" lub "Niepowodzenie"
RoleDisasterRecovery	rola przestrzeni nazw w usłudze GEO DR — możliwe wartości "Primary" lub "PrimaryNotReplicating" lub "Secondary"
systemData	Dane metadane systemowe odnoszące się do tego zasobu.

ArmDisasterRecovery

Lista aliasów (konfiguracje odzyskiwania po awarii)

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.alternateName	string	Podstawowa/pomocnicza nazwa przestrzeni nazw usługi EventHub, która jest częścią parowania odzyskiwania po awarii geograficznej
properties.partnerNamespace	string	Identyfikator arm nazwy podstawowej/pomocniczej przestrzeni nazw usługi EventHub, która jest częścią parowania odzyskiwania po awarii geograficznej
properties.pendingReplicationOperationsCount	integer	Liczba jednostek oczekujących na replikację.
properties.provisioningState	ProvisioningStateDR	Stan aprowizacji aliasu (konfiguracja odzyskiwania po awarii) — możliwe wartości "Zaakceptowane" lub "Powodzenie" lub "Niepowodzenie"
properties.role	RoleDisasterRecovery	rola przestrzeni nazw w usłudze GEO DR — możliwe wartości "Primary" lub "PrimaryNotReplicating" lub "Secondary"
systemData	systemData	Dane metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

ArmDisasterRecoveryListResult

Wynik operacji Alias listy (konfiguracja odzyskiwania po awarii).

Nazwa	Typ	Opis
nextLink	string	Połącz się z następnym zestawem wyników. Wartość nie jest pusta, jeśli wartość zawiera niekompletną listę aliasów (konfiguracja odzyskiwania po awarii)
value	ArmDisasterRecovery[]	Lista aliasów (konfiguracje odzyskiwania po awarii)

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Obiekt błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd zarządzania zasobami.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

ProvisioningStateDR

Stan aprowizacji aliasu (konfiguracja odzyskiwania po awarii) — możliwe wartości "Zaakceptowane" lub "Powodzenie" lub "Niepowodzenie"

Nazwa	Typ	Opis
Accepted	string
Failed	string
Succeeded	string

RoleDisasterRecovery

rola przestrzeni nazw w usłudze GEO DR — możliwe wartości "Primary" lub "PrimaryNotReplicating" lub "Secondary"

Nazwa	Typ	Opis
Primary	string
PrimaryNotReplicating	string
Secondary	string

systemData

Dane metadane systemowe odnoszące się do tego zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Disaster Recovery Configs - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

SBAliasList

Sample Request

Sample Response

Definicje

ArmDisasterRecovery

ArmDisasterRecoveryListResult

createdByType

Error

ErrorAdditionalInfo

ErrorResponse

ProvisioningStateDR

RoleDisasterRecovery

systemData

Dodatkowe zasoby