Skip to main content

Create a protection group to protect Azure entities​

Select

SaaS
Customer Managed

Create a protection group to protect Azure entities

Header Parameters
  • AzureSubscriptionId string required

    Azure Subscription Id

  • AzureTenantId string required

    Azure Tenant Id

  • LiftrCorrelationId string required

    Liftr Correlation Id

  • ArmResourceId string required

    Arm Resource Id

  • ArmResourceIdForCCA string required

    Arm Resource Id For CCA

Request Body
  • name string

    Name of the protection group

  • subscriptionId string

    Azure Subscription ID

  • credentials object
  • id int32
  • name string
  • planEntity object
  • id int32
  • name string
  • content object

    Protection group workload content

  • virtualMachine object

    Virtual Machine content to be protected under a Protection Group

  • virtualMachines object[]
  • name string

    Name of the VM to be added as content

  • resourceGroup string

    Resource Group name in which VM is present

  • ruleGroups object[]
  • matchRule MatchRule

    Possible values: [ALL, ANY]

    Enum which specifies the whether to match all rules or any of the rules

  • rules object[]
  • name string

    name of the VM to be added as content

  • type string

    Possible values: [NONE, SERVER, RES_POOL, VAPP, DATACENTER, FOLDER, CLUSTER, DATASTORE, DATASTORE_CLUSTER, VM, VM_NAME, VM_GUEST_OS, VM_GUEST_HOST_NAME, CLUSTER_SHARED_VOLUMES, LOCAL_DISK, CLUSTER_DISK, UNPROTECTED_VMS, ROOT, FILE_SERVER, SMB_SHARE, TYPES_FOLDER, VM_FOLDER, SERVER_FOLDER, TEMPLATE_FOLDER, STORAGE_REPOSITORY_FOLDER, VAPPFOLDER, DATACENTER_FOLDER, CLUSTER_FOLDER, VM_POWER_STATE, VM_NOTES, VM_CUSTOM_ATTRIBUTE, NETWORK, USER, VM_TEMPLATE, TAG, TAG_CATEGORY, SUBCLIENT, CLIENT_GROUP, PROTECTION_DOMAIN, CONSISTENCY_GROUP, INSTANCE_SIZE, ORGANIZATION, IMAGES, STORAGE_POLICY, DATABASE, TABLE, PROJECT, SELECTOR, MANAGED_BY, REPLICATION_MODE, METADATATAG, CATALOG, VAPPTEMPLATE, VOLUME, VM_BADGE]

  • value string

    value for the few type of VM Content like powerstate

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • GUID string

    GUID of the entity to be added as content

  • displayName string

    The display name of the entity to be added

  • workloadType string

    Possible values: [VIRTUAL_MACHINE, OBJECT_STORAGE]

    Protection group workload type

  • resourceId string

    Azure Managed Identity resourceId

Responses

Success

Schema
  • response object
  • id int32
  • name string
POST /v4/cloud/azure/protectiongroup

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
AzureSubscriptionId — header required
AzureTenantId — header required
LiftrCorrelationId — header required
ArmResourceId — header required
ArmResourceIdForCCA — header required
Body
{

  "name": "string",

  "subscriptionId": "string",

  "credentials": {

    "id": 0,

    "name": "string"

  },

  "planEntity": {

    "id": 0,

    "name": "string"

  },

  "content": {

    "virtualMachine": {

      "virtualMachines": [

        {

          "name": "string",

          "resourceGroup": "string"

        }

      ],

      "ruleGroups": [

        {

          "matchRule": "ALL",

          "rules": [

            {

              "name": "string",

              "type": "NONE",

              "value": "string",

              "condition": "CONTAINS",

              "GUID": "string",

              "displayName": "string"

            }

          ]

        }

      ]

    }

  },

  "workloadType": "VIRTUAL_MACHINE",

  "resourceId": "string"

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/v4/Cloud/Azure/ProtectionGroup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "subscriptionId": "string",
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "content": {
    "virtualMachine": {
      "virtualMachines": [
        {
          "name": "string",
          "resourceGroup": "string"
        }
      ],
      "ruleGroups": [
        {
          "matchRule": "ALL",
          "rules": [
            {
              "name": "string",
              "type": "NONE",
              "value": "string",
              "condition": "CONTAINS",
              "GUID": "string",
              "displayName": "string"
            }
          ]
        }
      ]
    }
  },
  "workloadType": "VIRTUAL_MACHINE",
  "resourceId": "string"
}'