Search <book_title>...

InfoScale™ 9.0 Cluster Server Bundled Agents Reference Guide - Windows

Last Published: 2025-04-13

Product(s): InfoScale & Storage Foundation (9.0)

Platform: Windows

AzureDisk agent

Virtual machines in Azure use data disks to store the applications data. The AzureDisk agent supports managed and unmanaged data disks and provides high availability of these disks during a failover of an application.

The AzureDisk agent brings online, takes offline, and monitors the managed and unmanaged Azure data disks. The agent attaches the managed and unmanaged data disks to a virtual machine of the same resource group or a different resource group. The AzureDisk agent uses Azure Python SDK to determine whether or not the Azure data disks are attached to the Azure virtual machines.

Prerequisites

Configure the AzureAuth agent.

See AzureAuth agent.

Configure an authentication method for authenticating Azure subscription:

To use the AzureAuth agent for a service principal-based authentication, configure the AzureAuth agent.
See AzureAuth agent.
To use an Azure managed identity-based authentication, configure a user-assigned managed identity in the cluster.
See Using Azure managed identity.

Dependencies

The AzureDisk resources depend on the AzureAuth resource.

If an Azure managed identity is configured for authenticating Azure subscription, the AzureDisk resources do not depend on the AzureAuth resource.
If the AzureAuth agent is configured for a service principal-based authentication, the AzureDisk resources depend on the AzureAuth resources.

Figure: Sample service group dependency (if using AzureAuth agent)

os_winSample service group dependency (if using AzureAuth agent)

Agent functions

Open	Fetches the name of the Azure VM.
Online	Attaches the Azure data disk to the Azure VM.
Offline	Detaches the Azure data disk from the Azure VM.
Monitor	Determines if the Azure data disk is attached to the current Azure VM or not.
Clean	Terminates all ongoing resource actions and detaches the Azure data disk from the Azure VM.

State definitions

ONLINE	Indicates that the Azure data disk is attached to the Azure VM.
OFFLINE	Indicates that the Azure data disk is detached from the Azure VM.
FAULTED	Indicates that the Azure data disk was unexpectedly detached from the Azure VM outside of VCS control.
UNKNOWN	Indicates that a problem exists because of one of the following reasons: Azure Python SDK is not installed. Azure VM is not found in the specified Resource Group. Azure data disk is not configured correctly or has invalid ID. Roles are not configured correctly or attached to the instance. The disks are attached to Azure VM of another cluster. DiskIds has a combination of managed and unmanaged disks. Configured unmanaged disks belong to different storage accounts.

Attributes

Table: Required attributes

Attribute	Description
DiskIds	In case of managed disks, resource ID of the disk. In case of unmanaged disks, VHDUri of the disk. You can add one or more disk Ids. Use a space as a separator for multiple entries. Type and dimension: string-vector
VMResourceGroup	Azure resource group where the Azure VM resides. Type and dimension: string-scalar
AzureAuthResName	Name of the authentication agent resource that handles Azure related authentication. This attribute is required only if the AzureAuth agent is configured for using a service principal-based authentication for Azure subscription. This attribute is not required if using managed identities for Azure authentication. Note: If both AzureAuth agent and user-assigned managed identity are configured in the cluster, the AzureAuth agent configuration takes precedence. The cluster defaults to using the AzureAuth service principal-based Azure authentication. Type and dimension: string-scalar
ManagedIdentityClientID	ID of the user-assigned managed identity that is obtained from the Azure portal. This attribute is required only if using managed identity-based authentication for Azure subscription. This attribute is not required if the AzureAuth agent is configured for using a service principal for Azure authentication. Note: If both AzureAuth agent and user-assigned managed identity are configured in the cluster, the AzureAuth agent configuration takes precedence. The cluster defaults to using the AzureAuth service principal-based Azure authentication. Type and dimension: string-scalar
StorageAccountKey	Access key of the storage account. You must encrypt this key by using the vcsencrypt utility. For details, see the Cluster Server Administrator's Guide. This attribute is required only if unmanaged disks are configured. Type and dimension: string-scalar

Table: Optional attribute

Attribute	Description
AzureVMName	Name of the VM in Azure on which agent is running. Type and dimension: string-scalar

Attribute

Description

AzureVMName

Name of the VM in Azure on which agent is running.

Type and dimension: string-scalar

Resource type definition

type AzureDisk (
    static int MonitorTimeout = 120
    static i18nstr ArgList[] = { StorageAccountKey, tempVMName, 
      DiskIds, VMResourceGroup, AzureVMName, 
      "AzureAuthResName:SubscriptionId","AzureAuthResName:ClientId", 
						"AzureAuthResName:SecretKey", "AzureAuthResName:TenantId" }
    str DiskIds[]
    str VMResourceGroup
    str AzureVMName
    str AzureAuthResName
    temp str tempVMName
    str StorageAccountKey
)

type AzureDisk (
    static int FaultOnMonitorTimeouts = 0
    static int MonitorTimeout = 120
    static i18nstr ArgList[] = { StorageAccountKey, tempVMName, DiskIds, 
   	VMResourceGroup, AzureVMName, "AzureAuthResName:SubscriptionId",  
   	"AzureAuthResName:ClientId", "AzureAuthResName:SecretKey", 
   	"AzureAuthResName:TenantId", tempSubscriptionId,   
   	ManagedIdentityClientID }
    str DiskIds[]
    str VMResourceGroup
    str AzureVMName
    str AzureAuthResName
    temp str tempVMName
    str StorageAccountKey
    str ManagedIdentityClientID
    temp str tempSubscriptionId
    )

Sample configuration

Sample configuration using AzureAuth agent

Sample configuration with managed disks:

AzureDisk azure-res-disk (
    DiskIds = { "/subscriptions/6940a326-fgh6-40dd-b616-c1e9bbdf1d63/
    resourceGroups/azureRG/providers/Microsoft.Compute/disks/
    AzureManagedDisk" }
    VMResourceGroup = "azureVMRG"
    AzureAuthResName = "azure-auth-res"
    )

Sample configuration with unmanaged disks:

AzureDisk azure-res-disk (
    DiskIds = { "https://azureunstorageaccount2.blob.core.windows.net/
    vhds/unmanageddisk.vhd" }
    VMResourceGroup = "azureVMRG"
    AzureAuthResName = "azure-auth-res"
    storageAccountKey = fpjNjrNrgRupNnnLhlKHnlRjpKLitIpjTgnTpfNglSls
    )

Sample configuration using a managed identity

Sample configuration with managed disks:

AzureDisk azure-res-disk (
    DiskIds = { "/subscriptions/6940a326-fgh6-40dd-b616-c1e9bbdf1d63
    /resourceGroups/azureRG/providers/Microsoft.Compute/disks/
    AzureManagedDisk" }
    VMResourceGroup = "azureVMRG"
    ManagedIdentityClientID = 1da89bd2-9735-4266-b920-27c23b98f022
    )

Sample configuration with unmanaged disks:

AzureDisk azure-res-disk (
    DiskIds = {"https://azureunstorageaccount2.blob.core.windows.net
    /vhds/unmanageddisk.vhd" }
    VMResourceGroup = "azureVMRG" 
    ManagedIdentityClientID = 1da89bd2-9735-4266-b920-27c23b98f022
    storageAccountKey = fpjNjrNrgRupNnnLhlKHnlRjpKLitIpjTgnTpfNglSls
    )

Debug log levels

The AzureDisk agent uses the DBG_1 debug log level.