@datafire/azure_adhybridhealthservice_adhybridheal

@datafire/azure_adhybridhealthservice_adhybridhealthservice

Client library for ADHybridHealthService

Installation and Usage

npm install --save @datafire/azure_adhybridhealthservice_adhybridhealthservice

let azure_adhybridhealthservice_adhybridhealthservice = require('@datafire/azure_adhybridhealthservice_adhybridhealthservice').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

REST APIs for Azure Active Directory Connect Health

Actions

addsServices_list

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_list({
  "api-version": ""
}, context)

Input

input object
- $filter string: The service property filter to apply.
- serviceType string: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
- skipCount integer: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
- takeCount integer: The take count , which specifies the number of elements that can be returned from a sequence.
- api-version required string: The version of the API to be used with the client request.

Output

output Services

addsServices_add

Onboards a service for a given tenant in Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_add({
  "api-version": "",
  "service": {}
}, context)

Input

input object
- api-version required string: The version of the API to be used with the client request.
- service required ServiceProperties

Output

output ServiceProperties

addsServices_listPremiumServices

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listPremiumServices({
  "api-version": ""
}, context)

Input

input object
- $filter string: The service property filter to apply.
- serviceType string: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
- skipCount integer: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
- takeCount integer: The take count , which specifies the number of elements that can be returned from a sequence.
- api-version required string: The version of the API to be used with the client request.

Output

output Services

