az servicebus namespace
Servicebus namespace.
コマンド
az servicebus namespace create
Service Bus 名前空間を作成します。
az servicebus namespace create --name
--resource-group
[--alternate-name]
[--capacity {1, 16, 2, 4, 8}]
[--disable-local-auth {false, true}]
[--encryption-config]
[--geo-data-replication-config --replica-config]
[--infra-encryption {false, true}]
[--location]
[--max-lag --max-replication-lag-duration-in-seconds]
[--mi-system-assigned {false, true}]
[--mi-user-assigned]
[--min-tls --minimum-tls-version {1.0, 1.1, 1.2}]
[--no-wait]
[--premium-messaging-partitions --premium-partitions]
[--public-network --public-network-access {Disabled, Enabled}]
[--sku {Basic, Premium, Standard}]
[--tags]
[--zone-redundant {false, true}]
例
Service Bus 名前空間を作成します。
az servicebus namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard
ID と暗号化が有効になっている新しい名前空間を作成します。
az servicebus namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
必須のパラメーター
名前空間の名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
別名と名前空間名が同じ場合に指定される代替名。
メッセージユニットの数。 このプロパティは、Premium SKU の名前空間にのみ適用されます。
プロパティ | 値 |
---|---|
指定可能な値: | 1, 16, 2, 4, 8 |
Service Bus で SAS 認証が有効または無効になっているかどうかを示すブール値。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
KeyVaultProperties オブジェクトの一覧。
名前空間のレプリカが保持されているリージョンの一覧オブジェクトです。
Infrastructure Encryption (Double Encryption) かどうかを示すブール値。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
Location. 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
プライマリ レプリカからセカンダリ レプリカのクォーラムへのデータ レプリケーション操作に許容される最大ラグ。
システム割り当て ID を有効にします。
プロパティ | 値 |
---|---|
Parameter group: | Managed Identity Arguments |
指定可能な値: | false, true |
ユーザー割り当て ID の一覧。
プロパティ | 値 |
---|---|
Parameter group: | Managed Identity Arguments |
サポートするクラスターの最小 TLS バージョン (例: 1.2)。
プロパティ | 値 |
---|---|
指定可能な値: | 1.0, 1.1, 1.2 |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
規定値: | False |
Service Bus 名前空間のパーティションの数。 このプロパティは、Premium SKU 名前空間にのみ適用されます。 既定値は 1、使用可能な値は 1、2、4 です。
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。
プロパティ | 値 |
---|---|
指定可能な値: | Disabled, Enabled |
Namespace SKU.
プロパティ | 値 |
---|---|
規定値: | Standard |
指定可能な値: | Basic, Premium, Standard |
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
このプロパティを有効にすると、サポートされている可用性ゾーンのリージョンに ServiceBus ゾーン冗長名前空間が作成されます。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace delete
既存の名前空間を削除します。 この操作により、名前空間に関連付けられているすべてのリソースも削除されます。
az servicebus namespace delete [--ids]
[--name --namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
例
Service Bus 名前空間を削除します。
az servicebus namespace delete --resource-group myresourcegroup --name mynamespace
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
名前空間名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
resourceGroup 名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace exists
名前空間名の指定の可用性を確認します。
az servicebus namespace exists --name
必須のパラメーター
名前空間名の可用性を確認する名前と名前空間名には、文字、数字、ハイフンのみを含めることができます。 名前空間は文字で始まる必要があり、末尾は文字または数字である必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Parameters Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace failover
GeoDR Failover.
az servicebus namespace failover [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--primary-location]
[--resource-group]
[--subscription]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Force が false の場合は、データ損失がないことを確認した後、グレースフル フェールオーバーが試行されます。 Force フラグが true に設定されている場合、データ損失の可能性がある強制フェールオーバーが試行されます。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
名前空間名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
フェールオーバー後の新しいプライマリ ロケーションのクエリ パラメーター。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace list
リソース グループ & リソース グループに関係なく、サブスクリプション内で使用可能なすべての名前空間を一覧表示します。
az servicebus namespace list [--resource-group]
例
リソース グループの Service Bus 名前空間を一覧表示します。
az servicebus namespace list --resource-group myresourcegroup
サブスクリプションの Service Bus 名前空間を一覧表示する
az servicebus namespace list
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace show
指定した名前空間の説明を取得します。
az servicebus namespace show [--ids]
[--name --namespace-name]
[--resource-group]
[--subscription]
例
には、名前空間の詳細が表示されます。
az servicebus namespace show --resource-group myresourcegroup --name mynamespace
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
名前空間名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
resourceGroup 名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace update
サービス名前空間を更新します。 作成されると、この名前空間のリソース マニフェストは変更できません。 この操作はべき等です。
az servicebus namespace update [--add]
[--alternate-name]
[--capacity]
[--connections --private-endpoint-connections]
[--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
[--encryption]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--locations]
[--max-lag --max-replication-lag-duration-in-seconds]
[--minimum-tls-version {1.0, 1.1, 1.2}]
[--name --namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--premium-messaging-partitions --premium-partitions]
[--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
[--remove]
[--resource-group]
[--set]
[--sku {Basic, Premium, Standard}]
[--subscription]
[--tags]
[--tier {Basic, Premium, Standard}]
例
Service Bus 名前空間を更新します
az servicebus namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value
az servicebus namespace update --name mynamespace --resource-group myresourcegroup --sku Basic
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
名前空間の代替名。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
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 です。
プロパティ | 値 |
---|---|
Parameter group: | Sku Arguments |
プライベート エンドポイント接続の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
このプロパティは、Service Bus 名前空間の SAS 認証を無効にします。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
BYOK 暗号化の説明のプロパティは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
BYOK ID の説明のプロパティは、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Parameters Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
名前空間のレプリカが保持されているリージョンの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | GeoDataReplication Arguments |
プライマリ レプリカからセカンダリ レプリカのクォーラムへのデータ レプリケーション操作に許容される最大ラグ。 ラグが構成された量を超えると、プライマリ レプリカに対する操作は失敗します。 使用できる値は 0 と 5 分から 1 日です。
プロパティ | 値 |
---|---|
Parameter group: | GeoDataReplication Arguments |
サポートするクラスターの最小 TLS バージョン (例: '1.2')。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 1.0, 1.1, 1.2 |
名前空間名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
Service Bus 名前空間のパーティションの数。 このプロパティは、Premium SKU 名前空間にのみ適用されます。 既定値は 1、使用可能な値は 1、2、4 です。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | Disabled, Enabled, SecuredByPerimeter |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
この SKU の名前。
プロパティ | 値 |
---|---|
Parameter group: | Sku Arguments |
指定可能な値: | Basic, Premium, Standard |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース タグでは、短縮構文、json-file、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Parameters Arguments |
この特定の SKU の課金レベル。
プロパティ | 値 |
---|---|
Parameter group: | Sku Arguments |
指定可能な値: | Basic, Premium, Standard |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az servicebus namespace wait
条件が満たされるまで CLI を待機状態にします。
az servicebus namespace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --namespace-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
削除されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
リソースが存在するまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 30 |
名前空間名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
最大待機時間 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |