Microsoft.ServiceBus 名前空間

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.ServiceBus/namespaces@2022-01-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    alternateName: 'string'
    disableLocalAuth: bool
    encryption: {
      keySource: 'Microsoft.KeyVault'
      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
  }
}

プロパティの値

namespaces

名前 説明
name リソース名 string (必須)

文字数制限: 6 から 50

有効な文字:
英数字とハイフン。

文字で始めます。 文字または数字で終了します。

詳細については、[名前空間の作成](/rest/api/servicebus/create-namespace)に関するページを参照してください。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku SKU のプロパティ SBSku
identity BYOK ID の説明のプロパティ ID
properties 名前空間のプロパティ。 SBNamespaceProperties

ID

名前 説明
type マネージド サービス ID の種類。 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID のプロパティ object

SBNamespaceProperties

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

暗号化

名前 説明
keySource 暗号化に使用できる keySource の値を列挙します 'Microsoft.KeyVault'
keyVaultProperties KeyVault のプロパティ KeyVaultProperties[]
requireInfrastructureEncryption インフラストラクチャ暗号化を有効にする (二重暗号化) [bool]

KeyVaultProperties

名前 説明
identity UserAssignedIdentityProperties
keyName KeyVault からのキーの名前 string
keyVaultUri KeyVault の URI string
keyVersion KeyVault のバージョン string

UserAssignedIdentityProperties

名前 説明
userAssignedIdentity 暗号化用に選択されたユーザー ID の ARM ID string

PrivateEndpointConnection

名前 説明
properties PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint
privateLinkServiceConnectionState 接続の状態の詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

PrivateEndpoint

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

ConnectionState

名前 説明
description 接続状態の説明。 string
status 接続の状態。 '承認済み'
'Disconnected'
'保留中'
'Rejected'

SBSku

名前 説明
capacity レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。 INT
name この SKU の名前。 'Basic'
'Premium'
'Standard' (必須)
レベル この特定の SKU の課金レベル。 'Basic'
'Premium'
'Standard'

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

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 説明
Azure での EPiserverCMS

Azure へのデプロイ
このテンプレートを使用すると、Azure での EpiServerCMS のデプロイに必要なリソースを作成できます
統合パターン - メッセージ ルーター - Service Bus

Azure へのデプロイ
Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する

Azure へのデプロイ
Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
カスタム トピック サブスクリプションAzure Event Grid作成する

Azure へのデプロイ
Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Service Bus を使用した Logic Apps でのメッセージの関連付け

Azure へのデプロイ
これは、Azure Service Busを使用して Logic Apps にメッセージを関連付ける方法を示しています
Service Bus 名前空間とキュー承認規則を作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間と、名前空間とキューの両方に対する承認規則をデプロイできます。
Service Bus 名前空間の作成

Azure へのデプロイ
このテンプレートを使用すると、Basic/Standard SKU を使用して Service Bus 名前空間をデプロイできます。
Service Bus geo 復旧を作成する

Azure へのデプロイ
このテンプレートを使用すると、Premium SKU 名前空間で Service Bus geo ディザスター リカバリー エイリアスを構成できます。
Service Bus の名前空間とキューを作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。
Service Bus 名前空間、トピック、サブスクリプションを作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間、トピック、サブスクリプションをデプロイできます。
Service Bus 名前空間、トピック、サブスクリプション、ルールを作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間、トピック、サブスクリプション、ルールをデプロイできます。
Service Bus 名前空間の IP フィルター規則を作成する

Azure へのデプロイ
このテンプレートを使用すると、IP フィルター規則を使用して Service Bus Premium 名前空間をデプロイできます
Service Bus 名前空間Virtual Network規則を作成する

Azure へのデプロイ
このテンプレートを使用すると、Virtual Networkルールを使用して Service Bus Premium 名前空間をデプロイできます
Service Bus Premium 名前空間と AuthorizationRule を作成する

