az dt job deletion

  • Reference

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az dt job deletion command. Learn more about extensions.

Manage and configure jobs for deleting model, twin and relationships data in a digital twin instance.

A deletion job cannot be cancelled or deleted.

Commands

Name Description Type Status
az dt job deletion create

Create and execute a deletion job on a digital twin instance.

 Extension GA
az dt job deletion list

List all deletion jobs executed on a digital twins instance.

 Extension GA
az dt job deletion show

Show details of a deletion job executed on a digital twins instance.

 Extension GA

az dt job deletion create

Create and execute a deletion job on a digital twin instance.

A deletion job cannot be cancelled or deleted. The command will delete all models, twins, and relationships in the digital twin instance. To delete only certain aspects in a digital twin instance, please see

  • az dt twin relationship delete-all
  • az dt twin delete-all
  • az dt model delete-all These commands will not show up in deletion job history.
az dt job deletion create --dt-name
                          [--job-id]
                          [--resource-group]
                          [--timeout]
                          [--yes]

Examples

Creates a deletion job with a given job id.

az dt job deletion create -n {instance_or_hostname} -j {job_id}

Creates a deletion job with a generated job id and no confirmation prompts.

az dt job deletion create -n {instance_or_hostname} -y

Required Parameters

--dt-name --dtn -n

Digital Twins instance name or hostname. If an instance name is provided, the user subscription is first queried for the target instance to retrieve the hostname. If a hostname is provided, the subscription query is skipped and the provided value is used for subsequent interaction.

Optional Parameters

--job-id -j

Id of job. A system generated id is assigned when this parameter is ommitted during job creation.

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group=<name>.

--timeout -t

Timeout in minutes for the deletion job. Must be a positive integer between 15 and 1440 inclusive.

--yes -y

Do not prompt for confirmation.

default value: False
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 dt job deletion list

List all deletion jobs executed on a digital twins instance.

az dt job deletion list --dt-name
                        [--resource-group]

Examples

List all deletion jobs on a target digital twins instance.

az dt job deletion list -n {instance_or_hostname}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name or hostname. If an instance name is provided, the user subscription is first queried for the target instance to retrieve the hostname. If a hostname is provided, the subscription query is skipped and the provided value is used for subsequent interaction.

Optional Parameters

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group=<name>.

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 dt job deletion show

Show details of a deletion job executed on a digital twins instance.

az dt job deletion show --dt-name
                        --job-id
                        [--resource-group]

Examples

Show details of a data deletion job by job id.

az dt job deletion show -n {instance_or_hostname} -j {job_id}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name or hostname. If an instance name is provided, the user subscription is first queried for the target instance to retrieve the hostname. If a hostname is provided, the subscription query is skipped and the provided value is used for subsequent interaction.

--job-id -j

Id of job. A system generated id is assigned when this parameter is ommitted during job creation.

Optional Parameters

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group=<name>.

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.