azure_arm

Azure ARM module for management of Azure ARM Resources

Project URL RSS Feed Report issues

Module Stats

19,825 downloads

6,988 latest version

5.0 quality score

Version information

released Sep 3rd 2019

This version is compatible with:

Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >= 4.7.0 < 7.0.0
, , , , , ,

This module has been deprecated by its author since Apr 15th 2020.

The reason given was: We are no longer developing this module.

Tasks:

job_azure_job_list

account_azure_accounts_check_name_availability

account_azure_accounts_create

account_azure_accounts_list

account_azure_accounts_list_by_resource_group

account_azure_compute_policies_create_or_update

account_azure_compute_policies_list_by_account

and 1989 more. See all tasks

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-azure_arm', '0.2.2'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-azure_arm

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-azure_arm --version 0.2.2

Documentation

puppetlabs/azure_arm — version 0.2.2 Sep 3rd 2019

Azure ARM

Description
Setup
Usage
- Examples
Reference
- Types and providers

Description

Microsoft Azure exposes a powerful API for creating and managing its Infrastructure as a Service platform. Using Puppet code, the azure arm (Azure Resource Manager) module enables you to interact with that API to create and destroy virtual machines, and to manage other resources.

The azure arm module is generated from the Microsoft Azure REST API specifications. For additional information, see the Azure documentation.

Classic (ASM) Azure is not supported.

Note: This module and the puppetlabs-azure module are mutually exclusive and should not be installed on the same machine. To avoid potential errors during a puppet run, install each module on separate machines.

Setup

Getting Azure credentials

To use this module, you need an Azure account. If you already have one, you can skip this section.

Sign up for an Azure account.
To generate a certificate for the Puppet module, install the Azure CLI which is a cross-platform node.js-based tool that works on Windows and Linux.
To authenticate with the Azure CLI, run the following command to receive the authentication code:
```
az login
```
Visit https://microsoft.com/devicelogin and enter the authentication code.
To get a subscription ID, run the az account list command:
```
``` shell
$ az account list
```
[ { "cloudName": "AzureCloud", "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "isDefault": true, "name": "xxxx", "state": "Enabled", "tenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "user": { "name": "xxxx@xxxx.xxx", "type": "user" } } ]
```
```
```

To use the Resource Manager API instead, you need a service principal on the Active Directory. For more information, see the Azure documentation.

Setting environment variables

Set the following environment variables specific to your Azure installation (note the casing here).

export azure_subscription_id='your-subscription-id'
export azure_tenant_id='your-tenant-id'
export azure_client_id='your-client-id'
export azure_client_secret='your-client-secret'

Installing the module

To install the azure arm module, run the following command:

puppet module install puppetlabs-azure_arm

Validating the module

The azure arm module is compliant with the Puppet Development Kit (PDK), which provides the tool to help validate the modules's metadata, syntax, and style. When you run validations, the PDK output tells you which validations are running and notifies you of any errors, or warnings, it finds for each type of validation; syntax, code style, and metadata.

To run all validations against this module, run the following commands:

pdk validate ruby
pdk validate metadata

To change validation behavior, add options flags to the command. For a complete list of command options and usage information, see the PDK command reference.

Usage

To create or remove resources in your manifests, set the ensure parameter to present or absent. The stopped and running states are managed using the Microsoft Azure Portal. This functionality is available in the next Puppet Azure ARM release.

Examples

The examples directory contains the following usage examples:

create_vm.pp to create 2 virtual machines.
delete_vm.pp to delete the virtual machines.
create_virtual_machine_extension.pp to create a virtual machine extension.
create_aks.pp for creating the Azure Kubernetes Service (AKS).
delete_aks.pp for deleting the Azure Kubernetes Service (AKS).
create_resource_level_deployment.pp to deploy resources to a resource group in your Azure subscription.
delete_resource_level_deployment.pp to delete a resource level deployment in your Azure subscription.
task_example.sh contains a number of sample tasks, each using Puppet Bolt:
- list the available Azure operations.
- list virtual machines by location.
- create Azure storage accounts.
- create or delete resource level deployments.

