@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md
*
* Uses Azure REST API version 2024-03-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
*
* Other available API versions: 2023-05-01, 2023-11-01-preview, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native storagecache [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Cache extends pulumi.CustomResource {
/**
* Get an existing Cache resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Cache;
/**
* Returns true if the given object is an instance of Cache. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Cache;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The size of this Cache, in GB.
*/
readonly cacheSizeGB: pulumi.Output<number | undefined>;
/**
* Specifies Directory Services settings of the cache.
*/
readonly directoryServicesSettings: pulumi.Output<outputs.storagecache.CacheDirectorySettingsResponse | undefined>;
/**
* Specifies encryption settings of the cache.
*/
readonly encryptionSettings: pulumi.Output<outputs.storagecache.CacheEncryptionSettingsResponse | undefined>;
/**
* Health of the cache.
*/
readonly health: pulumi.Output<outputs.storagecache.CacheHealthResponse>;
/**
* The identity of the cache, if configured.
*/
readonly identity: pulumi.Output<outputs.storagecache.CacheIdentityResponse | undefined>;
/**
* Region name string.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Array of IPv4 addresses that can be used by clients mounting this cache.
*/
readonly mountAddresses: pulumi.Output<string[]>;
/**
* Name of cache.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies network settings of the cache.
*/
readonly networkSettings: pulumi.Output<outputs.storagecache.CacheNetworkSettingsResponse | undefined>;
/**
* Specifies the priming jobs defined in the cache.
*/
readonly primingJobs: pulumi.Output<outputs.storagecache.PrimingJobResponse[]>;
/**
* ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Specifies security settings of the cache.
*/
readonly securitySettings: pulumi.Output<outputs.storagecache.CacheSecuritySettingsResponse | undefined>;
/**
* SKU for the cache.
*/
readonly sku: pulumi.Output<outputs.storagecache.CacheResponseSku | undefined>;
/**
* Specifies the space allocation percentage for each storage target in the cache.
*/
readonly spaceAllocation: pulumi.Output<outputs.storagecache.StorageTargetSpaceAllocationResponse[]>;
/**
* Subnet used for the cache.
*/
readonly subnet: pulumi.Output<string | undefined>;
/**
* The system meta data relating to this resource.
*/
readonly systemData: pulumi.Output<outputs.storagecache.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Type of the cache; Microsoft.StorageCache/Cache
*/
readonly type: pulumi.Output<string>;
/**
* Upgrade settings of the cache.
*/
readonly upgradeSettings: pulumi.Output<outputs.storagecache.CacheUpgradeSettingsResponse | undefined>;
/**
* Upgrade status of the cache.
*/
readonly upgradeStatus: pulumi.Output<outputs.storagecache.CacheUpgradeStatusResponse>;
/**
* Availability zones for resources. This field should only contain a single element in the array.
*/
readonly zones: pulumi.Output<string[] | undefined>;
/**
* Create a Cache resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CacheArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Cache resource.
*/
export interface CacheArgs {
/**
* Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
*/
cacheName?: pulumi.Input<string>;
/**
* The size of this Cache, in GB.
*/
cacheSizeGB?: pulumi.Input<number>;
/**
* Specifies Directory Services settings of the cache.
*/
directoryServicesSettings?: pulumi.Input<inputs.storagecache.CacheDirectorySettingsArgs>;
/**
* Specifies encryption settings of the cache.
*/
encryptionSettings?: pulumi.Input<inputs.storagecache.CacheEncryptionSettingsArgs>;
/**
* The identity of the cache, if configured.
*/
identity?: pulumi.Input<inputs.storagecache.CacheIdentityArgs>;
/**
* Region name string.
*/
location?: pulumi.Input<string>;
/**
* Specifies network settings of the cache.
*/
networkSettings?: pulumi.Input<inputs.storagecache.CacheNetworkSettingsArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Specifies security settings of the cache.
*/
securitySettings?: pulumi.Input<inputs.storagecache.CacheSecuritySettingsArgs>;
/**
* SKU for the cache.
*/
sku?: pulumi.Input<inputs.storagecache.CacheSkuArgs>;
/**
* Subnet used for the cache.
*/
subnet?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Upgrade settings of the cache.
*/
upgradeSettings?: pulumi.Input<inputs.storagecache.CacheUpgradeSettingsArgs>;
/**
* Availability zones for resources. This field should only contain a single element in the array.
*/
zones?: pulumi.Input<pulumi.Input<string>[]>;
}