CloudGuard Azure Virtual Machine API

The Azure Virtual Machine API from CloudGuard — 2 operation(s) for azure virtual machine.

Operations 2

GET /v2/AzureVirtualMachine Get #
GET /v2/AzureVirtualMachine/{id} Get #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudguard-azure-virtual-machine-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudguard-azure-virtual-machine-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Inventory - Azure Azure Virtual Machine API
  version: v2
servers:
- url: https://api.dome9.com/
  description: US region
- url: https://api.{region}.dome9.com/
  description: Other regions
  variables:
    region:
      enum:
      - eu1
      - ap1
      - ap2
      - ap3
      - cace1
      default: eu1
security:
- basic: []
tags:
- name: Azure Virtual Machine
paths:
  /v2/AzureVirtualMachine:
    get:
      tags:
      - Azure Virtual Machine
      operationId: AzureVirtualMachine_Get_get_/v2/AzureVirtualMachine
      parameters:
      - name: cloudAccountId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureVirtualMachineViewModel'
      description: ''
      summary: Get
  /v2/AzureVirtualMachine/{id}:
    get:
      tags:
      - Azure Virtual Machine
      operationId: AzureVirtualMachine_Get_get_/v2/AzureVirtualMachine/{id}
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureVirtualMachineViewModel'
      description: ''
      summary: Get
