Disaster Recovery Configs - Create Or Update

Odwołanie

Service:: Service Bus

API Version:: 2021-11-01

Tworzy lub aktualizuje nowy alias (konfiguracja odzyskiwania po awarii)

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
alias	path	True	string	Nazwa konfiguracji odzyskiwania po awarii
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.

Treść żądania

Nazwa	Typ	Opis
parameters	ArmDisasterRecovery	Parametry wymagane do utworzenia aliasu (konfiguracja odzyskiwania po awarii)

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ArmDisasterRecovery	Alias (konfiguracja odzyskiwania po awarii) została pomyślnie utworzona
201 Created		Odebrano żądanie utworzenia aliasu (konfiguracja odzyskiwania po awarii)
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

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

Definicje

Nazwa	Opis
ArmDisasterRecovery	Pojedynczy element w operacji List lub Get Alias (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

Pojedynczy element w operacji List lub Get Alias (Konfiguracja 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"

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 - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

SBAliasCreate

Sample Request

Sample Response

Definicje

ArmDisasterRecovery

createdByType

Error

ErrorAdditionalInfo

ErrorResponse

ProvisioningStateDR

RoleDisasterRecovery

systemData

Dodatkowe zasoby