Namespaces - Get

Ссылка

Служба:: Relay

Версия API:: 2024-01-01

Возвращает описание указанного пространства имен.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}?api-version=2024-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string minLength: 6 maxLength: 50	Имя пространства имен
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов в подписке Azure.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Ответы

Имя	Тип	Описание
200 OK	RelayNamespace	Описание пространства имен успешно возвращено.
Other Status Codes	ErrorResponse	Ответ об ошибке ретранслятора, описывающий, почему операция завершилась ошибкой.

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

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

RelayNameSpaceGet

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01?api-version=2024-01-01

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01",
  "name": "example-RelayRelayNamespace-01",
  "type": "Microsoft.Relay/Namespaces",
  "location": "West US",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01",
    "createdAt": "2017-01-23T20:38:12.46Z",
    "serviceBusEndpoint": "https://example-RelayRelayNamespace-01.servicebus.windows.net:443/",
    "updatedAt": "2017-01-23T20:38:34.533Z"
  }
}

Определения

Имя	Описание
ConnectionState	Сведения о состоянии подключения.
createdByType	Тип удостоверения, создавшего ресурс.
EndPointProvisioningState	Состояние подготовки подключения к частной конечной точке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PrivateEndpoint	Ресурс частной конечной точки для этого подключения.
PrivateEndpointConnection	Список подключений к частной конечной точке.
PrivateLinkConnectionStatus	Состояние подключения.
PublicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена
RelayNamespace	Описание ресурса пространства имен.
Sku	Номер SKU пространства имен.
SkuName	Имя этого номера SKU.
SkuTier	Уровень этого номера SKU.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

ConnectionState

Object

Сведения о состоянии подключения.

Имя	Тип	Описание
description	string	Описание состояния подключения.
status	PrivateLinkConnectionStatus	Состояние подключения.

createdByType

Перечисление

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

Значение	Описание
Application
Key
ManagedIdentity
User

EndPointProvisioningState

Перечисление

Состояние подготовки подключения к частной конечной точке.

Значение	Описание
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

Ответ на ошибку

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

PrivateEndpoint

Object

Ресурс частной конечной точки для этого подключения.

Имя	Тип	Описание
id	string	Идентификатор ARM для частной конечной точки.

PrivateEndpointConnection

Object

Список подключений к частной конечной точке.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.privateEndpoint	PrivateEndpoint	Ресурс частной конечной точки для этого подключения.
properties.privateLinkServiceConnectionState	ConnectionState	Сведения о состоянии подключения.
properties.provisioningState	EndPointProvisioningState	Состояние подготовки подключения к частной конечной точке.
systemData	systemData	Системные метаданные, относящиеся к этому ресурсу.
type	string	Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Перечисление

Состояние подключения.

Значение	Описание
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Перечисление

Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена

Значение	Описание
Disabled
Enabled
SecuredByPerimeter

RelayNamespace

Object

Описание ресурса пространства имен.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.createdAt	string (date-time)		Время создания пространства имен.
properties.metricId	string		Идентификатор метрик Azure Insights.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Список подключений к частной конечной точке.
properties.provisioningState	string		Состояние подготовки пространства имен.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
properties.serviceBusEndpoint	string		Конечная точка, используемая для выполнения операций служебной шины.
properties.status	string		Состояние пространства имен.
properties.updatedAt	string (date-time)		Время обновления пространства имен.
sku	Sku		Номер SKU пространства имен.
systemData	systemData		Системные метаданные, относящиеся к этому ресурсу.
tags	object		Теги ресурсов.
type	string		Тип ресурса.

Sku

Object

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

Имя	Тип	Описание
name	SkuName	Имя этого номера SKU.
tier	SkuTier	Уровень этого номера SKU.

SkuName

Перечисление

Имя этого номера SKU.

Значение	Описание
Standard

SkuTier

Перечисление

Уровень этого номера SKU.

Значение	Описание
Standard

systemData

Object

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

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

Поделиться через

Namespaces - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

RelayNameSpaceGet

Образец запроса

Пример ответа

Определения

ConnectionState

createdByType

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

RelayNamespace

Sku

SkuName

SkuTier

systemData

Дополнительные ресурсы