IBM Cloud Docs
Azure Disk CSI driver

Azure Disk CSI driver

The Azure Disk CSI driver for IBM Cloud Satellite® implements the CSI specification so that container orchestration tools can manage the lifecycle of Azure Disk volumes.

For an overview of the available features of the Azure Disk CSI driver, see Features.

The Azure Disk CSI driver template for Satellite is currently available for cluster versions 4.7 and later.

Before you can deploy storage templates to clusters in your location, make sure you set up Satellite Config by selecting the Enable cluster admin access for Satellite Config option in the console or including the --enable-config-admin option when you create your cluster.

You cannot customize your storage classes because Satellite Config overwrites your changes.

You cannot scope Satellite storage service to resource groups. However, if you are scoping other resources such as location and cluster to resource groups, you need to add Satellite reader and link administrator role for all resources in the account.

Prerequisites for using Azure Disk

Set up Azure Disk storage for Satellite clusters by creating a storage configuration in your location. When you assign a storage configuration to your clusters, the storage drivers of the selected storage provider are installed in your cluster.

To use the Azure Disk CSI driver storage template, complete the following tasks.

  1. Create an Azure location by using the location template or manually adding Azure hosts to Satellite. If you choose to manually assign hosts, you must label your worker nodes before creating your storage configuration.

  2. Create a Satellite cluster that runs on compute hosts in Azure. Make sure that you select the Enable cluster admin access for Satellite Config option when you create the cluster. If you don't enable Administrator (admin) access for Satellite Config when creating your cluster, you must re-create your cluster and enable admin access before you can deploy storage.

  3. Create your configuration file.

Optional: Labeling your worker nodes for Azure Disk

Complete the following steps to add the required labels to your worker nodes for the Azure Disk CSI driver template.

If you manually assigned your Azure hosts to your Location and did not use the Schematics template in the console, you must label your worker nodes before creating your storage configuration.

  1. List your Azure worker nodes and make a note of the name of each node.

    oc get nodes

  2. Get the details of each node and make a note of the zone that the node is in. For example: eastus-1.

    oc get nodes <node-name> -o yaml | grep zone

  3. Label your worker nodes with the zone value that you retrieved earlier. Replace <node-name> and <zone> with the node name and zone of your worker node. For example, if you have a worker node in zone: eastus-1, use the following commands to add eastus-1 as a label to the worker node in the eastus-1 zone.

    oc label node <node-name> topology.kubernetes.io/zone-
oc label node <node-name> topology.kubernetes.io/zone=<zone> --overwrite

  4. Repeat the previous steps for each worker node

  5. Sign in to your Azure account and retrieve the required parameters. For more information about the parameters, see Cluster config.

Creating and assigning a configuration in the console

  1. Review the parameter reference.

  2. From the Locations console, select the location where you want to create a storage configuration.

  3. Select Storage > Create storage configuration

  4. Enter a name for your configuration.

  5. Select the Storage type.

  6. Select the Version and click Next

  7. If the Storage type that you selected accepts custom parameters, enter them on the Parameters tab.

  8. If the Storage type that you selected requires secrets, enter them on the Secrets tab.

  9. On the Storage classes tab, review the storage classes that are deployed by the configuration or create a custom storage class.

  10. On the Assign to service tab, select the service that you want to assign your configuration to.

  11. Click Complete to assign your storage configuration.

