Disaster Recovery Configs - Check Name Availability

Service:

Service Bus

API Version:

2021-11-01

Controllare la disponibilità del nome dello spazio dei nomi.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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	Necessario	Tipo	Descrizione
name	True	string	Nome per verificare la disponibilità del nome dello spazio dei nomi e Il nome dello spazio dei nomi può contenere solo lettere, numeri e trattini. Lo spazio dei nomi deve iniziare con una lettera e deve terminare con una lettera o un numero.

Risposte

Nome	Tipo	Descrizione
200 OK	CheckNameAvailabilityResult	verificare la disponibilità restituita correttamente.
Other Status Codes	ErrorResponse	Risposta di errore del bus di servizio 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

AliasNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/CheckNameAvailability?api-version=2021-11-01

{
  "name": "sdk-DisasterRecovery-9474"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.servicebus.models.CheckNameAvailability;

/** Samples for DisasterRecoveryConfigs CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs
     * /SBAliasCheckNameAvailability.json
     */
    /**
     * Sample code: AliasNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void aliasNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getDisasterRecoveryConfigs()
            .checkNameAvailabilityWithResponse("exampleResourceGroup", "sdk-Namespace-9080",
                new CheckNameAvailability().withName("sdk-DisasterRecovery-9474"), 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

Python

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_check_name_availability.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="exampleSubscriptionId",
    )

    response = client.disaster_recovery_configs.check_name_availability(
        resource_group_name="exampleResourceGroup",
        namespace_name="sdk-Namespace-9080",
        parameters={"name": "sdk-DisasterRecovery-9474"},
    )
    print(response)


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

Go

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/SBAliasCheckNameAvailability.json
func ExampleDisasterRecoveryConfigsClient_CheckNameAvailability() {
	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().CheckNameAvailability(ctx, "exampleResourceGroup", "sdk-Namespace-9080", armservicebus.CheckNameAvailability{
		Name: to.Ptr("sdk-DisasterRecovery-9474"),
	}, 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.CheckNameAvailabilityResult = armservicebus.CheckNameAvailabilityResult{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armservicebus.UnavailableReasonNone),
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Check the give namespace name availability.
 *
 * @summary Check the give namespace name availability.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json
 */
async function aliasNameAvailability() {
  const subscriptionId = "exampleSubscriptionId";
  const resourceGroupName = "exampleResourceGroup";
  const namespaceName = "sdk-Namespace-9080";
  const parameters = {
    name: "sdk-DisasterRecovery-9474",
  };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.disasterRecoveryConfigs.checkNameAvailability(
    resourceGroupName,
    namespaceName,
    parameters
  );
  console.log(result);
}

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

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

Definizioni

Nome	Descrizione
CheckNameAvailability	Descrizione delle proprietà della richiesta di disponibilità Check Name.
CheckNameAvailabilityResult	Descrizione delle proprietà della richiesta di disponibilità Check Name.
Error	Oggetto error.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta all'errore di gestione delle risorse.
UnavailableReason	Specifica il motivo dell'indisponibilità del servizio.

CheckNameAvailability

Descrizione delle proprietà della richiesta di disponibilità Check Name.

Nome	Tipo	Descrizione
name	string	Nome per verificare la disponibilità del nome dello spazio dei nomi e Il nome dello spazio dei nomi può contenere solo lettere, numeri e trattini. Lo spazio dei nomi deve iniziare con una lettera e deve terminare con una lettera o un numero.

CheckNameAvailabilityResult

Descrizione delle proprietà della richiesta di disponibilità Check Name.

Nome	Tipo	Descrizione
message	string	Informazioni dettagliate relative al motivo associato allo spazio dei nomi.
nameAvailable	boolean	Valore che indica che lo spazio dei nomi è disponibile, true se lo spazio dei nomi è disponibile; in caso contrario, false.
reason	UnavailableReason	Motivo dell'indisponibilità di uno spazio dei nomi.

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 sull'errore di 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.

UnavailableReason

Specifica il motivo dell'indisponibilità del servizio.

Nome	Tipo	Descrizione
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string