Check Name Availability - Namespaces - Check Name Availability

Referência

Service:: Event Hubs

API Version:: 2024-01-01

Verifique a disponibilidade do nome do namespace.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/checkNameAvailability?api-version=2024-01-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 da API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	Nome para marcar a disponibilidade do nome do namespace

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityResult	marcar disponibilidade retornada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do Eventhub 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

NamespacesCheckNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.EventHub/checkNameAvailability?api-version=2024-01-01

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

Sample Response

Status code:: 200

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

Definições

Nome	Description
CheckNameAvailabilityParameter	Parâmetro fornecido para marcar operação de disponibilidade de nome do namespace
CheckNameAvailabilityResult	O resultado da operação CheckNameAvailability
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
UnavailableReason	Especifica o motivo da indisponibilidade do serviço.

CheckNameAvailabilityParameter

Parâmetro fornecido para marcar operação de disponibilidade de nome do namespace

Nome	Tipo	Description
name	string	Nome para marcar a disponibilidade do nome do namespace

CheckNameAvailabilityResult

O resultado da operação CheckNameAvailability

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

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.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
error	ErrorDetail	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

Share via