Following the create_vm.pp example, use the puppet resource command on existing resources to determine which values to populate in custom manifests.

For example:

puppet resource azure_application_gateway

Reference

Types and providers

Here is a list of the types and providers with links to detailed descriptions for each one:

account.json

account.json(1)

accountfilters.json

azure_account_filter

accounts.json

azure_media_service

actiongroups_api.json

azure_action_group_resource

activitylogalerts_api.json

azure_activity_log_alert_resource

advisor.json

azure_suppression_contract

alertrules_api.json

azure_alert_rule_resource

analysisservices.json

azure_analysis_services_server

analyticsitems_api.json

azure_application_insights_component_analytics_item

apimdeployment.json

azure_api_management_service_resource

apimemailtemplate.json

azure_email_template_contract

apimversionsets.json

azure_api_version_set_contract

application.json

azure_application_type_resource

applicationgateway.json

azure_application_gateway

applicationsecuritygroup.json

azure_application_security_group

appservicecertificateorders.json

appserviceenvironments.json

azure_app_service_environment_resource

assetsandassetfilters.json

authorization-roleassignmentscalls.json

azure_role_assignment

authorization-roledefinitionscalls.json

azure_role_definition

autoscale_api.json

azure_autoscale_setting_resource

azureactivedirectory.json

azure_diagnostic_settings_resource

azurefirewall.json

azure_azure_firewall

bastionhost.json

azure_bastion_host

batchai.json

blob.json

bms.json

azure_protection_intent_resource

cdn.json

certificates.json

azure_certificate

cluster.json

azure_cluster

cognitiveservices.json

azure_cognitive_services_account

components_api.json

azure_application_insights_component

compute.json

consumption.json

azure_budget

containerinstance.json

azure_container_group

containerregistry.json

containerregistry_build.json

azure_task

containerservice.json

azure_container_service

containerservice.json(1)

azure_container_service

contentkeypolicies.json

azure_content_key_policy

contentmoderator.json

cosmos-db.json

costmanagement.json

azure_export

customer-insights.json

customersubscription.json

azure_customer_subscription

databox.json

azure_job_resource

databricks.json

azure_workspace

datacatalog.json

azure_adc_catalog

datafactory.json

ddoscustompolicy.json

azure_ddos_custom_policy

ddosprotectionplan.json

azure_ddos_protection_plan

devspaces.json

azure_controller

disasterrecoveryconfigurations.json

azure_disaster_recovery_configuration

azure_elastic_pool

encoding.json

eventgrid.json

eventhub.json

expressroutecircuit.json

expressroutecrossconnection.json

azure_express_route_cross_connection_peering

expressroutegateway.json

expressrouteport.json

azure_express_route_port

favorites_api.json

azure_application_insights_component_favorite

file.json

azure_file_share

firewallpolicy.json

firewallrules.json

azure_firewall_rule

frontdoor.json

functions.json

azure_function

gallery.json

graphrbac.json

guestconfiguration.json

azure_guest_configuration_assignment

healthcare-apis.json

azure_services_description

hybriddata.json

inputs.json

azure_input

interfaceendpoint.json

azure_interface_endpoint

iotcentral.json

azure_app

iotdps.json

iothub.json

iotsecuritysolutions.json

azure_io_t_security_solution_model

keyvault.json

azure_vault

kusto.json

links.json

azure_resource_link

loadbalancer.json

locks.json

azure_management_lock_object

logic.json

logicappsmanagementclient.json

logprofiles_api.json

azure_log_profile_resource

machinelearningservices.json

managedapplications.json

managedclusters.json

managedidentity.json

azure_identity

managedservices.json

maps-management.json

azure_maps_account

mariadb.json

media.json

azure_media_service

metricalert_api.json

azure_metric_alert_resource

azure_nat_gateway

networkinterface.json

networkprofile.json

azure_network_profile

networksecuritygroup.json

networkwatcher.json

notificationhubs.json

openshiftmanagedclusters.json