Creating a configuration in the CLI

  1. Review the parameter reference for the template version that you want to use.

  2. Log in to the IBM Cloud CLI.

    ibmcloud login

  3. List your Satellite locations and note the Managed from column.

    ibmcloud sat location ls

  4. Target the Managed from region of your Satellite location. For example, for wdc target us-east. For more information, see Satellite regions.

    ibmcloud target -r us-east

  5. If you use a resource group other than default, target it.

    ibmcloud target -g <resource-group>

  6. Copy one of the following example command for the template version that you want to use. For more information about the command, see ibmcloud sat storage config create in the command reference.

    Example command to create a version 1.4.0 configuration.

    ibmcloud sat storage config create --location LOCATION --name NAME --template-name azuredisk-csi-driver --template-version 1.4.0 --param "tenantId=TENANTID"  --param "subscriptionId=SUBSCRIPTIONID"  --param "aadClientId=AADCLIENTID"  --param "location=LOCATION"  --param "aadClientSecret=AADCLIENTSECRET"  --param "resourceGroup=RESOURCEGROUP"  --param "vmType=VMTYPE"  --param "securityGroupName=SECURITYGROUPNAME"  --param "vnetName=VNETNAME"

    Example command to create a version 1.18.0 configuration.

    ibmcloud sat storage config create --location LOCATION --name NAME --template-name azuredisk-csi-driver --template-version 1.18.0 --param "tenantId=TENANTID"  --param "subscriptionId=SUBSCRIPTIONID"  --param "aadClientId=AADCLIENTID"  --param "location=LOCATION"  --param "aadClientSecret=AADCLIENTSECRET"  --param "resourceGroup=RESOURCEGROUP"  --param "vmType=VMTYPE"  --param "securityGroupName=SECURITYGROUPNAME"  --param "vnetName=VNETNAME"

    Example command to create a version 1.23.0 configuration.

    ibmcloud sat storage config create --location LOCATION --name NAME --template-name azuredisk-csi-driver --template-version 1.23.0 --param "tenantId=TENANTID"  --param "subscriptionId=SUBSCRIPTIONID"  --param "aadClientId=AADCLIENTID"  --param "location=LOCATION"  --param "aadClientSecret=AADCLIENTSECRET"  --param "resourceGroup=RESOURCEGROUP"  --param "vmType=VMTYPE"  --param "securityGroupName=SECURITYGROUPNAME"  --param "vnetName=VNETNAME"

  7. Customize the command based on the settings that you want to use.

  8. Run the command to create a configuration.

  9. Verify your configuration was created.

    ibmcloud sat storage config get --config CONFIG

Creating a configuration in the API

  1. Generate an API key, then request a refresh token. For more information, see Generating an IBM Cloud IAM token by using an API key.

  2. Review the parameter reference for the template version that you want to use.

  3. Copy one of the following example requests and replace the variables that you want to use.

    Example request to create a version 1.4.0 configuration.

    curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"azuredisk-csi-driver\", \"storage-template-version\": \"1.4.0\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"LOCATION\", { \"entry.name\": \"RESOURCEGROUP\", { \"entry.name\": \"VMTYPE\", { \"entry.name\": \"SECURITYGROUPNAME\", { \"entry.name\": \"VNETNAME\",\"user-secret-parameters\": { \"entry.name\": \"TENANTID\",{ \"entry.name\": \"SUBSCRIPTIONID\",{ \"entry.name\": \"AADCLIENTID\",{ \"entry.name\": \"AADCLIENTSECRET\",}

    Example request to create a version 1.18.0 configuration.

    curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"azuredisk-csi-driver\", \"storage-template-version\": \"1.18.0\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"LOCATION\", { \"entry.name\": \"RESOURCEGROUP\", { \"entry.name\": \"VMTYPE\", { \"entry.name\": \"SECURITYGROUPNAME\", { \"entry.name\": \"VNETNAME\",\"user-secret-parameters\": { \"entry.name\": \"TENANTID\",{ \"entry.name\": \"SUBSCRIPTIONID\",{ \"entry.name\": \"AADCLIENTID\",{ \"entry.name\": \"AADCLIENTSECRET\",}

    Example request to create a version 1.23.0 configuration.

    curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"azuredisk-csi-driver\", \"storage-template-version\": \"1.23.0\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"LOCATION\", { \"entry.name\": \"RESOURCEGROUP\", { \"entry.name\": \"VMTYPE\", { \"entry.name\": \"SECURITYGROUPNAME\", { \"entry.name\": \"VNETNAME\",\"user-secret-parameters\": { \"entry.name\": \"TENANTID\",{ \"entry.name\": \"SUBSCRIPTIONID\",{ \"entry.name\": \"AADCLIENTID\",{ \"entry.name\": \"AADCLIENTSECRET\",}

