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 サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	RelayNamespace	名前空間の説明が正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するリレーエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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	リソースを作成した ID の種類。
EndPointProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PrivateEndpoint	この接続のプライベートエンドポイントリソース。
PrivateEndpointConnection	プライベートエンドポイント接続の一覧。
PrivateLinkConnectionStatus	接続の状態。
PublicNetworkAccess	これにより、パブリックネットワーク経由でトラフィックが許可されるかどうかが決まります。既定では有効になっています
RelayNamespace	名前空間リソースの説明。
Sku	名前空間の SKU。
SkuName	この SKU の名前。
SkuTier	この SKU のレベル。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ConnectionState

Object

接続の状態に関する詳細。

名前	型	説明
description	string	接続状態の説明。
status	PrivateLinkConnectionStatus	接続の状態。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
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	リソースの完全修飾リソース ID。例 - /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

名前空間リソースの説明。

名前	型	規定値	説明
id	string		リソース ID。
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		Service Bus 操作の実行に使用できるエンドポイント。
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	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Namespaces - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

RelayNameSpaceGet

要求のサンプル

応答のサンプル

定義

ConnectionState

createdByType

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

RelayNamespace

Sku

SkuName

SkuTier

systemData

その他のリソース