exec.azurerm.resource.subscription

Azure Resource Manager (ARM) Resource Subscription Execution Module

New in version 1.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.resource.subscription.get(hub, ctx, subscription_id=None, **kwargs)

New in version 1.0.0.

Get details about a subscription.

Parameters:subscription_id – The ID of the subscription to query.

CLI Example:

azurerm.resource.subscription.get XXXXXXXX
idem_azurerm.exec.azurerm.resource.subscription.list_(hub, ctx, **kwargs)

New in version 1.0.0.

List all subscriptions for a tenant.

CLI Example:

azurerm.resource.subscription.list
idem_azurerm.exec.azurerm.resource.subscription.list_locations(hub, ctx, subscription_id=None, **kwargs)

New in version 1.0.0.

List all locations for a subscription.

Parameters:subscription_id – The ID of the subscription to query.

CLI Example:

azurerm.resource.subscription.list_locations XXXXXXXX