Creating a storage assignment in the console

If you didn't assign your configuration to a cluster or service when you created it, you can create an assignment by completing the following steps.

  1. Open the Satellite console in your browser.
  2. Select the location where you created your storage configuration.
  3. Click the Locations tab, then click Storage.
  4. Click the storage configuration that you want to assign to a cluster group.
  5. On the Configuration details page, click Create storage assignment.
  6. In the Create an assignment pane, enter a name for your assignment.
  7. From the Version drop-down list, select the storage configuration version that you want to assign.
  8. Click Create to create the assignment.
  9. Verify that your storage configuration is deployed to your cluster.
    1. From the Satellite console, navigate to your Location and select Storage
    2. Click the storage configuration that you created and review the Assignments tab.
    3. Click the Assignment that you created and review the Rollout status for your configuration.

Creating an assignment in the CLI

  1. List your storage configurations and make a note of the storage configuration that you want to assign to your clusters.

    ibmcloud sat storage config ls

  2. Get the ID of the cluster, cluster group, or service that you want to assign storage to.

    To make sure that your cluster is registered with Satellite Config or to create groups, see Setting up clusters to use with Satellite Config.

    Example command to list cluster groups.

    ibmcloud sat group ls

    Example command to list clusters.

    ibmcloud oc cluster ls --provider satellite

    Example command to list Satellite services.

    ibmcloud sat service ls --location <location>

  3. Assign your storage configuration to the cluster, group, or service that you retrieved earlier. For more information, see the ibmcloud sat storage assignment create command.

    Example command to assign a configuration to a cluster group.

    ibmcloud sat storage assignment create --group GROUP --config CONFIG --name NAME

    Example command to assign a configuration to a cluster.

    ibmcloud sat storage assignment create --cluster CLUSTER --config CONFIG --name NAME

    Example command to assign a configuration to a service cluster.

    ibmcloud sat storage assignment create --service-cluster-id CLUSTER --config CONFIG --name NAME

  4. Verify that your assignment is created.

    ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)

Creating a storage assignment in the API

  1. Copy one of the following example requests.

    Example request to assign a configuration to a cluster.

    curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createAssignmentByCluster" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"channelName\": \"CONFIGURATION-NAME\", \"cluster\": \"CLUSTER-ID\", \"controller\": \"LOCATION-ID\", \"name\": \"ASSIGNMENT-NAME\"}"

    Example request to assign configuration to a cluster group.

    curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createAssignment" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"channelName\": \"CONFIGURATION-NAME\", \"cluster\": \"string\", \"groups\": [ \"CLUSTER-GROUP\" ], \"name\": \"ASSIGNMENT-NAME\"}"

  2. Replace the variables with your details and run the request.

  3. Verify the assignment was created by listing your assignments.

    curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignments" -H "accept: application/json" -H "Authorization: Bearer TOKEN"

Updating storage assignments in the console

You can use the Satellite console to apply the latest patch updates to your assignments.

  1. From the Locations page in the Satellite console, select your location.

  2. Click the Storage tab to view your configurations.

  3. Click the configuration you want to update.

  4. Click information Information (i) icon to apply the latest revision or patch.

  5. Optional: Enable automatic patch updates for your storage assignment. Enabling automatic patch updates ensures that your assignment always has the latest security fixes.

If you enable automatic patch updates, you must still apply major updates manually.

Manually upgrading assignments in the CLI