Azure へのデプロイ
このテンプレートは、Service Bus Premium 名前空間と名前空間 AuthorizationRule を作成します
プライベート エンドポイントを使用して Service Bus 名前空間に接続する

Azure へのデプロイ
このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Service Bus 名前空間にアクセスする方法を示します。
Service Bus の名前空間とトピックを作成する

Azure へのデプロイ
このテンプレートは、Service Bus 名前空間とトピックを作成します。
サブスクリプションと SQL フィルターを使用して Service Bus トピックを作成する

Azure へのデプロイ
このテンプレートは、定義された SQL フィルター式に一致するメッセージのみを受信する SQL フィルター式を使用して、サブスクリプションを含む Service Bus 名前空間とトピックを作成します。

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

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

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

リソース形式

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

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2022-01-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "alternateName": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "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"
  }
}

プロパティの値

namespaces

名前 説明
type リソースの種類 'Microsoft.ServiceBus/namespaces'
apiVersion リソース API のバージョン '2022-01-01-preview'
name リソース名 string (必須)

文字制限: 6 から 50

有効な文字:
英数字とハイフン。

文字で始めます。 文字または数字で終了します。

詳細については、[名前空間の作成](/rest/api/servicebus/create-namespace)に関するページを参照してください。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
sku SKU のプロパティ SBSku
identity BYOK ID の説明のプロパティ ID
properties 名前空間のプロパティ。 SBNamespaceProperties

ID

名前 説明
type マネージド サービス ID の種類。 'None'
'SystemAssigned'
'SystemAssigned、UserAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID のプロパティ object

SBNamespaceProperties

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

暗号化

名前 説明
keySource 暗号化に使用できる keySource の値を列挙します 'Microsoft.KeyVault'
keyVaultProperties KeyVault のプロパティ KeyVaultProperties[]
requireInfrastructureEncryption インフラストラクチャ暗号化を有効にする (二重暗号化) [bool]

KeyVaultProperties

名前 説明
identity UserAssignedIdentityProperties
keyName KeyVault からのキーの名前 string
keyVaultUri KeyVault の URI string
keyVersion KeyVault のバージョン string

UserAssignedIdentityProperties

名前 説明
userAssignedIdentity 暗号化用に選択されたユーザー ID の ARM ID string

PrivateEndpointConnection

名前 説明
properties PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint
privateLinkServiceConnectionState 接続の状態の詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

PrivateEndpoint

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

ConnectionState

名前 説明
description 接続状態の説明。 string
status 接続の状態。 '承認済み'
'Disconnected'
'保留中'
'Rejected'

SBSku

名前 説明
capacity レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。 INT
name この SKU の名前。 'Basic'
'Premium'
'Standard' (必須)
レベル この特定の SKU の課金レベル。 'Basic'
'Premium'
'Standard'

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

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Azure での EPiserverCMS

Azure へのデプロイ
このテンプレートを使用すると、Azure での EpiServerCMS のデプロイに必要なリソースを作成できます
統合パターン - メッセージ ルーター - Service Bus

Azure へのデプロイ
Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する

Azure へのデプロイ
Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
カスタム トピック サブスクリプションAzure Event Grid作成する

Azure へのデプロイ
Azure Event Gridカスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Service Bus を使用した Logic Apps でのメッセージの関連付け

Azure へのデプロイ
を使用して Logic Apps にメッセージを関連付ける方法を示Azure Service Bus
Service Bus 名前空間とキュー承認規則を作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間と、名前空間とキューの両方の承認規則をデプロイできます。
Service Bus 名前空間の作成

Azure へのデプロイ
このテンプレートを使用すると、Basic/Standard SKU を使用して Service Bus 名前空間をデプロイできます。
Service Bus Geo 復旧を作成する

