Skip to main content

Get Azure permutations

Contributors netapp-ranuk

You can use the permutations endpoint to retrieve the Cloud Volumes ONTAP configuration information.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Get permutations for single node

You can use this workflow to retrieve the Cloud Volumes ONTAP configurations information for a single node working environment.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

GET

/occm/api/azure/vsa/metadata/permutations

Curl example
curl --request GET \
--location "https://cloudmanager.cloud.netapp.com/occm/api/azure/vsa/metadata/permutations" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>" \
--header "Content-Type: application/json"
Additional input parameters

The JSON input example includes the minimum list of parameters.

There are several optional query parameters you can use:

  • region string

  • version string

  • license string

  • instance_type string

  • default_instance_type string

  • feature string

  • latest_only string

  • marketplace_version string

  • marketplace_sku string

Output

The JSON output example includes the list of Cloud Volumes ONTAP configurations.

JSON output example
[
    {
        "ontapVersion": "ONTAP-9.9.0X5.T1.azure",
        "license": {
            "type": "azure-cot-explore-paygo",
            "name": "Cloud Volumes ONTAP Explore",
            "description": "Suitable for smaller capacity applications. Supports up to 2 TB of underlying Azure storage.",
            "subName": "",
            "subDescription": "Support of tiering to object storage is not included.",
            "capacity_limit": "2TB",
            "platformLicenseRequired": false,
            "default": false,
            "capacityLimit": {
                "size": 2.0,
                "unit": "TB"
            }
        },
        "instanceType": "Standard_DS3_v2",
        "region": {
            "name": "East US 2",
            "code": "eastus2",
            "location": "Virginia",
            "s3Region": null
        },
        "defaultInstance": true,
        "features": [
            "four-nics",
            "no-sidl"
        ],
        "upgradeableFrom": [
            "9.8",
            "9.9"
        ]
    },
    {
        "ontapVersion": "ONTAP-9.9.0X5.T1.azure",
        "license": {
            "type": "azure-cot-explore-paygo",
            "name": "Cloud Volumes ONTAP Explore",
            "description": "Suitable for smaller capacity applications. Supports up to 2 TB of underlying Azure storage.",
            "subName": "",
            "subDescription": "Support of tiering to object storage is not included.",
            "capacity_limit": "2TB",
            "platformLicenseRequired": false,
            "default": false,
            "capacityLimit": {
                "size": 2.0,
                "unit": "TB"
            }
        },
        "instanceType": "Standard_DS3_v2",
        "region": {
            "name": "East US 2",
            "code": "eastus2",
            "location": "Virginia",
            "s3Region": null
        },
        "defaultInstance": true,
        "features": [
            "four-nics",
            "no-sidl"
        ],
        "upgradeableFrom": [
            "9.8",
            "9.9"
        ]
    }
]

Get permutations for high availability pair

You can use this workflow to retrieve the Cloud Volumes ONTAP configurations information for an HA working environment.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

GET

/occm/api/azure/ha/metadata/permutations

curl example
curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/azure/ha/metadata/permutations' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>' --header 'Content-Type: application/json'
Additional input parameters

The JSON input example includes the minimum list of parameters.

There are several optional query parameters you can use:

  • region string

  • version string

  • license string

  • instance_type string

  • default_instance_type string

  • feature string

  • latest_only string

  • marketplace_version string

  • marketplace_sku string

Output

The JSON output example includes the list of Cloud Volumes ONTAP configurations.

JSON output example
[
    {
        "ontapVersion": "ONTAP-9.9.0X5.T1.azureha",
        "license": {
            "type": "azure-ha-cot-standard-paygo",
            "name": "Cloud Volumes ONTAP Standard",
            "description": "Flexible performance and larger capacity for a wider range of applications. Supports up to 10 TB of underlying Azure storage.",
            "subName": "",
            "subDescription": "Supports tiering to object storage of replicated volumes and snapshots.",
            "capacity_limit": "10TB",
            "platformLicenseRequired": false,
            "default": true,
            "capacityLimit": {
                "size": 10.0,
                "unit": "TB"
            }
        },
        "instanceType": "Standard_DS4_v2",
        "region": {
            "name": "Southeast Asia",
            "code": "southeastasia",
            "location": "Singapore",
            "s3Region": null
        },
        "defaultInstance": true,
        "features": [],
        "upgradeableFrom": [
            "9.8",
            "9.9"
        ]
    },
    {
        "ontapVersion": "ONTAP-9.9.0X5.T1.azureha",
        "license": {
            "type": "azure-ha-cot-standard-paygo",
            "name": "Cloud Volumes ONTAP Standard",
            "description": "Flexible performance and larger capacity for a wider range of applications. Supports up to 10 TB of underlying Azure storage.",
            "subName": "",
            "subDescription": "Supports tiering to object storage of replicated volumes and snapshots.",
            "capacity_limit": "10TB",
            "platformLicenseRequired": false,
            "default": true,
            "capacityLimit": {
                "size": 10.0,
                "unit": "TB"
            }
        },
        "instanceType": "Standard_DS4_v2",
        "region": {
            "name": "Southeast Asia",
            "code": "southeastasia",
            "location": "Singapore",
            "s3Region": null
        },
        "defaultInstance": true,
        "features": [],
        "upgradeableFrom": [
            "9.8",
            "9.9"
        ]
    }
]