az resiliency drill

Note

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

Manage Drill.

Commands

Name Description Type Status
az resiliency drill add-or-update-resource

This enables the user to include, exclude or update resources from their Drill.

Extension GA
az resiliency drill create

Create a Drill.

Extension GA
az resiliency drill delete

Delete a Drill.

Extension GA
az resiliency drill drill-resource

Manage Drill Resource.

Extension GA
az resiliency drill drill-resource list

List DrillResource resources by Drill.

Extension GA
az resiliency drill drill-resource show

Get a DrillResource.

Extension GA
az resiliency drill drill-run

Manage Drill Run.

Extension GA
az resiliency drill drill-run add-note

This enables the user to add notes on this Drill Run.

Extension GA
az resiliency drill drill-run drill-run-resource

Manage Drill Run Resource.

Extension GA
az resiliency drill drill-run drill-run-resource list

List DrillRunResource resources by DrillRun.

Extension GA
az resiliency drill drill-run drill-run-resource show

Get a DrillRunResource.

Extension GA
az resiliency drill drill-run fail-over

This initiates a new Failover operation on this Drill Run.

Extension GA
az resiliency drill drill-run generate-report

This generates, or regenerates, the report for this Drill Run. The action is idempotent and is safe to call at any time: a call that arrives while a generation is already running joins it, and a call made after a failed attempt retries it. A report that has been finalized is never regenerated.

Extension GA
az resiliency drill drill-run list

List DrillRun resources by Drill.

Extension GA
az resiliency drill drill-run list-report-download-url

This returns a short-lived, read-only URL to download the report for this Drill Run. The URL expires at the returned expiryTimestamp and grants access to that single report only.

Extension GA
az resiliency drill drill-run mark-as-complete

This enables the user to mark this stage as complete, disabling further retries on it.

Extension GA
az resiliency drill drill-run reprotect

This initiates a new Reprotect operation on this Drill Run.

Extension GA
az resiliency drill drill-run resume

This unblocks a Failover workflow that is paused after the Fault stage, to proceed to the Failover stage.

Extension GA
az resiliency drill drill-run show

Get a DrillRun.

Extension GA
az resiliency drill end

This ends the currently running instance of the Drill.

Extension GA
az resiliency drill identity

Manage Identity.

Extension GA
az resiliency drill identity assign

Assign the user or system managed identities.

Extension GA
az resiliency drill identity remove

Remove the user or system managed identities.

Extension GA
az resiliency drill identity show

Show the details of managed identities.

Extension GA
az resiliency drill identity wait

Place the CLI in a waiting state until a condition is met.

Extension GA
az resiliency drill list

List Drill resources by tenant.

Extension GA
az resiliency drill resync-readiness-check

This triggers detection of any drifts from the desired state of Resources and RBAC.

Extension GA
az resiliency drill show

Get a Drill.

Extension GA
az resiliency drill start

This starts a new running instance of the Drill.

Extension GA
az resiliency drill update

Update a Drill.

Extension GA
az resiliency drill validate-for-execution

This returns eligible resource to be faulted or failed over.

Extension GA
az resiliency drill wait

Place the CLI in a waiting state until a condition is met.

Extension GA

az resiliency drill add-or-update-resource

This enables the user to include, exclude or update resources from their Drill.

az resiliency drill add-or-update-resource --drill-name
                                           --fault-duration-in-min
                                           --operation-id
                                           --service-group-name
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--force-inclusion-and-update --force-update {Disable, Enable}]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-lists]

Examples

Add a virtual machine to a drill

az resiliency drill add-or-update-resource --service-group-name sampleServiceGroupName --drill-name drill1 --operation-id 3f1c2a4b-5d6e-4f70-8a9b-0c1d2e3f4a5b --fault-duration-in-min 10 --resource-lists "{include-resources:[{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1}]}"

Set the default fault of a resource in a drill

az resiliency drill add-or-update-resource --service-group-name sampleServiceGroupName --drill-name drill1 --operation-id 3f1c2a4b-5d6e-4f70-8a9b-0c1d2e3f4a5b --fault-duration-in-min 10 --resource-lists "{update-resources:[{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1,fault-properties:{default-fault:{fault-name:VMShutdown,fault-urn:'urn:csci:microsoft:virtualMachine:shutdown/1.0',target-resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1}}}]}"

Required Parameters

--drill-name

The name of the Drill.

--fault-duration-in-min

Duration of faults.

