Namespaces - Get
返回指定命名空间的说明。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}?api-version=2024-01-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
namespace
|
path | True |
string minLength: 6maxLength: 50 |
命名空间名称 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
要用于此操作的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
Azure作已成功完成。 |
|
| Other Status Codes |
意外错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
RelayNameSpaceGet
示例请求
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
示例响应
{
"name": "example-RelayRelayNamespace-01",
"type": "Microsoft.Relay/Namespaces",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01",
"location": "West US",
"properties": {
"createdAt": "2017-01-23T20:38:12.46Z",
"metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01",
"provisioningState": "Succeeded",
"serviceBusEndpoint": "https://example-RelayRelayNamespace-01.servicebus.windows.net:443/",
"updatedAt": "2017-01-23T20:38:34.533Z"
},
"sku": {
"name": "Standard",
"tier": "Standard"
},
"tags": {
"tag1": "value1",
"tag2": "value2"
}
}
定义
| 名称 | 说明 |
|---|---|
|
Connection |
ConnectionState 信息。 |
|
created |
创建资源的标识的类型。 |
|
End |
专用终结点连接的预配状态。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Private |
PrivateEndpoint 信息。 |
|
Private |
PrivateEndpointConnection 的属性。 |
|
Private |
连接状态。 |
|
Public |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 |
|
Relay |
命名空间资源的说明。 |
| Sku |
命名空间的 SKU。 |
|
Sku |
此 SKU 的名称。 |
|
Sku |
此 SKU 的层。 |
|
system |
与创建和上次修改资源相关的元数据。 |
ConnectionState
ConnectionState 信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
连接状态的说明。 |
| status |
连接状态。 |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
EndPointProvisioningState
专用终结点连接的预配状态。
| 值 | 说明 |
|---|---|
| Creating | |
| Updating | |
| Deleting | |
| Succeeded | |
| Canceled | |
| Failed |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
PrivateEndpoint
PrivateEndpoint 信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
专用终结点的 ARM 标识符。 |
PrivateEndpointConnection
PrivateEndpointConnection 的属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
资源所在的地理位置 |
| name |
string |
资源的名称 |
| properties.privateEndpoint |
此连接的专用终结点资源。 |
|
| properties.privateLinkServiceConnectionState |
有关连接状态的详细信息。 |
|
| properties.provisioningState |
专用终结点连接的预配状态。 |
|
| systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
| type |
string |
资源的类型。 例如,“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
PrivateLinkConnectionStatus
连接状态。
| 值 | 说明 |
|---|---|
| Pending | |
| Approved | |
| Rejected | |
| Disconnected |
PublicNetworkAccess
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。
| 值 | 说明 |
|---|---|
| Enabled | |
| Disabled | |
| SecuredByPerimeter |
RelayNamespace
命名空间资源的说明。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
| location |
string |
资源所在的地理位置 |
|
| name |
string |
资源的名称 |
|
| properties.createdAt |
string (date-time) |
创建命名空间的时间。 |
|
| properties.metricId |
string |
Azure Insights 指标的标识符。 |
|
| properties.privateEndpointConnections |
专用终结点连接列表。 |
||
| properties.provisioningState |
string |
Namespace的预配状态。 |
|
| properties.publicNetworkAccess | Enabled |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 |
|
| properties.serviceBusEndpoint |
string |
可用于执行服务总线操作的终结点。 |
|
| properties.status |
string |
命名空间的状态。 |
|
| properties.updatedAt |
string (date-time) |
命名空间的更新时间。 |
|
| sku |
命名空间的 SKU。 |
||
| systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
||
| tags |
object |
资源标记。 |
|
| type |
string |
资源的类型。 例如,“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
Sku
命名空间的 SKU。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
此 SKU 的名称。 |
|
| tier |
此 SKU 的层。 |
SkuName
此 SKU 的名称。
| 值 | 说明 |
|---|---|
| Standard |
SkuTier
此 SKU 的层。
| 值 | 说明 |
|---|---|
| Standard |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |