az iot ops secretsync secret
注
このリファレンスは、Azure CLI (バージョン 2.70.0 以降) の azure-iot-ops 拡張機能の一部です。 拡張機能は、 az iot ops secretsync secret コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
SecretSync リソース内の個々のシークレットを管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az iot ops secretsync secret list |
SecretSync リソース内のシークレットを一覧表示します。 |
Extension | GA |
| az iot ops secretsync secret remove |
SecretSync リソースから特定のシークレットを削除します。 すべてのシークレットが削除されると、SecretSync リソース自体が自動的に削除されます。 |
Extension | GA |
| az iot ops secretsync secret set |
SecretSync リソースに AKV シークレット マッピングを設定します。 |
Extension | GA |
az iot ops secretsync secret list
SecretSync リソース内のシークレットを一覧表示します。
az iot ops secretsync secret list --instance
--resource-group
--secret-sync-name
例
特定の SecretSync リソース内のシークレットを一覧表示します。
az iot ops secretsync secret list --instance myInstance -g myRG --secret-sync-name my-certs
必須のパラメーター
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
SecretSync リソースの名前。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot ops secretsync secret remove
SecretSync リソースから特定のシークレットを削除します。 すべてのシークレットが削除されると、SecretSync リソース自体が自動的に削除されます。
SecretSync の objectSecretMapping からシークレット エントリを削除します。 これが SecretSync の最後のシークレットである場合、ARM API ではシークレット マッピングが 0 個の SecretSync が許可されないため、SecretSync リソース全体が削除されます。
共有 SPC からシークレットを削除する前に、カスタムの場所のすべての SecretSyncs で参照カウント チェックが実行されます。 SPC エントリは、他の SecretSync がまだ同じ AKV シークレットを参照していない場合にのみ削除されます。 これにより、共有 SPC の他のコンシューマーの中断が防止されます。
このコマンドは、Azure Key Vaultからシークレットを削除しません。
az iot ops secretsync secret remove --instance
--resource-group
--secret-name
--secret-sync-name
[--acquire-policy-token]
[--change-reference]
[--yes {false, true}]
例
SecretSync からシークレットを削除します。
az iot ops secretsync secret remove --instance myInstance -g myRG --secret-sync-name my-certs --secret-name my-tls-cert
確認プロンプトなしでシークレットを削除します。
az iot ops secretsync secret remove --instance myInstance -g myRG --secret-sync-name my-certs --secret-name my-tls-cert -y
必須のパラメーター
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
SecretSync から削除する AKV シークレット名 (sourcePath 値)。
SecretSync リソースの名前。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot ops secretsync secret set
SecretSync リソースに AKV シークレット マッピングを設定します。
インスタンスの既定のシークレット プロバイダー クラス (SPC) を解決し、各 AKV シークレットが存在することを確認し、各シークレットを SPC のオブジェクト リストに追加して、名前付き SecretSync リソースにエントリを作成またはマージします。
SecretSync が既に存在する場合は、新しいシークレット エントリがマージされます。 同じ AKV シークレット名を持つ既存のエントリのターゲット キーが更新されます。
--secret-sync-name 値は K8s シークレット名になります。 コンシューマーは、デバイス エンドポイントの <secret-sync-name>/<target-key> を介して参照するか、データフロー エンドポイントの場合は単に <secret-sync-name> します。
az iot ops secretsync secret set --instance
--resource-group
--secret-map
--secret-sync-name
[--acquire-policy-token]
[--change-reference]
例
デバイス エンドポイント x509 証明書認証用の SecretSync を作成します。
az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name my-certs --secret-map my-tls-cert=certificate --secret-map my-tls-key=privateKey
既存の SecretSync (べき等マージ) に別のシークレットを追加します。
az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name my-certs --secret-map my-intermediate-cert=intermediateCerts
SASL ベースのデータフロー エンドポイント用の SecretSync を作成します。
az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name eventhub-sasl --secret-map my-eh-user=username --secret-map my-eh-pass=password
必須のパラメーター
IoT Operations インスタンス名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
<akv-secret-name>=<target-key>形式の AKV シークレット マッピング。 再現。 AKV シークレットが存在する必要があります。
SecretSync ARM リソースの名前と、結果の K8s シークレット。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |