az adp workspace
Note
This reference is part of the adp extension for the Azure CLI (version 2.40.0 or higher). The extension will automatically install the first time you run an az adp workspace command. Learn more about extensions.
Manage adp workspace.
Commands
Name | Description | Type | Status |
---|---|---|---|
az adp workspace create |
Create a Workspace. |
Extension | GA |
az adp workspace delete |
Delete a Workspace. |
Extension | GA |
az adp workspace list |
List Workspace resources by subscription ID. |
Extension | GA |
az adp workspace show |
Get a Workspace. |
Extension | GA |
az adp workspace update |
Update a Workspace. |
Extension | GA |
az adp workspace wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az adp workspace create
Create a Workspace.
az adp workspace create --name
--resource-group
[--data-location]
[--direct-read-access {Disabled, Enabled}]
[--domain-name-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
[--encryption]
[--identity]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--source-resource-id]
[--storage-account-count]
[--storage-sku]
[--tags]
Examples
create workspace with 3 storage accounts with LRS sku
az adp workspaces create --name sample-ws --subscription sample-subscription --resource-group sample-rg --location westus3 --storage-account-count 3 --storage-sku name=Standard_LRS
create workspace with encryption
az adp workspace create --name sample-ws --resource-group sample-rg --location westus3 --encryption key-encryption-key-url=https://contosovault.vault.azure.net/keys/contosokek user-assigned-identity-resource-id=/subscriptions/<subscriptionid>/resourceGroups/<resourcegroup>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId
Required Parameters
Workspace Name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The Workspace's data location. If not provided, defaults to the resource's location.
Enables direct data plane read access to the Workspace's underlying Azure resources according to Azure RBAC (thus bypassing the Autonomous Development Platform's authorization systems).
The scope for the FQDN label generation. If not provided, defaults to TenantReuse.
The encryption configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
The ARM Id of the source resource that originated the data for this Workspace.
The amount of storage accounts provisioned per Workspace. If not provided, defaults to 5.
The Storage SKU. If not provided, defaults to Standard_ZRS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 adp workspace delete
Delete a Workspace.
az adp workspace delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
delete workspace
az adp workspace delete --subscription sample-subscription --resource-group sample-rg --name sample-ws
Optional Parameters
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.
Workspace Name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
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 adp workspace list
List Workspace resources by subscription ID.
az adp workspace list [--resource-group]
Examples
list workspaces in resource group
az adp workspace list --subscription sample-subscription --resource-group sample-rg
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 adp workspace show
Get a Workspace.
az adp workspace show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
show workspace in resource group
az adp workspace show --subscription sample-subscription --resource-group sample-rg --name sample-ws
Optional Parameters
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.
Workspace Name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 adp workspace update
Update a Workspace.
az adp workspace update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
Examples
update workspace to 3 storage account
az adp workspace update --subscription sample-rg --resource-group sample-rg --workspace-name sample-ws --set properties.StorageAccountCount=3
Optional Parameters
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Workspace Name.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 adp workspace wait
Place the CLI in a waiting state until a condition is met.
az adp workspace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Workspace Name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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.