definitions.json

{
  "swagger": "2.0",
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ],
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "Azure Active Directory OAuth2 Flow",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  },
  "info": {
    "version": "2018-06-30-preview",
    "title": "Common types"
  },
  "paths": {},
  "definitions": {
    "ErrorResponse": {
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "description": "Error code.",
              "type": "string"
            },
            "message": {
              "description": "Detail error message indicating why the operation failed.",
              "type": "string"
            }
          }
        }
      },
      "description": "Error response of an operation failure"
    },
    "Resource": {
      "description": "The core properties of ARM resources",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true,
          "description": "ARM resource id of the guest configuration assignment."
        },
        "name": {
          "type": "string",
          "readOnly": false,
          "description": "Name of the guest configuration assignment."
        },
        "location": {
          "type": "string",
          "readOnly": false,
          "description": "Region where the VM is located."
        },
        "type": {
          "readOnly": true,
          "type": "string",
          "description": "The type of the resource."
        }
      },
      "x-ms-azure-resource": true
    },
    "TrackedResource": {
      "description": "The resource model definition for a ARM tracked top level resource",
      "type": "object",
      "properties": {
        "tags": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "x-ms-mutability": [
            "read",
            "create",
            "update"
          ],
          "description": "Resource tags."
        },
        "location": {
          "type": "string",
          "x-ms-mutability": [
            "read",
            "create"
          ],
          "description": "The Azure Region where the resource lives"
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/Resource"
        }
      ]
    },
    "ProxyResource": {
      "description": "ARM proxy resource.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Resource"
        }
      ],
      "properties": {}
    },
    "Operation": {
      "description": "GuestConfiguration REST API operation",
      "type": "object",
      "properties": {
        "name": {
          "description": "Operation name: For ex. providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/write or read",
          "type": "string"
        },
        "display": {
          "properties": {
            "provider": {
              "description": "Service provider: Microsoft.GuestConfiguration",
              "type": "string"
            },
            "resource": {
              "description": "Resource on which the operation is performed:  For ex. ",
              "type": "string"
            },
            "operation": {
              "description": "Operation type: Read, write, delete, etc.",
              "type": "string"
            },
            "description": {
              "description": "Description about operation.",
              "type": "string"
            }
          },
          "description": "Provider, Resource, Operation and description values."
        },
        "properties": {
          "properties": {
            "statusCode": {
              "description": "Service provider: Microsoft.GuestConfiguration",
              "type": "string"
            }
          },
          "x-ms-client-flatten": true,
          "description": "Provider, Resource, Operation and description values."
        }
      }
    },
    "OperationList": {
      "properties": {
        "value": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Operation"
          },
          "description": "List of Automation operations supported by the Automation resource provider."
        }
      },
      "description": "The response model for the list of Automation operations"
    }
  },
  "parameters": {
    "SubscriptionIdParameter": {
      "name": "subscriptionId",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
    },
    "ApiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "required": true,
      "type": "string",
      "description": "Client Api Version."
    },
    "VmNameParameter": {
      "name": "vmName",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "The name of the virtual machine.",
      "x-ms-parameter-location": "method"
    },
    "VMSSNameParameter": {
      "name": "vmssName",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "The name of the virtual machine scale set.",
      "x-ms-parameter-location": "method"
    },
    "MachineNameParameter": {
      "name": "machineName",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "The name of the ARC machine.",
      "x-ms-parameter-location": "method"
    },
    "ResourceGroupNameParameter": {
      "name": "resourceGroupName",
      "in": "path",
      "required": true,
      "type": "string",
      "pattern": "^[-\\w\\._]+$",
      "description": "The resource group name.",
      "x-ms-parameter-location": "method"
    }
  }
}