az disk-access

  • Reference

Manage disk access resources.

Commands

az disk-access create

Create a disk access resource.
az disk-access delete

Delete a disk access resource.
az disk-access list

List disk access resources.
az disk-access show

Get information of a disk access resource.
az disk-access update

Update a disk access resource.
az disk-access wait

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

az disk-access create

Create a disk access resource.

az disk-access create --name
                      --resource-group
                      [--location]
                      [--no-wait]
                      [--subscription]
                      [--tags]

Examples

Create a disk access resource.

az disk-access create -g MyResourceGroup -l centraluseuap -n MyDiskAccess

Required Parameters

--name -n

Name of the disk access resource.

--resource-group -g

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az disk-access delete

Delete a disk access resource.

az disk-access delete [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Examples

Delete a disk access reosurce.

az disk-access delete -g MyResourceGroup -n MyDiskAccess

Optional Parameters

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

--name -n

Name of the disk access resource.

--resource-group -g

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

--subscription

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

az disk-access list

List disk access resources.

az disk-access list [--query-examples]
                    [--resource-group]
                    [--subscription]

Examples

List all disk access reosurces in a resource group.

az disk-access list -g MyResourceGroup

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

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

--subscription

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

az disk-access show

Get information of a disk access resource.

az disk-access show [--ids]
                    [--name]
                    [--query-examples]
                    [--resource-group]
                    [--subscription]

Examples

Get information of a disk access reosurce.

az disk-access show -g MyResourceGroup -n MyDiskAccess

Optional Parameters

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

--name -n

Name of the disk access resource.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

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

--subscription

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

az disk-access update

Update a disk access resource.

az disk-access update [--add]
                      [--force-string]
                      [--ids]
                      [--name]
                      [--no-wait]
                      [--remove]
                      [--resource-group]
                      [--set]
                      [--subscription]
                      [--tags]

Examples

Update a disk access resource.

az disk-access update -g MyResourceGroup -n MyDiskAccess --tags tag1=val1 tag2=val2

Optional Parameters

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

--force-string

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

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

--name -n

Name of the disk access resource.

--no-wait

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

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az disk-access wait

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

az disk-access wait [--created]
                    [--custom]
                    [--deleted]
                    [--exists]
                    [--ids]
                    [--interval]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--timeout]
                    [--updated]

Examples

Place the CLI in a waiting state until the disk access is created with 'provisioningState' at 'Succeeded'.

az disk-access wait --created -g MyResourceGroup -n MyDiskAccess

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

--interval

Polling interval in seconds.

default value: 30
--name -n

Name of the disk access resource.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.