Namespaces - Check Availability

Referência

Service:: Notification Hubs

API Version:: 2023-09-01

Verifica a disponibilidade do espaço de nomes de serviço especificado em todas as subscrições do Azure. Isto é útil porque o nome de domínio é criado com base no nome do espaço de nomes do serviço.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability?api-version=2023-09-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string uuid	O ID da subscrição de destino. O valor tem de ser um UUID.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	Obtém ou define o nome do recurso
isAvailiable		boolean	Não utilizado e preterido desde a versão da API 2023-09-01
location		string	Obtém ou define a localização dos recursos
sku		Sku	A descrição do SKU para um espaço de nomes
tags		object	Obtém ou define etiquetas de recursos

Respostas

Name	Tipo	Description
200 OK	CheckAvailabilityResult	Com êxito
Other Status Codes	ErrorResponse	Código de erro com motivo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Namespaces_CheckAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/checkNamespaceAvailability?api-version=2023-09-01

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

Sample Response

Status code:: 200

{
  "isAvailiable": true,
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability"
}

Definições

Name	Description
CheckAvailabilityParameters	Parâmetros fornecidos para a Disponibilidade de Nomes de Verificação para Espaço de Nomes e NotificationHubs.
CheckAvailabilityResult	Descrição de um recurso CheckAvailability.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
Sku	A descrição do SKU para um espaço de nomes
SkuName	Nome do SKU do espaço de nomes.
systemData	Metadados relativos à criação e última modificação do recurso.

CheckAvailabilityParameters

Parâmetros fornecidos para a Disponibilidade de Nomes de Verificação para Espaço de Nomes e NotificationHubs.

Name	Tipo	Description
id	string	Obtém o ID do recurso
isAvailiable	boolean	Não utilizado e preterido desde a versão da API 2023-09-01
location	string	Obtém ou define a localização dos recursos
name	string	Obtém ou define o nome do recurso
sku	Sku	A descrição do SKU para um espaço de nomes
tags	object	Obtém ou define etiquetas de recursos
type	string	Obtém o tipo de recurso

CheckAvailabilityResult

Descrição de um recurso CheckAvailability.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isAvailiable	boolean	Obtém ou define verdadeiro se o nome estiver disponível e puder ser utilizado para criar um novo Espaço de Nomes/NotificationHub. Caso contrário, falso.
location	string	Preterido - apenas para compatibilidade.
name	string	O nome do recurso
sku	Sku	A descrição do SKU para um espaço de nomes
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
tags	object	Preterido - apenas para compatibilidade.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Sku

A descrição do SKU para um espaço de nomes

Name	Tipo	Description
capacity	integer	Obtém ou define a capacidade do recurso
family	string	Obtém ou define a Família de SKU
name	SkuName	Nome do SKU do espaço de nomes.
size	string	Obtém ou define o tamanho do SKU
tier	string	Obtém ou define a camada de um SKU específico

SkuName

Nome do SKU do espaço de nomes.

Name	Tipo	Description
Basic	string
Free	string
Standard	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via