Skip to content

Latest commit

 

History

History
88 lines (78 loc) · 3.46 KB

dx-view-formViewType-properties-formCloudShell.md

File metadata and controls

88 lines (78 loc) · 3.46 KB
Raw

view-formViewType-properties-formCloudShell

Definitions:

An object with the following properties
Name Required Description
kind True kind for Cloud Shell environment. See here for more information on kind.
commands True
fx.feature False

Sample Snippet

Executing Cloud Shell commands using form based parameters

If you need to add a list of cloud shell commands to execute, for example, in bash environment, you need to add commands to your view and reference Form blade that implements Cloud Shell scenario.

Supported shell environments: bash (with Azure CLI preinstalled), powershell (with Azure PowerShell preinstalled)

Form sample:

Says cloudShell as an action, defines kind of Cloud Shell environment to execute in, constructs array of commands passing name of command, and an array of parameters (can be optional) that the command expects. A parameter is constructed using name, and value (can be optional) using Form inputs (could be any function, resources(), steps()…)

FormBladeCloudShell.Dx.json:

{
    "$schema": "../../../Definitions/dx.schema.json",
    "view": {
        "kind": "Form",
        "properties": {
            "primaryButtonLabel": "Run Shell Commands",
            "steps": [
                {
                    "name": "parameters",
                    "label": "Cloud Shell parameters",
                    "elements": [
                        {
                            "name": "name",
                            "type": "Microsoft.Common.TextBox",
                            "label": "Resource name",
                            "defaultValue": "",
                            "visible": true
                        }
                    ]
                }
            ],
            "cloudShell": {
                "kind": "bash",
                "commands": [
                    {
                        "name": "az resource list",
                        "parameters": [
                            {
                                "name": "--name",
                                "value": "[steps('parameters').name]"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Command:

If your parent blade is a declarative blade: add the below into commands section.

      {
        "icon": "MsPortalFx.Base.Images.ArrowUp",
        "id": "formcloudshellCommand",
        "kind": "OpenBladeCommand",
        "displayName": {
          "property": "formCloudShell"
        },
        "blade": {
          "name": "FormBladeCloudShell_Dx",
          "inContextPane": true
        }
      },