pure_storage_policies

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

Overview

Name	pure_storage_policies
Type	Resource
Id	azure_isv.avs.pure_storage_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The state of the Pure Storage Policy Based Management policy provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Deleting, Updating)
storagePolicyDefinition	string	Definition of a Pure Storage Policy Based Management policy. Required.
storagePoolId	string	Azure resource ID of the Pure Storage Pool associated with the storage policy. Required.
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The state of the Pure Storage Policy Based Management policy provisioning. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Updating". (Succeeded, Failed, Canceled, Deleting, Updating)
storagePolicyDefinition	string	Definition of a Pure Storage Policy Based Management policy. Required.
storagePoolId	string	Azure resource ID of the Pure Storage Pool associated with the storage policy. Required.
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	resource_group_name, private_cloud_name, storage_policy_name, subscription_id		Get a PureStoragePolicy.
list	select	resource_group_name, private_cloud_name, subscription_id		List PureStoragePolicy resources by PrivateCloud.
create_or_update	insert	resource_group_name, private_cloud_name, storage_policy_name, subscription_id		Create a PureStoragePolicy.
create_or_update	replace	resource_group_name, private_cloud_name, storage_policy_name, subscription_id		Create a PureStoragePolicy.
delete	delete	resource_group_name, private_cloud_name, storage_policy_name, subscription_id		Delete a PureStoragePolicy.

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
private_cloud_name	string	Name of the private cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_policy_name	string	Name of the storage policy. Required.
subscription_id	string

SELECT examples

get

Get a PureStoragePolicy.

SELECT
id,
name,
provisioningState,
storagePolicyDefinition,
storagePoolId,
systemData,
type
FROM azure_isv.avs.pure_storage_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND storage_policy_name = '{{ storage_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List PureStoragePolicy resources by PrivateCloud.

SELECT
id,
name,
provisioningState,
storagePolicyDefinition,
storagePoolId,
systemData,
type
FROM azure_isv.avs.pure_storage_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_cloud_name = '{{ private_cloud_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a PureStoragePolicy.

INSERT INTO azure_isv.avs.pure_storage_policies (
properties,
resource_group_name,
private_cloud_name,
storage_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_cloud_name }}',
'{{ storage_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: pure_storage_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the pure_storage_policies resource.
  - name: private_cloud_name
    value: "{{ private_cloud_name }}"
    description: Required parameter for the pure_storage_policies resource.
  - name: storage_policy_name
    value: "{{ storage_policy_name }}"
    description: Required parameter for the pure_storage_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the pure_storage_policies resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      storagePolicyDefinition: "{{ storagePolicyDefinition }}"
      storagePoolId: "{{ storagePoolId }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a PureStoragePolicy.

REPLACE azure_isv.avs.pure_storage_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND storage_policy_name = '{{ storage_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a PureStoragePolicy.

DELETE FROM azure_isv.avs.pure_storage_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_cloud_name = '{{ private_cloud_name }}' --required
AND storage_policy_name = '{{ storage_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;