Microsoft.ServiceBus 名前空間 2022-01-01-preview

• 最新の を する
• 2024-01-01
• 2023-01-01-プレビュー
• 2022-10-01-プレビュー
• 2022-01-01-プレビュー
• 2021-11-01
• 2021-06-01-プレビュー
• 2021-01-01-プレビュー
• 2018-01-01-プレビュー
• 2017-04-01
• 2015-08-01

Bicep リソース定義

名前空間のリソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ServiceBus/namespaces リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ServiceBus/namespaces@2022-01-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    alternateName: 'string'
    disableLocalAuth: bool
    encryption: {
      keySource: 'string'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyName: 'string'
          keyVaultUri: 'string'
          keyVersion: 'string'
        }
      ]
      requireInfrastructureEncryption: bool
    }
    minimumTlsVersion: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.ServiceBus/名前空間

名前	形容	価値
同一性	BYOK ID の説明のプロパティ	ID
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	string (必須)
プロパティ	名前空間のプロパティ。	SBNamespaceProperties の
エスケーユー	SKU のプロパティ	SBスカイ
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

接続状態

名前	形容	価値
形容	接続状態の説明。	糸
地位	接続の状態。	「承認済み」 「切断」 「保留中」 「拒否されました」

暗号化

名前	形容	価値
キーソース	暗号化の keySource の使用可能な値を列挙します。	'Microsoft.KeyVault'
keyVaultプロパティ	KeyVault のプロパティ	キーボールトのプロパティ[]
requireInfrastructure暗号化	インフラストラクチャ暗号化を有効にする (二重暗号化)	ブール (bool)

同一性

名前	形容	価値
種類	マネージド サービス ID の種類。	「なし」 'システム割り当て' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ)	ユーザー割り当て ID のプロパティ	IdentityUserAssignedIdentities の

IdentityUserAssignedIdentities

名前	形容	価値

KeyVaultプロパティ

名前	形容	価値
同一性		UserAssignedIdentityProperties の
キー名	KeyVault からのキーの名前	糸
keyVaultUri	KeyVault の URI	糸
キーバージョン	KeyVault のバージョン	糸

プライベートエンドポイント

名前	形容	価値
身分証明書	プライベート エンドポイントの ARM 識別子。	糸

プライベートエンドポイント接続

名前	形容	価値
プロパティ	PrivateEndpointConnection のプロパティ。	プライベートエンドポイント接続プロパティ

プライベートエンドポイント接続プロパティ

名前	形容	価値
プライベートエンドポイント	この接続のプライベート エンドポイント リソース。	PrivateEndpoint を する
privateLinkServiceConnectionState	接続の状態に関する詳細。	コネクションステート
プロビジョニング状態	プライベート エンドポイント接続のプロビジョニング状態。	「キャンセル」 「創造する」 '削除中' 「失敗しました」 「成功しました」 '更新中'

SBNamespaceプロパティ

名前	形容	価値
代替名	名前空間の代替名	糸
disableLocalAuth	このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。	ブール (bool)
暗号化	BYOK 暗号化の説明のプロパティ	暗号化
minimumTlsVersion	サポートするクラスターの最小 TLS バージョン (例: '1.2')	'1.0' '1.1' '1.2'
privateEndpointConnections(プライベートエンドポイント接続)	プライベート エンドポイント接続の一覧。	プライベートエンドポイント接続[]
publicNetworkAccess (パブリックネットワークアクセス)	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。	「無効」 「有効」 「SecuredByPerimeter」
ゾーン冗長	このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。	ブール (bool)

SBスカイ

名前	形容	価値
能力	レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。	整数 (int)
名前	この SKU の名前。	「ベーシック」 「プレミアム」 'Standard' (必須)
層	この特定の SKU の課金レベル。	「ベーシック」 「プレミアム」 「スタンダード」

追跡リソースタグ

名前	形容	価値

