Disaster Recovery Configs - Check Name Availability

Referentie

Service:: Service Bus

API-versie:: 2021-11-01

Controleer de beschikbaarheid van naamruimtenaam opgeven.

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

URI-parameters

Name	In	Vereist	Type	Description
namespaceName	path	True	string	De naam van de naamruimte
resourceGroupName	path	True	string	Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam om de beschikbaarheid van de naamruimte te controleren en De naamruimtenaam mag alleen letters, cijfers en afbreekstreepjes bevatten. De naamruimte moet beginnen met een letter en moet eindigen met een letter of cijfer.

Antwoorden

Name	Type	Description
200 OK	CheckNameAvailabilityResult	controleer of de beschikbaarheid is geretourneerd.
Other Status Codes	ErrorResponse	ServiceBus-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

AliasNameAvailability

Voorbeeldaanvraag

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


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"), com.azure.core.util.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_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

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

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
CheckNameAvailability	Beschrijving van de eigenschappen van de beschikbaarheidsaanvraag Naam controleren.
CheckNameAvailabilityResult	Beschrijving van de eigenschappen van de beschikbaarheidsaanvraag Naam controleren.
Error	Het foutobject.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Het antwoord op de resourcebeheerfout.
UnavailableReason	Hiermee geeft u de reden op voor het niet beschikbaar zijn van de service.

CheckNameAvailability

Beschrijving van de eigenschappen van de beschikbaarheidsaanvraag Naam controleren.

Name	Type	Description
name	string	De naam om de beschikbaarheid van de naamruimte te controleren en De naamruimtenaam mag alleen letters, cijfers en afbreekstreepjes bevatten. De naamruimte moet beginnen met een letter en moet eindigen met een letter of cijfer.

CheckNameAvailabilityResult

Beschrijving van de eigenschappen van de beschikbaarheidsaanvraag Naam controleren.

Name	Type	Description
message	string	Gedetailleerde informatie over de reden die is gekoppeld aan de naamruimte.
nameAvailable	boolean	Waarde die aangeeft dat de naamruimte beschikbaarheid is, waar als de naamruimte beschikbaar is; anders onwaar.
reason	UnavailableReason	De reden voor het niet beschikbaar zijn van een naamruimte.

Error

Het foutobject.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Het antwoord op de resourcebeheerfout.

Name	Type	Description
error	Error	Het foutobject.

UnavailableReason

Hiermee geeft u de reden op voor het niet beschikbaar zijn van de service.

Name	Type	Description
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string

Delen via

Disaster Recovery Configs - Check Name Availability

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

AliasNameAvailability

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CheckNameAvailability

CheckNameAvailabilityResult

Error

ErrorAdditionalInfo

ErrorResponse

UnavailableReason

Aanvullende resources