azure_open_shift_managed_cluster

operationalinsights.json

outputs.json

azure_output

policy.json

policyassignments.json

azure_policy_assignment

policydefinitions.json

azure_policy_definition

policysetdefinitions.json

azure_policy_set_definition

postgresql.json

powerbidedicated.json

azure_dedicated_capacity

privatedns.json

privateendpoint.json

azure_private_endpoint

privatelinkservice.json

azure_private_link_service

publicipaddress.json

azure_public_ip_address

publicipprefix.json

azure_public_ip_prefix

recoveryservicesbackup.json

azure_protection_policy_resource

redis.json

registration.json

azure_registration

scheduledqueryrule_api.json

azure_log_search_rule_resource

search.json

serverazureadadministrators.json

azure_server_azure_ad_administrator

servercommunicationlinks.json

azure_server_communication_link

servers.json

azure_server

service.json

service.json(1)

servicebus.json

serviceendpointpolicy.json

signalr.json

azure_signal_r_resource

smartdetectoralertrulesapi.json

azure_alert_rule

storage.json

storageimportexport.json

azure_job_response

storagesync.json

storsimple.json

streamingjobs.json

azure_streaming_job

streamingpoliciesandstreaminglocators.json

streamingservice.json

timeseriesinsights.json

vaults.json

azure_vault

virtualnetwork.json

virtualnetworkgateway.json

virtualnetworktap.json

azure_virtual_network_tap

virtualwan.json

vmwarecloudsimple.json

webapplicationfirewall.json

azure_web_application_firewall_policy

webapplicationfirewall.json(1)

azure_web_application_firewall_policy

webapps.json

webservices.json

azure_web_service

webtests_api.json

azure_web_test

windowsiotservices.json

azure_device_service

workbooks_api.json

azure_workbook

workspaces.json

azure_workspace

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

account_azure_accounts_check_name_availability

Checks whether the specified account name is available or taken.

Parameters
api_version	Client Api Version. `Optional[String[1]]`
location	The resource location without whitespace. `Optional[String[1]]`
name	The Data Lake Analytics name to check availability for. `Optional[String[1]]`
parameters	Parameters supplied to check the Data Lake Analytics account name availability. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
type	The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeAnalytics/accounts `Optional[String[1]]`

Input method

stdin

account_azure_accounts_create

Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
location	The resource location. `Optional[String[1]]`
parameters	Parameters supplied to create a new Data Lake Analytics account. `Optional[String[1]]`
properties	The Data Lake Analytics account properties to use for creating. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
tags	The resource tags. `Optional[String[1]]`

Input method

stdin

account_azure_accounts_list

Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any.

Parameters
api_version	Client Api Version. `Optional[String[1]]`
count	The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. `Optional[String[1]]`
filter	OData filter. Optional. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
orderby	OrderBy clause. One or more comma-separated expressions with an optional 'asc' (the default) or 'desc' depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. `Optional[String[1]]`
select	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. `Optional[String[1]]`
skip	The number of items to skip over before returning elements. Optional. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
top	The number of items to return. Optional. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

account_azure_accounts_list_by_resource_group

Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any.

Parameters
api_version	Client Api Version. `Optional[String[1]]`
count	The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. `Optional[String[1]]`
filter	OData filter. Optional. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
orderby	OrderBy clause. One or more comma-separated expressions with an optional 'asc' (the default) or 'desc' depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
select	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. `Optional[String[1]]`
skip	The number of items to skip over before returning elements. Optional. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
top	The number of items to return. Optional. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

account_azure_compute_policies_create_or_update

Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
compute_policy_name	The name of the compute policy to create or update. `Optional[String[1]]`
parameters	Parameters supplied to create or update the compute policy. The max degree of parallelism per job property, min priority per job property, or both must be present. `Optional[String[1]]`
properties	The compute policy properties to use when creating a new compute policy. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`

Input method

stdin

account_azure_compute_policies_list_by_account

Lists the Data Lake Analytics compute policies within the specified Data Lake Analytics account. An account supports, at most, 50 policies

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

account_azure_data_lake_store_accounts_add

Updates the specified Data Lake Analytics account to include the additional Data Lake Store account.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
data_lake_store_account_name	The name of the Data Lake Store account to add. `Optional[String[1]]`
parameters	The details of the Data Lake Store account. `Optional[String[1]]`
properties	The Data Lake Store account properties to use when adding a new Data Lake Store account. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`