Property Value
Parameter group: Body Arguments
--operation-id

A GUID that represents the Long Running OperationId.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--force-inclusion-and-update --force-update

Whether to allow inclusion and update despite attention reasons.

Property Value
Parameter group: Body Arguments
Accepted values: Disable, Enable
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-lists

Add, Update, Delete resource lists Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
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 resiliency drill create

Create a Drill.

az resiliency drill create --drill-name
                           --service-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--chaos-properties --chaos-resource-properties]
                           [--drill-asset-properties]
                           [--goal-assignment-properties --goal-properties]
                           [--health-model-monitoring-properties --health-properties]
                           [--mi-system-assigned --system-assigned]
                           [--mi-user-assigned --user-assigned]
                           [--monitoring-properties]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--rbac-setup-mode {AutomatedBuiltinRoles, AutomatedCustomRole, Manual}]
                           [--recovery-plan-properties --recovery-properties]
                           [--regional]
                           [--sli-monitoring-properties --sli-properties]
                           [--zonal]

Examples

Drills_Create_MaximumSet

az resiliency drill create --service-group-name sampleServiceGroupName --drill-name drill1 --rbac-setup-mode AutomatedCustomRole --recovery-plan-properties "{identity:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1}}" --monitoring-properties "{identity:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1}}" --drill-asset-properties "{subscription:4e88bed3-114f-443d-9975-28f64122ec5e,region:eastus,resource-group:customDrillResourceGroup}" --chaos-resource-properties "{identity:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1},chaos-resource-identity-for-faults:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1}}" --health-model-monitoring-properties "{identity:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1},health-model-id:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourceGroups/contoso-health/providers/Microsoft.CloudHealth/healthmodels/contoso-payments-hm}" --sli-monitoring-properties "{identity:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1},slis:[{sli-id:/providers/Microsoft.Management/serviceGroups/sampleServiceGroupName/providers/Microsoft.Monitor/slis/checkout-availability,type:Availability},{sli-id:/providers/Microsoft.Management/serviceGroups/sampleServiceGroupName/providers/Microsoft.Monitor/slis/checkout-latency,type:Latency}]}" --goal-assignment-properties "{identity:{type:UserAssigned,userAssignedIdentity:/subscriptions/4e88bed3-114f-443d-9975-28f64122ec5e/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1}}"

Required Parameters

--drill-name

The name of the Drill.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--chaos-properties --chaos-resource-properties

Chaos Resource properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--drill-asset-properties

Properties for internal resources that are created for the Drill. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--goal-assignment-properties --goal-properties

Goal Assignment properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--health-model-monitoring-properties --health-properties

Azure Health Model monitoring properties of the Drill. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--mi-system-assigned --system-assigned

Set the system managed identity.

Property Value
Parameter group: Identity Arguments
--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity Arguments
--monitoring-properties

Monitoring properties of the Drill. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--rbac-setup-mode

RBAC setup mode.

Property Value
Parameter group: Properties Arguments
Accepted values: AutomatedBuiltinRoles, AutomatedCustomRole, Manual
--recovery-plan-properties --recovery-properties

ROPlan properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--regional

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--sli-monitoring-properties --sli-properties

SLI monitoring properties of the Drill. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--zonal

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
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 resiliency drill delete

Delete a Drill.

az resiliency drill delete --drill-name
                           --service-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--yes]

Examples

Drills_Delete_MaximumSet

az resiliency drill delete --service-group-name sampleServiceGroupName --drill-name drill1

Required Parameters

--drill-name

The name of the Drill.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 resiliency drill end

This ends the currently running instance of the Drill.

az resiliency drill end --attestation {Failed, Success}
                        --attestation-notes
                        --drill-name
                        --operation-id
                        --service-group-name
                        [--acquire-policy-token]
                        [--change-reference]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Drills_End_MaximumSet

az resiliency drill end --service-group-name sampleServiceGroupName --operation-id qmn --drill-name drill1 --attestation Success --attestation-notes ycnqvrgduotohgycsapckhixwqwgp

Required Parameters

--attestation

Attestation Status.

Property Value
Parameter group: Body Arguments
Accepted values: Failed, Success
--attestation-notes

Notes.

Property Value
Parameter group: Body Arguments
--drill-name

The name of the Drill.

--operation-id

A GUID that represents the Long Running OperationId.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 resiliency drill list

List Drill resources by tenant.

