configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.ad_hybrid_health_service.configurations

Fields

The following fields are returned by SELECT queries:

get

The tenant details.

Name	Datatype	Description
aadLicense	string	The Azure Active Directory license of the tenant.
aadPremium	boolean	Indicate if the tenant has Azure Active Directory Premium license or not.
agentAutoUpdate	boolean	Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features.
alertSuppressionTimeInMins	integer	The time in minutes after which an alert will be auto-suppressed.
consentedToMicrosoftDevOps	boolean	Indicates if the tenant data can be seen by Microsoft through Azure portal.
countryLetterCode	string	The country letter code of the tenant.
createdDate	string (date-time)	The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health.
devOpsTtl	string (date-time)	The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal.
disabled	boolean	Indicates if the tenant is disabled in Azure Active Directory Connect Health.
disabledReason	integer	The reason due to which the tenant was disabled in Azure Active Directory Connect Health.
globalAdminsEmail	array	The list of global administrators for the tenant.
initialDomain	string	The initial domain of the tenant.
lastDisabled	string (date-time)	The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health.
lastVerified	string (date-time)	The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified.
onboarded	boolean	Indicates if the tenant is already onboarded to Azure Active Directory Connect Health.
onboardingAllowed	boolean	Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health.
pksCertificate	object	The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health.
privatePreviewTenant	boolean	Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features.
tenantId	string	The Id of the tenant.
tenantInQuarantine	boolean	Indicates if data collection for this tenant is disabled or not.
tenantName	string	The name of the tenant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets the details of a tenant onboarded to Azure Active Directory Connect Health.
update	update			Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.
add	exec			Onboards a tenant in Azure Active Directory Connect Health.

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

SELECT examples

get

Gets the details of a tenant onboarded to Azure Active Directory Connect Health.

SELECT
aadLicense,
aadPremium,
agentAutoUpdate,
alertSuppressionTimeInMins,
consentedToMicrosoftDevOps,
countryLetterCode,
createdDate,
devOpsTtl,
disabled,
disabledReason,
globalAdminsEmail,
initialDomain,
lastDisabled,
lastVerified,
onboarded,
onboardingAllowed,
pksCertificate,
privatePreviewTenant,
tenantId,
tenantInQuarantine,
tenantName
FROM azure.ad_hybrid_health_service.configurations
;

UPDATE examples

update

Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.

UPDATE azure.ad_hybrid_health_service.configurations
SET 
data__tenantId = '{{ tenantId }}',
data__aadLicense = '{{ aadLicense }}',
data__aadPremium = {{ aadPremium }},
data__agentAutoUpdate = {{ agentAutoUpdate }},
data__alertSuppressionTimeInMins = {{ alertSuppressionTimeInMins }},
data__consentedToMicrosoftDevOps = {{ consentedToMicrosoftDevOps }},
data__countryLetterCode = '{{ countryLetterCode }}',
data__createdDate = '{{ createdDate }}',
data__devOpsTtl = '{{ devOpsTtl }}',
data__disabled = {{ disabled }},
data__disabledReason = {{ disabledReason }},
data__globalAdminsEmail = '{{ globalAdminsEmail }}',
data__initialDomain = '{{ initialDomain }}',
data__lastDisabled = '{{ lastDisabled }}',
data__lastVerified = '{{ lastVerified }}',
data__onboardingAllowed = {{ onboardingAllowed }},
data__onboarded = {{ onboarded }},
data__pksCertificate = '{{ pksCertificate }}',
data__privatePreviewTenant = {{ privatePreviewTenant }},
data__tenantInQuarantine = {{ tenantInQuarantine }},
data__tenantName = '{{ tenantName }}'
RETURNING
aadLicense,
aadPremium,
agentAutoUpdate,
alertSuppressionTimeInMins,
consentedToMicrosoftDevOps,
countryLetterCode,
createdDate,
devOpsTtl,
disabled,
disabledReason,
globalAdminsEmail,
initialDomain,
lastDisabled,
lastVerified,
onboarded,
onboardingAllowed,
pksCertificate,
privatePreviewTenant,
tenantId,
tenantInQuarantine,
tenantName;

Lifecycle Methods

add

Onboards a tenant in Azure Active Directory Connect Health.

EXEC azure.ad_hybrid_health_service.configurations.add 

;