Input method

stdin

account_azure_data_lake_store_accounts_get

Gets the specified Data Lake Store account details in the specified Data Lake Analytics account.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
data_lake_store_account_name	The name of the Data Lake Store account to retrieve `Optional[String[1]]`
id	The resource identifier. `Optional[String[1]]`
name	The resource name. `Optional[String[1]]`
properties	The Data Lake Store account properties. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
type	The resource type. `Optional[String[1]]`

Input method

stdin

account_azure_firewall_rules_create_or_update

Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
firewall_rule_name	The name of the firewall rule to create or update. `Optional[String[1]]`
parameters	Parameters supplied to create or update the firewall rule. `Optional[String[1]]`
properties	The firewall rule properties to use when creating a new firewall rule. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`

Input method

stdin

account_azure_firewall_rules_list_by_account

Lists the Data Lake Analytics firewall rules within the specified Data Lake Analytics account.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

account_azure_locations_get_capability

Gets subscription-level properties and limits for Data Lake Analytics specified by resource location.

Parameters
accountcount	The current number of accounts under this subscription. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
location	The resource location without whitespace. `Optional[String[1]]`
maxaccountcount	The maximum supported number of accounts under this subscription. `Optional[String[1]]`
migrationstate	The Boolean value of true or false to indicate the maintenance state. `Optional[String[1]]`
state	The subscription state. `Optional[String[1]]`
subscription_id	`Optional[String[1]]`
subscriptionid	The subscription credentials that uniquely identifies the subscription. `Optional[String[1]]`

Input method

stdin

account_azure_locations_get_usage

Gets the current usage count and the limit for the resources of the location under the subscription.

Parameters
api_version	Client Api Version. `Optional[String[1]]`
location	The resource location without whitespace. `Optional[String[1]]`
subscription_id	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
value	Gets or sets the list of Storage Resource Usages. `Optional[String[1]]`

Input method

stdin

account_azure_operations_list

Lists all of the available Data Lake Analytics REST API operations.

Parameters
api_version	Client Api Version. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

account_azure_storage_accounts_add

Updates the specified Data Lake Analytics account to add an Azure Storage account.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
parameters	The parameters containing the access key and optional suffix for the Azure Storage Account. `Optional[String[1]]`
properties	The Azure Storage account properties to use when adding a new Azure Storage account. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
storage_account_name	The name of the Azure Storage account to add `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`

Input method

stdin

account_azure_storage_accounts_get

Gets the specified Azure Storage account linked to the given Data Lake Analytics account.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
id	The resource identifier. `Optional[String[1]]`
name	The resource name. `Optional[String[1]]`
properties	The Azure Storage account properties. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
storage_account_name	The name of the Azure Storage account for which to retrieve the details. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
type	The resource type. `Optional[String[1]]`

Input method

stdin

account_azure_storage_accounts_list_by_account

Gets the first page of Azure Storage accounts, if any, linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
count	The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. `Optional[String[1]]`
filter	The OData filter. Optional. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
orderby	OrderBy clause. One or more comma-separated expressions with an optional 'asc' (the default) or 'desc' depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
select	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. `Optional[String[1]]`
skip	The number of items to skip over before returning elements. Optional. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
top	The number of items to return. Optional. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

account_azure_storage_accounts_list_sas_tokens

Gets the SAS token associated with the specified Data Lake Analytics and Azure Storage account and container combination.

Parameters
account_name	The name of the Data Lake Analytics account. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
container_name	The name of the Azure storage container for which the SAS token is being requested. `Optional[String[1]]`
nextlink	The link (url) to the next page of results. `Optional[String[1]]`
resource_group_name	The name of the Azure resource group. `Optional[String[1]]`
storage_account_name	The name of the Azure storage account for which the SAS token is being requested. `Optional[String[1]]`
subscription_id	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. `Optional[String[1]]`
value	The results of the list operation. `Optional[String[1]]`

Input method

stdin

accountfilters_azure_account_filters_delete

Deletes an Account Filter in the Media Services account.

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
filter_name	The Account Filter name `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accountfilters_azure_account_filters_get

