Table of Contents

Deploy-CafJumphost

Deploys a Jumphost virtual machine to an Azure subscription.

Syntax

Deploy-CafJumphost
    [-AutoShutdownTime <string>]
    [-AutoShutdownTimeZone <string>]
    [-Location <string>]
    [-SubscriptionId <string>]
    [-SubscriptionName <string>]
    [-VmSize <string>]
    [-DeployPublicIp]
    [-GenerateRdpFile]
    [-WhatIf]

Description

Automates deployment of a Jumphost virtual machine using direct Az PowerShell commands. Creates a new Resource Group if it does not exist and deploys a VM based on CAF naming conventions.

Example

Deploy-CafJumphost
    -SubscriptionName "lz-mycompany-myproject"
    -Location "westeurope"
    -VmSize "Standard_D2s_v3"

Parameter

-AutoShutdownTime Time of day at which the VM is automatically shut down. Must be in HHmm format.

Property Value
Type: string
Default value: "1800"
Required: False

-AutoShutdownTimeZone Timezone identifier for the auto-shutdown schedule.

Property Value
Type: string
Default value: "W. Europe Standard Time"
Required: False

-Location The Azure region for the deployment.

Property Value
Type: string
Default value: "westeurope"
Required: False

-SubscriptionId The ID of the target Azure subscription.

Property Value
Type: string
Default value: ""
Required: False

-SubscriptionName The name of the target Azure subscription.

Property Value
Type: string
Default value: None
Required: False

-VmSize The Azure VM size for the Jumphost.

Property Value
Type: string
Default value: "Standard_D2s_v3"
Required: False

-DeployPublicIp
If specified, creates and associates a basic SKU dynamic Public IP with the VM.

Property Value
Type: SwitchParameter
Default value: False
Required: False

-GenerateRdpFile
If specified, generates an RDP file for connecting to the VM.

Property Value
Type: SwitchParameter
Default value: False
Required: False

-WhatIf
If specified, only simulates the deployment without making any changes.

Property Value
Type: SwitchParameter
Default value: False
Required: False