Disaster Recovery Configs - Create Or Update

Riferimento

Service:: Service Bus

API Version:: 2021-11-01

Crea o aggiorna una nuova configurazione alias(ripristino di emergenza)

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
alias	path	True	string	Nome di configurazione ripristino di emergenza
namespaceName	path	True	string	Nome dello spazio dei nomi
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione API client.

Corpo della richiesta

Nome	Tipo	Descrizione
parameters	ArmDisasterRecovery	Parametri necessari per creare un alias(configurazione ripristino di emergenza)

Risposte

Nome	Tipo	Descrizione
200 OK	ArmDisasterRecovery	Alias(Configurazione ripristino di emergenza) creata correttamente
201 Created		Richiesta di creazione alias(configurazione ripristino di emergenza) ricevuta
Other Status Codes	ErrorResponse	Risposta di errore servicebus che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

SBAliasCreate

Sample Request

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

{
  "properties": {
    "partnerNamespace": "sdk-Namespace-37",
    "alternateName": "alternameforAlias-Namespace-8860"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.servicebus.fluent.models.ArmDisasterRecoveryInner;

/** Samples for DisasterRecoveryConfigs CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs
     * /SBAliasCreate.json
     */
    /**
     * Sample code: SBAliasCreate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void sBAliasCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getDisasterRecoveryConfigs().createOrUpdateWithResponse(
            "ardsouzatestRG", "sdk-Namespace-8860", "sdk-Namespace-8860", new ArmDisasterRecoveryInner()
                .withPartnerNamespace("sdk-Namespace-37").withAlternateName("alternameforAlias-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_create.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.create_or_update(
        resource_group_name="ardsouzatestRG",
        namespace_name="sdk-Namespace-8860",
        alias="sdk-Namespace-8860",
        parameters={
            "properties": {"alternateName": "alternameforAlias-Namespace-8860", "partnerNamespace": "sdk-Namespace-37"}
        },
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasCreate.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/azcore/to"
	"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/SBAliasCreate.json
func ExampleDisasterRecoveryConfigsClient_CreateOrUpdate() {
	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)
	}
	res, err := clientFactory.NewDisasterRecoveryConfigsClient().CreateOrUpdate(ctx, "ardsouzatestRG", "sdk-Namespace-8860", "sdk-Namespace-8860", armservicebus.ArmDisasterRecovery{
		Properties: &armservicebus.ArmDisasterRecoveryProperties{
			AlternateName:    to.Ptr("alternameforAlias-Namespace-8860"),
			PartnerNamespace: to.Ptr("sdk-Namespace-37"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ArmDisasterRecovery = armservicebus.ArmDisasterRecovery{
	// 	Name: to.Ptr("sdk-Namespace-8860"),
	// 	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-Namespace-8860"),
	// 	Properties: &armservicebus.ArmDisasterRecoveryProperties{
	// 		AlternateName: to.Ptr("alternameforAlias-Namespace-8860"),
	// 		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 Creates or updates a new Alias(Disaster Recovery configuration)
 *
 * @summary Creates or updates a new Alias(Disaster Recovery configuration)
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasCreate.json
 */
async function sbAliasCreate() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ardsouzatestRG";
  const namespaceName = "sdk-Namespace-8860";
  const alias = "sdk-Namespace-8860";
  const parameters = {
    alternateName: "alternameforAlias-Namespace-8860",
    partnerNamespace: "sdk-Namespace-37",
  };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.disasterRecoveryConfigs.createOrUpdate(
    resourceGroupName,
    namespaceName,
    alias,
    parameters
  );
  console.log(result);
}

sbAliasCreate().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

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

Status code:: 201

Definizioni

Nome	Descrizione
ArmDisasterRecovery	Singolo elemento nell'operazione List o Get Alias(Disaster Recovery)
createdByType	Tipo di identità che ha creato la risorsa.
Error	Oggetto error.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorResponse	Risposta all'errore di gestione delle risorse.
ProvisioningStateDR	Stato di provisioning dell'alias(configurazione ripristino di emergenza) - valori possibili 'Accettati' o 'Successed' o 'Failed'
RoleDisasterRecovery	ruolo dello spazio dei nomi in GEO DR - valori possibili 'Primary' o 'PrimaryNotReplicating' o 'Secondary'
systemData	Metadati di sistema relativi a questa risorsa.

ArmDisasterRecovery

Singolo elemento nell'operazione List o Get Alias(Disaster Recovery)

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui vive la risorsa
name	string	nome della risorsa.
properties.alternateName	string	Nome dello spazio dei nomi eventhub primario/secondario, che fa parte dell'associazione di ripristino di emergenza GEOGRAFICA
properties.partnerNamespace	string	ID ARM del nome dello spazio dei nomi eventhub primario/secondario, che fa parte dell'associazione GEO DR
properties.pendingReplicationOperationsCount	integer	Numero di entità in sospeso da replicare.
properties.provisioningState	ProvisioningStateDR	Stato di provisioning dell'alias(configurazione ripristino di emergenza) - valori possibili 'Accettati' o 'Successed' o 'Failed'
properties.role	RoleDisasterRecovery	ruolo dello spazio dei nomi in GEO DR - valori possibili 'Primary' o 'PrimaryNotReplicating' o 'Secondary'
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Oggetto error.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta all'errore di gestione delle risorse.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

ProvisioningStateDR

Stato di provisioning dell'alias(configurazione ripristino di emergenza) - valori possibili 'Accettati' o 'Successed' o 'Failed'

Nome	Tipo	Descrizione
Accepted	string
Failed	string
Succeeded	string

RoleDisasterRecovery

ruolo dello spazio dei nomi in GEO DR - valori possibili 'Primary' o 'PrimaryNotReplicating' o 'Secondary'

Nome	Tipo	Descrizione
Primary	string
PrimaryNotReplicating	string
Secondary	string

systemData

Metadati di sistema relativi a questa risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Tipo di identità che ha modificato l'ultima risorsa.
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

Disaster Recovery Configs - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

SBAliasCreate

Sample Request

Sample Response

Definizioni

ArmDisasterRecovery

createdByType

Error

ErrorAdditionalInfo

ErrorResponse

ProvisioningStateDR

RoleDisasterRecovery

systemData

Risorse aggiuntive