Microsoft.ServiceBus 名前空間
Bicep リソース定義
名前空間のリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ServiceBus/namespaces リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ServiceBus/namespaces@2024-01-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
alternateName: 'string'
disableLocalAuth: bool
encryption: {
keySource: 'Microsoft.KeyVault'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
]
requireInfrastructureEncryption: bool
}
minimumTlsVersion: 'string'
premiumMessagingPartitions: int
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'
}
}
プロパティ値
ConnectionState
名前 | 形容 | 価値 |
---|---|---|
形容 | 接続状態の説明。 | 糸 |
地位 | 接続の状態。 | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
暗号化
名前 | 形容 | 価値 |
---|---|---|
keySource | 暗号化の keySource の使用可能な値を列挙します。 | 'Microsoft.KeyVault' |
keyVaultProperties | KeyVault のプロパティ | KeyVaultProperties[] |
requireInfrastructureEncryption | インフラストラクチャ暗号化を有効にする (二重暗号化) | bool |
同一性
名前 | 形容 | 価値 |
---|---|---|
種類 | マネージド サービス ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | ユーザー割り当て ID のプロパティ | IdentityUserAssignedIdentities の |
IdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
KeyVaultProperties
名前 | 形容 | 価値 |
---|---|---|
同一性 | UserAssignedIdentityProperties の |
|
keyName | KeyVault からのキーの名前 | 糸 |
keyVaultUri | KeyVault の URI | 糸 |
keyVersion | KeyVault のバージョン | 糸 |
Microsoft.ServiceBus/namespaces
名前 | 形容 | 価値 |
---|---|---|
同一性 | BYOK ID の説明のプロパティ | ID |
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | string (必須) |
プロパティ | 名前空間のプロパティ。 | SBNamespaceProperties の |
sku | SKU のプロパティ | SBSku |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
PrivateEndpoint
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | プライベート エンドポイントの ARM 識別子。 | 糸 |
PrivateEndpointConnection
名前 | 形容 | 価値 |
---|---|---|
プロパティ | PrivateEndpointConnection のプロパティ。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
名前 | 形容 | 価値 |
---|---|---|
privateEndpoint | この接続のプライベート エンドポイント リソース。 | PrivateEndpoint を |
privateLinkServiceConnectionState | 接続の状態に関する詳細。 | ConnectionState |
provisioningState | プライベート エンドポイント接続のプロビジョニング状態。 | 'Canceled' 'Creating' '削除中' 'Failed' 'Succeeded' '更新中' |
SBNamespaceProperties
名前 | 形容 | 価値 |
---|---|---|
alternateName | 名前空間の代替名 | 糸 |
disableLocalAuth | このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。 | bool |
暗号化 | BYOK 暗号化の説明のプロパティ | 暗号化 |
minimumTlsVersion | サポートするクラスターの最小 TLS バージョン (例: '1.2') | '1.0' '1.1' '1.2' |
premiumMessagingPartitions | Service Bus 名前空間のパーティションの数。 このプロパティは、Premium SKU 名前空間にのみ適用されます。 既定値は 1、使用可能な値は 1、2、4 です | int |
privateEndpointConnections | プライベート エンドポイント接続の一覧。 | PrivateEndpointConnection[] |
publicNetworkAccess | これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
zoneRedundant | このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。 | bool |
SBSku
名前 | 形容 | 価値 |
---|---|---|
能力 | 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 です。 | int |
名前 | この SKU の名前。 | 'Basic' 'Premium' 'Standard' (必須) |
層 | この特定の SKU の課金レベル。 | 'Basic' 'Premium' 'Standard' |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UserAssignedIdentity
名前 | 形容 | 価値 |
---|
UserAssignedIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
userAssignedIdentity | 暗号化用に選択されたユーザー ID の ARM ID | 糸 |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
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": "2024-01-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"alternateName": "string",
"disableLocalAuth": "bool",
"encryption": {
"keySource": "Microsoft.KeyVault",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
}
],
"requireInfrastructureEncryption": "bool"
},
"minimumTlsVersion": "string",
"premiumMessagingPartitions": "int",
"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"
}
}
プロパティ値
ConnectionState
名前 | 形容 | 価値 |
---|---|---|
形容 | 接続状態の説明。 | 糸 |
地位 | 接続の状態。 | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
暗号化
名前 | 形容 | 価値 |
---|---|---|
keySource | 暗号化の keySource の使用可能な値を列挙します。 | 'Microsoft.KeyVault' |
keyVaultProperties | KeyVault のプロパティ | KeyVaultProperties[] |
requireInfrastructureEncryption | インフラストラクチャ暗号化を有効にする (二重暗号化) | bool |
同一性
名前 | 形容 | 価値 |
---|---|---|
種類 | マネージド サービス ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | ユーザー割り当て ID のプロパティ | IdentityUserAssignedIdentities の |
IdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
KeyVaultProperties
名前 | 形容 | 価値 |
---|---|---|
同一性 | UserAssignedIdentityProperties の |
|
keyName | KeyVault からのキーの名前 | 糸 |
keyVaultUri | KeyVault の URI | 糸 |
keyVersion | KeyVault のバージョン | 糸 |
Microsoft.ServiceBus/namespaces
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2024-01-01' |
同一性 | BYOK ID の説明のプロパティ | ID |
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | string (必須) |
プロパティ | 名前空間のプロパティ。 | SBNamespaceProperties の |
sku | SKU のプロパティ | SBSku |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
種類 | リソースの種類 | 'Microsoft.ServiceBus/namespaces' |
PrivateEndpoint
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | プライベート エンドポイントの ARM 識別子。 | 糸 |
PrivateEndpointConnection
名前 | 形容 | 価値 |
---|---|---|
プロパティ | PrivateEndpointConnection のプロパティ。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
名前 | 形容 | 価値 |
---|---|---|
privateEndpoint | この接続のプライベート エンドポイント リソース。 | PrivateEndpoint を |
privateLinkServiceConnectionState | 接続の状態に関する詳細。 | ConnectionState |
provisioningState | プライベート エンドポイント接続のプロビジョニング状態。 | 'Canceled' 'Creating' '削除中' 'Failed' 'Succeeded' '更新中' |
SBNamespaceProperties
名前 | 形容 | 価値 |
---|---|---|
alternateName | 名前空間の代替名 | 糸 |
disableLocalAuth | このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。 | bool |
暗号化 | BYOK 暗号化の説明のプロパティ | 暗号化 |
minimumTlsVersion | サポートするクラスターの最小 TLS バージョン (例: '1.2') | '1.0' '1.1' '1.2' |
premiumMessagingPartitions | Service Bus 名前空間のパーティションの数。 このプロパティは、Premium SKU 名前空間にのみ適用されます。 既定値は 1、使用可能な値は 1、2、4 です | int |
privateEndpointConnections | プライベート エンドポイント接続の一覧。 | PrivateEndpointConnection[] |
publicNetworkAccess | これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
zoneRedundant | このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。 | bool |
SBSku
名前 | 形容 | 価値 |
---|---|---|
能力 | 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 です。 | int |
名前 | この SKU の名前。 | 'Basic' 'Premium' 'Standard' (必須) |
層 | この特定の SKU の課金レベル。 | 'Basic' 'Premium' 'Standard' |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UserAssignedIdentity
名前 | 形容 | 価値 |
---|
UserAssignedIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
userAssignedIdentity | 暗号化用に選択されたユーザー ID の ARM ID | 糸 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
プライベート エンドポイントを使用して 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@2024-01-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
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"
premiumMessagingPartitions = int
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
zoneRedundant = bool
}
})
}
プロパティ値
ConnectionState
名前 | 形容 | 価値 |
---|---|---|
形容 | 接続状態の説明。 | 糸 |
地位 | 接続の状態。 | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
暗号化
名前 | 形容 | 価値 |
---|---|---|
keySource | 暗号化の keySource の使用可能な値を列挙します。 | 'Microsoft.KeyVault' |
keyVaultProperties | KeyVault のプロパティ | KeyVaultProperties[] |
requireInfrastructureEncryption | インフラストラクチャ暗号化を有効にする (二重暗号化) | bool |
同一性
名前 | 形容 | 価値 |
---|---|---|
種類 | マネージド サービス ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | ユーザー割り当て ID のプロパティ | IdentityUserAssignedIdentities の |
IdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
KeyVaultProperties
名前 | 形容 | 価値 |
---|---|---|
同一性 | UserAssignedIdentityProperties の |
|
keyName | KeyVault からのキーの名前 | 糸 |
keyVaultUri | KeyVault の URI | 糸 |
keyVersion | KeyVault のバージョン | 糸 |
Microsoft.ServiceBus/namespaces
名前 | 形容 | 価値 |
---|---|---|
同一性 | BYOK ID の説明のプロパティ | ID |
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | string (必須) |
プロパティ | 名前空間のプロパティ。 | SBNamespaceProperties の |
sku | SKU のプロパティ | SBSku |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
種類 | リソースの種類 | "Microsoft.ServiceBus/namespaces@2024-01-01" |
PrivateEndpoint
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | プライベート エンドポイントの ARM 識別子。 | 糸 |
PrivateEndpointConnection
名前 | 形容 | 価値 |
---|---|---|
プロパティ | PrivateEndpointConnection のプロパティ。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
名前 | 形容 | 価値 |
---|---|---|
privateEndpoint | この接続のプライベート エンドポイント リソース。 | PrivateEndpoint を |
privateLinkServiceConnectionState | 接続の状態に関する詳細。 | ConnectionState |
provisioningState | プライベート エンドポイント接続のプロビジョニング状態。 | 'Canceled' 'Creating' '削除中' 'Failed' 'Succeeded' '更新中' |
SBNamespaceProperties
名前 | 形容 | 価値 |
---|---|---|
alternateName | 名前空間の代替名 | 糸 |
disableLocalAuth | このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。 | bool |
暗号化 | BYOK 暗号化の説明のプロパティ | 暗号化 |
minimumTlsVersion | サポートするクラスターの最小 TLS バージョン (例: '1.2') | '1.0' '1.1' '1.2' |
premiumMessagingPartitions | Service Bus 名前空間のパーティションの数。 このプロパティは、Premium SKU 名前空間にのみ適用されます。 既定値は 1、使用可能な値は 1、2、4 です | int |
privateEndpointConnections | プライベート エンドポイント接続の一覧。 | PrivateEndpointConnection[] |
publicNetworkAccess | これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
zoneRedundant | このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに Premium Service Bus 名前空間が作成されます。 | bool |
SBSku
名前 | 形容 | 価値 |
---|---|---|
能力 | 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 です。 | int |
名前 | この SKU の名前。 | 'Basic' 'Premium' 'Standard' (必須) |
層 | この特定の SKU の課金レベル。 | 'Basic' 'Premium' 'Standard' |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UserAssignedIdentity
名前 | 形容 | 価値 |
---|
UserAssignedIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
userAssignedIdentity | 暗号化用に選択されたユーザー ID の ARM ID | 糸 |