Namespaces - Get

リファレンス

サービス:: Service Bus

API バージョン:: 2024-01-01

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

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

URI パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string minLength: 6 maxLength: 50	名前空間名
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

NameSpaceGet

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924?api-version=2024-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceGet.json
// this example is just showing the usage of "Namespaces_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusNamespaceResource created on azure
// for more information of creating ServiceBusNamespaceResource, please refer to the document of ServiceBusNamespaceResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-2924";
ResourceIdentifier serviceBusNamespaceResourceId = ServiceBusNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
ServiceBusNamespaceResource serviceBusNamespace = client.GetServiceBusNamespaceResource(serviceBusNamespaceResourceId);

// invoke the operation
ServiceBusNamespaceResource result = await serviceBusNamespace.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceBusNamespaceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:59.35Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2",
    "disableLocalAuth": 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"
          }
        }
      }
    ]
  }
}

定義

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

ConnectionState

Object

ConnectionState 情報。

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

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

EndPointProvisioningState

列挙

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

値	説明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Error

Object

エラーオブジェクト。

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

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

リソース管理エラー応答。

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

keySource

列挙

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

値	説明
Microsoft.KeyVault

KeyVaultProperties

Object

keyVault プロパティを構成するプロパティ

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

ManagedServiceIdentityType

列挙

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

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

PrivateEndpoint 情報。

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

PrivateEndpointConnection

Object

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
Disconnected
Pending
Rejected

PublicNetworkAccess

列挙

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

値	説明
Disabled
Enabled
SecuredByPerimeter

SBNamespace

Object

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

名前	型	規定値	説明
id	string		リソース ID
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.createdAt	string (date-time)		名前空間が作成された時刻
properties.disableLocalAuth	boolean		このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。
properties.encryption.keySource	keySource	Microsoft.KeyVault	暗号化の keySource の使用可能な値を列挙します。
properties.encryption.keyVaultProperties	KeyVaultProperties[]		KeyVault のプロパティ
properties.encryption.requireInfrastructureEncryption	boolean		インフラストラクチャ暗号化を有効にする (二重暗号化)
properties.metricId	string		Azure Insights メトリックの識別子
properties.minimumTlsVersion	TlsVersion		サポートするクラスターの最小 TLS バージョン (例: '1.2')
properties.premiumMessagingPartitions	integer (int32)		Service Bus 名前空間のパーティションの数。このプロパティは、Premium SKU 名前空間にのみ適用されます。既定値は 1、使用可能な値は 1、2、4 です
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		このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。
sku	SBSku		SKU のプロパティ
systemData	systemData		このリソースに関連するシステムメタデータ。
tags	object		リソースタグ
type	string		リソースの種類

SBSku

Object

名前空間の SKU。

名前	型	説明
capacity	integer (int32)	Service Bus Premium 名前空間のメッセージングユニット。有効な容量は、properties.premiumMessagingPartitions 設定の {1、2、4、8、16} の倍数です。たとえば、properties.premiumMessagingPartitions が 1 の場合、使用可能な容量値は 1、2、4、8、16 です。 properties.premiumMessagingPartitions が 4 の場合、使用可能な容量値は 4、8、16、32、64 です。
name	SkuName	この SKU の名前。
tier	SkuTier	この特定の SKU の課金レベル。

SkuName

列挙

この SKU の名前。

値	説明
Basic
Premium
Standard

SkuTier

列挙

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

値	説明
Basic
Premium
Standard

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

次の方法で共有

Namespaces - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

NameSpaceGet

要求のサンプル

応答のサンプル

定義

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity

その他のリソース