Get the details of an Account Filter in the Media Services account.

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
filter_name	The Account Filter name `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accountfilters_azure_account_filters_list

List Account Filters in the Media Services account.

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accounts_azure_mediaservices_create_or_update

Creates or updates a Media Services account

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
parameters	The request parameters `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accounts_azure_mediaservices_delete

Deletes a Media Services account

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accounts_azure_mediaservices_get

Get the details of a Media Services account

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accounts_azure_mediaservices_list

List Media Services accounts in the resource group

Parameters
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accounts_azure_mediaservices_sync_storage_keys

Synchronizes storage account keys for a storage account associated with the Media Service account.

Parameters
account_name	The Media Services account name. `Optional[String[1]]`
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
error	The error properties. `Optional[String[1]]`
parameters	The request parameters `Optional[String[1]]`
resource_group_name	The name of the resource group within the Azure subscription. `Optional[String[1]]`
subscription_id	The unique identifier for a Microsoft Azure subscription. `Optional[String[1]]`

Input method

stdin

accounts_azure_operations_list

Lists all the Media Services operations.

Parameters
api_version	The Version of the API to be used with the client request. `Optional[String[1]]`
odatanextlink	A link to the next page of the collection (when the collection contains too many results to return in one response). `Optional[String[1]]`
value	A collection of Operation items. `Optional[String[1]]`

Input method

stdin

actiongroups_api_azure_action_groups_delete

Delete an action group.

Parameters
action_group_name	The name of the action group. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
code	Error code `Optional[String[1]]`
message	Error message indicating why the operation failed. `Optional[String[1]]`
resource_group_name	The name of the resource group. `Optional[String[1]]`
subscription_id	The Azure subscription Id. `Optional[String[1]]`

Input method

stdin

actiongroups_api_azure_action_groups_get

Get an action group.

Parameters
action_group_name	The name of the action group. `Optional[String[1]]`
api_version	Client Api Version. `Optional[String[1]]`
code	Error code `Optional[String[1]]`
message	Error message indicating why the operation failed. `Optional[String[1]]`
resource_group_name	The name of the resource group. `Optional[String[1]]`
subscription_id	The Azure subscription Id. `Optional[String[1]]`

Input method

stdin

activitylogs_api_azure_activity_logs_list

Provides the list of records from the activity logs.

Parameters
api_version	Client Api Version. `Optional[String[1]]`
filter	Reduces the set of data collected.This argument is required and it also requires at least the start date/time.The $filter argument is very restricted and allows only the following patterns.- List events for a resource group: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceGroupName eq 'resourceGroupName'.- List events for resource: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceUri eq 'resourceURI'.- List events for a subscription in a time range: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z'.- List events for a resource provider: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and resourceProvider eq 'resourceProviderName'.- List events for a correlation Id: $filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and correlationId eq 'correlationID'.NOTE: No other syntax is allowed. `Optional[String[1]]`
nextlink	Provides the link to retrieve the next set of events. `Optional[String[1]]`
select	Used to fetch events with only the given properties.The $select argument is a comma separated list of property names to be returned. Possible values are: authorization, claims, correlationId, description, eventDataId, eventName, eventTimestamp, httpRequest, level, operationId, operationName, properties, resourceGroupName, resourceProviderName, resourceId, status, submissionTimestamp, subStatus, subscriptionId `Optional[String[1]]`
subscription_id	The Azure subscription Id. `Optional[String[1]]`
value	this list that includes the Azure audit logs. `Optional[String[1]]`

Input method

stdin

