az arcdata dc
Note
This reference is part of the arcdata extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az arcdata dc command. Learn more about extensions.
Create, delete, and manage data controllers.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az arcdata dc config |
Configuration commands. |
Extension | GA |
| az arcdata dc config add |
Add a value for a json path in a config file. |
Extension | GA |
| az arcdata dc config init |
Initialize a data controller configuration profile that can be used with |
Extension | GA |
| az arcdata dc config list |
List available configuration profile choices. |
Extension | GA |
| az arcdata dc config patch |
Patch a config file based on a json patch file. |
Extension | GA |
| az arcdata dc config remove |
Remove a value for a json path in a config file. |
Extension | GA |
| az arcdata dc config replace |
Replace a value for a json path in a config file. |
Extension | GA |
| az arcdata dc config show |
Return the config of the data controller custom resource. |
Extension | GA |
| az arcdata dc create |
Create data controller. |
Extension | GA |
| az arcdata dc debug |
Debug data controller. |
Extension | GA |
| az arcdata dc debug controldb-cdc |
Enable/disable CDC on Data Controller Database and Tables - for troubleshooting purposes only. |
Extension | GA |
| az arcdata dc debug copy-logs |
Copy logs. |
Extension | GA |
| az arcdata dc debug dump |
Trigger memory dump. |
Extension | GA |
| az arcdata dc debug restore-controldb-snapshot |
Restores a unique copy of ControlDB from backup - for troubleshooting purposes only. |
Extension | GA |
| az arcdata dc delete |
Delete data controller. |
Extension | GA |
| az arcdata dc endpoint |
Endpoint commands. |
Extension | GA |
| az arcdata dc endpoint list |
List the data controller endpoint. |
Extension | GA |
| az arcdata dc export |
Export metrics, logs or usage. |
Extension | GA |
| az arcdata dc list |
List Azure Arc data controllers by resource group or subscription. |
Extension | GA |
| az arcdata dc list-upgrades |
List available upgrade versions. |
Extension | GA |
| az arcdata dc status |
Status commands. |
Extension | GA |
| az arcdata dc status show |
Show the status of the data controller. |
Extension | GA |
| az arcdata dc update |
Update data controller. |
Extension | GA |
| az arcdata dc upgrade |
Upgrade data controller. |
Extension | GA |
| az arcdata dc upload |
Upload exported data file. |
Extension | GA |
az arcdata dc create
Create data controller.
Create data controller - kube config is required on your system along with credentials for the monitoring dashboards provided by the following environment variables - AZDATA_LOGSUI_USERNAME and AZDATA_LOGSUI_PASSWORD for Logs Dashboard, and AZDATA_METRICSUI_USERNAME and AZDATA_METRICSUI_PASSWORD for Metrics Dashboard. Alternatively AZDATA_USERNAME and AZDATA_PASSWORD will be used as a fallback if either sets of environment variables are missing. When using ARM-targeted arguments, the following optional environment variables are also possible - WORKSPACE_ID for Log Analytics Workspace ID and WORKSPACE_SHARED_KEY for the Log Analytics Primary Key.
az arcdata dc create --connectivity-mode
--name
--resource-group
[--annotations]
[--auto-upload-logs {false, true}]
[--auto-upload-metrics {false, true}]
[--cluster-name]
[--custom-location]
[--image-tag]
[--infrastructure]
[--k8s-namespace]
[--labels]
[--location]
[--logs-ui-private-key-file]
[--logs-ui-public-key-file]
[--metrics-ui-private-key-file]
[--metrics-ui-public-key-file]
[--no-wait]
[--path]
[--profile-name]
[--service-annotations]
[--service-labels]
[--storage-annotations]
[--storage-class]
[--storage-labels]
[--use-k8s]Examples
Deploy an Arc data controller through the Kubernetes API (indirect connectivity mode only).
az arcdata dc create --name dc-name --k8s-namespace arc --connectivity-mode indirect --resource-group rg-name --location eastasia --subscription subscription --use-k8sDeploy an Arc data controller through Azure Resource Manager (direct connectivity mode only).
az arcdata dc create --name dc-name --connectivity-mode direct --resource-group rg-name --location eastasia --subscription subscription --custom-location arc-clDeploy an Arc data controller to a given Arc-enabled Kubernetes cluster through ARM (direct connectivity mode only). This command will deploy the Arc data services extension and custom location if they do not exist already.
az arcdata dc create --name dc-name --subscription subscription --resource-group rg-name --cluster-name arc-cluster --connectivity-mode direct --custom-location arc-clRequired Parameters
The connectivity to Azure - indirect or direct - which the data controller should operate in.
The name for the data controller.
The Azure resource group in which the data controller resource should be added.
Optional Parameters
Comma-separated list of annotations to apply all data controller resources.
Enable auto upload logs.
Enable auto upload metrics.
Name of the Kubernetes cluster.
The name of the custom location.
Arc data services image tag to use for the data controller.
The infrastructure on which the data controller will be running on. Allowed values: ['aws', 'gcp', 'azure', 'alibaba', 'onpremises', 'other', 'auto'].
The Kubernetes namespace to deploy the data controller into. If it exists already it will be used. If it does not exist, an attempt will be made to create it first.
Comma-separated list of labels to apply to all data controller resources.
The Azure location in which the data controller metadata will be stored (e.g. eastus).
Path to the file containing a PEM formatted certificate private key to be used for the Logs UI dashboard endpoint.
Path to the file containing a PEM formatted certificate to be used for the Logs UI dashboard endpoint.
Path to the file containing a PEM formatted certificate private key to be used for the Metrics UI dashboard endpoint.
Path to the file containing a PEM formatted certificate to be used for the Metrics UI dashboard endpoint.
Do not wait for the long-running operation to finish.
The path to a directory containing a custom configuration profile to use. Run az arcdata dc config init to create a custom configuration profile.
The name of an existing configuration profile. Run az arcdata dc config list to see available options. One of the following: ['azure-arc-ake', 'azure-arc-aks-default-storage', 'azure-arc-aks-hci', 'azure-arc-aks-premium-storage', 'azure-arc-azure-openshift', 'azure-arc-eks', 'azure-arc-gke', 'azure-arc-kubeadm', 'azure-arc-openshift', 'azure-arc-unit-test'].
Comma-separated list of annotations to apply to all external data controller services.
Comma-separated list of labels to apply to all external data controller services.
Comma-separated list of annotations to apply to all PVCs created by the data controller.
The storage class to be used for all data and logs persistent volumes for all data controller pods that require them.
Comma-separated list of labels to apply to all PVCs created by the data controller.
Create data controller using local Kubernetes APIs.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc delete
Delete data controller.
Delete data controller - kube config is required on your system.
az arcdata dc delete --name
[--force]
[--k8s-namespace]
[--no-wait]
[--resource-group]
[--use-k8s]
[--yes]Examples
Delete a data controller through the Kubernetes API.
az arcdata dc delete --name dc-name --k8s-namespace arc --use-k8sDelete a data controller through Azure Resource Manager (ARM).
az arcdata dc delete --name dc-name --resource-group rg-nameRequired Parameters
Data controller name.
Optional Parameters
Force delete data controller and all of its data services.
The Kubernetes namespace in which the data controller exists.
Do not wait for the long-running operation to finish.
The Azure resource group in which the data controller exists.
Use local Kubernetes APIs to perform this action.
Delete data controller without confirmation prompt.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc export
Export metrics, logs or usage.
Export metrics, logs or usage to a file.
az arcdata dc export --k8s-namespace
--path
--type
[--force]
[--use-k8s]Required Parameters
The Kubernetes namespace in which the data controller exists.
The full or relative path including the file name of the file to be exported.
The type of data to be exported. Options: logs, metrics, and usage.
Optional Parameters
Force create output file. Overwrites any existing file at the same path.
Use local Kubernetes APIs to perform this action.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc list
List Azure Arc data controllers by resource group or subscription.
az arcdata dc list [--resource-group]Examples
Lists all Arc data controllers in the given resource group.
az arcdata dc list --resource-group rg-nameLists all Arc data controllers in the given subscription.
az arcdata dc list --subscription subscriptionIdOptional Parameters
The Azure resource group containing the Arc data controller(s).
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc list-upgrades
List available upgrade versions.
Attempts to list versions that are available in the docker image registry for upgrade. - kube config is required on your system along with the following environment variables ['AZDATA_USERNAME', 'AZDATA_PASSWORD'].
az arcdata dc list-upgrades --k8s-namespace
[--use-k8s]Examples
Data controller upgrade list.
az arcdata dc list-upgrades --k8s-namespace namespace --use-k8sRequired Parameters
The Kubernetes namespace in which the data controller exists.
Optional Parameters
List available data controller versions using local Kubernetes APIs.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc update
Update data controller.
Updates the datacontroller to enable/disable auto-uploading logs and metrics.
az arcdata dc update [--auto-upload-logs {false, true}]
[--auto-upload-metrics {false, true}]
[--desired-version]
[--k8s-namespace]
[--maintenance-duration]
[--maintenance-enabled {false, true}]
[--maintenance-recurrence]
[--maintenance-start]
[--maintenance-time-zone]
[--name]
[--no-wait]
[--resource-group]
[--use-k8s]Examples
Enable auto-uploading of logs through Azure Resource Manager (ARM).
az arcdata dc update --auto-upload-logs true --name dc-name --resource-group rg-nameEnable auto-uploading of metrics through ARM.
az arcdata dc update --auto-upload-metrics true --name dc-name --resource-group rg-nameOptional Parameters
Enable auto upload logs.
Enable auto upload metrics.
The desired version tag to which the data controller will be upgraded, or empty to use the latest valid version.
The Kubernetes namespace with a deployed data controller.
Duration of the default maintenance window.
Set the enabled flag on the default maintenance window.
Recurring interval for the default maintenance window.
Date time of the start of the first default maintenance window.
Timezone used to calculate the default maintenance window.
Data controller name.
Do not wait for the long-running operation to finish.
The Azure resource group in which the data controller exists.
Use local Kubernetes APIs to perform this action.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc upgrade
Upgrade data controller.
Upgrade data controller to the desired-version specified. If desired-version is not specified, an attempt to upgrade to the latest version will be made. If you are unsure of the desired version, you may use the list-upgrades command to view available versions, or use the --dry-run argument to show which version would be used.
az arcdata dc upgrade [--desired-version]
[--dry-run]
[--k8s-namespace]
[--name]
[--no-wait]
[--resource-group]
[--target]
[--use-k8s]Examples
Data controller upgrade.
az arcdata dc upgrade --k8s-namespace arc --use-k8sOptional Parameters
The desired version tag to which the data controller will be upgraded, or empty to use the latest valid version.
Indicates which instance would be upgraded but does not actually upgrade the instances.
The Kubernetes namespace in which the data controller exists.
The name of the data controller.
If given, the command will start the upgrade, but will not wait for the entire upgrade to complete. Upgrade will continue in the background.
The Azure resource group in which the data controller exists.
Option '--target' has been deprecated and will be removed in a future release. Use '--desired-version' instead.
The desired version tag to which the data controller will be upgraded, or empty to use the latest valid version.
Upgrade data controller using local Kubernetes APIs.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcdata dc upload
Upload exported data file.
Upload data file exported from a data controller to Azure.
az arcdata dc upload --pathRequired Parameters
The full or relative path including the file name of the file to be uploaded.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for