Azure Tasks

This article provides information on how to use the out-of-the-box task library components within MSPComplete

Tasks


Create Storage Blob

Creates a Blob Container within the specified resource group and storage account if the blob container doesn't already exist

Inputs:

Usage option 1: Create an Azure Blob Container

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • StorageAccountName

    String; required.

    The name of the storage account to create the blob container within

  • ResourceGroupName

    String; required.

    The name of the resource group to create the blob container within

  • BlobContainerName

    String; optional.

    The name for the blob container. If no name is provided, will default to 'blob'

Outputs:

  • None

Version: 1.1

Date: 01 August 2018

Back to top


Create File Share

Creates a File Share within the specified resource group and storage account if the file share doesn't already exist

Inputs:

Usage option 1: Create an Azure Fileshare

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • StorageAccountName

    String; required.

    The name of the storage account to create the fileshare within

  • ResourceGroupName

    String; required.

    The name of the resource group to create the fileshare within

  • FileshareName

    String; optional.

    The name for the fileshare. If no name is provided, will default to 'fileshare'

  • FileshareMapDrive

    String; optional.

    The drive to map the fileshare to when constructing the connection string. If no drive is specified, will default to 'Z:'

Outputs:

  • FileshareConnectionString

    The fileshare connection string to execute within a Window's environment to create a mapped drive

Version: 1.1

Date: 01 August 2018

Back to top


Create Managed Disk

Creates a Managed Disk and attach to VM if specified

Inputs:

Usage option 1: Create an Azure Managed Disk

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the managed disk within

  • VirtualMachineName

    String; optional.

    If provided, the name of the VM to attach the disk to

  • ManagedDiskName

    String; optional.

    If provided, the name of the managed disk. Will default to VMNAME_managedDisk

  • DiskSize

    String; optional.

    The disk size in GB. Default to 100GB

  • AccountType

    String; optional.

    The account type for the disk. Valid values are Standard_LRS (default), Premium_LRS, StandardSSD_LRS or UltraSSD_LRS

  • OsType

    String; optional.

    The disk OS Type. Valid values Windows (default) and Linux

Outputs:

  • None

Version: 1.0

Date: 13 August 2018

Back to top


Create Network Interface

Creates a network interface. If a VM name is supplied, will use the VM naming as part of the name for the network interface.

Inputs:

Usage option 1: Create a network interface

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the network interface within

  • NetworkInterfaceName

    String; optional.

    The name for the network interface. If no name is provided, will default to 'VM_NAME-nic'

  • NetworkSecurityGroupName

    String; optional.

    The name of the network security group within the network interface. If no name is provided, will assume default 'VM_NAME-nsg'

  • PublicIpAddressName

    String; optional.

    The name of the public IP address within the network interface. If no name is provided, will assume default 'VM_NAME-ip'

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the network security interface for. If no name is provided, all optional values are required

  • VirtualNetworkName

    String; optional.

    The name of the virtual network within the network interface. If no name is provided, will assume default to 'VM_NAME-vnet'

Outputs:

  • None

  • .NOTES

  • Version: 1.1

  • Date: 01 August 2018

  • Copyright (c) BitTitan, Inc. All rights reserved.

  • Licensed under the MIT License.

Version: 1.1

Date: 01 August 2018

Back to top


Create Network Security Group

Creates a network security rule

Inputs:

Usage option 1: Create an Azure Managed Disk

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the network security group within

  • NetworkSecurityGroupName

    String; optional.

    The name of the network security group. If default to 'VM_NAME-nsg' if a Virtual Machine name is provided

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the network security group for. If no name is provided, all optional values are required

Outputs:

  • None

Version: 1.1

Date: 10 August 2018

Back to top


Create Network Security Rule

Creates a network security rule

Inputs:

Usage option 1: Create a network security rule

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the managed disk within

  • Access

    String; required.

    Access of rule. Valid values are Allow or Deny

  • Direction

    String; required.

    Direction of the rule. Valid values are Inbound or Outbound

  • Priority

    String; required.

    The priority of the rule. Valid values are between 100 to 4096. The lower the number, the higher the priority of the rule

  • NetworkSecurityRuleName

    String; required.

  • The name of the network security rule

  • DestinationAddressPrefix

    String; optional.

    The destination address prefix for the rule. Defaults to * (match any IP address)

  • DestinationApplicationSecurityGroupName

    String; optional.

    The name of the destination application security group for the rule. If not provided, must provide the destination address prefix instead

  • DestinationPortRange

    String; optional.

    The destination port or range for the rule. Defaults to * (match any port)

  • NetworkSecurityGroupName

    String; optional.

    The name of the network security group to create the rule within. If no name is provided, will assume the default of 'VM_NAME-nsg'

  • Protocol

    String; optional.

    The rule protocol. Valid values are * (default), TCP or UDP

  • SourceAddressPrefix

    String; optional.

    The source address prefix for the rule. Defaults to * (match any IP address)

  • SourceApplicationSecurityGroupName

    String; optional.

    The name of the source application security group for the rule. If not provided, must provide the source address prefix instead

  • SourcePortRange

    String; optional.

    The source port or range for the rule. Defaults to * (match any port)

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the network security group for. If no name is provided, all optional values are required