adhybridhealthservice_azure_adds_services_add

Onboards a service for a given tenant in Azure Active Directory Connect Health.

Parameters
activealerts	The count of alerts that are currently active for the service. `Optional[String[1]]`
additionalinformation	The additional information related to the service. `Optional[String[1]]`
api_version	The version of the API to be used with the client request. `Optional[String[1]]`
createddate	The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. `Optional[String[1]]`
customnotificationemails	The list of additional emails that are configured to receive notifications about the service. `Optional[String[1]]`
disabled	Indicates if the service is disabled or not. `Optional[String[1]]`
displayname	The display name of the service. `Optional[String[1]]`
health	The health of the service. `Optional[String[1]]`
id	The id of the service. `Optional[String[1]]`
lastdisabled	The date and time, in UTC, when the service was last disabled. `Optional[String[1]]`
lastupdated	The date or time , in UTC, when the service properties were last updated. `Optional[String[1]]`
monitoringconfigurationscomputed	The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. `Optional[String[1]]`
monitoringconfigurationscustomized	The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. `Optional[String[1]]`
notificationemailenabled	Indicates if email notification is enabled or not. `Optional[String[1]]`
notificationemailenabledforglobaladmins	Indicates if email notification is enabled for global administrators of the tenant. `Optional[String[1]]`
notificationemails	The list of emails to whom service notifications will be sent. `Optional[String[1]]`
notificationemailsenabledforglobaladmins	Indicates if email notification is enabled for global administrators of the tenant. `Optional[String[1]]`
originaldisabledstate	Gets the original disable state. `Optional[String[1]]`
resolvedalerts	The total count of alerts that has been resolved for the service. `Optional[String[1]]`
service	The service object. `Optional[String[1]]`
serviceid	The id of the service. `Optional[String[1]]`
servicename	The name of the service. `Optional[String[1]]`
signature	The signature of the service. `Optional[String[1]]`
simpleproperties	List of service specific configuration properties. `Optional[String[1]]`
tenantid	The id of the tenant to which the service is registered to. `Optional[String[1]]`
type	The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. `Optional[String[1]]`

Input method

stdin

Modules

Discover

Contribute

Topics

How-to Guides

Collections

Resources

About Forge

Getting Started

azure_arm

Version information

This version is compatible with:

This module has been deprecated by its author since Apr 15th 2020.

Tasks:

Start using this module

Documentation

Azure ARM

Table of Contents

Description

Setup

Getting Azure credentials

Setting environment variables

Installing the module

Validating the module

Usage

Examples

Reference

Types and providers

What are tasks?

Tasks in this module release

account_azure_accounts_check_name_availability

account_azure_accounts_create

account_azure_accounts_list

account_azure_accounts_list_by_resource_group

account_azure_compute_policies_create_or_update

account_azure_compute_policies_list_by_account

account_azure_data_lake_store_accounts_add

account_azure_data_lake_store_accounts_get

account_azure_firewall_rules_create_or_update

account_azure_firewall_rules_list_by_account

account_azure_locations_get_capability

account_azure_locations_get_usage

account_azure_operations_list

account_azure_storage_accounts_add

account_azure_storage_accounts_get

account_azure_storage_accounts_list_by_account

account_azure_storage_accounts_list_sas_tokens

accountfilters_azure_account_filters_delete

accountfilters_azure_account_filters_get

accountfilters_azure_account_filters_list

accounts_azure_mediaservices_create_or_update

accounts_azure_mediaservices_delete

accounts_azure_mediaservices_get

accounts_azure_mediaservices_list

accounts_azure_mediaservices_sync_storage_keys

accounts_azure_operations_list

actiongroups_api_azure_action_groups_delete

actiongroups_api_azure_action_groups_get

activitylogs_api_azure_activity_logs_list

adhybridhealthservice_azure_adds_services_add

Version 0.2.2

Version 0.2.1

Version 0.2.0

Version 0.1.5

Version 0.1.4

Version 0.1.3

Version 0.1.2

Version 0.1.1

Version 0.1.0