ユーザー割り当て識別子

名前	形容	価値

UserAssignedIdentityプロパティ

名前	形容	価値
ユーザー割り当てアイデンティティ	暗号化用に選択されたユーザー ID の ARM ID	糸

使用例

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール	形容
Service Bus 名前空間の	Service Bus 名前空間の AVM リソース モジュール

Azure クイック スタートのサンプル

次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル	形容
Service Bus の名前空間とキューを作成する	このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。
Service Bus 名前空間の仮想ネットワーク規則 を作成する	このテンプレートを使用すると、Virtual Network ルールを使用して Service Bus Premium 名前空間をデプロイできます
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する	Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Container Apps を使用して Dapr マイクロサービス アプリを作成する	Container Apps を使用して Dapr マイクロサービス アプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します	Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。

ARM テンプレート リソース定義

名前空間のリソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ServiceBus/namespaces リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2022-01-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "alternateName": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyName": "string",
          "keyVaultUri": "string",
          "keyVersion": "string"
        }
      ],
      "requireInfrastructureEncryption": "bool"
    },
    "minimumTlsVersion": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.ServiceBus/名前空間

名前	形容	価値
apiVersion (英語)	API のバージョン	'2022-01-01-プレビュー'
同一性	BYOK ID の説明のプロパティ	ID
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	string (必須)
プロパティ	名前空間のプロパティ。	SBNamespaceProperties の
エスケーユー	SKU のプロパティ	SBスカイ
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類	リソースの種類	'Microsoft.ServiceBus/名前空間'

接続状態

名前	形容	価値
形容	接続状態の説明。	糸
地位	接続の状態。	「承認済み」 「切断」 「保留中」 「拒否されました」

暗号化

名前	形容	価値
キーソース	暗号化の keySource の使用可能な値を列挙します。	'Microsoft.KeyVault'
keyVaultプロパティ	KeyVault のプロパティ	キーボールトのプロパティ[]
requireInfrastructure暗号化	インフラストラクチャ暗号化を有効にする (二重暗号化)	ブール (bool)

同一性

名前	形容	価値
種類	マネージド サービス ID の種類。	「なし」 'システム割り当て' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ)	ユーザー割り当て ID のプロパティ	IdentityUserAssignedIdentities の

IdentityUserAssignedIdentities

名前	形容	価値

KeyVaultプロパティ

名前	形容	価値
同一性		UserAssignedIdentityProperties の
キー名	KeyVault からのキーの名前	糸
keyVaultUri	KeyVault の URI	糸
キーバージョン	KeyVault のバージョン	糸

プライベートエンドポイント

名前	形容	価値
身分証明書	プライベート エンドポイントの ARM 識別子。	糸

プライベートエンドポイント接続

名前	形容	価値
プロパティ	PrivateEndpointConnection のプロパティ。	プライベートエンドポイント接続プロパティ

プライベートエンドポイント接続プロパティ

名前	形容	価値
プライベートエンドポイント	この接続のプライベート エンドポイント リソース。	PrivateEndpoint を する
privateLinkServiceConnectionState	接続の状態に関する詳細。	コネクションステート
プロビジョニング状態	プライベート エンドポイント接続のプロビジョニング状態。	「キャンセル」 「創造する」 '削除中' 「失敗しました」 「成功しました」 '更新中'

SBNamespaceプロパティ

名前	形容	価値
代替名	名前空間の代替名	糸
disableLocalAuth	このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。	ブール (bool)
暗号化	BYOK 暗号化の説明のプロパティ	暗号化
minimumTlsVersion	サポートするクラスターの最小 TLS バージョン (例: '1.2')	'1.0' '1.1' '1.2'
privateEndpointConnections(プライベートエンドポイント接続)	プライベート エンドポイント接続の一覧。	プライベートエンドポイント接続[]
publicNetworkAccess (パブリックネットワークアクセス)	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。	「無効」 「有効」 「SecuredByPerimeter」
ゾーン冗長	このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。	ブール (bool)

