exec.azurerm.compute.disk

Azure Resource Manager (ARM) Compute Disk Execution Module

New in version 1.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct 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

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
idem_azurerm.exec.azurerm.compute.disk.delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete a disk.

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

CLI Example:

azurerm.compute.disk.delete test_name test_group
idem_azurerm.exec.azurerm.compute.disk.get(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Gets information about a disk.

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

CLI Example:

azurerm.compute.disk.get test_name test_group
idem_azurerm.exec.azurerm.compute.disk.grant_access(hub, ctx, name, resource_group, access, duration, **kwargs)

New in version 4.0.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:

azurerm.compute.disk.grant_access test_name test_group
idem_azurerm.exec.azurerm.compute.disk.list_(hub, ctx, resource_group=None, **kwargs)

New in version 4.0.0.

Lists all the disks under a subscription.

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

CLI Example:

azurerm.compute.disk.list
idem_azurerm.exec.azurerm.compute.disk.revoke_access(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.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:

azurerm.compute.disk.revoke_access test_name test_group