Share via

az acat report webhook

Note

This reference is part of the acat extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az acat report webhook command. Learn more about extensions.

Manage ACAT report webhooks.

Commands

Name Description Type Status
az acat report webhook create

Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook.

 Extension GA
az acat report webhook delete

Delete an AppComplianceAutomation webhook.

 Extension GA
az acat report webhook list

List the AppComplianceAutomation webhook list.

 Extension GA
az acat report webhook show

Get the AppComplianceAutomation webhook and its properties.

 Extension GA
az acat report webhook update

Update an exiting AppComplianceAutomation webhook.

 Extension GA

az acat report webhook create

Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook.

az acat report webhook create --payload-url
                              --report-name
                              --webhook-name
                              [--content-type-hidden {application/json}]
                              [--disable {false, true}]
                              [--enable-ssl {false, true}]
                              [--events]
                              [--secret]
                              [--trigger-mode {all, customize}]

Required Parameters

--payload-url

Webhook payload url.

Property Value
Parameter group: Properties Arguments
--report-name

Report Name.

--webhook-name

Webhook Name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--content-type-hidden

Content type.

Property Value
Parameter group: Properties Arguments
Default value: application/json
Accepted values: application/json
--disable

Webhook status.

Property Value
Parameter group: Properties Arguments
Default value: Enalbed
Accepted values: false, true
--enable-ssl

Whether to enable ssl verification.

Property Value
Parameter group: Properties Arguments
Default value: true
Accepted values: false, true
--events

Under which event notification should be sent. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Default value: []
--secret

Webhook secret token. If not set, this field value is null; otherwise, please set a string value.

Property Value
Parameter group: Properties Arguments
--trigger-mode

Whether to send notification under any event.

Property Value
Parameter group: Properties Arguments
Default value: true
Accepted values: all, customize
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acat report webhook delete

Delete an AppComplianceAutomation webhook.

az acat report webhook delete --report-name
                              --webhook-name
                              [--yes]

Required Parameters

--report-name

Report Name.

--webhook-name

Webhook Name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acat report webhook list

List the AppComplianceAutomation webhook list.

az acat report webhook list --report-name
                            [--filter]
                            [--max-items]
                            [--next-token]
                            [--offer-guid]
                            [--orderby]
                            [--select]
                            [--skip-token]
                            [--tenant]
                            [--top]

Required Parameters

--report-name

Report Name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

The filter to apply on the operation.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--offer-guid

The offerGuid which mapping to the reports.

--orderby

OData order by query option.

--select

OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.

--skip-token

Skip over when retrieving results.

--tenant

The tenant id of the report creator.

--top

Number of elements to return when retrieving results.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acat report webhook show

Get the AppComplianceAutomation webhook and its properties.

az acat report webhook show --report-name
                            --webhook-name

Required Parameters

--report-name

Report Name.

--webhook-name

Webhook Name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acat report webhook update

Update an exiting AppComplianceAutomation webhook.

az acat report webhook update --report-name
                              --webhook-name
                              [--content-type {application/json}]
                              [--disable {false, true}]
                              [--enable-ssl {false, true}]
                              [--events-hidden]
                              [--payload-url-hidden]
                              [--secret]
                              [--trigger-mode {all, customize}]

Required Parameters

--report-name

Report Name.

--webhook-name

Webhook Name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--content-type

Content type.

Property Value
Parameter group: Properties Arguments
Accepted values: application/json
--disable

Webhook status.

Property Value
Parameter group: Properties Arguments
Accepted values: false, true
--enable-ssl

Whether to enable ssl verification.

Property Value
Parameter group: Properties Arguments
Accepted values: false, true
--events-hidden

Under which event notification should be sent. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--payload-url-hidden

Webhook payload url.

Property Value
Parameter group: Properties Arguments
--secret

Webhook secret token. If not set, this field value is null; otherwise, please set a string value.

Property Value
Parameter group: Properties Arguments
--trigger-mode

Whether to send notification under any event.

Property Value
Parameter group: Properties Arguments
Accepted values: all, customize
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False