Notification Hubs - Check Notification Hub Availability

Ссылка

Service:: Notification Hubs

API Version:: 2023-09-01

Проверяет доступность заданного notificationHub в пространстве имен.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability?api-version=2023-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string	Имя пространства имен Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Возвращает или задает имя ресурса.
isAvailiable		boolean	Не используется и не рекомендуется с версии API 2023-09-01
location		string	Возвращает или задает расположение ресурса.
sku		Sku	Описание номера SKU для пространства имен
tags		object	Возвращает или задает теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	CheckAvailabilityResult	Успешное завершение
Other Status Codes	ErrorResponse	Код ошибки с причиной.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

NotificationHubs_CheckNotificationHubAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/locp-newns/checkNotificationHubAvailability?api-version=2023-09-01

{
  "name": "sdktest",
  "location": "West Europe"
}

Sample Response

Status code:: 200

{
  "isAvailiable": true,
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/sdktest",
  "name": "sdktest",
  "type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability"
}

Определения

Имя	Описание
CheckAvailabilityParameters	Параметры, предоставляемые для проверки доступности имени для пространства имен и концентраторов уведомлений.
CheckAvailabilityResult	Описание ресурса CheckAvailability.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
Sku	Описание номера SKU для пространства имен
SkuName	Имя SKU пространства имен.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

CheckAvailabilityParameters

Параметры, предоставляемые для проверки доступности имени для пространства имен и концентраторов уведомлений.

Имя	Тип	Описание
id	string	Возвращает идентификатор ресурса
isAvailiable	boolean	Не используется и не рекомендуется с версии API 2023-09-01
location	string	Возвращает или задает расположение ресурса.
name	string	Возвращает или задает имя ресурса.
sku	Sku	Описание номера SKU для пространства имен
tags	object	Возвращает или задает теги ресурсов.
type	string	Возвращает тип ресурса

CheckAvailabilityResult

Описание ресурса CheckAvailability.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isAvailiable	boolean	Возвращает или задает значение true, если имя доступно и может использоваться для создания пространства имен или центра уведомлений. В противном случае false.
location	string	Не рекомендуется — только для обеспечения совместимости.
name	string	Имя ресурса.
sku	Sku	Описание номера SKU для пространства имен
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
tags	object	Не рекомендуется — только для обеспечения совместимости.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

Sku

Описание номера SKU для пространства имен

Имя	Тип	Описание
capacity	integer	Возвращает или задает емкость ресурса.
family	string	Возвращает или задает семейство SKU
name	SkuName	Имя SKU пространства имен.
size	string	Возвращает или задает размер SKU.
tier	string	Возвращает или задает уровень определенного номера SKU.

SkuName

Имя SKU пространства имен.

Имя	Тип	Описание
Basic	string
Free	string
Standard	string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

Share via