Upgrade an assignment to use the latest storage template revision.

  1. List your Satellite storage assignments, make a note of the Satellite assignment you want to upgrade.

    ibmcloud sat storage assignment ls

  2. List the Satellite storage templates to see the latest available versions.

    ibmcloud sat storage template ls

  3. Upgrade the Satellite assignment.

    Example command to upgrade an assignment.

    ibmcloud sat storage assignment upgrade --assignment ASSIGNMENT

Enabling automatic patch updates for configurations and assignments in the CLI

You can use the sat storage assignment autopatch enable CLI to enable automatic patch updates for your assignments. Enabling automatic patch updates applies the latest storage template revisions (patches) automatically. You must still apply major updates manually.

  1. List your Satellite storage configurations. Make a note of the configuration ID.

    ibmcloud sat storage assignment ls

  2. Run one of the following example commands to enable automatic patch updates for your configuration and its associated assignments. Enter the configuration ID that you retrieved in the previous step.

    Example command to enable automatic patch updates for an assignment.

    ibmcloud sat storage assignment autopatch enable --config CONFIG  (--all | --assignment ASSIGNMENT-ID [--assignment ASSIGNMENT-ID])

    Example command to enable automatic patch updates for all storage assignments under a given configuration.

    ibmcloud sat storage assignment autopatch enable --config CONFIG --all

    Example command to disable automatic patch updates for all assignments under a specific configuration.

    ibmcloud sat storage assignment autopatch disable --config CONFIG --all

    Example command to disable automatic patch updates for an single assignment and a specific configuration.

    ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID

    Example command to disable automatic patch updates for an multiple assignment and a specific configuration.

    ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID --assignment ASSIGNMENT-ID

Upgrading a configuration and assignments in the API

You can use the /v2/storage/satellite/updateAssignment API to update your assignments with new clusters or cluster groups. Set updateConfigVersion to true to apply the revision update.

  1. Copy the following example request and replace the variables for the cluster groups and assignments that you want to update.

    curl -X PATCH "https://containers.cloud.ibm.com/global/v2/storage/satellite/updateAssignment" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"groups\": [ \"CLUSTER-GROUPS\" ], \"name\": \"ASSIGNMENT-NAME\", \"updateConfigVersion\": true, \"uuid\": \"ASSIGNMENT-ID\"}"

  2. Run the request.

  3. Get the details of you assignment to verify the update.

    curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN"

Enabling automatic patch updates for assignments in the API

You can use the /v2/storage/satellite/setAssignmentAutoupgrade API to enable automatic patch updates for your assignments. Enabling automatic patch updates applies the latest storage template revisions (patches) automatically. You must still apply major updates manually.

  1. Copy the following example request and replace the variables for the cluster groups and assignments that you want to update.

    curl -X PATCH "https://containers.cloud.ibm.com/global/v2/storage/satellite/setAssignmentAutoupgrade" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d { "config": "string", "controller": "string", "autopatch": boolean,"assignment" : { "all": boolean, "uuid": ["string", "string", ...], } }

  2. Run the request.

  3. Get the details of you assignment to verify the upgrade.

    curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN"

Deploying an app that uses your Azure Disk storage

You can use the Azure Disk driver to create PVCs that you can use in your cluster workloads.

  1. Create a PVC that references an Azure Disk storage class that you created earlier.

    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: pvc-azuredisk
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 10Gi
  storageClassName: sat-azure-block-silver

  2. Create the PVC in your cluster.

    oc apply -f pvc-azuredisk.yaml

  3. Verify that the PVC is created and the status is Bound.

    oc get pvc

  4. Create a YAML configuration file for a stateful set that mounts the PVC that you created.

    apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: statefulset-azuredisk
  labels:
    app: nginx