Outputs:

  • None

Version: 1.1

Date: 1st August 2018

Back to top


Create Basic Network Security Rule

Creates a pre-defined network security rule

Inputs:

Usage option 1: Creates a pre-defined network security rule

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the network security rule within

  • RuleName

    String; required.

    The name of the rule to create. Valid values are 'HTTP', 'HTTPS', 'SSH', 'RDP' or 'MS SQL'

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the network security group for. If no name is provided, all optional values are required

  • NetworkSecurityGroupName

    String; optional.

    The name of the network security group to create the rule within

Outputs:

  • None

Version: 1.1

Date: 1st August 2018

Back to top


Create Public IP Address

Creates a public IP address

Inputs:

Usage option 1: Create an Azure Public IP address

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the network security rule within

  • Location

    String; required.

    The location code to create the public IP address within. For all valid codes, see Get-AzureRmLocation

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the public IP address for. If no name is provided, PublicIPAddressName is required

  • PublicIpAddressName

    String; optional.

    The name for the public IP address

  • PublicIpAllocationMethod

    String; optional.

    The method with which to allocate the public IP address. Valid values are 'Dynamic' (default), or 'Static'

Outputs:

  • None

Version: 1.1

Date: 11 July 2018

Back to top


Create Resource Group

Creates a Resource Group if the resource group doesn't exist

Inputs:

Usage option 1: Creates a Resource Group

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name for the resource group

  • Location

    String; required.

    The location code to create the resource group within. For all valid codes, see Get-AzureRmLocation

Outputs:

  • None

Version: 1.1

Date: 01 August 2018

Back to top


Create Service Plan

Creates a service plan

Inputs:

Usage option 1: Create an Azure Service Plan

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the application service plan within

  • AppServicePlanName

    String; required.

    The name for the application service plan.

  • Tier

    String; optional.

    The application service plan tier. Valid values are 'Free' (default), 'Shared', 'Basic', 'Standard' and 'Premium'

Outputs:

  • None

Version: 1.0

Date: 13 August 2018

Back to top


Create SQL Database

Creates a SQL database

Inputs:

Usage option 1: Create an Azure SQL database

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the managed disk within

  • DatabaseName

    String; required.

    The name for the SQL database

  • ServerName

    String; required.

    The name of the SQL database server to create the database within

  • DatabaseMaxSizeBytes

    String, Conditionally optional. Provide either DatabaseMaxSizeBytes or DatabaseMaxSizeGigabytes.

    The maximum size for the database in bytes

  • DatabaseMaxSizeGigabytes

    String, Conditionally optional. Provide either DatabaseMaxSizeBytes or DatabaseMaxSizeGigabytes.

    The maximum size for the data base in gigabytes

  • DatabaseServiceObjectiveName

    String; optional.

    The Service Object for the database. Valid values are Basic, S0, S1, S2, S3 (default), P1, P2, and P3.

Outputs:

  • None

Version: 1.1

Date: 01 August 2018

Back to top


Create SQL Server

Creates a SQL database server

Inputs:

Usage option 1: Create an Azure SQL database server

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the network security rule within

  • Location

    String; required.

    The location code to create the SQL database server within. For all valid codes, see Get-AzureRmLocation

  • ServerName

    String; required.

    The name for the SQL database server

  • ServerAdminName

    String; required.

    The username for the server administration account

  • ServerAdminPassword

    String; optional.

    The password for the server administrator account. If no password is provided, a randomly generated password will be created

Outputs:

  • ServerAdminPasswordOutput

    The server administration account password

Version: 1.1

Date: 01 August 2018

Back to top


Create Storage Account

Creates a Storage Account if the storage account doesn't exist

Inputs:

Usage option 1: Create an Azure Storage Account

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the network security rule within

  • Location

    String; required.

    The location code to create the storage account within. For all valid codes, see Get-AzureRmLocation

  • StorageAccountName

    String; required.

    The name for the storage account

  • Kind

    String; required.

    The kind of storage to create. Valid values are 'Storage', 'Storage V2', or 'Blob'

  • AccessTier

    String; optional.

    The storage access tier. Valid values are 'Hot' (default) or 'Cool'

  • SKU

    String; optional.

    The storage SKU. Valid values are 'Locally Redundant Storage' (default), 'Geo-Redundant Storage', 'Zone-Redundant Storage', 'Read Access Geo-Redundant Storage' or 'Premium Locally Redundant Storage'