SBスカイ

名前	形容	価値
能力	レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。	整数 (int)
名前	この SKU の名前。	「ベーシック」 「プレミアム」 'Standard' (必須)
層	この特定の SKU の課金レベル。	「ベーシック」 「プレミアム」 「スタンダード」

追跡リソースタグ

名前	形容	価値

ユーザー割り当て識別子

名前	形容	価値

UserAssignedIdentityプロパティ

名前	形容	価値
ユーザー割り当てアイデンティティ	暗号化用に選択されたユーザー ID の ARM ID	糸

使用例

Azure クイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート	形容
プライベート エンドポイントを使用して Service Bus 名前空間に接続 Azure にデプロイする	このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Service Bus 名前空間にアクセスする方法を示します。
Service Bus を使用した Logic Apps でのメッセージの関連付け Azure にデプロイする	Azure Service Bus を使用して Logic Apps 上でメッセージを関連付ける方法を示す
Service Bus geo 復旧 を作成する Azure にデプロイする	このテンプレートを使用すると、Premium SKU 名前空間で Service Bus geo ディザスター リカバリーエイリアスを構成できます。
Service Bus 名前空間の作成 Azure にデプロイする	このテンプレートを使用すると、Basic/Standard SKU を使用して Service Bus 名前空間をデプロイできます。
Service Bus の名前空間とキューを作成する Azure にデプロイする	このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。
Service Bus 名前空間とキュー承認規則を作成 Azure にデプロイする	このテンプレートを使用すると、Service Bus Standard 名前空間と、名前空間とキューの両方の承認規則をデプロイできます。
Service Bus 名前空間とトピック を作成する Azure にデプロイする	このテンプレートでは、Service Bus 名前空間とトピックが作成されます。
Service Bus 名前空間の IP フィルター規則を作成 Azure にデプロイする	このテンプレートを使用すると、IP フィルター規則を使用して Service Bus Premium 名前空間をデプロイできます
Service Bus 名前空間の仮想ネットワーク規則 を作成する Azure にデプロイする	このテンプレートを使用すると、Virtual Network ルールを使用して Service Bus Premium 名前空間をデプロイできます
Service Bus の名前空間、トピック、サブスクリプションの を作成する Azure にデプロイする	このテンプレートを使用すると、Service Bus Standard 名前空間、トピック、サブスクリプションをデプロイできます。
Service Bus 名前空間、トピック、サブスクリプション、ルール を作成する Azure にデプロイする	このテンプレートを使用すると、Service Bus Standard 名前空間、トピック、サブスクリプション、ルールをデプロイできます。
Service Bus Premium 名前空間と AuthorizationRule を作成する Azure にデプロイする	このテンプレートは、Service Bus Premium 名前空間と名前空間 AuthorizationRule を作成します。
サブスクリプションと SQL フィルター を使用して Service Bus トピックを作成する Azure にデプロイする	このテンプレートは、定義された SQL フィルター式に一致するメッセージのみを受信する SQL フィルター式を使用して、サブスクリプションを含む Service Bus 名前空間とトピックを作成します。
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する Azure にデプロイする	Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Azure Event Grid カスタム トピック サブスクリプション を作成する Azure にデプロイする	Azure Event Grid カスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Container Apps を使用して Dapr マイクロサービス アプリを作成する Azure にデプロイする	Container Apps を使用して Dapr マイクロサービス アプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します Azure にデプロイする	Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
Azure で EPiserverCMS を する Azure にデプロイする	このテンプレートを使用すると、Azure での EpiServerCMS のデプロイに必要なリソースを作成できます
統合パターン - メッセージ ルーター - Service Bus Azure にデプロイする	Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション

Terraform (AzAPI プロバイダー) リソース定義

