az durabletask scheduler transparent-data-encryption

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Transparent Data Encryption.

Commands

Name	Description	Type	Status
az durabletask scheduler transparent-data-encryption create	Create a Transparent Data Encryption.	Extension	Preview
az durabletask scheduler transparent-data-encryption delete	Delete a Transparent Data Encryption.	Extension	Preview
az durabletask scheduler transparent-data-encryption show	Get a Transparent Data Encryption.	Extension	Preview
az durabletask scheduler transparent-data-encryption update	Update a Transparent Data Encryption.	Extension	Preview
az durabletask scheduler transparent-data-encryption wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az durabletask scheduler transparent-data-encryption create

Preview

Command group 'az durabletask scheduler transparent-data-encryption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Transparent Data Encryption.

az durabletask scheduler transparent-data-encryption create --resource-group
                                                            --scheduler-name
                                                            [--acquire-policy-token]
                                                            [--change-reference]
                                                            [--key-source {CustomerManaged, MicrosoftManaged}]
                                                            [--key-vault-key-uri]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Configure Transparent Data Encryption

az durabletask scheduler transparent-data-encryption create --resource-group rgdurabletask --scheduler-name testscheduler --key-source CustomerManaged --key-vault-key-uri https://myencryption.vault.azure.net/keys/encryptionKey

Required Parameters

--resource-group -g

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

--scheduler-name

The name of the Scheduler.

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

--key-source

The key source for the transparent data encryption.

Property	Value
Parameter group:	Properties Arguments
Default value:	CustomerManaged
Accepted values:	CustomerManaged, MicrosoftManaged

--key-vault-key-uri

The URI of the key in Key Vault to be used for transparent data encryption.

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

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 durabletask scheduler transparent-data-encryption delete

Preview

Command group 'az durabletask scheduler transparent-data-encryption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Transparent Data Encryption.

az durabletask scheduler transparent-data-encryption delete [--acquire-policy-token]
                                                            [--change-reference]
                                                            [--ids]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--resource-group]
                                                            [--scheduler-name]
                                                            [--subscription]
                                                            [--yes]

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

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

Property	Value
Parameter group:	Resource Id 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

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--scheduler-name

The name of the Scheduler.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

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

Property	Value
Default value:	False

az durabletask scheduler transparent-data-encryption show

Preview

Command group 'az durabletask scheduler transparent-data-encryption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Transparent Data Encryption.

az durabletask scheduler transparent-data-encryption show [--ids]
                                                          [--resource-group]
                                                          [--scheduler-name]
                                                          [--subscription]

Optional Parameters

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--scheduler-name

The name of the Scheduler.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

az durabletask scheduler transparent-data-encryption update

Preview

Command group 'az durabletask scheduler transparent-data-encryption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Transparent Data Encryption.

az durabletask scheduler transparent-data-encryption update [--acquire-policy-token]
                                                            [--add]
                                                            [--change-reference]
                                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--ids]
                                                            [--key-source {CustomerManaged, MicrosoftManaged}]
                                                            [--key-vault-key-uri]
                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                            [--remove]
                                                            [--resource-group]
                                                            [--scheduler-name]
                                                            [--set]
                                                            [--subscription]

Examples

Update Transparent Data Encryption

az durabletask scheduler transparent-data-encryption update --resource-group rgdurabletask --scheduler-name testscheduler --key-vault-key-uri https://myencryption.vault.azure.net/keys/newEncryptionKey

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

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

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--key-source

The key source for the transparent data encryption.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	CustomerManaged, MicrosoftManaged

--key-vault-key-uri

The URI of the key in Key Vault to be used for transparent data encryption.

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

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--scheduler-name

The name of the Scheduler.

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

az durabletask scheduler transparent-data-encryption wait

Preview

Command group 'az durabletask scheduler transparent-data-encryption' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az durabletask scheduler transparent-data-encryption wait [--acquire-policy-token]
                                                          [--change-reference]
                                                          [--created]
                                                          [--custom]
                                                          [--deleted]
                                                          [--exists]
                                                          [--ids]
                                                          [--interval]
                                                          [--resource-group]
                                                          [--scheduler-name]
                                                          [--subscription]
                                                          [--timeout]
                                                          [--updated]

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

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

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

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--scheduler-name

The name of the Scheduler.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

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

Property	Value
Default value:	False