Share via

az site-recovery alert-setting

  • Reference

Note

This reference is part of the site-recovery extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az site-recovery alert-setting command. Learn more about extensions.

Manage Alert Setting.

Commands

Name Description Type Status
az site-recovery alert-setting create

Create an email notification(alert) configuration.

 Extension GA
az site-recovery alert-setting list

List the list of email notification(alert) configurations for the vault.

 Extension GA
az site-recovery alert-setting show

Get the details of the specified email notification(alert) configuration.

 Extension GA
az site-recovery alert-setting update

Update an email notification(alert) configuration.

 Extension GA

az site-recovery alert-setting create

Create an email notification(alert) configuration.

az site-recovery alert-setting create --alert-setting-name
                                      --resource-group
                                      --vault-name
                                      [--custom-email-addresses]
                                      [--locale]
                                      [--send-to-owners]

Examples

alert-setting create

az site-recovery alert-setting create -n defaultAlertSetting -g rg --vault-name vault_name --custom-email-addresses email@address.com --locale en_US --send-to-owners Send

Required Parameters

--alert-setting-name --name -n

The name of the email notification(alert) configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vault-name

The name of the recovery services vault.

Optional Parameters

--custom-email-addresses

The custom email address for sending emails. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--locale

The locale for the email notification.

--send-to-owners

A value indicating whether to send email to subscription administrator. Allowed values: "Send", "DoNotSend".

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az site-recovery alert-setting list

List the list of email notification(alert) configurations for the vault.

az site-recovery alert-setting list --resource-group
                                    --vault-name
                                    [--max-items]
                                    [--next-token]

Examples

alert-setting list

az site-recovery alert-setting list -g rg --vault-name vault_name

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vault-name

The name of the recovery services vault.

Optional Parameters

--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.

--next-token

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az site-recovery alert-setting show

Get the details of the specified email notification(alert) configuration.

az site-recovery alert-setting show [--alert-setting-name]
                                    [--ids]
                                    [--resource-group]
                                    [--subscription]
                                    [--vault-name]

Examples

alert-setting show

az site-recovery alert-setting show -n defaultAlertSetting -g rg --vault-name vault_name

Optional Parameters

--alert-setting-name --name -n

The name of the email notification configuration.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--vault-name

The name of the recovery services vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az site-recovery alert-setting update

Update an email notification(alert) configuration.

az site-recovery alert-setting update [--add]
                                      [--alert-setting-name]
                                      [--custom-email-addresses]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--locale]
                                      [--remove]
                                      [--resource-group]
                                      [--send-to-owners]
                                      [--set]
                                      [--subscription]
                                      [--vault-name]

Examples

alert-setting update

az site-recovery alert-setting update -n defaultAlertSetting -g rg --vault-name vault_name --custom-email-addresses email2@address.com --locale fr_FR --send-to-owners DoNotSend

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--alert-setting-name --name -n

The name of the email notification configuration.

--custom-email-addresses

The custom email address for sending emails. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--locale

The locale for the email notification.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--send-to-owners

A value indicating whether to send email to subscription administrator. Allowed values: "Send", "DoNotSend".

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

--vault-name

The name of the recovery services vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.