We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages a Storage Blob Inventory Policy.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
BlobProperties = new Azure.Storage.Inputs.AccountBlobPropertiesArgs
{
VersioningEnabled = true,
},
});
var exampleContainer = new Azure.Storage.Container("exampleContainer", new Azure.Storage.ContainerArgs
{
StorageAccountName = exampleAccount.Name,
ContainerAccessType = "private",
});
var exampleBlobInventoryPolicy = new Azure.Storage.BlobInventoryPolicy("exampleBlobInventoryPolicy", new Azure.Storage.BlobInventoryPolicyArgs
{
StorageAccountId = exampleAccount.Id,
Rules =
{
new Azure.Storage.Inputs.BlobInventoryPolicyRuleArgs
{
Name = "rule1",
StorageContainerName = exampleContainer.Name,
Format = "Csv",
Schedule = "Daily",
Scope = "Container",
SchemaFields =
{
"Name",
"Last-Modified",
},
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
BlobProperties: &storage.AccountBlobPropertiesArgs{
VersioningEnabled: pulumi.Bool(true),
},
})
if err != nil {
return err
}
exampleContainer, err := storage.NewContainer(ctx, "exampleContainer", &storage.ContainerArgs{
StorageAccountName: exampleAccount.Name,
ContainerAccessType: pulumi.String("private"),
})
if err != nil {
return err
}
_, err = storage.NewBlobInventoryPolicy(ctx, "exampleBlobInventoryPolicy", &storage.BlobInventoryPolicyArgs{
StorageAccountId: exampleAccount.ID(),
Rules: storage.BlobInventoryPolicyRuleArray{
&storage.BlobInventoryPolicyRuleArgs{
Name: pulumi.String("rule1"),
StorageContainerName: exampleContainer.Name,
Format: pulumi.String("Csv"),
Schedule: pulumi.String("Daily"),
Scope: pulumi.String("Container"),
SchemaFields: pulumi.StringArray{
pulumi.String("Name"),
pulumi.String("Last-Modified"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
blobProperties: {
versioningEnabled: true,
},
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
storageAccountName: exampleAccount.name,
containerAccessType: "private",
});
const exampleBlobInventoryPolicy = new azure.storage.BlobInventoryPolicy("exampleBlobInventoryPolicy", {
storageAccountId: exampleAccount.id,
rules: [{
name: "rule1",
storageContainerName: exampleContainer.name,
format: "Csv",
schedule: "Daily",
scope: "Container",
schemaFields: [
"Name",
"Last-Modified",
],
}],
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS",
blob_properties=azure.storage.AccountBlobPropertiesArgs(
versioning_enabled=True,
))
example_container = azure.storage.Container("exampleContainer",
storage_account_name=example_account.name,
container_access_type="private")
example_blob_inventory_policy = azure.storage.BlobInventoryPolicy("exampleBlobInventoryPolicy",
storage_account_id=example_account.id,
rules=[azure.storage.BlobInventoryPolicyRuleArgs(
name="rule1",
storage_container_name=example_container.name,
format="Csv",
schedule="Daily",
scope="Container",
schema_fields=[
"Name",
"Last-Modified",
],
)])
Example coming soon!
Create BlobInventoryPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BlobInventoryPolicy(name: string, args: BlobInventoryPolicyArgs, opts?: CustomResourceOptions);@overload
def BlobInventoryPolicy(resource_name: str,
args: BlobInventoryPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BlobInventoryPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
rules: Optional[Sequence[BlobInventoryPolicyRuleArgs]] = None,
storage_account_id: Optional[str] = None,
storage_container_name: Optional[str] = None)func NewBlobInventoryPolicy(ctx *Context, name string, args BlobInventoryPolicyArgs, opts ...ResourceOption) (*BlobInventoryPolicy, error)public BlobInventoryPolicy(string name, BlobInventoryPolicyArgs args, CustomResourceOptions? opts = null)
public BlobInventoryPolicy(String name, BlobInventoryPolicyArgs args)
public BlobInventoryPolicy(String name, BlobInventoryPolicyArgs args, CustomResourceOptions options)
type: azure:storage:BlobInventoryPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BlobInventoryPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BlobInventoryPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BlobInventoryPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BlobInventoryPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BlobInventoryPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var blobInventoryPolicyResource = new Azure.Storage.BlobInventoryPolicy("blobInventoryPolicyResource", new()
{
Rules = new[]
{
new Azure.Storage.Inputs.BlobInventoryPolicyRuleArgs
{
Format = "string",
Name = "string",
Schedule = "string",
SchemaFields = new[]
{
"string",
},
Scope = "string",
StorageContainerName = "string",
Filter = new Azure.Storage.Inputs.BlobInventoryPolicyRuleFilterArgs
{
BlobTypes = new[]
{
"string",
},
IncludeBlobVersions = false,
IncludeSnapshots = false,
PrefixMatches = new[]
{
"string",
},
},
},
},
StorageAccountId = "string",
});
example, err := storage.NewBlobInventoryPolicy(ctx, "blobInventoryPolicyResource", &storage.BlobInventoryPolicyArgs{
Rules: storage.BlobInventoryPolicyRuleArray{
&storage.BlobInventoryPolicyRuleArgs{
Format: pulumi.String("string"),
Name: pulumi.String("string"),
Schedule: pulumi.String("string"),
SchemaFields: pulumi.StringArray{
pulumi.String("string"),
},
Scope: pulumi.String("string"),
StorageContainerName: pulumi.String("string"),
Filter: &storage.BlobInventoryPolicyRuleFilterArgs{
BlobTypes: pulumi.StringArray{
pulumi.String("string"),
},
IncludeBlobVersions: pulumi.Bool(false),
IncludeSnapshots: pulumi.Bool(false),
PrefixMatches: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
StorageAccountId: pulumi.String("string"),
})
var blobInventoryPolicyResource = new BlobInventoryPolicy("blobInventoryPolicyResource", BlobInventoryPolicyArgs.builder()
.rules(BlobInventoryPolicyRuleArgs.builder()
.format("string")
.name("string")
.schedule("string")
.schemaFields("string")
.scope("string")
.storageContainerName("string")
.filter(BlobInventoryPolicyRuleFilterArgs.builder()
.blobTypes("string")
.includeBlobVersions(false)
.includeSnapshots(false)
.prefixMatches("string")
.build())
.build())
.storageAccountId("string")
.build());
blob_inventory_policy_resource = azure.storage.BlobInventoryPolicy("blobInventoryPolicyResource",
rules=[{
"format": "string",
"name": "string",
"schedule": "string",
"schema_fields": ["string"],
"scope": "string",
"storage_container_name": "string",
"filter": {
"blob_types": ["string"],
"include_blob_versions": False,
"include_snapshots": False,
"prefix_matches": ["string"],
},
}],
storage_account_id="string")
const blobInventoryPolicyResource = new azure.storage.BlobInventoryPolicy("blobInventoryPolicyResource", {
rules: [{
format: "string",
name: "string",
schedule: "string",
schemaFields: ["string"],
scope: "string",
storageContainerName: "string",
filter: {
blobTypes: ["string"],
includeBlobVersions: false,
includeSnapshots: false,
prefixMatches: ["string"],
},
}],
storageAccountId: "string",
});
type: azure:storage:BlobInventoryPolicy
properties:
rules:
- filter:
blobTypes:
- string
includeBlobVersions: false
includeSnapshots: false
prefixMatches:
- string
format: string
name: string
schedule: string
schemaFields:
- string
scope: string
storageContainerName: string
storageAccountId: string
BlobInventoryPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BlobInventoryPolicy resource accepts the following input properties:
- Rules
List<Blob
Inventory Policy Rule> - One or more
rulesblocks as defined below. - Storage
Account stringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- Storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- Rules
[]Blob
Inventory Policy Rule Args - One or more
rulesblocks as defined below. - Storage
Account stringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- Storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- rules
List<Blob
Inventory Policy Rule> - One or more
rulesblocks as defined below. - storage
Account StringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage
Container StringName - The storage container name to store the blob inventory files for this rule.
- rules
Blob
Inventory Policy Rule[] - One or more
rulesblocks as defined below. - storage
Account stringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- rules
Sequence[Blob
Inventory Policy Rule Args] - One or more
rulesblocks as defined below. - storage_
account_ strid - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage_
container_ strname - The storage container name to store the blob inventory files for this rule.
- rules List<Property Map>
- One or more
rulesblocks as defined below. - storage
Account StringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage
Container StringName - The storage container name to store the blob inventory files for this rule.
Outputs
All input properties are implicitly available as output properties. Additionally, the BlobInventoryPolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing BlobInventoryPolicy Resource
Get an existing BlobInventoryPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BlobInventoryPolicyState, opts?: CustomResourceOptions): BlobInventoryPolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
rules: Optional[Sequence[BlobInventoryPolicyRuleArgs]] = None,
storage_account_id: Optional[str] = None,
storage_container_name: Optional[str] = None) -> BlobInventoryPolicyfunc GetBlobInventoryPolicy(ctx *Context, name string, id IDInput, state *BlobInventoryPolicyState, opts ...ResourceOption) (*BlobInventoryPolicy, error)public static BlobInventoryPolicy Get(string name, Input<string> id, BlobInventoryPolicyState? state, CustomResourceOptions? opts = null)public static BlobInventoryPolicy get(String name, Output<String> id, BlobInventoryPolicyState state, CustomResourceOptions options)resources: _: type: azure:storage:BlobInventoryPolicy get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Rules
List<Blob
Inventory Policy Rule> - One or more
rulesblocks as defined below. - Storage
Account stringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- Storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- Rules
[]Blob
Inventory Policy Rule Args - One or more
rulesblocks as defined below. - Storage
Account stringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- Storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- rules
List<Blob
Inventory Policy Rule> - One or more
rulesblocks as defined below. - storage
Account StringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage
Container StringName - The storage container name to store the blob inventory files for this rule.
- rules
Blob
Inventory Policy Rule[] - One or more
rulesblocks as defined below. - storage
Account stringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- rules
Sequence[Blob
Inventory Policy Rule Args] - One or more
rulesblocks as defined below. - storage_
account_ strid - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage_
container_ strname - The storage container name to store the blob inventory files for this rule.
- rules List<Property Map>
- One or more
rulesblocks as defined below. - storage
Account StringId - The ID of the storage account to apply this Blob Inventory Policy to. Changing this forces a new Storage Blob Inventory Policy to be created.
- storage
Container StringName - The storage container name to store the blob inventory files for this rule.
Supporting Types
BlobInventoryPolicyRule, BlobInventoryPolicyRuleArgs
- Format string
- The format of the inventory files. Possible values are
CsvandParquet. - Name string
- The name which should be used for this Blob Inventory Policy Rule.
- Schedule string
- The inventory schedule applied by this rule. Possible values are
DailyandWeekly. - Schema
Fields List<string> - A list of fields to be included in the inventory. See the Azure API reference for all the supported fields.
- Scope string
- The scope of the inventory for this rule. Possible values are
BlobandContainer. - Storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- Filter
Blob
Inventory Policy Rule Filter - A
filterblock as defined above. Can only be set when thescopeisBlob.
- Format string
- The format of the inventory files. Possible values are
CsvandParquet. - Name string
- The name which should be used for this Blob Inventory Policy Rule.
- Schedule string
- The inventory schedule applied by this rule. Possible values are
DailyandWeekly. - Schema
Fields []string - A list of fields to be included in the inventory. See the Azure API reference for all the supported fields.
- Scope string
- The scope of the inventory for this rule. Possible values are
BlobandContainer. - Storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- Filter
Blob
Inventory Policy Rule Filter - A
filterblock as defined above. Can only be set when thescopeisBlob.
- format String
- The format of the inventory files. Possible values are
CsvandParquet. - name String
- The name which should be used for this Blob Inventory Policy Rule.
- schedule String
- The inventory schedule applied by this rule. Possible values are
DailyandWeekly. - schema
Fields List<String> - A list of fields to be included in the inventory. See the Azure API reference for all the supported fields.
- scope String
- The scope of the inventory for this rule. Possible values are
BlobandContainer. - storage
Container StringName - The storage container name to store the blob inventory files for this rule.
- filter
Blob
Inventory Policy Rule Filter - A
filterblock as defined above. Can only be set when thescopeisBlob.
- format string
- The format of the inventory files. Possible values are
CsvandParquet. - name string
- The name which should be used for this Blob Inventory Policy Rule.
- schedule string
- The inventory schedule applied by this rule. Possible values are
DailyandWeekly. - schema
Fields string[] - A list of fields to be included in the inventory. See the Azure API reference for all the supported fields.
- scope string
- The scope of the inventory for this rule. Possible values are
BlobandContainer. - storage
Container stringName - The storage container name to store the blob inventory files for this rule.
- filter
Blob
Inventory Policy Rule Filter - A
filterblock as defined above. Can only be set when thescopeisBlob.
- format str
- The format of the inventory files. Possible values are
CsvandParquet. - name str
- The name which should be used for this Blob Inventory Policy Rule.
- schedule str
- The inventory schedule applied by this rule. Possible values are
DailyandWeekly. - schema_
fields Sequence[str] - A list of fields to be included in the inventory. See the Azure API reference for all the supported fields.
- scope str
- The scope of the inventory for this rule. Possible values are
BlobandContainer. - storage_
container_ strname - The storage container name to store the blob inventory files for this rule.
- filter
Blob
Inventory Policy Rule Filter - A
filterblock as defined above. Can only be set when thescopeisBlob.
- format String
- The format of the inventory files. Possible values are
CsvandParquet. - name String
- The name which should be used for this Blob Inventory Policy Rule.
- schedule String
- The inventory schedule applied by this rule. Possible values are
DailyandWeekly. - schema
Fields List<String> - A list of fields to be included in the inventory. See the Azure API reference for all the supported fields.
- scope String
- The scope of the inventory for this rule. Possible values are
BlobandContainer. - storage
Container StringName - The storage container name to store the blob inventory files for this rule.
- filter Property Map
- A
filterblock as defined above. Can only be set when thescopeisBlob.
BlobInventoryPolicyRuleFilter, BlobInventoryPolicyRuleFilterArgs
- Blob
Types List<string> - A set of blob types. Possible values are
blockBlob,appendBlob, andpageBlob. The storage account withis_hns_enabledistruedoesn't supportpageBlob. - Include
Blob boolVersions - Includes blob versions in blob inventory or not? Defaults to
false. - Include
Snapshots bool - Includes blob snapshots in blob inventory or not? Defaults to
false. - Prefix
Matches List<string> - A set of strings for blob prefixes to be matched.
- Blob
Types []string - A set of blob types. Possible values are
blockBlob,appendBlob, andpageBlob. The storage account withis_hns_enabledistruedoesn't supportpageBlob. - Include
Blob boolVersions - Includes blob versions in blob inventory or not? Defaults to
false. - Include
Snapshots bool - Includes blob snapshots in blob inventory or not? Defaults to
false. - Prefix
Matches []string - A set of strings for blob prefixes to be matched.
- blob
Types List<String> - A set of blob types. Possible values are
blockBlob,appendBlob, andpageBlob. The storage account withis_hns_enabledistruedoesn't supportpageBlob. - include
Blob BooleanVersions - Includes blob versions in blob inventory or not? Defaults to
false. - include
Snapshots Boolean - Includes blob snapshots in blob inventory or not? Defaults to
false. - prefix
Matches List<String> - A set of strings for blob prefixes to be matched.
- blob
Types string[] - A set of blob types. Possible values are
blockBlob,appendBlob, andpageBlob. The storage account withis_hns_enabledistruedoesn't supportpageBlob. - include
Blob booleanVersions - Includes blob versions in blob inventory or not? Defaults to
false. - include
Snapshots boolean - Includes blob snapshots in blob inventory or not? Defaults to
false. - prefix
Matches string[] - A set of strings for blob prefixes to be matched.
- blob_
types Sequence[str] - A set of blob types. Possible values are
blockBlob,appendBlob, andpageBlob. The storage account withis_hns_enabledistruedoesn't supportpageBlob. - include_
blob_ boolversions - Includes blob versions in blob inventory or not? Defaults to
false. - include_
snapshots bool - Includes blob snapshots in blob inventory or not? Defaults to
false. - prefix_
matches Sequence[str] - A set of strings for blob prefixes to be matched.
- blob
Types List<String> - A set of blob types. Possible values are
blockBlob,appendBlob, andpageBlob. The storage account withis_hns_enabledistruedoesn't supportpageBlob. - include
Blob BooleanVersions - Includes blob versions in blob inventory or not? Defaults to
false. - include
Snapshots Boolean - Includes blob snapshots in blob inventory or not? Defaults to
false. - prefix
Matches List<String> - A set of strings for blob prefixes to be matched.
Import
Storage Blob Inventory Policies can be imported using the resource id, e.g.
$ pulumi import azure:storage/blobInventoryPolicy:BlobInventoryPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Storage/storageAccounts/storageAccount1/inventoryPolicies/inventoryPolicy1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