Outputs:

  • None

Version: 1.1

Date: 01 August 2018

Back to top


Create Virtual Machine

Creates a virtual machine

Inputs:

Usage option 1: Create a virtual machine

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the managed disk within

  • VirtualMachineName

    String; required.

    The name for the Virtual Machine

  • VirtualMachineSize

    String; required.

    The virtual machine computer size.

  • VirtualMachineSKU

    String; required.

    The virtual machine SKU. Use Get-AzureRmVMImageSku for available SKUs

  • VirtualMachineUsername

    String; required.

    The virtual machine administrative username

  • NetworkInterfaceName

    String; optional.

    The OS Type

  • VirtualMachineOffer

    String; optional.

    The virtual machine image offer. Defaulted to 'WindowsServer'. Use Get-AzureRmVMImageOffer for available images

  • VirtualMachinePassword

    String; optional.

  • VirtualMachinePublisherName

    String; optional.

    The virtual machine publisher. Defaulted to 'MicrosoftWindowsServer'. Use Get-AzureRmVMImagePublisher for available publishers

  • VirtualMachineVersion

    String; optional.

    The Virtual Machine version. Defaulted to 'latest'

Outputs:

  • VirtualMachinePasswordOutput

    The generated password for the virtual machine administration account

Version: 1.1

Date: 01 August 2018

Back to top


Create Virtual Network

Creates an Azure Virtual Network

Inputs:

Usage option 1: Create an Azure Virtual Network

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the virtual network within

  • Location

    String; required.

    The location code to create the virtual network within. For all valid codes, see Get-AzureRmLocation

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the network for

  • VirtualNetworkIp

    String; optional.

    The virtual network IP. Defaulted to '10.0.0.0/24'

  • VirtualNetworkName

    String; optional.

    The name for the virtual network. If no name is provided, will default to 'VM_NAME-vnet'

Outputs:

  • None

Version: 1.1

Date: 01 August 2018

Back to top


Create Virtual Network Subnet

Creates a Virtual Network subnet

Inputs:

Usage option 1: Create a Virtual Network subnet

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the virtual network subnet within

  • VirtualNetworkSubnetConfigName

    String; optional.

    The name for the virtual network subnet. If no name is provided, will default to 'default'

  • VirtualMachineName

    String; optional.

    The name of the virtual machine to create the subnet for

  • NetworkSubnetIp

    String; optional.

    The virtual network subnet IP. Defaulted to '10.0.0.0/24'

  • VirtualNetworkName

    String; optional.

    The name of the virtual network to create the subnet within. If no name is provided, will assume a virtual network name of 'VM_NAME-vnet'

Outputs:

  • None

Version: 1.1

Date: 08 August 2018

Back to top


Create Web Application

Creates a web application

Inputs:

Usage option 1: Create an Azure Managed Disk

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to create the managed disk within

  • AppServicePlanName

    String; required.

    The name of the application service plan to create the web application within

  • WebAppName

    String; required.

    The name for the web application

Outputs:

  • None

Version: 1.0

Date: 13 August 2018

Back to top


Remove Resource Group

Deletes a Resource Group

Inputs:

Usage option 1: Deletes a Resource Group

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group to delete

Outputs:

  • None

Version: 1.1

Date: 08 August 2018

Back to top


Run custom script on VM

Runs a custom script on the specified VM provisioning a temp disk space to store the script

Inputs:

Usage option 1: Runs a custom script

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group containing the virtual machine

  • VirtualMachineName

    String; required.

    The name of the virtual machine to run the script on

  • VirtualMachineScript

    String; required.

    The PowerShell script to run

Outputs:

  • None

Version: 1.0

Date: 13 August 2018

Back to top


Start Virtual Machine

Starts the specified Virtual Machine(s)

Inputs:

Usage option 1: Start virtual machines

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group containing the virtual machines

  • VirtualMachineNames

    String; required.

    List of virtual machine names, separated by semi-colons (;), to start

Outputs:

  • None

Version: 1.1

Date: 08 August 2018

Back to top


Stop Virtual Machine

Stops the specified Virtual Machine(s)

Inputs:

Usage option 1: Stop virtual machines

  • Endpoint

    An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  • ResourceGroupName

    String; required.

    The name of the resource group containing the virtual machines

  • VirtualMachineNames

    String; required.

    List of virtual machine names, separated by semi-colons (;), to stop

Outputs:

  • None

Version: 1.1

Date: 08 August 2018

Back to top

Was this article helpful?
0 out of 0 found this helpful