@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about a disk encryption set.
*
* Uses Azure REST API version 2024-03-02.
*
* Other available API versions: 2022-07-02, 2023-01-02, 2023-04-02, 2023-10-02, 2025-01-02. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDiskEncryptionSet(args: GetDiskEncryptionSetArgs, opts?: pulumi.InvokeOptions): Promise<GetDiskEncryptionSetResult>;
export interface GetDiskEncryptionSetArgs {
/**
* The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
*/
diskEncryptionSetName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* disk encryption set resource.
*/
export interface GetDiskEncryptionSetResult {
/**
* The key vault key which is currently used by this disk encryption set.
*/
readonly activeKey?: outputs.compute.KeyForDiskEncryptionSetResponse;
/**
* The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
*/
readonly autoKeyRotationError: outputs.compute.ApiErrorResponse;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The type of key used to encrypt the data of the disk.
*/
readonly encryptionType?: string;
/**
* Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.
*/
readonly federatedClientId?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
*/
readonly identity?: outputs.compute.EncryptionSetIdentityResponse;
/**
* The time when the active key of this disk encryption set was updated.
*/
readonly lastKeyRotationTimestamp: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
*/
readonly previousKeys: outputs.compute.KeyForDiskEncryptionSetResponse[];
/**
* The disk encryption set provisioning state.
*/
readonly provisioningState: string;
/**
* Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
*/
readonly rotationToLatestKeyVersionEnabled?: boolean;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.compute.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Gets information about a disk encryption set.
*
* Uses Azure REST API version 2024-03-02.
*
* Other available API versions: 2022-07-02, 2023-01-02, 2023-04-02, 2023-10-02, 2025-01-02. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDiskEncryptionSetOutput(args: GetDiskEncryptionSetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDiskEncryptionSetResult>;
export interface GetDiskEncryptionSetOutputArgs {
/**
* The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
*/
diskEncryptionSetName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}