blob_inventory_policies

Creates, updates, deletes, gets or lists a blob_inventory_policies resource.

Overview

Name	blob_inventory_policies
Type	Resource
Id	azure.storage.blob_inventory_policies

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the blob inventory policy successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Returns the storage account blob inventory policy rules.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

OK -- Get the blob inventory policies successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Returns the storage account blob inventory policy rules.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, blobInventoryPolicyName		Gets the blob inventory policy associated with the specified storage account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the blob inventory policy associated with the specified storage account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, blobInventoryPolicyName		Sets the blob inventory policy to the specified storage account.
delete	delete	resourceGroupName, accountName, subscriptionId, blobInventoryPolicyName		Deletes the blob inventory policy associated with the specified storage account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	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.
blobInventoryPolicyName	string	The name of the storage account blob inventory policy. It should always be 'default'
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the blob inventory policy associated with the specified storage account.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.blob_inventory_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND blobInventoryPolicyName = '{{ blobInventoryPolicyName }}' -- required
;

list

Gets the blob inventory policy associated with the specified storage account.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.blob_inventory_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Sets the blob inventory policy to the specified storage account.

INSERT INTO azure.storage.blob_inventory_policies (
data__properties,
resourceGroupName,
accountName,
subscriptionId,
blobInventoryPolicyName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ blobInventoryPolicyName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: blob_inventory_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the blob_inventory_policies resource.
    - name: accountName
      value: string
      description: Required parameter for the blob_inventory_policies resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the blob_inventory_policies resource.
    - name: blobInventoryPolicyName
      value: string
      description: Required parameter for the blob_inventory_policies resource.
    - name: properties
      value: object
      description: |
        Returns the storage account blob inventory policy rules.

DELETE examples

delete

Deletes the blob inventory policy associated with the specified storage account.

DELETE FROM azure.storage.blob_inventory_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND blobInventoryPolicyName = '{{ blobInventoryPolicyName }}' --required
;