az acr webhook

Azure Container Registries の Webhook を管理します。

コマンド

名前	説明	型	状態
az acr webhook create	Azure コンテナー レジストリ用の Webhook を作成します。	コア	GA
az acr webhook delete	Azure コンテナー レジストリから Webhook を削除します。	コア	GA
az acr webhook get-config	Webhook のサービス URI とカスタム ヘッダーを取得します。	コア	GA
az acr webhook list	Azure コンテナー レジストリのすべての Webhook を一覧表示します。	コア	GA
az acr webhook list-events	Webhook の最近のイベントを一覧表示します。	コア	GA
az acr webhook ping	Webhook の ping イベントをトリガーします。	コア	GA
az acr webhook show	Webhook の詳細を取得します	コア	GA
az acr webhook update	Webhook を更新します。	コア	GA

az acr webhook create

Azure コンテナー レジストリ用の Webhook を作成します。

az acr webhook create --actions {chart_delete, chart_push, delete, push, quarantine}
                      --name
                      --registry
                      --uri
                      [--headers]
                      [--location]
                      [--resource-group]
                      [--scope]
                      [--status {disabled, enabled}]
                      [--tags]

例

Docker プッシュイベントと削除イベントをサービス URI に配信する Azure Container Registry 用の Webhook を作成します。

az acr webhook create -n mywebhook -r myregistry --uri http://myservice.com --actions push delete

基本認証ヘッダーを使用してサービス URI に Docker プッシュ イベントを配信する Azure Container Registry 用の Webhook を作成します。

az acr webhook create -n mywebhook -r myregistry --uri http://myservice.com --actions push --headers "Authorization=Basic 000000"

サービス URI に対して Helm Chart プッシュおよび削除イベントを配信する Azure Container Registry 用の Webhook を作成します。

az acr webhook create -n mywebhook -r myregistry --uri http://myservice.com --actions chart_push chart_delete

必須のパラメーター

--actions

Webhook が通知を投稿するようにトリガーするアクションのスペース区切りの一覧。

指定可能な値: chart_delete, chart_push, delete, push, quarantine

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

--uri

通知を投稿する Webhook のサービス URI。

省略可能のパラメーター

--headers

webhook 通知に追加される 'key[=value]' 形式のスペース区切りのカスタム ヘッダー。 既存のヘッダーをクリアするには、"" を使用します。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--scope

イベントをトリガーできるリポジトリのスコープ。 たとえば、'foo:*' はリポジトリ 'foo' のすべてのタグのイベントを意味します。 'foo:bar' は 'foo:bar' のみのイベントを意味します。 'foo' は 'foo:latest' に相当します。 空は、すべてのリポジトリのイベントを意味します。

--status

Webhook が有効かどうかを示します。

指定可能な値: disabled, enabled

規定値: enabled

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook delete

Azure コンテナー レジストリから Webhook を削除します。

az acr webhook delete --name
                      --registry
                      [--resource-group]

例

Azure コンテナー レジストリから Webhook を削除します。

az acr webhook delete -n mywebhook -r myregistry

必須のパラメーター

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook get-config

Webhook のサービス URI とカスタム ヘッダーを取得します。

az acr webhook get-config --name
                          --registry
                          [--resource-group]

例

Webhook の構成情報を取得します。

az acr webhook get-config -n mywebhook -r myregistry

必須のパラメーター

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook list

Azure コンテナー レジストリのすべての Webhook を一覧表示します。

az acr webhook list --registry
                    [--resource-group]

例

Webhook を一覧表示し、結果をテーブルに表示します。

az acr webhook list -r myregistry -o table

必須のパラメーター

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook list-events

Webhook の最近のイベントを一覧表示します。

az acr webhook list-events --name
                           --registry
                           [--resource-group]

例

Webhook の最近のイベントを一覧表示します。

az acr webhook list-events -n mywebhook -r myregistry

必須のパラメーター

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook ping

Webhook の ping イベントをトリガーします。

az acr webhook ping --name
                    --registry
                    [--resource-group]

例

Webhook の ping イベントをトリガーします。

az acr webhook ping -n mywebhook -r myregistry

必須のパラメーター

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook show

Webhook の詳細を取得します

az acr webhook show --name
                    --registry
                    [--resource-group]

例

Webhook の詳細を取得します

az acr webhook show -n mywebhook -r myregistry

必須のパラメーター

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az acr webhook update

Webhook を更新します。

az acr webhook update --name
                      --registry
                      [--actions {chart_delete, chart_push, delete, push, quarantine}]
                      [--add]
                      [--force-string]
                      [--headers]
                      [--remove]
                      [--resource-group]
                      [--scope]
                      [--set]
                      [--status {disabled, enabled}]
                      [--tags]
                      [--uri]

例

Webhook のヘッダーを更新します。

az acr webhook update -n mywebhook -r myregistry --headers "Authorization=Basic 000000"

Webhook のサービス URI とアクションを更新します。

az acr webhook update -n mywebhook -r myregistry --uri http://myservice.com --actions push delete

Webhook を無効にします。

az acr webhook update -n mywebhook -r myregistry --status disabled

必須のパラメーター

--name -n

Webhook の名前。

--registry -r

コンテナー レジストリの名前。 小文字で指定する必要があります。 を使用して、既定のレジストリ名を az configure --defaults acr=<registry name>構成できます。

省略可能のパラメーター

--actions

Webhook が通知を投稿するようにトリガーするアクションのスペース区切りの一覧。

指定可能な値: chart_delete, chart_push, delete, push, quarantine

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

規定値: []

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False

--headers

webhook 通知に追加される 'key[=value]' 形式のスペース区切りのカスタム ヘッダー。 既存のヘッダーをクリアするには、"" を使用します。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

規定値: []

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--scope

イベントをトリガーできるリポジトリのスコープ。 たとえば、'foo:*' はリポジトリ 'foo' のすべてのタグのイベントを意味します。 'foo:bar' は 'foo:bar' のみのイベントを意味します。 'foo' は 'foo:latest' に相当します。 空は、すべてのリポジトリのイベントを意味します。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

規定値: []

--status

Webhook が有効かどうかを示します。

指定可能な値: disabled, enabled

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--uri

通知を投稿する Webhook のサービス URI。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。