addsServices_delete

Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_delete({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service which needs to be deleted.
- confirm boolean: Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

addsServices_get

Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_get({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceProperties

addsServices_update

Updates an Active Directory Domain Service properties of an onboarded service.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_update({
  "serviceName": "",
  "service": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service which needs to be deleted.
- service required ServiceProperties
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceProperties

adDomainServiceMembers_list

Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.adDomainServiceMembers_list({
  "serviceName": "",
  "isGroupbySite": true,
  "nextPartitionKey": "",
  "nextRowKey": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The server property filter to apply.
- isGroupbySite required boolean: Indicates if the result should be grouped by site or not.
- query string: The custom query.
- nextPartitionKey required string (values: ): The next partition key to query for.
- nextRowKey required string (values: ): The next row key to query for.
- takeCount integer: The take count , which specifies the number of elements that can be returned from a sequence.
- api-version required string: The version of the API to be used with the client request.

Output

output AddsServiceMembers

addsServiceMembers_list

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServiceMembers_list({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The server property filter to apply.
- api-version required string: The version of the API to be used with the client request.

Output

output AddsServiceMembers

alerts_listAddsAlerts

Gets the alerts for a given Active Directory Domain Service.

azure_adhybridhealthservice_adhybridhealthservice.alerts_listAddsAlerts({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The alert property filter to apply.
- state string: The alert state to query for.
- from string: The start date to query for.
- to string: The end date till when to query for.
- api-version required string: The version of the API to be used with the client request.

Output

output Alerts

configuration_listAddsConfigurations

Gets the service configurations.

azure_adhybridhealthservice_adhybridhealthservice.configuration_listAddsConfigurations({
  "serviceName": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- grouping string: The grouping for configurations.

Output

output AddsConfiguration

dimensions_listAddsDimensions

Gets the dimensions for a given dimension type in a server.

azure_adhybridhealthservice_adhybridhealthservice.dimensions_listAddsDimensions({
  "serviceName": "",
  "dimension": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- dimension required string: The dimension type.
- api-version required string: The version of the API to be used with the client request.

Output

output Dimensions

addsServicesUserPreference_delete

Deletes the user preferences for a given feature.

azure_adhybridhealthservice_adhybridhealthservice.addsServicesUserPreference_delete({
  "serviceName": "",
  "featureName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- featureName required string: The name of the feature.
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

addsServicesUserPreference_get

Gets the user preferences for a given feature.

azure_adhybridhealthservice_adhybridhealthservice.addsServicesUserPreference_get({
  "serviceName": "",
  "featureName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- featureName required string: The name of the feature.
- api-version required string: The version of the API to be used with the client request.

Output

output UserPreference

addsServicesUserPreference_add

Adds the user preferences for a given feature.

azure_adhybridhealthservice_adhybridhealthservice.addsServicesUserPreference_add({
  "serviceName": "",
  "featureName": "",
  "setting": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- featureName required string: The name of the feature.
- setting required UserPreference
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

addsServices_getForestSummary

Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_getForestSummary({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output ForestSummary

addsServices_listMetricMetadata

Gets the service related metrics information.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listMetricMetadata({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- $filter string: The metric metadata property filter to apply.
- serviceName required string: The name of the service.
- perfCounter boolean: Indicates if only performance counter metrics are requested.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricMetadataList

addsServices_getMetricMetadata

Gets the service related metric information.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_getMetricMetadata({
  "serviceName": "",
  "metricName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- api-version required string: The version of the API to be used with the client request.

Output

output MetricMetadata

addsServices_getMetricMetadataForGroup

Gets the service related metrics for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_getMetricMetadataForGroup({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- groupKey string: The group key
- fromDate string: The start date.
- toDate string: The end date.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricSets

addsService_getMetrics

Gets the server related metrics for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.addsService_getMetrics({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- groupKey string: The group key
- fromDate string: The start date.
- toDate string: The end date.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricSets

addsServices_listMetricsAverage

Gets the average of the metric values for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listMetricsAverage({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- api-version required string: The version of the API to be used with the client request.

Output

output Metrics

addsServices_listMetricsSum

Gets the sum of the metric values for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listMetricsSum({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- api-version required string: The version of the API to be used with the client request.

Output

output Metrics

addsServices_listReplicationDetails

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listReplicationDetails({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The server property filter to apply.
- withDetails boolean: Indicates if InboundReplicationNeighbor details are required or not.
- api-version required string: The version of the API to be used with the client request.

Output

output ReplicationDetailsList

addsServicesReplicationStatus_get

Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServicesReplicationStatus_get({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output ReplicationStatus

addsServices_listReplicationSummary

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listReplicationSummary({
  "serviceName": "",
  "isGroupbySite": true,
  "query": "",
  "nextPartitionKey": "",
  "nextRowKey": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The server property filter to apply.
- isGroupbySite required boolean: Indicates if the result should be grouped by site or not.
- query required string: The custom query.
- nextPartitionKey required string (values: ): The next partition key to query for.
- nextRowKey required string (values: ): The next row key to query for.
- takeCount integer: The take count , which specifies the number of elements that can be returned from a sequence.
- api-version required string: The version of the API to be used with the client request.

Output

output ReplicationSummaryList

addsServicesServiceMembers_list

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.addsServicesServiceMembers_list({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The server property filter to apply.
- dimensionType string: The server specific dimension.
- dimensionSignature string: The value of the dimension.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceMembers

addsServicesServiceMembers_add

Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.addsServicesServiceMembers_add({
  "serviceName": "",
  "serviceMember": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service under which the server is to be onboarded.
- serviceMember required ServiceMember
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceMember

addsServiceMembers_delete

Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.addsServiceMembers_delete({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- confirm boolean: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

addsServiceMembers_get

Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.addsServiceMembers_get({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceMember

addsServices_listServerAlerts

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

azure_adhybridhealthservice_adhybridhealthservice.addsServices_listServerAlerts({
  "serviceMemberId": "",
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceMemberId required string: The server Id for which the alert details needs to be queried.
- serviceName required string: The name of the service.
- $filter string: The alert property filter to apply.
- state string: The alert state to query for.
- from string: The start date to query for.
- to string: The end date till when to query for.
- api-version required string: The version of the API to be used with the client request.

Output

output Alerts

addsServiceMembers_listCredentials

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.addsServiceMembers_listCredentials({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The property filter to apply.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output Credentials

configuration_get

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

azure_adhybridhealthservice_adhybridhealthservice.configuration_get({
  "api-version": ""
}, context)

Input

input object
- api-version required string: The version of the API to be used with the client request.

Output

output Tenant

configuration_update

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

azure_adhybridhealthservice_adhybridhealthservice.configuration_update({
  "tenant": {},
  "api-version": ""
}, context)

Input

input object
- tenant required Tenant
- api-version required string: The version of the API to be used with the client request.

Output

output Tenant

configuration_add

Onboards a tenant in Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.configuration_add({
  "api-version": ""
}, context)

Input

input object
- api-version required string: The version of the API to be used with the client request.

Output

output Tenant

operations_list

Lists the available Azure Data Factory API operations.

azure_adhybridhealthservice_adhybridhealthservice.operations_list({
  "api-version": ""
}, context)

Input

input object
- api-version required string: The version of the API to be used with the client request.

Output

output OperationListResponse

reports_getDevOps

Checks if the user is enabled for Dev Ops access.

azure_adhybridhealthservice_adhybridhealthservice.reports_getDevOps({
  "api-version": ""
}, context)

Input

input object
- api-version required string: The version of the API to be used with the client request.

Output

output Result

serviceMembers_listConnectors

Gets the connector details for a service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_listConnectors({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output Connectors

services_list

Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.services_list({
  "api-version": ""
}, context)

Input

input object
- $filter string: The service property filter to apply.
- serviceType string: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
- skipCount integer: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
- takeCount integer: The take count , which specifies the number of elements that can be returned from a sequence.
- api-version required string: The version of the API to be used with the client request.

Output

output Services

services_add

Onboards a service for a given tenant in Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.services_add({
  "api-version": "",
  "service": {}
}, context)

Input

input object
- api-version required string: The version of the API to be used with the client request.
- service required ServiceProperties

Output

output ServiceProperties

services_listPremium

Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.services_listPremium({
  "api-version": ""
}, context)

Input

input object
- $filter string: The service property filter to apply.
- serviceType string: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
- skipCount integer: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
- takeCount integer: The take count , which specifies the number of elements that can be returned from a sequence.
- api-version required string: The version of the API to be used with the client request.

Output

output Services

services_delete

Deletes a service which is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.services_delete({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service which needs to be deleted.
- confirm boolean: Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

services_get

Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

azure_adhybridhealthservice_adhybridhealthservice.services_get({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceProperties

services_update

Updates the service properties of an onboarded service.

azure_adhybridhealthservice_adhybridhealthservice.services_update({
  "serviceName": "",
  "service": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service which needs to be deleted.
- service required ServiceProperties
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceProperties

services_getTenantWhitelisting

Checks if the tenant, to which a service is registered, is whitelisted to use a feature.

azure_adhybridhealthservice_adhybridhealthservice.services_getTenantWhitelisting({
  "serviceName": "",
  "featureName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- featureName required string: The name of the feature.
- api-version required string: The version of the API to be used with the client request.

Output

output Result

services_listAlerts

Gets the alerts for a given service.

azure_adhybridhealthservice_adhybridhealthservice.services_listAlerts({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The alert property filter to apply.
- state string: The alert state to query for.
- from string: The start date to query for.
- to string: The end date till when to query for.
- api-version required string: The version of the API to be used with the client request.

Output

output Alerts

services_getFeatureAvailibility

Checks if the service has all the pre-requisites met to use a feature.

azure_adhybridhealthservice_adhybridhealthservice.services_getFeatureAvailibility({
  "serviceName": "",
  "featureName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- featureName required string: The name of the feature.
- api-version required string: The version of the API to be used with the client request.

Output

output Result

services_listExportErrors

Gets the count of latest AAD export errors.

azure_adhybridhealthservice_adhybridhealthservice.services_listExportErrors({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output ErrorCounts

services_listExportErrorsV2

Gets the categorized export errors.

azure_adhybridhealthservice_adhybridhealthservice.services_listExportErrorsV2({
  "serviceName": "",
  "errorBucket": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- errorBucket required string: The error category to query for.
- api-version required string: The version of the API to be used with the client request.

Output

output MergedExportErrors

services_listExportStatus

Gets the export status.

azure_adhybridhealthservice_adhybridhealthservice.services_listExportStatus({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output ExportStatuses

services_addAlertFeedback

Adds an alert feedback submitted by customer.

azure_adhybridhealthservice_adhybridhealthservice.services_addAlertFeedback({
  "serviceName": "",
  "alertFeedback": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- alertFeedback required AlertFeedback
- api-version required string: The version of the API to be used with the client request.

Output

output AlertFeedback

services_listAlertFeedback

Gets a list of all alert feedback for a given tenant and alert type.

azure_adhybridhealthservice_adhybridhealthservice.services_listAlertFeedback({
  "serviceName": "",
  "shortName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- shortName required string: The name of the alert.
- api-version required string: The version of the API to be used with the client request.

Output

output AlertFeedbacks

services_listMetricMetadata

Gets the service related metrics information.

azure_adhybridhealthservice_adhybridhealthservice.services_listMetricMetadata({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- $filter string: The metric metadata property filter to apply.
- serviceName required string: The name of the service.
- perfCounter boolean: Indicates if only performance counter metrics are requested.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricMetadataList

services_getMetricMetadata

Gets the service related metrics information.

azure_adhybridhealthservice_adhybridhealthservice.services_getMetricMetadata({
  "serviceName": "",
  "metricName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- api-version required string: The version of the API to be used with the client request.

Output

output MetricMetadata

services_getMetricMetadataForGroup

Gets the service related metrics for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.services_getMetricMetadataForGroup({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- groupKey string: The group key
- fromDate string: The start date.
- toDate string: The end date.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricSets

service_getMetrics

Gets the server related metrics for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.service_getMetrics({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- groupKey string: The group key
- fromDate string: The start date.
- toDate string: The end date.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricSets

services_listMetricsAverage

Gets the average of the metric values for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.services_listMetricsAverage({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- api-version required string: The version of the API to be used with the client request.

Output

output Metrics

services_listMetricsSum

Gets the sum of the metric values for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.services_listMetricsSum({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- api-version required string: The version of the API to be used with the client request.

Output

output Metrics

services_updateMonitoringConfiguration

Updates the service level monitoring configuration.

azure_adhybridhealthservice_adhybridhealthservice.services_updateMonitoringConfiguration({
  "serviceName": "",
  "configurationSetting": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- configurationSetting required Item
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

services_listMonitoringConfigurations

Gets the service level monitoring configurations.

azure_adhybridhealthservice_adhybridhealthservice.services_listMonitoringConfigurations({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output Items

services_listUserBadPasswordReport

Gets the bad password login attempt report for an user

azure_adhybridhealthservice_adhybridhealthservice.services_listUserBadPasswordReport({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- dataSource string: The source of data, if its test data or customer data.
- api-version required string: The version of the API to be used with the client request.

Output

output ErrorReportUsersEntries

services_listAllRiskyIpDownloadReport

Gets all Risky IP report URIs for the last 7 days.

azure_adhybridhealthservice_adhybridhealthservice.services_listAllRiskyIpDownloadReport({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output RiskyIPBlobUris

services_listCurrentRiskyIpDownloadReport

Initiate the generation of a new Risky IP report. Returns the URI for the new one.

azure_adhybridhealthservice_adhybridhealthservice.services_listCurrentRiskyIpDownloadReport({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- api-version required string: The version of the API to be used with the client request.

Output

output RiskyIPBlobUris

serviceMembers_list

Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_list({
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The server property filter to apply.
- dimensionType string: The server specific dimension.
- dimensionSignature string: The value of the dimension.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceMembers

serviceMembers_add

Onboards a server, for a given service, to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_add({
  "serviceName": "",
  "serviceMember": {},
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service under which the server is to be onboarded.
- serviceMember required ServiceMember
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceMember

serviceMembers_delete

Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_delete({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- confirm boolean: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

serviceMembers_get

Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_get({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceMember

serviceMembers_listAlerts

Gets the details of an alert for a given service and server combination.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_listAlerts({
  "serviceMemberId": "",
  "serviceName": "",
  "api-version": ""
}, context)

Input

input object
- serviceMemberId required string: The server Id for which the alert details needs to be queried.
- serviceName required string: The name of the service.
- $filter string: The alert property filter to apply.
- state string: The alert state to query for.
- from string: The start date to query for.
- to string: The end date till when to query for.
- api-version required string: The version of the API to be used with the client request.

Output

output Alerts

serviceMembers_listCredentials

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_listCredentials({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- $filter string: The property filter to apply.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output Credentials

serviceMembers_deleteData

Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_deleteData({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

Output schema unknown

serviceMembers_listDataFreshness

Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_listDataFreshness({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output DataFreshnessDetails

serviceMembers_listExportStatus

Gets the export status.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_listExportStatus({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output ExportStatuses

serviceMembers_listGlobalConfiguration

Gets the global configuration.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_listGlobalConfiguration({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server id.
- api-version required string: The version of the API to be used with the client request.

Output

output GlobalConfigurations

serviceMembers_getConnectorMetadata

Gets the list of connectors and run profile names.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_getConnectorMetadata({
  "serviceName": "",
  "serviceMemberId": "",
  "metricName": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The service member id.
- metricName required string: The name of the metric.
- api-version required string: The version of the API to be used with the client request.

Output

output ConnectorMetadata

serviceMembers_getMetrics

Gets the server related metrics for a given metric and group combination.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_getMetrics({
  "serviceName": "",
  "metricName": "",
  "groupName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- metricName required string: The metric name
- groupName required string: The group name
- serviceMemberId required string: The server id.
- groupKey string: The group key
- fromDate string: The start date.
- toDate string: The end date.
- api-version required string: The version of the API to be used with the client request.

Output

output MetricSets

serviceMembers_getServiceConfiguration

Gets the service configuration.

azure_adhybridhealthservice_adhybridhealthservice.serviceMembers_getServiceConfiguration({
  "serviceName": "",
  "serviceMemberId": "",
  "api-version": ""
}, context)

Input

input object
- serviceName required string: The name of the service.
- serviceMemberId required string: The server Id.
- api-version required string: The version of the API to be used with the client request.

Output

output ServiceConfiguration

Definitions

AdditionalInformation

AdditionalInformation object: The additional information for a property.
- hasProperties boolean: Indicates if properties are present or not.
- properties object: The list of properties which are included in the additional information.
  - items Item
- titleName string: The title name for the property.
- titleValue string: The title value for the property.

AddsConfiguration

AddsConfiguration object: The list of key value properties.
- continuationToken string: The continuation token for paginated calls.
- nextLink string: The link used to get the next page of operations.
- totalCount integer: The total count of configuration.
- value array: The value returned by the operation.
  - items Item

AddsServiceMember

AddsServiceMember object: The server details for ADDS service.
- activeAlerts integer: The total number of alerts that are currently active for the server.
- additionalInformation string: The additional information, if any, for the server.
- addsRoles array: The list of ADDS roles.
  - items string
- createdDate string: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.
- dcTypes array: The list of domain controller types.
  - items string
- dimensions array: The server specific configuration related dimensions.
  - items Item
- disabled boolean: Indicates if the server is disabled or not.
- disabledReason integer: The reason for disabling the server.
- domainName string: The domain name.
- gcReachable boolean: Indicates if the global catalog for this domain is reachable or not.
- installedQfes array: The list of installed QFEs for the server.
  - items Hotfix
- isAdvertising boolean: Indicates if the Dc is advertising or not.
- lastDisabled string: The date and time , in UTC, when the server was last disabled.
- lastReboot string: The date and time, in UTC, when the server was last rebooted.
- lastServerReportedMonitoringLevelChange string: The date and time, in UTC, when the server's data monitoring configuration was last changed.
- lastUpdated string: The date and time, in UTC, when the server properties were last updated.
- machineId string: The id of the machine.
- machineName string: The name of the server.
- monitoringConfigurationsComputed array: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
  - items Item
- monitoringConfigurationsCustomized array: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
  - items Item
- osName string: The name of the operating system installed in the machine.
- osVersion string: The version of the operating system installed in the machine.
- pdcReachable boolean: Indicates if the primary domain controller is reachable or not.
- properties array: Server specific properties.
  - items Item
- recommendedQfes array: The list of recommended hotfixes for the server.
  - items Hotfix
- resolvedAlerts integer: The total count of alerts that are resolved for this server.
- role string: The service role that is being monitored in the server.
- serverReportedMonitoringLevel string (values: Partial, Full, Off): The monitoring level reported by the server.
- serviceId string: The service id to whom this server belongs.
- serviceMemberId string: The id of the server.
- siteName string: The site name.
- status string: The health status of the server.
- sysvolState boolean: Indicates if the SYSVOL state is healthy or not.
- tenantId string: The tenant id to whom this server belongs.

AddsServiceMembers

AddsServiceMembers object: The list of ADDS service members.
- continuationToken string: The continuation token for paginated calls.
- nextLink string: The link used to get the next page of operations.
- totalCount integer: The total count of service members.
- value array: The value returned by the operation.
  - items AddsServiceMember

Agent

Agent object: The agent details.
- agentVersion string: The agent version.
- createdDate string: The date and time, in UTC, when the agent was created.
- credential object: The agent credential details.
  - items Credential
- key string: The connector hash key.
- machineId string: The machine Id.
- machineName string: The machine name.
- tenantId string: The tenant Id.

Alert

Alert object: The alert details indicating an issue with service or server.
- activeAlertProperties array: The active alert properties.
  - items Item
- additionalInformation array: Additional information related to the alert.
  - items AdditionalInformation
- alertId string: The alert Id.
- createdDate string: The date and time,in UTC,when the alert was created.
- description string: The alert description.
- displayName string: The display name for the alert.
- lastUpdated string: The date and time, in UTC, when the alert was last updated.
- level string (values: Warning, Error, PreWarning): The alert level which indicates the severity of the alert.
- monitorRoleType string: The monitoring role type for which the alert was raised.
- relatedLinks array: The help links to get more information related to the alert.
  - items HelpLink
- remediation string: The alert remediation.
- resolvedAlertProperties array: The resolved alert properties.
  - items Item
- resolvedDate string: The date and time, in UTC, when the alert was resolved.
- scope string: The scope of the alert. Indicates if it is a service or a server related alert.
- serviceId string: The service Id.
- serviceMemberId string: The server Id.
- shortName string: The alert short name.
- state string (values: Active, ResolvedByPositiveResult, ResolvedManually, ResolvedByTimer, ResolvedByStateChange): The alert state which can be either active or resolved with multiple resolution types.
- tenantId string: The tenant Id.

AlertFeedback

AlertFeedback object: The alert feedback details.
- comment string: Additional comments related to the alert.
- consentedToShare boolean: Indicates if the alert feedback can be shared from product team.
- createdDate string: The date and time,in UTC,when the alert was created.
- feedback string: The feedback for the alert which indicates if the customer likes or dislikes the alert.
- level string: The alert level which indicates the severity of the alert.
- serviceMemberId string: The server Id of the alert.
- shortName string: The alert short name.
- state string: The alert state which can be either active or resolved with multiple resolution types.

AlertFeedbacks

AlertFeedbacks object: The list of alert feedback.
- value array: The value returned by the operation.
  - items AlertFeedback

Alerts

Alerts object: The list of alerts for a service.
- continuationToken string: The continuation token for paginated calls.
- nextLink string: The link used to get the next page of operations.
- totalCount integer: The total count of alert elements.
- value array: The value returned by the operation.
  - items Alert

AssociatedObject

AssociatedObject object: Object that hold sync object details.
- displayName string: The display name of the object.
- distinguishedName string: The distinguished name of the object.
- lastDirSyncTime string: The last dirSync time.
- mail string: The email of the object.
- objectGuid string: The object guid.
- objectType string: The object type.
- onpremisesUserPrincipalName string: The On-premises UPN.
- proxyAddresses string: The proxy addresses.
- sourceAnchor string: The source anchor.
- sourceOfAuthority string: The source of authority.
- timeOccurred string: The time of the error.
- userPrincipalName string: The UPN.

AttributeDelta

AttributeDelta object: The delta attributes.
- multiValued boolean: Indicates if the attribute delta is multivalued or not.
- name string: The name of the attribute delta.
- operationType string (values: Undefined, Add, Replace, Update, Delete): The attribute delta operation type.
- valueType string (values: Undefined, Dn, Binary, String, Integer, Boolean): The value type.
- values array: The delta values.
  - items ValueDelta

AttributeMapping

AttributeMapping object: The attribute mapping details.
- contextId string: The context Id.
- destinationAttribute string: The destination attribute.
- mappingSource AttributeMppingSource
- type string (values: Constant, Direct, DnPart, Script): The attribute mapping type.

AttributeMppingSource

AttributeMppingSource object: The attribute mapping source.
- constantValue string: The constant value.
- dnPart integer: The value for dn part.
- scriptContext string: The script context.
- sourceAttribute array: The source attribute.
  - items string

ChangeNotReimported

ChangeNotReimported object: The changes which are not re-imported.
- delta ChangeNotReimportedDelta
- entry ChangeNotReimportedEntry

ChangeNotReimportedDelta

ChangeNotReimportedDelta object: The delta in a change that is not re-imported.
- anchor string: The anchor.
- attributes array: The attributes.
  - items AttributeDelta
- dnAttributes array: The delta attributes for distinguished names.
  - items AttributeDelta
- operationType string (values: Undefined, None, Add, Replace, Update, Delete, Obsolete, DeleteAdd): The operation type.

ChangeNotReimportedEntry

ChangeNotReimportedEntry object: The object entry in a change that is not re-imported.
- anchor string: The anchor.
- attributes array: The attributes.
  - items AttributeDelta
- dn string: The distinguished name.
- dnAttributes array: The delta attributes for distinguished names.
  - items AttributeDelta
- objectClasses array: The list of object classes.
  - items string
- parentAnchor string: The parent anchor.
- primaryObjectClass string: The primary object class.

Connector

Connector object: The connect details.
- attributesIncluded array: The attribute inclusion list of the connector.
  - items string
- classesIncluded array: The class inclusion list of the connector.
  - items string
- connectorId string: The connector Id.
- description string: The connector description.
- id string: The connector Id.
- name string: The connector name.
- partitions array: The partitions of the connector.
  - items Partition
- passwordHashSyncConfiguration object: The password hash synchronization configuration of the connector.
  - items PasswordHashSyncConfiguration
- passwordManagementSettings object: The password management settings of the connector.
  - items PasswordManagementSettings
- runProfiles array: The run profiles of the connector.
  - items RunProfile
- schemaXml string: The schema xml for the connector.
- timeCreated string: The date and time when this connector was created.
- timeLastModified string: The date and time when this connector was last modified.
- type string: The connector type.
- version integer: The connector version

ConnectorConnectionError

ConnectorConnectionError object: The connector connection error.
- connectorId string: The connector Id.
- errorCode string: The error code.
- id string: The error Id.
- message string: The message for the connection error.
- runStepResultId string: The run step result Id.
- server string: The server where the connection error happened.
- timeOccured string: The time when the connection error occurred.
- type string: The type of error.

ConnectorConnectionErrors

ConnectorConnectionErrors object: The list of connector connection errors.
- value array: The value returned by the operation.
  - items ConnectorConnectionError

ConnectorMetadata

ConnectorMetadata object: Gets the list of connectors and run profile names.
- connectors array: The list of connectors.
  - items ConnectorMetadataDetails
- runProfileNames array: The list of run profile names.
  - items string

ConnectorMetadataDetails

ConnectorMetadataDetails object: Details of the connector.
- connectorDisplayName string: The Connector Display Name
- connectorId string: The Connector Id.

ConnectorObjectError

ConnectorObjectError object: The connector object error.
- anchor string: The name for the anchor of the object.
- attributeName string: The attribute name of the object.
- columnNumber integer: The column number for the object error.
- connectorId string: The connector Id.
- dn string: The distinguished name of the object.
- entryNumber integer: The entry number for object error occurred.
- errorCode string: The error code.
- id string: The error Id.
- lineNumber integer: The line number for the object error.
- message string: The message for the object error.
- runStepResultId string: The run step result Id.
- serverErrorDetail string: The server side error details.
- type string: The type of error.
- values array: The value corresponding to attribute name.
  - items string

ConnectorObjectErrors

ConnectorObjectErrors object: The list of connector object errors.
- value array: The value returned by the operation.
  - items ConnectorObjectError

Connectors

Connectors object: The list of connects for a service.
- value array: The value returned by the operation.
  - items Connector

Credential

Credential object: The credential for a given server.
- credentialData array: The credential data.
  - items string
- identifier string: The credential identifier.
- type string: The type of credential.

Credentials

Credentials object: The list of agent credentials.
- value array: The value returned by the operation.
  - items Credential

DataFreshnessDetails

DataFreshnessDetails object: The data freshness details for the server.
- value array: The value returned by the operation.
  - items Item

Dimension

Dimension object: The connector object error.
- activeAlerts integer: The count of alerts that are currently active for the service.
- additionalInformation string: The additional information related to the service.
- displayName string: The display name of the service.
- health string (values: Healthy, Warning, Error, NotMonitored, Missing): The health status for the domain controller.
- lastUpdated string: The date or time , in UTC, when the service properties were last updated.
- resolvedAlerts integer: The total count of alerts that has been resolved for the service.
- signature string: The signature of the service.
- simpleProperties object: List of service specific configuration properties.
  - items Item
- type string: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.

Dimensions

Dimensions object: The list of dimensions.
- continuationToken string: The continuation token for paginated calls.
- nextLink string: The link used to get the next page of operations.
- totalCount integer: The total count of dimensions.
- value array: The value returned by the operation.
  - items Dimension

Display

Display object: Displays the details related to operations supported by Azure Active Directory Connect Health.
- description string: The description for the operation.
- operation string: The details of the operation.
- provider string: The provider name.

ErrorCount

ErrorCount object: The error count details.
- count integer: The error count.
- errorBucket string:

datafire

@infinitebrahmanuniverse/nolb-_datafire_az @everything-registry/sub-chunk-220

3.0.0

5 years ago