spec:
  podManagementPolicy: Parallel  # default is OrderedReady
  serviceName: statefulset-azuredisk
  replicas: 1
  template:
    metadata:
      labels:
        app: nginx
    spec:
      nodeSelector:
        "kubernetes.io/os": linux
      containers:
        - name: statefulset-azuredisk
          image: mcr.microsoft.com/oss/nginx/nginx:1.19.5
          command:
            - "/bin/bash"
            - "-c"
            - set -euo pipefail; while true; do echo $(date) >> /mnt/azuredisk/outfile; sleep 1; done
          volumeMounts:
            - name: persistent-storage
              mountPath: /mnt/azuredisk
  updateStrategy:
    type: RollingUpdate
  selector:
    matchLabels:
      app: nginx
  volumeClaimTemplates:
    - metadata:
        name: persistent-storage
        annotations:
          volume.beta.kubernetes.io/storage-class: sat-azure-block-silver
      spec:
        accessModes: ["ReadWriteOnce"]
        resources:
          requests:
            storage: 10Gi

  5. Create the pod in your cluster.

    oc apply -f statefulset-azuredisk.yaml

  6. Verify that the pod is deployed. Note that it might take a few minutes for your app to get into a Running state.

    oc get pods

    NAME                                READY   STATUS    RESTARTS   AGE
statefulset-azuredisk       1/1     Running   0          2m58s

  7. Verify that the app can write to your Azure Disk by logging in to your pod.

    oc exec statefulset-azuredisk -it bash

  8. View the contents of the outfile file to confirm that your app can write data to your persistent storage.

    cat /mnt/azuredisk/outfile

    Example output

    Fri Jul 16 07:49:39 EDT 2021
Fri Jul 16 07:49:39 EDT 2021
Fri Jul 16 07:49:39 EDT 2021

  9. Exit the pod.

    exit

Manually upgrading configurations in the CLI

You can upgrade your Satellite storage configurations to get the latest storage template revision within the same major version.

  1. List your Satellite storage configurations, make a note of the Satellite configuration you want to upgrade.

    ibmcloud sat storage config ls

  2. Upgrade the Satellite configuration. Note, only the configuration is updated. If you want to upgrade the assignments that use this configuration, you can specify the --include-assignments option or you can manually update each assignment using the assignment update command.

    Example command to upgrade a configuration to the latest revision.

    ibmcloud sat storage config upgrade --config CONFIG [--include-assignments]

    Example command to upgrade a configuration and it's associated assignments to the latest revision.

    ibmcloud sat storage config upgrade --config CONFIG --include-assignments

Updating storage assignments in the console

You can use the Satellite console to apply the latest patch updates to your assignments.

  1. From the Locations page in the Satellite console, select your location.

  2. Click the Storage tab to view your configurations.

  3. Click the configuration you want to update.

  4. Click information Information (i) icon to apply the latest revision or patch.

  5. Optional: Enable automatic patch updates for your storage assignment. Enabling automatic patch updates ensures that your assignment always has the latest security fixes.

If you enable automatic patch updates, you must still apply major updates manually.

Removing Azure Disk storage from your apps

If you no longer need your Azure Disk configuration, you can remove your apps, PVCs, PVs, and assignment from your clusters.

  1. List your PVCs and note the name of the PVC that you want to remove.

    oc get pvc

  2. Remove any pods that mount the PVC.

    1. List all the pods that currently mount the PVC that you want to delete. If no pods are returned, you do not have any pods that currently use your PVC.

      oc get pods --all-namespaces -o=jsonpath='{range .items[*]}{"\n"}{.metadata.name}{":\t"}{range .spec.volumes[*]}{.persistentVolumeClaim.claimName}{" "}{end}{end}' | grep "<pvc_name>"

      Example output

      app    sat-azure-block-platinum

    2. Remove the pod that uses the PVC. If the pod is part of a deployment or statefulset, remove the deployment or statefulset.

      oc delete pod <pod_name>

      oc delete deployment <deployment_name>

      oc delete statefulset <statefulset_name>

    3. Verify that the pod, deployment, or statefulset is removed.

      oc get pods

      oc get deployments

      oc get statefulset

  3. Delete the PVC. Because the Azure Disk storage classes have a Delete reclaim policy, the PV and the disks in your Azure account are automatically deleted when you delete the PVC.

    oc delete pvc <pvc_name>

  4. Verify that your PV is automatically removed.

    oc get pv

