New-CmAzPaasFunction | Trustmarque Docs

Completes following: * Creates App service plan * Creates Consumption type app service plan (serverless)

Creates function on service plans
Optional App insights

This command forms part of the PaaS Building Block.

Parameters

-SettingsFile

Required. (String) File path for the settings file to be converted into a settings object.

-SettingsObject

Required. (Object) Object containing the configuration values required to run this cmdlet.

-TagSettingsFile

Required. (String) File path for the tag settings file to be converted into a tag settings object.

-OmitTags

Required. (SwitchParameter) Parmeter to specify if the cmdlet should handle its own tagging.

-WhatIf

(Switch) Run the command without executing any actions, so that no changes are made. The command will output a description of actions to be performed against the affected resources in the console window. Use this option if you are unsure of the overall impact of your command and wish to review it before committing to making changes.

-Confirm

Usage

Example 1

1
New-CmAzPaasFunction -SettingsFile ./functions.yml

Example 2

1
New-CmAzPaasFunction -SettingsObject $settings

Example 3

1
New-CmAzPaasFunction -SettingsObject $settings -TagSettingFile ./tag.yml

Settings

Beta documentation

The following schema documentation is automatically generated as part of a recent roadmap task. There may be inaccuracies or incomplete information while we flush out bugs; please refer to the packed project settings examples where necessary.

Settings Root.

Component

component [string]

Value to determine what cmdlet should be dynamically loaded for these settings.

Service

service [object] Mandatory

Contains dependency and publish details for service location.

Publish

publish [object]

Contains publish details for service location.

ResourceGroup

resourceGroup [string | null]

Global default value to publish on deployed resource type.

AppServicePlan

appServicePlan [string | null]

Global default value to publish on deployed resource type.

Function

function [string | null]

Global default value to publish on deployed resource type.

Dependencies

dependencies [object | null]

Contains dependency details for service location.

AppInsights

appInsights [string | null]

Global default dependency value to fetch existing resource type.

storage

storage [string | null]

Global default dependency value to fetch existing resource type.

FunctionAppSolutions

functionAppSolutions [array] Mandatory

List of details required to deploy all resource groups, app service plans and functions.

Examples

The following example files are automatically generated from the settings file schema definition to show how the specification can be used in practise. Cloudmarque can accept both JSON and YAML parameter files.

JSON
YAML

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "component": "string",
  "service": {
    "publish": {
      "resourceGroup": "string",
      "appServicePlan": "string",
      "function": "string"
    },
    "dependencies": {
      "appInsights": "string",
      "storage": "string"
    }
  },
  "functionAppSolutions": [

  ]
}

1
2
3
4
5
6
7
8
9
10
11
component: "string"    # Optional
service:     # Mandatory
  publish:     # Mandatory
    resourceGroup: "string"    # Mandatory
    appServicePlan: "string"    # Mandatory
    function: "string"    # Mandatory
  dependencies:     # Mandatory
    appInsights: "string"    # Optional
    storage: "string"    # Mandatory
functionAppSolutions:     # Mandatory
  -