tenant_opted_in
Creates, updates, deletes, gets or lists a tenant_opted_in resource.
Overview
| Name | tenant_opted_in |
| Type | Resource |
| Id | azure.customer_lockbox.tenant_opted_in |
Fields
The following fields are returned by SELECT queries:
- get
Retrieval of Opt-in status for Tenant successful.
| Name | Datatype | Description |
|---|---|---|
isOptedIn | boolean | True if tenant is opted in, false otherwise |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | tenantId | Get Customer Lockbox request |
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 |
|---|---|---|
tenantId | string | The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) |
SELECT examples
- get
Get Customer Lockbox request
SELECT
isOptedIn
FROM azure.customer_lockbox.tenant_opted_in
WHERE tenantId = '{{ tenantId }}' -- required
;