az resiliency drill list --service-group-name
                         [--max-items]
                         [--next-token]
                         [--skip-token]
                         [--top]

Examples

Drills_List_MaximumSet

az resiliency drill list --service-group-name sampleServiceGroupName --skip-token xntbyoswztnmvitj --top 69

Required Parameters

--service-group-name

The name of the service group.

Optional Parameters

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

--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
--skip-token

Skip over when retrieving results.

--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 resiliency drill resync-readiness-check

This triggers detection of any drifts from the desired state of Resources and RBAC.

az resiliency drill resync-readiness-check --drill-name
                                           --operation-id
                                           --service-group-name
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Drills_ResyncReadinessCheck_MaximumSet

az resiliency drill resync-readiness-check --service-group-name sampleServiceGroupName --operation-id qmn --drill-name drill1

Required Parameters

--drill-name

The name of the Drill.

--operation-id

A GUID that represents the Long Running OperationId.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 resiliency drill show

Get a Drill.

az resiliency drill show --drill-name
                         --service-group-name

Examples

Drills_Get_MaximumSet

az resiliency drill show --service-group-name sampleServiceGroupName --drill-name drill1

Required Parameters

--drill-name

The name of the Drill.

--service-group-name

The name of the service group.

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 resiliency drill start

This starts a new running instance of the Drill.

az resiliency drill start --drill-name
                          --mode {Failover}
                          --operation-id
                          --service-group-name
                          [--acquire-policy-token]
                          [--change-reference]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Drills_Start_MaximumSet

az resiliency drill start --service-group-name sampleServiceGroupName --operation-id qmn --drill-name drill1 --mode Failover

Required Parameters

--drill-name

The name of the Drill.

--mode

Mode of starting the Drill.

Property Value
Parameter group: Body Arguments
Accepted values: Failover
--operation-id

A GUID that represents the Long Running OperationId.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 resiliency drill update

Update a Drill.

az resiliency drill update --drill-name
                           --service-group-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--chaos-properties --chaos-resource-properties]
                           [--drill-asset-properties]
                           [--goal-assignment-properties --goal-properties]
                           [--health-model-monitoring-properties --health-properties]
                           [--monitoring-properties]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--rbac-setup-mode {AutomatedBuiltinRoles, AutomatedCustomRole, Manual}]
                           [--recovery-plan-properties --recovery-properties]
                           [--sli-monitoring-properties --sli-properties]

Examples

Update the RBAC setup mode of a drill

az resiliency drill update --service-group-name sampleServiceGroupName --drill-name drill1 --rbac-setup-mode Manual

Required Parameters

--drill-name

The name of the Drill.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--chaos-properties --chaos-resource-properties

Chaos Resource properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--drill-asset-properties

Properties for internal resources that are created for the Drill. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--goal-assignment-properties --goal-properties

Goal Assignment properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--health-model-monitoring-properties --health-properties

Azure Health Model monitoring properties of the Drill. Send null to clear the selection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--monitoring-properties

Monitoring properties of the Drill. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--rbac-setup-mode

RBAC setup mode.

Property Value
Parameter group: Properties Arguments
Accepted values: AutomatedBuiltinRoles, AutomatedCustomRole, Manual
--recovery-plan-properties --recovery-properties

Recovery Plan properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--sli-monitoring-properties --sli-properties

SLI monitoring properties of the Drill. Send null to clear the selection; the submitted slis array is the new desired state. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
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 resiliency drill validate-for-execution

This returns eligible resource to be faulted or failed over.

az resiliency drill validate-for-execution --drill-name
                                           --operation-id
                                           --service-group-name
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--execution-properties --validate-for-execution-properties]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Drills_ValidateForExecution_MaximumSet

az resiliency drill validate-for-execution --service-group-name sampleServiceGroupName --operation-id qmn --drill-name drill1 --validate-for-execution-properties "{source-locations:[eastus2-az1]}"

Required Parameters

--drill-name

The name of the Drill.

--operation-id

A GUID that represents the Long Running OperationId.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--execution-properties --validate-for-execution-properties

Additional properties for Validate for execute. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 resiliency drill wait

Place the CLI in a waiting state until a condition is met.

az resiliency drill wait --drill-name
                         --service-group-name
                         [--acquire-policy-token]
                         [--change-reference]
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--interval]
                         [--timeout]
                         [--updated]

Required Parameters

--drill-name

The name of the Drill.

--service-group-name

The name of the service group.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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