@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get HCI cluster.
*
* Uses Azure REST API version 2024-04-01.
*
* Other available API versions: 2022-12-15-preview, 2023-02-01, 2023-03-01, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-09-01-preview, 2024-12-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native azurestackhci [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>;
export interface GetClusterArgs {
/**
* The name of the cluster.
*/
clusterName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Cluster details.
*/
export interface GetClusterResult {
/**
* Object id of cluster AAD identity.
*/
readonly aadApplicationObjectId?: string;
/**
* App id of cluster AAD identity.
*/
readonly aadClientId?: string;
/**
* Id of cluster identity service principal.
*/
readonly aadServicePrincipalObjectId?: string;
/**
* Tenant id of cluster AAD identity.
*/
readonly aadTenantId?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Type of billing applied to the resource.
*/
readonly billingModel: string;
/**
* Unique, immutable resource id.
*/
readonly cloudId: string;
/**
* Endpoint configured for management from the Azure portal.
*/
readonly cloudManagementEndpoint?: string;
/**
* Overall connectivity status for the cluster resource.
*/
readonly connectivityStatus: string;
/**
* Desired properties of the cluster.
*/
readonly desiredProperties?: outputs.azurestackhci.ClusterDesiredPropertiesResponse;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
*/
readonly isolatedVmAttestationConfiguration: outputs.azurestackhci.IsolatedVmAttestationConfigurationResponse;
/**
* Most recent billing meter timestamp.
*/
readonly lastBillingTimestamp: string;
/**
* Most recent cluster sync timestamp.
*/
readonly lastSyncTimestamp: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* Log Collection properties of the cluster.
*/
readonly logCollectionProperties?: outputs.azurestackhci.LogCollectionPropertiesResponse;
/**
* The name of the resource
*/
readonly name: string;
/**
* The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
*/
readonly principalId: string;
/**
* Provisioning state.
*/
readonly provisioningState: string;
/**
* First cluster sync timestamp.
*/
readonly registrationTimestamp: string;
/**
* RemoteSupport properties of the cluster.
*/
readonly remoteSupportProperties?: outputs.azurestackhci.RemoteSupportPropertiesResponse;
/**
* Properties reported by cluster agent.
*/
readonly reportedProperties: outputs.azurestackhci.ClusterReportedPropertiesResponse;
/**
* Object id of RP Service Principal
*/
readonly resourceProviderObjectId: string;
/**
* Region specific DataPath Endpoint of the cluster.
*/
readonly serviceEndpoint: string;
/**
* Software Assurance properties of the cluster.
*/
readonly softwareAssuranceProperties?: outputs.azurestackhci.SoftwareAssurancePropertiesResponse;
/**
* Status of the cluster agent.
*/
readonly status: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.azurestackhci.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
*/
readonly tenantId: string;
/**
* Number of days remaining in the trial period.
*/
readonly trialDaysRemaining: number;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
*/
readonly userAssignedIdentities?: {
[key: string]: outputs.azurestackhci.UserAssignedIdentityResponse;
};
}
/**
* Get HCI cluster.
*
* Uses Azure REST API version 2024-04-01.
*
* Other available API versions: 2022-12-15-preview, 2023-02-01, 2023-03-01, 2023-06-01, 2023-08-01, 2023-08-01-preview, 2023-11-01-preview, 2024-01-01, 2024-02-15-preview, 2024-09-01-preview, 2024-12-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native azurestackhci [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getClusterOutput(args: GetClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClusterResult>;
export interface GetClusterOutputArgs {
/**
* The name of the cluster.
*/
clusterName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}