@azbake/ingredient-azure-vm-extension v0.1.112

Changelogs

• @azbake/ingredient-azure-vm-extension

Overview

The Azure VM Extension ingredient is a plugin for Bake. When included in a recipe, this plugin will create an Event Hub resource within Azure. It will also create a Shared Access Policy for the Event Hub.

This ingredient does not deploy an Event Hub namespace. It expects the namespace to already exist. The namespace can be created in another recipe or within the same recipe.

Usage

Recipe

name: vm-ext-test
shortName: vmext
version: 1.0.0
ingredients:
  - "@azbake/ingredient-azure-vm-extension@0.0.1"
resourceGroup: true
rgOverride: "test"
parallelRegions: false
recipe:
  vmext:
    properties:
      type: "@azbake/ingredient-azure-vm-extension"
      parameters:
        extName: "InstallCustomScript"
        vmName: "testvm"
        publisher: "Microsoft.Azure.Extensions"
        typeHandlerVersion: "2.0"        
        extensionType: "CustomScript"
        settings:
          fileUris: 
            - "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/201-customscript-extension-public-storage-on-ubuntu/scripts/hello.sh"
          commandToExecute: "sh hello.sh"   

See Azure VM Extension documentation for additional details

Utilities

Utility classes can be used inside of the bake.yaml file for parameter and source values.

eventhub class

Function Details

create_resource_name()

Returns the name of the Event Hub

...
parameters:
    eventHubName: "[vmextensionsutility.create_resource_name()]"
...

Returns

string

get(rg: string, vmName: string, vmExtensionName: string)

Gets the name of the extension installed on a vm

...
parameters:
    eventHubName: "[vmextensionsutility.get('test','testvm','testext')]"
...

Returns

string

list(rg: string, vmName: string)

Lists the names of the extensions installed on a vm

...
parameters:
    eventHubName: "[vmextensionsutility.list('test','testvm')]"
...

Returns

string[]

delete(rg: string, vmName: string, vmExtensionName: string)

Gets the specified extension installed on a vm

...
parameters:
    eventHubName: "[vmextensionsutility.delete('test','testvm','testext')]"
...

Returns

string

update(rg: string, vmName: string, vmExtensionName: string, extensionParameters: VirtualMachineExtensionUpdate)

Updates the extension installed on a vm

...
parameters:
    eventHubName: "[vmextensionsutility.delete('test','testvm','testext', 'updateobject: {}')]"
...

Returns

string