azurerm_compute_disk#

Azure Resource Manager (ARM) Compute Disk Execution Module

New in version 2.1.0.

maintainer:

<devops@eitr.tech>

configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function in order to work properly.

Required provider parameters:

if using username and password:

  • subscription_id

  • username

  • password

if using a service principal:

  • subscription_id

  • tenant

  • client_id

  • secret

if using managed identity:

  • subscription_id

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.

Possible values: * AZURE_PUBLIC_CLOUD (default) * AZURE_CHINA_CLOUD * AZURE_US_GOV_CLOUD * AZURE_GERMAN_CLOUD

saltext.azurerm.modules.azurerm_compute_disk.get(name, resource_group, **kwargs)[source]#

New in version 2.1.0.

Gets information about a disk.

Parameters:

  • name – The disk to query.

  • resource_group – The resource group name assigned to the disk.

CLI Example:

salt-call azurerm_compute_disk.get test_name test_group
saltext.azurerm.modules.azurerm_compute_disk.delete(name, resource_group, **kwargs)[source]#

New in version 2.1.0.

Delete a disk.

Parameters:

  • name – The disk to delete.

  • resource_group – The resource group name assigned to the disk.

CLI Example:

salt-call azurerm_compute_disk.delete test_name test_group
saltext.azurerm.modules.azurerm_compute_disk.list_(resource_group=None, **kwargs)[source]#

New in version 2.1.0.

Lists all the disks under a subscription.

Parameters:

resource_group – The name of the resource group to limit the results.

CLI Example:

salt-call azurerm_compute_disk.list
saltext.azurerm.modules.azurerm_compute_disk.grant_access(name, resource_group, access, duration, **kwargs)[source]#

New in version 2.1.0.

Grants access to a disk.

Parameters:

  • name – The name of the disk to grant access to.

  • resource_group – The resource group name assigned to the disk.

  • access – Possible values include: ‘None’, ‘Read’, ‘Write’.

  • duration – Time duration in seconds until the SAS access expires.

CLI Example:

salt-call azurerm_compute_disk.grant_access test_name test_group
saltext.azurerm.modules.azurerm_compute_disk.revoke_access(name, resource_group, **kwargs)[source]#

New in version 2.1.0.

Revokes access to a disk.

Parameters:

  • name – The name of the disk to revoke access to.

  • resource_group – The resource group name assigned to the disk.

CLI Example:

salt-call azurerm_compute_disk.revoke_access test_name test_group