Azure へのデプロイ
このテンプレートを使用すると、Premium SKU 名前空間で Service Bus geo ディザスター リカバリー エイリアスを構成できます。
Service Bus の名前空間とキューを作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。
Service Bus 名前空間、トピック、サブスクリプションを作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間、トピック、サブスクリプションをデプロイできます。
Service Bus 名前空間、トピック、サブスクリプション、ルールを作成する

Azure へのデプロイ
このテンプレートを使用すると、Service Bus Standard 名前空間、トピック、サブスクリプション、ルールをデプロイできます。
Service Bus 名前空間の IP フィルター規則を作成する

Azure へのデプロイ
このテンプレートを使用すると、IP フィルター規則を使用して Service Bus Premium 名前空間をデプロイできます
Service Bus 名前空間Virtual Network規則を作成する

Azure へのデプロイ
このテンプレートを使用すると、Virtual Networkルールを使用して Service Bus Premium 名前空間をデプロイできます
Service Bus Premium 名前空間と AuthorizationRule を作成する

Azure へのデプロイ
このテンプレートでは、Service Bus Premium 名前空間と名前空間 AuthorizationRule を作成します
プライベート エンドポイント経由で Service Bus 名前空間に接続する

Azure へのデプロイ
このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Service Bus 名前空間にアクセスする方法を示します。
Service Bus 名前空間とトピックを作成する

Azure へのデプロイ
このテンプレートでは、Service Bus 名前空間とトピックを作成します。
サブスクリプションと SQL フィルターを使用して Service Bus トピックを作成する

Azure へのデプロイ
このテンプレートでは、SQL Filter 式を使用してサブスクリプションを含む Service Bus 名前空間とトピックを作成し、定義された SQL フィルター式に一致するメッセージのみを受信します。

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      alternateName = "string"
      disableLocalAuth = bool
      encryption = {
        keySource = "Microsoft.KeyVault"
        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"
    }
  })
}

プロパティの値

namespaces

名前 説明
type リソースの種類 "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
name リソース名 string (必須)

文字制限: 6 から 50

有効な文字:
英数字とハイフン。

文字で始めます。 文字または数字で終了します。

詳細については、[名前空間の作成](/rest/api/servicebus/create-namespace)に関するページを参照してください。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。
sku SKU のプロパティ SBSku
identity BYOK ID の説明のプロパティ ID
properties 名前空間のプロパティ。 SBNamespaceProperties

ID

名前 説明
type マネージド サービス ID の種類。 "SystemAssigned"
"SystemAssigned、UserAssigned"
"UserAssigned"
identity_ids ユーザー割り当て ID のプロパティ ユーザー ID ID の配列。

SBNamespaceProperties

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

暗号化

名前 説明
keySource 暗号化の keySource の使用可能な値を列挙します "Microsoft.KeyVault"
keyVaultProperties KeyVault のプロパティ KeyVaultProperties[]
requireInfrastructureEncryption インフラストラクチャ暗号化を有効にする (二重暗号化) [bool]

KeyVaultProperties

名前 説明
identity UserAssignedIdentityProperties
keyName KeyVault からのキーの名前 string
keyVaultUri KeyVault の URI string
keyVersion KeyVault のバージョン string

UserAssignedIdentityProperties

名前 説明
userAssignedIdentity 暗号化用に選択されたユーザー ID の ARM ID string

PrivateEndpointConnection

名前 説明
properties PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint
privateLinkServiceConnectionState 接続の状態の詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 "キャンセル済み"
"作成中"
"削除中"
"Failed"
"Succeeded"
"更新中"

PrivateEndpoint

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

ConnectionState

名前 説明
description 接続状態の説明。 string
status 接続の状態。 "承認済み"
"Disconnected"
"保留中"
"Rejected"

SBSku

名前 説明
capacity レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。 INT
name この SKU の名前。 "Basic"
"Premium"
"Standard" (必須)
レベル この特定の SKU の課金レベル。 "Basic"
"Premium"
"Standard"