Removing the Azure Disk storage configuration from your cluster

If you no longer plan on using Azure Disk storage in your cluster, you can use the CLI unassign your cluster from the storage configuration.

Note that if you remove the storage configuration, the driver is then uninstalled from all assigned clusters. Your PVCs, PVs, and data are not removed. However, you might not be able to access your data until you re-install the driver in your cluster again.

Removing the Azure Disk storage configuration from the console

  1. From the Satellite storage dashboard, select the storage configuration you want to delete.
  2. Select Actions > Delete
  3. Enter the name of your storage configuration.
  4. Select Delete.

Removing the Azure Disk storage configuration from the cli

  1. List your storage assignments and find the one that you used for your cluster.

    ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)

  2. Remove the assignment. After the assignment is removed, the driver pods and storage classes are removed from all clusters that were part of the storage assignment.

    ibmcloud sat storage assignment rm --assignment <assignment_ID>

  3. Verify that the driver is removed from your cluster.

    1. List of the storage classes in your cluster and verify that the storage classes are removed.

      oc get sc

    2. List the pods in the kube-system namespace and verify that the storage driver pods are removed.

      oc get pods -n kube-system | grep azure

  4. Optional: Remove the storage configuration.

    1. List the storage configurations.

      ibmcloud sat storage config ls

    2. Remove the storage configuration.

      ibmcloud sat storage config rm --config <config_name>

Parameter reference

1.4.0 parameter reference

Table 1. 1.4.0 parameter reference
Display name CLI option Type Description Required? Default value
Tenant ID tenantId Secret Tenant ID : The Azure tenant ID that you want to use for your configuration. You can find your tenant ID in the Azure portal or by running the az account tenant list command. true N/A
Subscription ID subscriptionId Secret Your Azure subscription ID. From the Azure portal, search for Subscription to find a list of your subscriptions. You can also find your subscription ID by running the az account subscription list command. true N/A
Azure Active Directory Client ID aadClientId Secret Your Azure Active Directory Client ID. You can find your Client ID in the Azure portal or by running the az ad sp list --display-name appDisplayName command. true N/A
Location location Config The location of your Azure hosts. You can find the location of your virtual machines in the Azure portal or by running the az vm list command. Example location: useast. true N/A
Azure Active Directory Client Secret aadClientSecret Secret Your Azure Active Directory Client Secret. You can find your client secret in the Azure portal under the App registrations menu. true N/A
Resource Group resourceGroup Config The name of your Azure resource group. You can find your resource group detail in the Azure portal or by running the az group list command. true N/A
Virtual Machine Type vmType Config You can find your virtual machine type in the Azure portal or by running the az vm list command. Example types: standard or VMSS. true N/A
Network Security Group Name securityGroupName Config The name of your security group. You can find your security group details in the Azure portal or by running the az network nsg list command. true N/A
Virtual Network Name vnetName Config The name of the virtual network. You can find the name of your virtual network in the Azure portal or by running the az network vnet list command. true N/A

1.18.0 parameter reference

Table 2. 1.18.0 parameter reference
Display name CLI option Type Description Required? Default value
Tenant ID tenantId Secret Tenant ID : The Azure tenant ID that you want to use for your configuration. You can find your tenant ID in the Azure portal or by running the az account tenant list command. true N/A
Subscription ID subscriptionId Secret Your Azure subscription ID. From the Azure portal, search for Subscription to find a list of your subscriptions. You can also find your subscription ID by running the az account subscription list command. true N/A
Azure Active Directory Client ID aadClientId Secret Your Azure Active Directory Client ID. You can find your Client ID in the Azure portal or by running the az ad sp list --display-name appDisplayName command. true N/A
Location location Config The location of your Azure hosts. You can find the location of your virtual machines in the Azure portal or by running the az vm list command. Example location: useast. true N/A
Azure Active Directory Client Secret aadClientSecret Secret Your Azure Active Directory Client Secret. You can find your client secret in the Azure portal under the App registrations menu. true N/A
Resource Group resourceGroup Config The name of your Azure resource group. You can find your resource group detail in the Azure portal or by running the az group list command. true N/A
Virtual Machine Type vmType Config You can find your virtual machine type in the Azure portal or by running the az vm list command. Example types: standard or VMSS. true N/A
Network Security Group Name securityGroupName Config The name of your security group. You can find your security group details in the Azure portal or by running the az network nsg list command. true N/A
Virtual Network Name vnetName Config The name of the virtual network. You can also find the name of your virtual network in the Azure portal or by running the az network vnet list command. true N/A