components:
  schemas:
    CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineDisk:
      type: object
      properties:
        name:
          type: string
        status:
          $ref: '#/components/schemas/CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineStatus'
        encryptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineDiskEncryptionSettings'
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiskEncryptionSetParametersViewModel:
      type: object
      properties:
        id:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureNicIpConfigurationViewModel:
      type: object
      properties:
        isPrimary:
          type: boolean
        privateIPAddressVersion:
          type: string
        name:
          type: string
        publicIPAddress:
          type: string
        publicIPAllocationMethod:
          enum:
          - Unallocated
          - Dynamic
          - Static
          type: string
        dnsName:
          type: string
        privateIPAddress:
          type: string
        privateIPAllocationMethod:
          enum:
          - Unallocated
          - Dynamic
          - Static
          type: string
        subnet:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeSubResourceViewModel:
      type: object
      properties:
        id:
          type: string
    Dome9.Web.Api.Models.VirtualMachineExtensionViewModel:
      type: object
      properties:
        forceUpdateTag:
          type: string
        publisher:
          type: string
        virtualMachineExtensionType:
          type: string
        typeHandlerVersion:
          type: string
        autoUpgradeMinorVersion:
          type: boolean
        provisioningState:
          type: string
        status:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeKeyVaultSecretReferenceViewModel:
      type: object
      properties:
        secretUrl:
          type: string
        sourceVault:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeSubResourceViewModel'
    Dome9.Web.Api.Models.AzureNetworkInterfaceDnsSettingsViewModel:
      type: object
      properties:
        appliedDNSServers:
          type: array
          items:
            type: string
        dnsServers:
          type: array
          items:
            type: string
        internalDNSNameLabel:
          type: string
        internalFQDN:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVirtualHardDiskViewModel:
      type: object
      properties:
        uri:
          type: string
    Dome9.Web.Api.Models.AzureNetworkInterfaceViewModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        dnsSettings:
          $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureNetworkInterfaceDnsSettingsViewModel'
        ipConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureNicIpConfigurationViewModel'
        subnet:
          type: string
        enableIPForwarding:
          type: boolean
        primary:
          type: boolean
        macAddress:
          type: string
        networkSecurityGroup:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDataDiskViewModel:
      type: object
      properties:
        lun:
          format: int32
          type: integer
        name:
          type: string
        vhd:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVirtualHardDiskViewModel'
        image:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVirtualHardDiskViewModel'
        caching:
          type: string
        writeAcceleratorEnabled:
          type: boolean
        createOption:
          type: string
        diskSizeGB:
          format: int32
          type: integer
        managedDisk:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeManagedDiskParametersViewModel'
        toBeDetached:
          type: boolean
        diskIOPSReadWrite:
          format: int32
          type: integer
        diskMBpsReadWrite:
          format: int32
          type: integer
        detachOption:
          type: string
        deleteOption:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeKeyVaultKeyReferenceViewModel:
      type: object
      properties:
        keyUrl:
          type: string
        sourceVault:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeSubResourceViewModel'
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiskEncryptionSettingsViewModel:
      type: object
      properties:
        diskEncryptionKey:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeKeyVaultSecretReferenceViewModel'
        keyEncryptionKey:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeKeyVaultKeyReferenceViewModel'
        enabled:
          type: boolean
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiffDiskSettingsViewModel:
      type: object
      properties:
        option:
          type: string
        placement:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeManagedDiskParametersViewModel:
      type: object
      properties:
        storageAccountType:
          type: string
        diskEncryptionSet:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiskEncryptionSetParametersViewModel'
        securityProfile:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVMDiskSecurityProfileViewModel'
        id:
          type: string
    CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineDiskEncryptionSettings:
      type: object
      properties:
        diskEncryptionKey:
          type: string
        keyEncryptionKey:
          type: string
        enabled:
          type: boolean
    CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineStatus:
      type: object
      properties:
        code:
          type: string
        displayStatus:
          type: string
        level:
          type: string
        message:
          type: string
        time:
          format: date-time
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeStorageProfileViewModel:
      type: object
      properties:
        imageReference:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeImageReferenceViewModel'
        osDisk:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeOSDiskViewModel'
        dataDisks:
          type: array
          items:
            $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDataDiskViewModel'
        diskControllerType:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeImageReferenceViewModel:
      type: object
      properties:
        publisher:
          type: string
        offer:
          type: string
        sku:
          type: string
        version:
          type: string
        exactVersion:
          type: string
        sharedGalleryImageId:
          type: string
        communityGalleryImageId:
          type: string
        id:
          type: string
    CGN.Inventory.Azure.Model.WrapperModels.Compute.MachineImage:
      type: object
      properties:
        id:
          type: string
        offer:
          type: string
        publisher:
          type: string
        sku:
          type: string
        version:
          type: string
        exactVersion:
          type: string
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeOSDiskViewModel:
      type: object
      properties:
        osType:
          type: string
        encryptionSettings:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiskEncryptionSettingsViewModel'
        name:
          type: string
        vhd:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVirtualHardDiskViewModel'
        image:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVirtualHardDiskViewModel'
        caching:
          type: string
        writeAcceleratorEnabled:
          type: boolean
        diffDiskSettings:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiffDiskSettingsViewModel'
        createOption:
          type: string
        diskSizeGB:
          format: int32
          type: integer
        managedDisk:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeManagedDiskParametersViewModel'
        deleteOption:
          type: string
    CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineAgent:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineStatus'
        vmAgentVersion:
          type: string
    Dome9.Web.Api.Models.AzureVirtualMachineViewModel:
      type: object
      properties:
        externalId:
          type: string
        id:
          type: string
        accountId:
          format: int64
          type: integer
        cloudAccountId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
        region:
          type: string
        resourceGroup:
          type: string
        virtualNetworkId:
          type: string
        virtualNetworkName:
          type: string
        isRunning:
          type: boolean
        agent:
          $ref: '#/components/schemas/CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineAgent'
        disks:
          type: array
          items:
            $ref: '#/components/schemas/CGN.Inventory.Azure.Model.WrapperModels.Compute.VirtualMachineDisk'
        networkInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureNetworkInterfaceViewModel'
        operatingSystem:
          type: string
        size:
          type: string
        machineImage:
          $ref: '#/components/schemas/CGN.Inventory.Azure.Model.WrapperModels.Compute.MachineImage'
        virtualHardDiskUri:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
        isBillable:
          type: boolean
        extensions:
          type: array
          items:
            $ref: '#/components/schemas/Dome9.Web.Api.Models.VirtualMachineExtensionViewModel'
        availabilityZones:
          type: array
          items:
            type: string
        vmId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        timeCreated:
          format: date-time
          type: string
        storageProfile:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeStorageProfileViewModel'
    Dome9.Web.Api.Azure.VirtualMachines.AzureComputeVMDiskSecurityProfileViewModel:
      type: object
      properties:
        securityEncryptionType:
          type: string
        diskEncryptionSet:
          $ref: '#/components/schemas/Dome9.Web.Api.Azure.VirtualMachines.AzureComputeDiskEncryptionSetParametersViewModel'
  securitySchemes:
    basic:
      type: http
      scheme: basic
x-readme:
  explorer-enabled: true
  proxy-enabled: true