AzurestackhciFunctions

Functions

Link copied to clipboard

Get ArcSetting resource details of HCI Cluster. Uses Azure REST API version 2023-03-01. Other available API versions: 2021-09-01-preview, 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getArcSetting(arcSettingName: String, clusterName: String, resourceGroupName: String): GetArcSettingResult
Link copied to clipboard

Get HCI cluster. Uses Azure REST API version 2023-03-01. Other available API versions: 2022-01-01, 2022-09-01, 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getCluster(argument: suspend GetClusterPlainArgsBuilder.() -> Unit): GetClusterResult
suspend fun getCluster(clusterName: String, resourceGroupName: String): GetClusterResult
Link copied to clipboard

Get a DeploymentSetting Uses Azure REST API version 2023-08-01-preview. Other available API versions: 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getDeploymentSetting(clusterName: String, deploymentSettingsName: String, resourceGroupName: String): GetDeploymentSettingResult
Link copied to clipboard

Get a EdgeDevice Uses Azure REST API version 2023-08-01-preview. Other available API versions: 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getEdgeDevice(edgeDeviceName: String, resourceUri: String): GetEdgeDeviceResult
Link copied to clipboard

Get particular Arc Extension of HCI Cluster. Uses Azure REST API version 2023-03-01. Other available API versions: 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getExtension(arcSettingName: String, clusterName: String, extensionName: String, resourceGroupName: String): GetExtensionResult
Link copied to clipboard

Gets a gallery image Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getGalleryImage(galleryImageName: String, resourceGroupName: String): GetGalleryImageResult
Link copied to clipboard

Implements GuestAgent GET method. Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getGuestAgent(name: String, resourceGroupName: String, virtualMachineName: String): GetGuestAgentResult
Link copied to clipboard

Get a EdgeDeviceJob Uses Azure REST API version 2024-09-01-preview.

suspend fun getHciEdgeDeviceJob(edgeDeviceName: String, jobsName: String, resourceUri: String): GetHciEdgeDeviceJobResult
Link copied to clipboard

Implements HybridIdentityMetadata GET method. Uses Azure REST API version 2022-12-15-preview.

suspend fun getHybridIdentityMetadatum(metadataName: String, resourceGroupName: String, virtualMachineName: String): GetHybridIdentityMetadatumResult
Link copied to clipboard

The logical network resource definition. Uses Azure REST API version 2023-09-01-preview. Other available API versions: 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getLogicalNetwork(logicalNetworkName: String, resourceGroupName: String): GetLogicalNetworkResult
Link copied to clipboard

The operation to get the extension. Uses Azure REST API version 2022-12-15-preview.

suspend fun getMachineExtension(extensionName: String, name: String, resourceGroupName: String): GetMachineExtensionResult
Link copied to clipboard

Gets a marketplace gallery image Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getMarketplaceGalleryImage(marketplaceGalleryImageName: String, resourceGroupName: String): GetMarketplaceGalleryImageResult
Link copied to clipboard

Gets a network interface Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getNetworkInterface(networkInterfaceName: String, resourceGroupName: String): GetNetworkInterfaceResult
Link copied to clipboard

Gets the specified network security group. Uses Azure REST API version 2024-02-01-preview. Other available API versions: 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getNetworkSecurityGroup(networkSecurityGroupName: String, resourceGroupName: String): GetNetworkSecurityGroupResult
Link copied to clipboard

Gets the specified security rule. Uses Azure REST API version 2024-02-01-preview. Other available API versions: 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getSecurityRule(networkSecurityGroupName: String, resourceGroupName: String, securityRuleName: String): GetSecurityRuleResult
Link copied to clipboard

Get a SecuritySetting Uses Azure REST API version 2023-11-01-preview. Other available API versions: 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getSecuritySetting(clusterName: String, resourceGroupName: String, securitySettingsName: String): GetSecuritySettingResult
Link copied to clipboard

Gets a storage container Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getStorageContainer(resourceGroupName: String, storageContainerName: String): GetStorageContainerResult
Link copied to clipboard

Get specified Update Uses Azure REST API version 2023-03-01. Other available API versions: 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getUpdate(argument: suspend GetUpdatePlainArgsBuilder.() -> Unit): GetUpdateResult
suspend fun getUpdate(clusterName: String, resourceGroupName: String, updateName: String): GetUpdateResult
Link copied to clipboard

Get the Update run for a specified update Uses Azure REST API version 2023-03-01. Other available API versions: 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getUpdateRun(clusterName: String, resourceGroupName: String, updateName: String, updateRunName: String): GetUpdateRunResult
Link copied to clipboard

Get all Update summaries under the HCI cluster Uses Azure REST API version 2023-03-01. Other available API versions: 2022-12-15-preview, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-04-01, 2024-09-01-preview, 2024-12-01-preview.

suspend fun getUpdateSummary(clusterName: String, resourceGroupName: String): GetUpdateSummaryResult
Link copied to clipboard

Gets a virtual hard disk Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

suspend fun getVirtualHardDisk(resourceGroupName: String, virtualHardDiskName: String): GetVirtualHardDiskResult
Link copied to clipboard

Gets a virtual machine Uses Azure REST API version 2022-12-15-preview.

suspend fun getVirtualMachine(resourceGroupName: String, virtualMachineName: String): GetVirtualMachineResult
Link copied to clipboard

Gets a virtual machine instance Uses Azure REST API version 2023-07-01-preview. Other available API versions: 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01-preview, 2025-04-01-preview.

Link copied to clipboard

The virtual network resource definition. Uses Azure REST API version 2022-12-15-preview. Other available API versions: 2023-07-01-preview.

suspend fun getVirtualNetwork(resourceGroupName: String, virtualNetworkName: String): GetVirtualNetworkResult