Skip to content

ArmGuiClient

Galin Iliev edited this page Mar 10, 2016 · 6 revisions

Launch ArmGuiClient.exe

ArmGuiClient.exe

Customization

Content display in ArmGuiClient is driven by config.json file. That includes

  • Endpoint Environment
  • Api Version dropdown
  • Logging setting
  • Editor path
  • Turn on/off auto prompt to edit payload when there is PUT/PATCH/POST action
  • Default values for placeholder in URL parameters and request payload
  • Define requests
Ctrl + P to open config.json
(ArmGuiClient will auto reload config.json when there is new changes)

Display rich/less request/response information. When "Verbose" set to "true", will display request, response together with headers. When "Verbose" set to false, will only display response data.

"Verbose": "true"

Update "Editor" to point to your editor

"Editor": "%windir%\\system32\\notepad.exe"

Set default values for placeholders. ArmGuiClient will populate value that specify in "DefaultValues" into params and payload.

"DefaultValues": {
        "resourceGroup": "default-web-westus",
        "location": "westus",
        "siteName" : "testsite101",
        "siteExtensionName":"filecounter"
    }

Add more ARM requests into Actions array.

{subscription} and {apiVersion} are built in placehoder that you do not need to define.

Actions": [
        {
            "httpMethod": "GET",
            "name": "List Resource Groups",
            "template": "/subscriptions/{subscription}/resourceGroups?api-version={apiVersion}"
        },
        {
            "httpMethod": "GET",
            "name": "Get Resource Group",
            "template": "/subscriptions/{subscription}/resourceGroups/{resourceGroup}?api-version={apiVersion}",
            "params": [
                {
                    "name": "Resource Group Name",
                    "placeHolder": "resourceGroup",
                    "required": "true"
                }
            ]
        },
        {
            "httpMethod": "PUT",
            "name": "Create Resource Group",
            "template": "/subscriptions/{subscription}/resourceGroups/{resourceGroup}?api-version={apiVersion}",
            "params": [
                {
                    "name": "Resource Group Name",
                    "placeHolder": "resourceGroup",
                    "required": "true"
                }
            ],
            "payload": {
                "location": "{location}"
            }
        },
        {
            "httpMethod": "DELETE",
            "name": "Delete Resource Group",
            "template": "/subscriptions/{subscription}/resourceGroups/{resourceGroup}?api-version={apiVersion}",
            "params": [
                {
                    "name": "Resource Group Name",
                    "placeHolder": "resourceGroup",
                    "required": "true"
                }
            ]
        }
]
Clone this wiki locally