Resource Type: dsc_xazurevmdscextension

Defined in:

lib/puppet/type/dsc_xazurevmdscextension.rb

Providers:

powershell

Overview

The DSC xAzureVMDscExtension resource type. Automatically generated from ‘xAzure/DSCResources/MSFT_xAzureVMDscExtension/MSFT_xAzureVMDscExtension.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_code

  Code - Returns the message code for the latest oepration by the DSC Extension.

• dsc_configuration

  Configuration - Name of the configuration script or module that will be invoked by the DSC Extension.

• dsc_configurationarchive

  ConfigurationArchive - The name of the configuration package .zip file that was previously uploaded by Publish-AzureVMDscConfiguration. This parameter must specify only the name of the file, without any path.

• dsc_configurationargument

  ConfigurationArgument - A hashtable specifying the arguments to the configuration function. The keys correspond to the parameter names and the values to the parameter values.

• dsc_configurationdatapath

  ConfigurationDataPath - The path to a .psd1 file that specifies the data for the configuration function.

• dsc_containername

  ContainerName - Name of the Azure Storage Container where the ConfigurationArchive is located.

• dsc_force

  Force - By default Set-AzureVMDscExtension will not overwrite any existing blobs. Use -Force to overwrite them.

  Supported values:

  • true
  • false
• dsc_message

  Message - Returns the formatted message string for the latest operation by the DSC Extension.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_referencename

  ReferenceName - The Extension Reference Name

• dsc_servicename

  ServiceName - Specifies name of the Service where the VM is deployed.

• dsc_status

  Status - Returns the state of the DSC Extension from Azure.

• dsc_storageaccountname

  StorageAccountName - Specifies the name of the Storage Account used to create the Storage Context. The Azure Storage Context provides the security settings used to access the configuration script. This context should provide read access to the container specified by ContainerName.

• dsc_storageendpointsuffix

  StorageEndpointSuffix - The DNS endpoint suffix for all storage services, e.g. core.windows.net

• dsc_timestamp

  TimeStamp - Returns the timestamp of the last DSC Extension execution.

• dsc_version

  Version - The specific version of the DSC Extension to use. If not given, it will default to 1.*

• dsc_vmname

  VMName - Specifies name of the VM. This is used together with ServiceName to construct a persistent vm object.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xazurevmdscextension` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.