@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag.
*
* Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
*
* Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01, 2025-01-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native storage [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class BlobContainerImmutabilityPolicy extends pulumi.CustomResource {
/**
* Get an existing BlobContainerImmutabilityPolicy 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): BlobContainerImmutabilityPolicy;
/**
* Returns true if the given object is an instance of BlobContainerImmutabilityPolicy. 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 BlobContainerImmutabilityPolicy;
/**
* This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
*/
readonly allowProtectedAppendWrites: pulumi.Output<boolean | undefined>;
/**
* This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
*/
readonly allowProtectedAppendWritesAll: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Resource Etag.
*/
readonly etag: pulumi.Output<string>;
/**
* The immutability period for the blobs in the container since the policy creation, in days.
*/
readonly immutabilityPeriodSinceCreationInDays: pulumi.Output<number | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
*/
readonly state: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a BlobContainerImmutabilityPolicy 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: BlobContainerImmutabilityPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a BlobContainerImmutabilityPolicy resource.
*/
export interface BlobContainerImmutabilityPolicyArgs {
/**
* The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
*/
accountName: pulumi.Input<string>;
/**
* This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
*/
allowProtectedAppendWrites?: pulumi.Input<boolean>;
/**
* This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
*/
allowProtectedAppendWritesAll?: pulumi.Input<boolean>;
/**
* The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
*/
containerName: pulumi.Input<string>;
/**
* The immutability period for the blobs in the container since the policy creation, in days.
*/
immutabilityPeriodSinceCreationInDays?: pulumi.Input<number>;
/**
* The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'
*/
immutabilityPolicyName?: pulumi.Input<string>;
/**
* The name of the resource group within the user's subscription. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}