data_policy_manifests
Creates, updates, deletes, gets or lists a data_policy_manifests resource.
Overview
| Name | data_policy_manifests |
| Type | Resource |
| Id | azure.resource.data_policy_manifests |
Fields
The following fields are returned by SELECT queries:
- get_by_policy_mode
- 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. |
effects | array | The effect definition. |
fieldValues | array | The non-alias field accessor values that can be used in the policy rule. |
isBuiltInOnly | boolean | A value indicating whether policy mode is allowed only in built-in definitions. |
namespaces | array | The list of namespaces for the data policy manifest. |
policyMode | string | The policy mode of the data policy manifest. |
resourceFunctions | object | The resource functions definition specified in the data manifest. |
resourceTypeAliases | array | An array of resource type aliases. |
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". |
| 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. |
effects | array | The effect definition. |
fieldValues | array | The non-alias field accessor values that can be used in the policy rule. |
isBuiltInOnly | boolean | A value indicating whether policy mode is allowed only in built-in definitions. |
namespaces | array | The list of namespaces for the data policy manifest. |
policyMode | string | The policy mode of the data policy manifest. |
resourceFunctions | object | The resource functions definition specified in the data manifest. |
resourceTypeAliases | array | An array of resource type aliases. |
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_by_policy_mode | select | policy_mode | Retrieves a data policy manifest. This operation retrieves the data policy manifest with the given policy mode. | |
list | select | $filter | Retrieves data policy manifests. This operation retrieves a list of all the data policy manifests that match the optional given $filter. Valid values for $filter are: "$filter=namespace eq '{0}'". If $filter is not provided, the unfiltered list includes all data policy manifests for data resource types. If $filter=namespace is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value. |
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 |
|---|---|---|
policy_mode | string | The policy mode of the data policy manifest to get. Required. |
$filter | string | The filter to apply on the operation. Valid values for $filter are: "namespace eq '{value}'". If $filter is not provided, no filtering is performed. If $filter=namespace eq '{value}' is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value. Default value is None. |
SELECT examples
- get_by_policy_mode
- list
Retrieves a data policy manifest. This operation retrieves the data policy manifest with the given policy mode.
SELECT
id,
name,
effects,
fieldValues,
isBuiltInOnly,
namespaces,
policyMode,
resourceFunctions,
resourceTypeAliases,
systemData,
type
FROM azure.resource.data_policy_manifests
WHERE policy_mode = '{{ policy_mode }}' -- required
;
Retrieves data policy manifests. This operation retrieves a list of all the data policy manifests that match the optional given $filter. Valid values for $filter are: "$filter=namespace eq '{0}'". If $filter is not provided, the unfiltered list includes all data policy manifests for data resource types. If $filter=namespace is provided, the returned list only includes all data policy manifests that have a namespace matching the provided value.
SELECT
id,
name,
effects,
fieldValues,
isBuiltInOnly,
namespaces,
policyMode,
resourceFunctions,
resourceTypeAliases,
systemData,
type
FROM azure.resource.data_policy_manifests
WHERE $filter = '{{ $filter }}'
;