Namespaces - CheckName Availability - Check Name Availability

Service:

Service Bus

API Version:

2021-11-01

Verifique a disponibilidade do nome do namespace.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	O Nome para marcar a disponibilidade do nome do namespace e O nome do namespace pode conter apenas letras, números e hifens. O namespace deve começar com uma letra e deve terminar com uma letra ou número.

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityResult	marcar disponibilidade retornada com êxito.
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

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NameSpaceCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2021-11-01

{
  "name": "sdk-Namespace-2924"
}

Java

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

/** Samples for Namespaces CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/
     * SBNameSpaceCheckNameAvailability.json
     */
    /**
     * Sample code: NameSpaceCheckNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nameSpaceCheckNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getNamespaces().checkNameAvailabilityWithResponse(
            new CheckNameAvailability().withName("sdk-Namespace-2924"), 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_name_space_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="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.namespaces.check_name_availability(
        parameters={"name": "sdk-Namespace-2924"},
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.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/NameSpaces/SBNameSpaceCheckNameAvailability.json
func ExampleNamespacesClient_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.NewNamespacesClient().CheckNameAvailability(ctx, armservicebus.CheckNameAvailability{
		Name: to.Ptr("sdk-Namespace-2924"),
	}, 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/NameSpaces/SBNameSpaceCheckNameAvailability.json
 */
async function nameSpaceCheckNameAvailability() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const parameters = { name: "sdk-Namespace-2924" };
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.namespaces.checkNameAvailability(parameters);
  console.log(result);
}

nameSpaceCheckNameAvailability().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": ""
}

Definições

Nome	Description
CheckNameAvailability	Descrição de uma solicitação de disponibilidade Verificar Nome.
CheckNameAvailabilityResult	Descrição de uma solicitação de disponibilidade Verificar Nome.
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.
UnavailableReason	Especifica o motivo da indisponibilidade do serviço.

CheckNameAvailability

Descrição de uma solicitação de disponibilidade Verificar Nome.

Nome	Tipo	Description
name	string	O Nome para marcar a disponibilidade do nome do namespace e O nome do namespace pode conter apenas letras, números e hifens. O namespace deve começar com uma letra e deve terminar com uma letra ou número.

CheckNameAvailabilityResult

Descrição de uma solicitação de disponibilidade Verificar Nome.

Nome	Tipo	Description
message	string	As informações detalhadas sobre o motivo associado ao namespace.
nameAvailable	boolean	Valor que indica que o namespace é disponibilidade, true se o namespace estiver disponível; caso contrário, false.
reason	UnavailableReason	O motivo da indisponibilidade de um namespace.

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.

UnavailableReason

Especifica o motivo da indisponibilidade do serviço.

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