名前空間のリソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ServiceBus/namespaces リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      alternateName = "string"
      disableLocalAuth = bool
      encryption = {
        keySource = "string"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyName = "string"
            keyVaultUri = "string"
            keyVersion = "string"
          }
        ]
        requireInfrastructureEncryption = bool
      }
      minimumTlsVersion = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

プロパティ値

Microsoft.ServiceBus/名前空間

名前	形容	価値
同一性	BYOK ID の説明のプロパティ	ID
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	string (必須)
プロパティ	名前空間のプロパティ。	SBNamespaceProperties の
エスケーユー	SKU のプロパティ	SBスカイ
タグ	リソース タグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.ServiceBus/namespaces@2022-01-01-preview" (英語)

接続状態

名前	形容	価値
形容	接続状態の説明。	糸
地位	接続の状態。	「承認済み」 「切断」 「保留中」 「拒否されました」

暗号化

名前	形容	価値
キーソース	暗号化の keySource の使用可能な値を列挙します。	'Microsoft.KeyVault'
keyVaultプロパティ	KeyVault のプロパティ	キーボールトのプロパティ[]
requireInfrastructure暗号化	インフラストラクチャ暗号化を有効にする (二重暗号化)	ブール (bool)

同一性

名前	形容	価値
種類	マネージド サービス ID の種類。	「なし」 'システム割り当て' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ)	ユーザー割り当て ID のプロパティ	IdentityUserAssignedIdentities の

IdentityUserAssignedIdentities

名前	形容	価値

KeyVaultプロパティ

名前	形容	価値
同一性		UserAssignedIdentityProperties の
キー名	KeyVault からのキーの名前	糸
keyVaultUri	KeyVault の URI	糸
キーバージョン	KeyVault のバージョン	糸

プライベートエンドポイント

名前	形容	価値
身分証明書	プライベート エンドポイントの ARM 識別子。	糸

プライベートエンドポイント接続

名前	形容	価値
プロパティ	PrivateEndpointConnection のプロパティ。	プライベートエンドポイント接続プロパティ

プライベートエンドポイント接続プロパティ

名前	形容	価値
プライベートエンドポイント	この接続のプライベート エンドポイント リソース。	PrivateEndpoint を する
privateLinkServiceConnectionState	接続の状態に関する詳細。	コネクションステート
プロビジョニング状態	プライベート エンドポイント接続のプロビジョニング状態。	「キャンセル」 「創造する」 '削除中' 「失敗しました」 「成功しました」 '更新中'

SBNamespaceプロパティ

名前	形容	価値
代替名	名前空間の代替名	糸
disableLocalAuth	このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。	ブール (bool)
暗号化	BYOK 暗号化の説明のプロパティ	暗号化
minimumTlsVersion	サポートするクラスターの最小 TLS バージョン (例: '1.2')	'1.0' '1.1' '1.2'
privateEndpointConnections(プライベートエンドポイント接続)	プライベート エンドポイント接続の一覧。	プライベートエンドポイント接続[]
publicNetworkAccess (パブリックネットワークアクセス)	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。	「無効」 「有効」 「SecuredByPerimeter」
ゾーン冗長	このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。	ブール (bool)

SBスカイ

名前	形容	価値
能力	レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。	整数 (int)
名前	この SKU の名前。	「ベーシック」 「プレミアム」 'Standard' (必須)
層	この特定の SKU の課金レベル。	「ベーシック」 「プレミアム」 「スタンダード」

追跡リソースタグ

名前	形容	価値

ユーザー割り当て識別子

名前	形容	価値

UserAssignedIdentityプロパティ

名前	形容	価値
ユーザー割り当てアイデンティティ	暗号化用に選択されたユーザー ID の ARM ID	糸

使用例

Azure 検証済みモジュール

次の Azure 検証済みモジュール を使用して、このリソースの種類をデプロイできます。

モジュール	形容
Service Bus 名前空間の	Service Bus 名前空間の AVM リソース モジュール