Disaster Recovery Configs - List

Referência

Serviço:: Service Bus

Versão da API:: 2021-11-01

Obtém todos os Alias (configurações de Recuperação de Desastre)

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string	O nome do namespace
resourceGroupName	path	True	string	Nome do grupo de recursos na assinatura do Azure.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão de API do cliente.

Respostas

Nome	Tipo	Description
200 OK	ArmDisasterRecoveryListResult	Recuperou com êxito a lista de Alias (configurações de recuperação de desastre) para o namespace do servicebus
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SBAliasList

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
      }
    }
  ]
}

Definições

Nome	Description
ArmDisasterRecovery	Lista de Alias (configurações de recuperação de desastre)
ArmDisasterRecoveryListResult	O resultado da operação Listar Alias (configuração de recuperação de desastre).
createdByType	O tipo de identidade que criou o recurso.
Error	O objeto de erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	A resposta de erro de gerenciamento de recursos.
ProvisioningStateDR	Estado de provisionamento do Alias (configuração de Recuperação de Desastre) – valores possíveis 'Aceito' ou 'Êxito' ou 'Falha'
RoleDisasterRecovery	função de namespace na RECUPERAÇÃO GEOGRÁFICA – valores possíveis 'Primary' ou 'PrimaryNotReplicating' ou 'Secondary'
systemData	Os metadados do sistema relacionados a esse recurso.

ArmDisasterRecovery

Lista de Alias (configurações de recuperação de desastre)

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica em que o recurso reside
name	string	O nome do recurso
properties.alternateName	string	Nome do namespace do eventhub primário/secundário, que faz parte do emparelhamento de RECUPERAÇÃO GEOGRÁFICA
properties.partnerNamespace	string	ID do ARM do nome do namespace do eventhub primário/secundário, que faz parte do emparelhamento de RECUPERAÇÃO GEOGRÁFICA
properties.pendingReplicationOperationsCount	integer	Número de entidades pendentes a serem replicadas.
properties.provisioningState	ProvisioningStateDR	Estado de provisionamento do Alias (configuração de Recuperação de Desastre) – valores possíveis 'Aceito' ou 'Êxito' ou 'Falha'
properties.role	RoleDisasterRecovery	função de namespace na RECUPERAÇÃO GEOGRÁFICA – valores possíveis 'Primary' ou 'PrimaryNotReplicating' ou 'Secondary'
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

ArmDisasterRecoveryListResult

O resultado da operação Listar Alias (configuração de recuperação de desastre).

Nome	Tipo	Description
nextLink	string	Vincular ao próximo conjunto de resultados. Não vazio se Value contiver uma lista incompleta de Alias (configuração de Recuperação de Desastre)
value	ArmDisasterRecovery[]	Lista de Alias (configurações de recuperação de desastre)

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

O objeto de erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

A resposta de erro de gerenciamento de recursos.

Nome	Tipo	Description
error	Error	O objeto de erro.

ProvisioningStateDR

Estado de provisionamento do Alias (configuração de Recuperação de Desastre) – valores possíveis 'Aceito' ou 'Êxito' ou 'Falha'

Nome	Tipo	Description
Accepted	string
Failed	string
Succeeded	string

RoleDisasterRecovery

função de namespace na RECUPERAÇÃO GEOGRÁFICA – valores possíveis 'Primary' ou 'PrimaryNotReplicating' ou 'Secondary'

Nome	Tipo	Description
Primary	string
PrimaryNotReplicating	string
Secondary	string

systemData

Os metadados do sistema relacionados a esse recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Disaster Recovery Configs - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

SBAliasList

Solicitação de exemplo

Resposta de exemplo

Definições

ArmDisasterRecovery

ArmDisasterRecoveryListResult

createdByType

Error

ErrorAdditionalInfo

ErrorResponse

ProvisioningStateDR

RoleDisasterRecovery

systemData

Recursos adicionais