Resource Type: dsc_xazurevm

Defined in:
lib/puppet/type/dsc_xazurevm.rb
Providers:
powershell

Overview

The DSC xAzureVM resource type. Automatically generated from ‘xAzure/DSCResources/MSFT_xAzureVM/MSFT_xAzureVM.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
    • absent

Parameters

  • dsc_credential

    Credential

  • dsc_ensure

    Ensure - Specifies whether the Azure VM should be present or absent. Valid values are Present, Absent.

  • dsc_extensioncontainername

    ExtensionContainerName - The name of the Container in Azure Blob storage where the script files will reside. Case sensitive.

  • dsc_extensionfilelist

    ExtensionFileList - List of files in Azure Blob container that should be copied in to the VM. Case sensitive.

  • dsc_extensionscriptname

    ExtensionScriptName - Name of one of the files in the container that will be exectued at startup. Case sensitive.

  • dsc_imagename

    ImageName - Specifies the name of the operating system image to use to create the operating system disk.

  • dsc_instancesize

    InstanceSize - Specifies the size of the instance. For a list of virtual machine sizes, see msdn.microsoft.com/library/azure/dn197896.aspx

  • dsc_linux

    Linux - Creates a Linux virtual machine.

    Supported values:
    • true
    • false
  • dsc_name

    Name - Specifies the name of the virtual machine.

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_servicename

    ServiceName - Specifies the new or existing service name.

  • dsc_storageaccountname

    StorageAccountName - Specifies the name of the storage account for the VM.

  • dsc_windows

    Windows - Creates a Windows virtual machine.

    Supported values:
    • true
    • false
  • name (namevar)
  • provider

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