Microsoft.ServiceBus 名前空間 2021-11-01

Bicep リソース定義

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

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

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

リソースの形式

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

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

プロパティ値

namespaces

名前 形容 価値
名前 リソース名 string (必須)

文字制限: 6 から 50

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

文字で始めます。 末尾は文字または数字です。

詳細については、「名前空間作成する」を参照してください。

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

同一性

名前 形容 価値
種類 マネージド サービス ID の種類。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID のプロパティ IdentityUserAssignedIdentities の

IdentityUserAssignedIdentities

名前 形容 価値
{カスタマイズされたプロパティ} UserAssignedIdentity の

UserAssignedIdentity

このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

SBNamespaceProperties

名前 形容 価値
alternateName 名前空間の代替名
disableLocalAuth このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。 bool
暗号化 BYOK 暗号化の説明のプロパティ 暗号化
privateEndpointConnections プライベート エンドポイント接続の一覧。 PrivateEndpointConnection[]
zoneRedundant このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。 bool

暗号化

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

KeyVaultProperties

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

UserAssignedIdentityProperties

名前 形容 価値
userAssignedIdentity 暗号化用に選択されたユーザー ID の ARM ID

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

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

ConnectionState

名前 形容 価値
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

SBSku

名前 形容 価値
能力 レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。 int
名前 この 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 名前空間の仮想ネットワーク規則 を作成する

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": "2021-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "alternateName": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyName": "string",
          "keyVaultUri": "string",
          "keyVersion": "string"
        }
      ],
      "requireInfrastructureEncryption": "bool"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "zoneRedundant": "bool"
  }
}

プロパティ値

namespaces

名前 形容 価値
種類 リソースの種類 'Microsoft.ServiceBus/namespaces'
apiVersion リソース API のバージョン '2021-11-01'
名前 リソース名 string (必須)

文字制限: 6 から 50

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

文字で始めます。 末尾は文字または数字です。

詳細については、「名前空間作成する」を参照してください。

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

同一性

名前 形容 価値
種類 マネージド サービス ID の種類。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID のプロパティ IdentityUserAssignedIdentities の

IdentityUserAssignedIdentities

名前 形容 価値
{カスタマイズされたプロパティ} UserAssignedIdentity の

UserAssignedIdentity

このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

SBNamespaceProperties

名前 形容 価値
alternateName 名前空間の代替名
disableLocalAuth このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。 bool
暗号化 BYOK 暗号化の説明のプロパティ 暗号化
privateEndpointConnections プライベート エンドポイント接続の一覧。 PrivateEndpointConnection[]
zoneRedundant このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。 bool

暗号化

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

KeyVaultProperties

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

UserAssignedIdentityProperties

名前 形容 価値
userAssignedIdentity 暗号化用に選択されたユーザー ID の ARM ID

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

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

ConnectionState

名前 形容 価値
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

SBSku

名前 形容 価値
能力 レベルに指定されたメッセージング ユニット。 Premium レベルの場合、容量は 1、2、4 です。 int
名前 この 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 名前空間の仮想ネットワーク規則 を作成する

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 名前空間とトピックを作成します。

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2021-11-01"
  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
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

プロパティ値

namespaces

名前 形容 価値
種類 リソースの種類 "Microsoft.ServiceBus/namespaces@2021-11-01"
名前 リソース名 string (必須)

文字制限: 6 から 50

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

文字で始めます。 末尾は文字または数字です。

詳細については、「名前空間作成する」を参照してください。

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

同一性

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

IdentityUserAssignedIdentities

名前 形容 価値
{カスタマイズされたプロパティ} UserAssignedIdentity の

UserAssignedIdentity

このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

SBNamespaceProperties

名前 形容 価値
alternateName 名前空間の代替名
disableLocalAuth このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。 bool
暗号化 BYOK 暗号化の説明のプロパティ 暗号化
privateEndpointConnections プライベート エンドポイント接続の一覧。 PrivateEndpointConnection[]
zoneRedundant このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。 bool

暗号化

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

KeyVaultProperties

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

UserAssignedIdentityProperties

名前 形容 価値
userAssignedIdentity 暗号化用に選択されたユーザー ID の ARM ID

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 "Canceled"
"作成中"
"削除中"
"Failed"
"Succeeded"
"更新中"

PrivateEndpoint

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

ConnectionState

名前 形容 価値
形容 接続状態の説明。
地位 接続の状態。 "承認済み"
"Disconnected"
"保留中"
"Rejected"

SBSku

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