Namespaces - Get

リファレンス

Service:: Event Hubs

API Version:: 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	名前空間名 Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	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 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

NameSpaceGet

Sample Request

HTTP

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

Sample Response

Status code:: 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	リストまたは取得操作の 1 つの名前空間項目
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

接続の状態の詳細。

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

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

EHNamespace

リストまたは取得操作の 1 つの名前空間項目

名前	型	既定値	説明
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		名前空間が作成された時刻。
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		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		名前空間が更新された時刻。
properties.zoneRedundant	boolean		このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Standard Event Hubs 名前空間が作成されます。
sku	Sku		SKU リソースのプロパティ
systemData	systemData		このリソースに関連するシステムメタデータ。
tags	object		リソースタグ。
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

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

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

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

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

keySource

暗号化に使用できる keySource の値を列挙します

名前	型	説明
Microsoft.KeyVault	string

KeyVaultProperties

KeyVault のプロパティ

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

ManagedServiceIdentityType

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

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

この接続のプライベートエンドポイントリソース。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子。

PrivateEndpointConnection

プライベートエンドポイント接続の一覧。

名前	型	説明
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	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

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

名前	型	説明
Disabled	string
Enabled	string
SecuredByPerimeter	string

Sku

SKU リソースのプロパティ

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

SkuName

この SKU の名前。

名前	型	説明
Basic	string
Premium	string
Standard	string

SkuTier

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

名前	型	説明
Basic	string
Premium	string
Standard	string

systemData

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

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

TlsVersion

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

名前	型	説明
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

認識された辞書の値。

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