1.23.0 parameter reference

Table 3. 1.23.0 parameter reference
Display name CLI option Type Description Required? Default value
Tenant ID tenantId Secret Tenant ID : The Azure tenant ID that you want to use for your configuration. You can find your tenant ID in the Azure portal or by running the az account tenant list command. true N/A
Subscription ID subscriptionId Secret Your Azure subscription ID. From the Azure portal, search for Subscription to find a list of your subscriptions. You can also find your subscription ID by running the az account subscription list command. true N/A
Azure Active Directory Client ID aadClientId Secret Your Azure Active Directory Client ID. You can find your Client ID in the Azure portal or by running the az ad sp list --display-name appDisplayName command. true N/A
Location location Config The location of your Azure hosts. You can find the location of your virtual machines in the Azure portal or by running the az vm list command. Example location: useast. true N/A
Azure Active Directory Client Secret aadClientSecret Secret Your Azure Active Directory Client Secret. You can find your client secret in the Azure portal under the App registrations menu. true N/A
Resource Group resourceGroup Config The name of your Azure resource group. You can find your resource group detail in the Azure portal or by running the az group list command. true N/A
Virtual Machine Type vmType Config You can find your virtual machine type in the Azure portal or by running the az vm list command. Example types: standard or VMSS. true N/A
Network Security Group Name securityGroupName Config The name of your security group. You can find your security group details in the Azure portal or by running the az network nsg list command. true N/A
Virtual Network Name vnetName Config The name of the virtual network. You can find the name of your virtual network in the Azure portal or by running the az network vnet list command. true N/A

Storage class reference for Azure Disk

Table 2. Storage class reference for Azure Disk storage
Storage class name IOPS range per disk Size range Disk type Reclaim policy Volume Binding Mode
sat-azure-block-platinum 1200 - 160000 4 GiB - 64 TiB SSD Delete Immediate
sat-azure-block-platinum-metro 1200 - 160000 4 GiB - 64 TiB SSD Delete WaitForFirstConsumer
sat-azure-block-gold 120 - 20000 32 GiB - 32 TiB SSD Delete Immediate
sat-azure-block-gold-metro Default 120 - 20000 32 GiB - 32 TiB SSD Delete WaitForFirstConsumer
sat-azure-block-silver 120 - 6000 N/A SSD Delete Immediate
sat-azure-block-silver-metro 120 - 6000 N/A SSD Delete WaitForFirstConsumer
sat-azure-block-bronze 500 - 2000 32 GiB - 32 TiB HDD Delete Immediate
sat-azure-block-bronze-metro 500 - 2000 32 GiB - 32 TiB HDD Delete WaitForFirstConsumer

Getting help and support for Azure Disk storage

When you use Azure Disk Storage, try the following resources before you open a support case.

  1. Review the FAQs in the Azure Knowledge Center.
  2. Review the troubleshooting documentation to troubleshoot and resolve common issues.
  3. Check the status of the IBM Cloud platform and resources by going to the Status page.
  4. Review Stack Overflow to see whether other users experienced the same problem. Tag any questions with ibm-cloud and Azure-Disk.
  5. Search the Azure Service Portal for more information.