Microsoft Azure Virtual Machines
18 min
the microsoft azure virtual machines connector allows for the management of vms through automated tasks, facilitating cloud infrastructure operations this connector ingests data from the microsoft azure virtual machines and integrates it with swimlane turbine microsoft azure virtual machines offer scalable computing resources in the cloud, providing the flexibility of virtualization without the need for physical hardware this connector enables swimlane turbine users to manage azure vms directly from the platform, allowing for the listing, starting, and stopping of virtual machines within specified resource groups by integrating with azure virtual machines, security automation is enhanced, offering streamlined management and operational efficiency for incident response and routine tasks prerequisites to utilize the microsoft azure virtual machines connector within swimlane turbine, ensure you have the following oauth 2 0 client credentials for authentication with the following parameters url endpoint for azure management api client id identifier for the registered azure application client secret secret key generated for the azure application token url url to retrieve the oauth2 token scopes permissions the app requires capabilities this connector provides the following capabilities list all virtual machines power off virtual machines start virtual machines api documentation link https //learn microsoft com/en us/rest/api/compute/virtual machines/list?view=rest compute 2024 03 01\&tabs=http configurations microsoft azure virtual machines oauth 2 0 authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required token url must start with https //login microsoftonline com/ and then continue with the tenant id, and then be prepended with /oauth2/v2 0/token string required client id the client id string required client secret the client secret string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions list all virtual machines retrieves a list of all virtual machines within a specified resource group in microsoft azure, requiring resource groupname, subscription id, and api version endpoint url /subscriptions/{{subscriptionid}}/providers/microsoft compute/virtualmachines method get input argument name type required description parameters api version string required client api version parameters $filter string optional the system query option to filter vms returned in the response allowed value is 'virtualmachinescaleset/id' eq /subscriptions/{subid}/resourcegroups/{resourcegroupname}/providers/microsoft compute/virtualmachinescalesets/{vmssname}' parameters $expand string optional the expand expression to apply on operation 'instanceview' enables fetching run time status of all virtual machines, this can only be specified if a valid $filter option is specified parameters statusonly string optional statusonly=true enables fetching run time status of all virtual machines in the subscription path parameters subscriptionid string required subscription credentials which uniquely identify microsoft azure subscription the subscription id forms part of the uri for every service call input example {"parameters" {"api version" "2024 03 01","$filter" "'virtualmachinescaleset/id' eq /subscriptions/{subid}/resourcegroups/{resourcegroupname}/providers/microsoft compute/virtualmachinescalesets/{vmssname}'","$expand" "instanceview","statusonly" "true"},"path parameters" {"subscriptionid" "abciz47"}} output parameter type description status code number http status code of the response reason string response reason phrase value array value for the parameter value properties object value for the parameter value type string type of the resource value location string value for the parameter value tags object value for the parameter value id string unique identifier value name string name of the resource value plan object value for the parameter value plan name string name of the resource value resources array value for the parameter value resources properties object value for the parameter value resources id string unique identifier value resources name string name of the resource value resources type string type of the resource value resources location string value for the parameter value resources tags object value for the parameter value resources tags key9428 string value for the parameter value identity object unique identifier value zones array value for the parameter nextlink string output field nextlink output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","date" "tue, 30 apr 2024 10 36 47 gmt"},"reason" "ok","json body" {"value" \[{}],"nextlink" "a"}} power off virtual machines powers off a specified azure virtual machine without deallocating resources, allowing for a restart with existing provisions endpoint url /subscriptions/{{subscriptionid}}/resourcegroups/{{resourcegroupname}}/providers/microsoft compute/virtualmachines/{{vmname}}/poweroff method post input argument name type required description parameters api version string required client api version parameters skipshutdown boolean optional the parameter to request non graceful vm shutdown true value for this flag indicates non graceful shutdown whereas false indicates otherwise default value for this flag is false if not specified path parameters resourcegroupname string required the name of the resource group path parameters subscriptionid string required subscription credentials which uniquely identify microsoft azure subscription the subscription id forms part of the uri for every service call path parameters vmname string required the name of the virtual machine input example {"parameters" {"api version" "2024 03 01","skipshutdown"\ false},"path parameters" {"resourcegroupname" "vm357","subscriptionid" "abciz47","vmname" "aaaaa"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","date" "tue, 30 apr 2024 10 36 47 gmt"},"reason" "ok","json body" {}} start virtual machines initiates the start process for an azure vm specified by resource group, subscription id, and vm name endpoint url /subscriptions/{{subscriptionid}}/resourcegroups/{{resourcegroupname}}/providers/microsoft compute/virtualmachines/{{vmname}}/start method post input argument name type required description parameters api version string required client api version path parameters resourcegroupname string required the name of the resource group path parameters subscriptionid string required subscription credentials which uniquely identify microsoft azure subscription the subscription id forms part of the uri for every service call path parameters vmname string required the name of the virtual machine input example {"parameters" {"api version" "2024 03 01"},"path parameters" {"resourcegroupname" "vm357","subscriptionid" "abciz47","vmname" "aaaaa"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","date" "tue, 30 apr 2024 10 36 47 gmt"},"reason" "ok","json body" {}} response headers header description example content encoding http response header content encoding gzip content type the media type of the resource application/json date the date and time at which the message was originated tue, 30 apr 2024 10 36 47 gmt strict transport security http response header strict transport security max age=31536000 transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding