Namespaces - Get

サービス:

Event Hubs

API バージョン:

2024-01-01

指定した名前空間の説明を取得します。

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

URI パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	名前空間名
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	EHNamespace	名前空間が正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Eventhub エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

NameSpaceGet

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample?api-version=2024-01-01

応答のサンプル

状態コード:

200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
  "name": "NamespaceSample",
  "type": "Microsoft.EventHub/Namespaces",
  "location": "East US",
  "tags": {},
  "identity": {
    "principalId": "PrincipalIdGUID",
    "tenantId": "TenantIdGUID",
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
        "clientId": "ClientIdGUID",
        "principalId": "PrincipalIdGUID"
      },
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
        "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
        "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
      }
    }
  },
  "properties": {
    "isAutoInflateEnabled": false,
    "disableLocalAuth": false,
    "maximumThroughputUnits": 0,
    "zoneRedundant": false,
    "minimumTlsVersion": "1.2",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "keyName": "Samplekey",
          "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
          "keyVersion": "",
          "identity": {
            "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
          }
        }
      ],
      "requireInfrastructureEncryption": false
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
        "name": "privateEndpointConnectionName",
        "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-Approved"
          }
        }
      }
    ],
    "provisioningState": "Succeeded",
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "metricId": "MetricGUID:NamespaceSample",
    "createdAt": "2021-01-30T00:28:38.963Z",
    "updatedAt": "2021-01-30T00:30:55.143Z",
    "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443"
  }
}

定義

名前	説明
ConnectionState	接続の状態に関する詳細。
createdByType	リソースを作成した ID の種類。
EHNamespace	List または Get Operation の単一の名前空間項目
EndPointProvisioningState	プライベート エンドポイント接続のプロビジョニング状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。
keySource	暗号化の keySource の使用可能な値を列挙します。
KeyVaultProperties	KeyVault のプロパティ
ManagedServiceIdentityType	マネージド サービス ID の種類。
PrivateEndpoint	この接続のプライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続の一覧。
PrivateLinkConnectionStatus	接続の状態。
PublicNetworkAccess	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
Sku	SKU リソースのプロパティ
SkuName	この SKU の名前。
SkuTier	この特定の SKU の課金レベル。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TlsVersion	サポートするクラスターの最小 TLS バージョン (例: '1.2')
UserAssignedIdentity	認識されたディクショナリ値。

ConnectionState

Object

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

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

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

EHNamespace

Object

List または Get Operation の単一の名前空間項目

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		KeyVault の ObjectId
identity.tenantId	string		KeyVault の TenantId
identity.type	ManagedServiceIdentityType		マネージド サービス ID の種類。
identity.userAssignedIdentities	<string,  UserAssignedIdentity>		ユーザー割り当て ID のプロパティ
location	string		リソースの場所。
name	string		リソースの名前
properties.alternateName	string		別名と名前空間名が同じ場合に指定される代替名。
properties.clusterArmId	string		名前空間のクラスター ARM ID。
properties.createdAt	string (date-time)		名前空間が作成された時刻。
properties.disableLocalAuth	boolean		このプロパティは、Event Hubs 名前空間の SAS 認証を無効にします。
properties.encryption.keySource	keySource	Microsoft.KeyVault	暗号化の keySource の使用可能な値を列挙します。
properties.encryption.keyVaultProperties	KeyVaultProperties[]		KeyVault のプロパティ
properties.encryption.requireInfrastructureEncryption	boolean		インフラストラクチャ暗号化を有効にする (二重暗号化)
properties.isAutoInflateEnabled	boolean		Eventhub 名前空間に対して AutoInflate が有効かどうかを示す値。
properties.kafkaEnabled	boolean		Kafka が eventhub 名前空間に対して有効になっているかどうかを示す値。
properties.maximumThroughputUnits	integer (int32) minimum: 0		AutoInflate が有効な場合のスループット ユニットの上限。値は 0 ~ 20 スループット ユニット以内にする必要があります。 ( AutoInflateEnabled = true の場合は '0' )
properties.metricId	string		Azure Insights メトリックの識別子。
properties.minimumTlsVersion	TlsVersion		サポートするクラスターの最小 TLS バージョン (例: '1.2')
properties.privateEndpointConnections	PrivateEndpointConnection[]		プライベート エンドポイント接続の一覧。
properties.provisioningState	string		名前空間のプロビジョニング状態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
properties.serviceBusEndpoint	string		Service Bus 操作の実行に使用できるエンドポイント。
properties.status	string		名前空間の状態。
properties.updatedAt	string (date-time)		名前空間が更新された時刻。
properties.zoneRedundant	boolean		このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Standard Event Hubs 名前空間が作成されます。
sku	Sku		SKU リソースのプロパティ
systemData	systemData		このリソースに関連するシステム メタデータ。
tags	object		リソース タグ。
type	string		リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

列挙

プライベート エンドポイント接続のプロビジョニング状態。

値	説明
Creating
Updating
Deleting
Succeeded
Canceled
Failed

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

keySource

列挙

暗号化の keySource の使用可能な値を列挙します。

値	説明
Microsoft.KeyVault

KeyVaultProperties

Object

KeyVault のプロパティ

名前	型	説明
identity.userAssignedIdentity	string	暗号化用に選択されたユーザー ID の ARM ID
keyName	string	KeyVault からのキーの名前
keyVaultUri	string	KeyVault の URI
keyVersion	string	キー のバージョン

ManagedServiceIdentityType

列挙

マネージド サービス ID の種類。

値	説明
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

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

列挙

接続の状態。

値	説明
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

列挙

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。

値	説明
Enabled
Disabled
SecuredByPerimeter

Sku

Object

SKU リソースのプロパティ

名前	型	説明
capacity	integer (int32) minimum: 0	Basic レベルまたは Standard レベルの Event Hubs スループット ユニット。値は 0 から 20 のスループット ユニットである必要があります。 Premium レベルの Event Hubs Premium ユニット。値は 0 から 10 の Premium ユニットである必要があります。
name	SkuName	この SKU の名前。
tier	SkuTier	この特定の SKU の課金レベル。

SkuName

列挙

この SKU の名前。

値	説明
Basic
Standard
Premium

SkuTier

列挙

この特定の SKU の課金レベル。

値	説明
Basic
Standard
Premium

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースを最後に変更した ID の種類。
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TlsVersion

列挙

サポートするクラスターの最小 TLS バージョン (例: '1.2')

値	説明
1.0
1.1
1.2

UserAssignedIdentity

Object

認識されたディクショナリ値。

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID
principalId	string	ユーザー割り当て ID のプリンシパル ID