data_boundaries
Creates, updates, deletes, gets or lists a data_boundaries resource.
Overview​
| Name | data_boundaries |
| Type | Resource |
| Id | azure.resource.data_boundaries |
Fields​
The following fields are returned by SELECT queries:
- get_scope
- get_tenant
| 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. |
dataBoundary | string | The data boundary definition. Known values are: "NotDefined", "Global", and "EU". (NotDefined, Global, EU) |
provisioningState | string | Denotes the state of provisioning. Known values are: "Accepted", "Running", "Creating", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Creating, Canceled, Failed, Succeeded, Updating) |
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. |
dataBoundary | string | The data boundary definition. Known values are: "NotDefined", "Global", and "EU". (NotDefined, Global, EU) |
provisioningState | string | Denotes the state of provisioning. Known values are: "Accepted", "Running", "Creating", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Creating, Canceled, Failed, Succeeded, Updating) |
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_scope | select | scope, default_name | Get data boundary at specified scope. | |
get_tenant | select | default_name | Get data boundary of tenant. | |
put | exec | default_name | Opt-in tenant to data boundary. |
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 |
|---|---|---|
default_name | string | Default string modeled as parameter for auto generation to work correctly. "default" Required. |
scope | string | The fully qualified Azure Resource manager identifier of the resource. Required. |
SELECT examples​
- get_scope
- get_tenant
Get data boundary at specified scope.
SELECT
id,
name,
dataBoundary,
provisioningState,
systemData,
type
FROM azure.resource.data_boundaries
WHERE scope = '{{ scope }}' -- required
AND default_name = '{{ default_name }}' -- required
;
Get data boundary of tenant.
SELECT
id,
name,
dataBoundary,
provisioningState,
systemData,
type
FROM azure.resource.data_boundaries
WHERE default_name = '{{ default_name }}' -- required
;
Lifecycle Methods​
- put
Opt-in tenant to data boundary.
EXEC azure.resource.data_boundaries.put
@default_name='{{ default_name }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;