{ "swagger": "2.0", "info": { "version": "2014-01-01", "title": "ADHybridHealthService", "description": "REST APIs for Azure Active Directory Connect Health" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/providers/Microsoft.ADHybridHealthService/addsservices": { "get": { "tags": [ "Adds" ], "description": "Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.", "operationId": "addsServices_list", "x-ms-examples": { "addsServices_list": { "$ref": "./examples/Services.json" } }, "parameters": [ { "name": "$filter", "in": "query", "description": "The service property filter to apply.", "required": false, "type": "string" }, { "name": "serviceType", "in": "query", "description": "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.", "required": false, "type": "string" }, { "name": "skipCount", "in": "query", "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", "required": false, "type": "integer" }, { "name": "takeCount", "in": "query", "description": "The take count , which specifies the number of elements that can be returned from a sequence.", "required": false, "type": "integer" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": " The list of Active Directory Domain Controller services.", "schema": { "$ref": "#/definitions/Services" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "tags": [ "Adds" ], "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", "operationId": "addsServices_add", "x-ms-examples": { "addsServices_add": { "$ref": "./examples/AddService.json" } }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "name": "service", "in": "body", "description": "The service object.", "required": true, "schema": { "$ref": "#/definitions/ServiceProperties" } } ], "responses": { "200": { "description": "Adds the Active Directory Domain Controller Services.", "schema": { "$ref": "#/definitions/ServiceProperties" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}": { "get": { "tags": [ "Services" ], "description": "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.", "x-ms-examples": { "addsServices_get": { "$ref": "./examples/Service.json" } }, "operationId": "addsServices_get", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The Active Directory Domain Controller service as specified by the serviceName property. ", "schema": { "$ref": "#/definitions/ServiceProperties" } } } }, "delete": { "tags": [ "Services" ], "description": "Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "addsServices_delete": { "$ref": "./examples/DeleteService.json" } }, "operationId": "addsServices_delete", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service which needs to be deleted.", "required": true, "type": "string" }, { "name": "confirm", "in": "query", "description": "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.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "Successfully deleted the service." } } }, "patch": { "tags": [ "Services" ], "description": "Updates an Active Directory Domain Service properties of an onboarded service.", "x-ms-examples": { "addsServices_update": { "$ref": "./examples/UpdateService.json" } }, "operationId": "addsServices_update", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service which needs to be deleted.", "required": true, "type": "string" }, { "name": "service", "in": "body", "description": "The service object.", "required": true, "schema": { "$ref": "#/definitions/ServiceProperties" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated service.", "schema": { "$ref": "#/definitions/ServiceProperties" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts": { "get": { "tags": [ "Adds" ], "description": "Gets the alerts for a given Active Directory Domain Service.", "x-ms-examples": { "alerts_listAddsAlerts": { "$ref": "./examples/Alerts.json" } }, "operationId": "alerts_listAddsAlerts", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The alert property filter to apply.", "required": false, "type": "string" }, { "name": "state", "in": "query", "description": "The alert state to query for.", "required": false, "type": "string" }, { "name": "from", "in": "query", "description": "The start date to query for.", "required": false, "type": "string", "format": "date-time" }, { "name": "to", "in": "query", "description": "The end date till when to query for.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of alerts for the given service.", "schema": { "$ref": "#/definitions/Alerts" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration": { "get": { "tags": [ "Adds" ], "description": "Gets the service configurations.", "x-ms-examples": { "configuration_listAddsConfigurations": { "$ref": "./examples/AddsConfiguration.json" } }, "operationId": "configuration_listAddsConfigurations", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "grouping", "in": "query", "description": "The grouping for configurations.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The Active Directory Domain Controller service configuration. ", "schema": { "$ref": "#/definitions/AddsConfiguration" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}": { "get": { "tags": [ "Adds" ], "description": "Gets the dimensions for a given dimension type in a server.", "x-ms-examples": { "dimensions_listAddsDimensions": { "$ref": "./examples/Dimensions.json" } }, "operationId": "dimensions_listAddsDimensions", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "dimension", "in": "path", "description": "The dimension type.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of dimensions for a server. ", "schema": { "$ref": "#/definitions/Dimensions" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers": { "get": { "tags": [ "Adds" ], "description": "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.", "x-ms-examples": { "addsServiceMembers_list": { "$ref": "./examples/AddsServiceMembers.json" } }, "operationId": "addsServiceMembers_list", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The server property filter to apply.", "required": false, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of Active Directory Domain Servers. ", "schema": { "$ref": "#/definitions/AddsServiceMembers" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers": { "get": { "tags": [ "Adds" ], "description": "Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "adDomainServiceMembers_list": { "$ref": "./examples/AddomainServiceMembers.json" } }, "operationId": "adDomainServiceMembers_list", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The server property filter to apply.", "required": false, "type": "string" }, { "name": "isGroupbySite", "in": "query", "description": "Indicates if the result should be grouped by site or not.", "required": true, "type": "boolean" }, { "name": "query", "in": "query", "description": "The custom query.", "required": false, "type": "string" }, { "name": "nextPartitionKey", "in": "query", "description": "The next partition key to query for.", "required": true, "type": "string", "enum": [ " " ], "x-ms-enum": { "name": "nextPartitionKey", "modelAsString": true } }, { "name": "nextRowKey", "in": "query", "description": "The next row key to query for.", "required": true, "type": "string", "enum": [ " " ], "x-ms-enum": { "name": "nextRowKey", "modelAsString": true } }, { "name": "takeCount", "in": "query", "description": "The take count , which specifies the number of elements that can be returned from a sequence.", "required": false, "type": "integer" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of Active Directory Domain Servers.", "schema": { "$ref": "#/definitions/AddsServiceMembers" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference": { "get": { "tags": [ "Adds" ], "description": "Gets the user preferences for a given feature.", "x-ms-examples": { "addsServicesUserPreference_get": { "$ref": "./examples/UserPreference.json" } }, "operationId": "addsServicesUserPreference_get", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "featureName", "in": "path", "description": "The name of the feature.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The user preference settings. ", "schema": { "$ref": "#/definitions/UserPreference" } } } }, "delete": { "tags": [ "Adds" ], "description": "Deletes the user preferences for a given feature.", "x-ms-examples": { "addsServicesUserPreference_delete": { "$ref": "./examples/DeleteUserPreference.json" } }, "operationId": "addsServicesUserPreference_delete", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "featureName", "in": "path", "description": "The name of the feature.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the user preference settings. " } } }, "post": { "tags": [ "Adds" ], "description": "Adds the user preferences for a given feature.", "x-ms-examples": { "addsServicesUserPreference_add": { "$ref": "./examples/AddUserPreference.json" } }, "operationId": "addsServicesUserPreference_add", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "featureName", "in": "path", "description": "The name of the feature.", "required": true, "type": "string" }, { "name": "setting", "in": "body", "description": "The user preference setting.", "required": true, "schema": { "$ref": "#/definitions/UserPreference" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": " Successfully added the user preference settings. " } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary": { "get": { "tags": [ "Adds" ], "description": "Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "addsServices_getForestSummary": { "$ref": "./examples/ForestSummary.json" } }, "operationId": "addsServices_getForestSummary", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of forest summary for the service. ", "schema": { "$ref": "#/definitions/ForestSummary" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}": { "get": { "tags": [ "Adds" ], "description": "Gets the server related metrics for a given metric and group combination.", "x-ms-examples": { "addsService_getMetrics": { "$ref": "./examples/Service_MetricSets.json" } }, "operationId": "addsService_getMetrics", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "name": "groupKey", "in": "query", "description": "The group key", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "description": "The start date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "The end date.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The metric sets for the service. ", "schema": { "$ref": "#/definitions/MetricSets" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { "get": { "tags": [ "Adds" ], "description": "Gets the average of the metric values for a given metric and group combination.", "x-ms-examples": { "addsServices_listMetricsAverage": { "$ref": "./examples/Metrics.json" } }, "operationId": "addsServices_listMetricsAverage", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of metrics. ", "schema": { "$ref": "#/definitions/Metrics" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { "get": { "tags": [ "Adds" ], "description": "Gets the sum of the metric values for a given metric and group combination.", "x-ms-examples": { "addsServices_listMetricsSum": { "$ref": "./examples/Metrics.json" } }, "operationId": "addsServices_listMetricsSum", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of aum of the metric values for a given service. ", "schema": { "$ref": "#/definitions/Metrics" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata": { "get": { "tags": [ "Adds" ], "description": "Gets the service related metrics information.", "x-ms-examples": { "addsServices_listMetricMetadata": { "$ref": "./examples/MetricMetadataList.json" } }, "operationId": "addsServices_listMetricMetadata", "parameters": [ { "name": "$filter", "in": "query", "description": "The metric metadata property filter to apply.", "required": false, "type": "string" }, { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "perfCounter", "in": "query", "description": "Indicates if only performance counter metrics are requested.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of metric metadata for a service. ", "schema": { "$ref": "#/definitions/MetricMetadataList" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}": { "get": { "tags": [ "Adds" ], "description": "Gets the service related metric information.", "x-ms-examples": { "addsServices_getMetricMetadata": { "$ref": "./examples/MetricMetadata.json" } }, "operationId": "addsServices_getMetricMetadata", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": " The metric metadata for the service.", "schema": { "$ref": "#/definitions/MetricMetadata" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { "get": { "tags": [ "Adds" ], "description": "Gets the service related metrics for a given metric and group combination.", "x-ms-examples": { "addsServices_getMetricMetadataForGroup": { "$ref": "./examples/MetricSets.json" } }, "operationId": "addsServices_getMetricMetadataForGroup", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "name": "groupKey", "in": "query", "description": "The group key", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "description": "The start date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "The end date.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The metric sets for a given service and group. ", "schema": { "$ref": "#/definitions/MetricSets" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails": { "get": { "tags": [ "Adds" ], "description": "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.", "x-ms-examples": { "addsServices_listReplicationDetails": { "$ref": "./examples/ReplicationDetails.json" } }, "operationId": "addsServices_listReplicationDetails", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The server property filter to apply.", "required": false, "type": "string" }, { "name": "withDetails", "in": "query", "description": "Indicates if InboundReplicationNeighbor details are required or not.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of replication details for a service. ", "schema": { "$ref": "#/definitions/ReplicationDetailsList" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus": { "get": { "tags": [ "Adds" ], "description": "Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "addsServicesReplicationStatus_get": { "$ref": "./examples/ReplicationStatus.json" } }, "operationId": "addsServicesReplicationStatus_get", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The replication status for a service. ", "schema": { "$ref": "#/definitions/ReplicationStatus" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary": { "get": { "tags": [ "Adds" ], "description": "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.", "x-ms-examples": { "addsServices_listReplicationSummary": { "$ref": "./examples/ReplicationSummary.json" } }, "operationId": "addsServices_listReplicationSummary", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The server property filter to apply.", "required": false, "type": "string" }, { "name": "isGroupbySite", "in": "query", "description": "Indicates if the result should be grouped by site or not.", "required": true, "type": "boolean" }, { "name": "query", "in": "query", "description": "The custom query.", "required": true, "type": "string" }, { "name": "nextPartitionKey", "in": "query", "description": "The next partition key to query for.", "required": true, "type": "string", "enum": [ " " ], "x-ms-enum": { "name": "nextPartitionKey", "modelAsString": true } }, { "name": "nextRowKey", "in": "query", "description": "The next row key to query for.", "required": true, "type": "string", "enum": [ " " ], "x-ms-enum": { "name": "nextRowKey", "modelAsString": true } }, { "name": "takeCount", "in": "query", "description": "The take count , which specifies the number of elements that can be returned from a sequence.", "required": false, "type": "integer" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of replication summary for a service. ", "schema": { "$ref": "#/definitions/ReplicationSummaryList" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers": { "get": { "tags": [ "Adds" ], "description": "Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", "x-ms-examples": { "addsServicesServiceMembers_list": { "$ref": "./examples/ServiceMembers.json" } }, "operationId": "addsServicesServiceMembers_list", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The server property filter to apply.", "required": false, "type": "string" }, { "name": "dimensionType", "in": "query", "description": "The server specific dimension.", "required": false, "type": "string" }, { "name": "dimensionSignature", "in": "query", "description": "The value of the dimension.", "required": false, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of service members for a given service.", "schema": { "$ref": "#/definitions/ServiceMembers" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "tags": [ "Adds" ], "description": "Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.", "x-ms-examples": { "addsServicesServiceMembers_add": { "$ref": "./examples/AddServiceMembers.json" } }, "operationId": "addsServicesServiceMembers_add", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service under which the server is to be onboarded.", "required": true, "type": "string" }, { "name": "serviceMember", "in": "body", "description": "The server object.", "required": true, "schema": { "$ref": "#/definitions/ServiceMember" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully added the service member.", "schema": { "$ref": "#/definitions/ServiceMember" } } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}": { "get": { "tags": [ "Adds" ], "description": "Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", "x-ms-examples": { "addsServiceMembers_get": { "$ref": "./examples/ServiceMember.json" } }, "operationId": "addsServiceMembers_get", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The service member details for a given service. ", "schema": { "$ref": "#/definitions/ServiceMember" } } } }, "delete": { "tags": [ "Adds" ], "description": "Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.", "x-ms-examples": { "addsServiceMembers_delete": { "$ref": "./examples/DeleteServer.json" } }, "operationId": "addsServiceMembers_delete", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "name": "confirm", "in": "query", "description": "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.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the service member." } } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts": { "get": { "tags": [ "Adds" ], "description": "Gets the details of an alert for a given Active Directory Domain Controller service and server combination.", "x-ms-examples": { "addsServices_listServerAlerts": { "$ref": "./examples/Server_Alerts.json" } }, "operationId": "addsServices_listServerAlerts", "parameters": [ { "name": "serviceMemberId", "in": "path", "description": "The server Id for which the alert details needs to be queried.", "required": true, "type": "string", "format": "uuid" }, { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The alert property filter to apply.", "required": false, "type": "string" }, { "name": "state", "in": "query", "description": "The alert state to query for.", "required": false, "type": "string" }, { "name": "from", "in": "query", "description": "The start date to query for.", "required": false, "type": "string", "format": "date-time" }, { "name": "to", "in": "query", "description": "The end date till when to query for.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of server alerts.", "schema": { "$ref": "#/definitions/Alerts" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials": { "get": { "tags": [ "Adds" ], "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", "x-ms-examples": { "addsServiceMembers_listCredentials": { "$ref": "./examples/Credentials.json" } }, "operationId": "addsServiceMembers_listCredentials", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The property filter to apply.", "required": false, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of server credentials.", "schema": { "$ref": "#/definitions/Credentials" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck": { "get": { "tags": [ "Services" ], "description": "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.", "x-ms-examples": { "addsServices_listPremiumServices": { "$ref": "./examples/Services.json" } }, "operationId": "addsServices_listPremiumServices", "parameters": [ { "name": "$filter", "in": "query", "description": "The service property filter to apply.", "required": false, "type": "string" }, { "name": "serviceType", "in": "query", "description": "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.", "required": false, "type": "string" }, { "name": "skipCount", "in": "query", "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", "required": false, "type": "integer" }, { "name": "takeCount", "in": "query", "description": "The take count , which specifies the number of elements that can be returned from a sequence.", "required": false, "type": "integer" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of premium services.", "schema": { "$ref": "#/definitions/Services" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/operations": { "get": { "tags": [ "operations" ], "x-ms-examples": { "operations_list": { "$ref": "./examples/OperationList.json" } }, "operationId": "operations_list", "description": "Lists the available Azure Data Factory API operations.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of operations.", "schema": { "$ref": "#/definitions/OperationListResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/configuration": { "post": { "tags": [ "Configuration" ], "description": "Onboards a tenant in Azure Active Directory Connect Health.", "x-ms-examples": { "configuration_add": { "$ref": "./examples/Tenant.json" } }, "operationId": "configuration_add", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully added the tenant.", "schema": { "$ref": "#/definitions/Tenant" } } } }, "get": { "tags": [ "Configuration" ], "description": "Gets the details of a tenant onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "configuration_get": { "$ref": "./examples/Tenant.json" } }, "operationId": "configuration_get", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The tenant details.", "schema": { "$ref": "#/definitions/Tenant" } } } }, "patch": { "tags": [ "Configuration" ], "description": "Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "configuration_update": { "$ref": "./examples/PatchTenant.json" } }, "operationId": "configuration_update", "parameters": [ { "name": "tenant", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Tenant" }, "description": "The tenant object with the properties set to the updated value." }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the tenant.", "schema": { "$ref": "#/definitions/Tenant" } } } } }, "/providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps": { "get": { "tags": [ "DevOps" ], "description": "Checks if the user is enabled for Dev Ops access.", "x-ms-examples": { "reports_getDevOps": { "$ref": "./examples/DevOps.json" } }, "operationId": "reports_getDevOps", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Indicates if the user is Dev Ops or not.", "schema": { "$ref": "#/definitions/Result" } } } } }, "/providers/Microsoft.ADHybridHealthService/services": { "get": { "tags": [ "Services" ], "description": "Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "services_list": { "$ref": "./examples/Services.json" } }, "operationId": "services_list", "parameters": [ { "name": "$filter", "in": "query", "description": "The service property filter to apply.", "required": false, "type": "string" }, { "name": "serviceType", "in": "query", "description": "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.", "required": false, "type": "string" }, { "name": "skipCount", "in": "query", "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", "required": false, "type": "integer" }, { "name": "takeCount", "in": "query", "description": "The take count , which specifies the number of elements that can be returned from a sequence.", "required": false, "type": "integer" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of services.", "schema": { "$ref": "#/definitions/Services" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "tags": [ "Services" ], "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", "x-ms-examples": { "services_add": { "$ref": "./examples/AddService.json" } }, "operationId": "services_add", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "name": "service", "in": "body", "description": "The service object.", "required": true, "schema": { "$ref": "#/definitions/ServiceProperties" } } ], "responses": { "200": { "description": "Successfully added the service.", "schema": { "$ref": "#/definitions/ServiceProperties" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/premiumCheck": { "get": { "tags": [ "Services" ], "description": "Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "services_listPremium": { "$ref": "./examples/Services.json" } }, "operationId": "services_listPremium", "parameters": [ { "name": "$filter", "in": "query", "description": "The service property filter to apply.", "required": false, "type": "string" }, { "name": "serviceType", "in": "query", "description": "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.", "required": false, "type": "string" }, { "name": "skipCount", "in": "query", "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", "required": false, "type": "integer" }, { "name": "takeCount", "in": "query", "description": "The take count , which specifies the number of elements that can be returned from a sequence.", "required": false, "type": "integer" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of premium services.", "schema": { "$ref": "#/definitions/Services" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}": { "get": { "tags": [ "Services" ], "description": "Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "services_get": { "$ref": "./examples/Service.json" } }, "operationId": "services_get", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of services.", "schema": { "$ref": "#/definitions/ServiceProperties" } } } }, "delete": { "tags": [ "Services" ], "description": "Deletes a service which is onboarded to Azure Active Directory Connect Health.", "x-ms-examples": { "services_delete": { "$ref": "./examples/DeleteService.json" } }, "operationId": "services_delete", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service which needs to be deleted.", "required": true, "type": "string" }, { "name": "confirm", "in": "query", "description": "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.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "204": { "description": "Successfully deleted the service." } } }, "patch": { "tags": [ "Services" ], "description": "Updates the service properties of an onboarded service.", "x-ms-examples": { "services_update": { "$ref": "./examples/UpdateService.json" } }, "operationId": "services_update", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service which needs to be deleted.", "required": true, "type": "string" }, { "name": "service", "in": "body", "description": "The service object.", "required": true, "schema": { "$ref": "#/definitions/ServiceProperties" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the service.", "schema": { "$ref": "#/definitions/ServiceProperties" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts": { "get": { "tags": [ "Alerts" ], "description": "Gets the alerts for a given service.", "x-ms-examples": { "services_listAlerts": { "$ref": "./examples/Alerts.json" } }, "operationId": "services_listAlerts", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The alert property filter to apply.", "required": false, "type": "string" }, { "name": "state", "in": "query", "description": "The alert state to query for.", "required": false, "type": "string" }, { "name": "from", "in": "query", "description": "The start date to query for.", "required": false, "type": "string", "format": "date-time" }, { "name": "to", "in": "query", "description": "The end date till when to query for.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of alerts.", "schema": { "$ref": "#/definitions/Alerts" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}": { "get": { "tags": [ "Services" ], "description": "Checks if the service has all the pre-requisites met to use a feature.", "x-ms-examples": { "services_getFeatureAvailibility": { "$ref": "./examples/CheckFeatureAvailibility.json" } }, "operationId": "services_getFeatureAvailibility", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "featureName", "in": "path", "description": "The name of the feature.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Indicates if the feature is available or not.", "schema": { "$ref": "#/definitions/Result" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts": { "get": { "tags": [ "Services" ], "description": "Gets the count of latest AAD export errors.", "x-ms-examples": { "services_listExportErrors": { "$ref": "./examples/ErrorCounts.json" } }, "operationId": "services_listExportErrors", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of export errors.", "schema": { "$ref": "#/definitions/ErrorCounts" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2": { "get": { "tags": [ "Services" ], "description": " Gets the categorized export errors.", "x-ms-examples": { "services_listExportErrorsV2": { "$ref": "./examples/MergedExportErrors.json" } }, "operationId": "services_listExportErrorsV2", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "errorBucket", "in": "query", "description": "The error category to query for.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of merged export errors.", "schema": { "$ref": "#/definitions/MergedExportErrors" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus": { "get": { "tags": [ "Services" ], "description": "Gets the export status.", "x-ms-examples": { "services_listExportStatus": { "$ref": "./examples/ExportStatus.json" } }, "operationId": "services_listExportStatus", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of export statuses.", "schema": { "$ref": "#/definitions/ExportStatuses" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback": { "post": { "tags": [ "Feedback" ], "description": "Adds an alert feedback submitted by customer.", "x-ms-examples": { "services_addAlertFeedback": { "$ref": "./examples/AddAlertFeedback.json" } }, "operationId": "services_addAlertFeedback", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "alertFeedback", "in": "body", "description": "The alert feedback.", "required": true, "schema": { "$ref": "#/definitions/AlertFeedback" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully added alert feedback.", "schema": { "$ref": "#/definitions/AlertFeedback" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback": { "get": { "tags": [ "Feedback" ], "description": "Gets a list of all alert feedback for a given tenant and alert type.", "x-ms-examples": { "services_listAlertFeedback": { "$ref": "./examples/GetAlertFeedback.json" } }, "operationId": "services_listAlertFeedback", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "shortName", "in": "path", "description": "The name of the alert.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of alert feedback.", "schema": { "$ref": "#/definitions/AlertFeedbacks" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}": { "get": { "tags": [ "Metrics" ], "description": "Gets the server related metrics for a given metric and group combination.", "x-ms-examples": { "service_getMetrics": { "$ref": "./examples/Service_MetricSets.json" } }, "operationId": "service_getMetrics", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "name": "groupKey", "in": "query", "description": "The group key", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "description": "The start date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "The end date.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The metric sets for a given service.", "schema": { "$ref": "#/definitions/MetricSets" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { "get": { "tags": [ "Metrics" ], "description": "Gets the average of the metric values for a given metric and group combination.", "x-ms-examples": { "services_listMetricsAverage": { "$ref": "./examples/Metrics.json" } }, "operationId": "services_listMetricsAverage", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of average metrics for a given service.", "schema": { "$ref": "#/definitions/Metrics" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { "get": { "tags": [ "Metrics" ], "description": "Gets the sum of the metric values for a given metric and group combination.", "x-ms-examples": { "services_listMetricsSum": { "$ref": "./examples/Metrics.json" } }, "operationId": "services_listMetricsSum", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of metrics for a given service.", "schema": { "$ref": "#/definitions/Metrics" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata": { "get": { "tags": [ "Metrics" ], "description": "Gets the service related metrics information.", "x-ms-examples": { "services_listMetricMetadata": { "$ref": "./examples/MetricMetadataList.json" } }, "operationId": "services_listMetricMetadata", "parameters": [ { "name": "$filter", "in": "query", "description": "The metric metadata property filter to apply.", "required": false, "type": "string" }, { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "perfCounter", "in": "query", "description": "Indicates if only performance counter metrics are requested.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of metric metadata for a given service.", "schema": { "$ref": "#/definitions/MetricMetadataList" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}": { "get": { "tags": [ "Metrics" ], "description": "Gets the service related metrics information.", "x-ms-examples": { "services_getMetricMetadata": { "$ref": "./examples/MetricMetadata.json" } }, "operationId": "services_getMetricMetadata", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The metric metadata for a given metric.", "schema": { "$ref": "#/definitions/MetricMetadata" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { "get": { "tags": [ "Metrics" ], "description": "Gets the service related metrics for a given metric and group combination.", "x-ms-examples": { "services_getMetricMetadataForGroup": { "$ref": "./examples/MetricSets.json" } }, "operationId": "services_getMetricMetadataForGroup", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "name": "groupKey", "in": "query", "description": "The group key", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "description": "The start date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "The end date.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The metric sets for a given service and group.", "schema": { "$ref": "#/definitions/MetricSets" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration": { "patch": { "tags": [ "Services" ], "description": "Updates the service level monitoring configuration.", "x-ms-examples": { "services_updateMonitoringConfiguration": { "$ref": "./examples/PatchMonitoringConfiguration.json" } }, "operationId": "services_updateMonitoringConfiguration", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "configurationSetting", "in": "body", "description": "The monitoring configuration to update", "required": true, "schema": { "$ref": "#/definitions/Item" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the monitoring configuration." } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations": { "get": { "tags": [ "Services" ], "description": "Gets the service level monitoring configurations.", "x-ms-examples": { "services_listMonitoringConfigurations": { "$ref": "./examples/MonitoringConfigurations.json" } }, "operationId": "services_listMonitoringConfigurations", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of monitoring configurations.", "schema": { "$ref": "#/definitions/Items" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user": { "get": { "tags": [ "Reports" ], "description": "Gets the bad password login attempt report for an user", "x-ms-examples": { "services_listUserBadPasswordReport": { "$ref": "./examples/BadPasswordDetails.json" } }, "operationId": "services_listUserBadPasswordReport", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "dataSource", "in": "query", "description": "The source of data, if its test data or customer data.", "required": false, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of bad password login attempts.", "schema": { "$ref": "#/definitions/ErrorReportUsersEntries" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_list": { "$ref": "./examples/ServiceMembers.json" } }, "operationId": "serviceMembers_list", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The server property filter to apply.", "required": false, "type": "string" }, { "name": "dimensionType", "in": "query", "description": "The server specific dimension.", "required": false, "type": "string" }, { "name": "dimensionSignature", "in": "query", "description": "The value of the dimension.", "required": false, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of service members.", "schema": { "$ref": "#/definitions/ServiceMembers" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "tags": [ "ServiceMembers" ], "description": "Onboards a server, for a given service, to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_add": { "$ref": "./examples/AddServiceMembers.json" } }, "operationId": "serviceMembers_add", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service under which the server is to be onboarded.", "required": true, "type": "string" }, { "name": "serviceMember", "in": "body", "description": "The server object.", "required": true, "schema": { "$ref": "#/definitions/ServiceMember" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully added the service member.", "schema": { "$ref": "#/definitions/ServiceMember" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_get": { "$ref": "./examples/ServiceMember.json" } }, "operationId": "serviceMembers_get", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The specific service member.", "schema": { "$ref": "#/definitions/ServiceMember" } } } }, "delete": { "tags": [ "ServiceMembers" ], "description": "Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_delete": { "$ref": "./examples/DeleteServer.json" } }, "operationId": "serviceMembers_delete", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "name": "confirm", "in": "query", "description": "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.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the service member." } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts": { "get": { "tags": [ "Alerts" ], "description": "Gets the details of an alert for a given service and server combination.", "x-ms-examples": { "serviceMembers_listAlerts": { "$ref": "./examples/Server_Alerts.json" } }, "operationId": "serviceMembers_listAlerts", "parameters": [ { "name": "serviceMemberId", "in": "path", "description": "The server Id for which the alert details needs to be queried.", "required": true, "type": "string", "format": "uuid" }, { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The alert property filter to apply.", "required": false, "type": "string" }, { "name": "state", "in": "query", "description": "The alert state to query for.", "required": false, "type": "string" }, { "name": "from", "in": "query", "description": "The start date to query for.", "required": false, "type": "string", "format": "date-time" }, { "name": "to", "in": "query", "description": "The end date till when to query for.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of alerts.", "schema": { "$ref": "#/definitions/Alerts" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the connector details for a service.", "x-ms-examples": { "serviceMembers_listConnectors": { "$ref": "./examples/Connectors.json" } }, "operationId": "serviceMembers_listConnectors", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of connector details.", "schema": { "$ref": "#/definitions/Connectors" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_listCredentials": { "$ref": "./examples/Credentials.json" } }, "operationId": "serviceMembers_listCredentials", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The property filter to apply.", "required": false, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of service member credentials.", "schema": { "$ref": "#/definitions/Credentials" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data": { "delete": { "tags": [ "ServiceMembers" ], "description": "Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_deleteData": { "$ref": "./examples/DeleteServer.json" } }, "operationId": "serviceMembers_deleteData", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the service member." } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.", "x-ms-examples": { "serviceMembers_listDataFreshness": { "$ref": "./examples/Datafreshness.json" } }, "operationId": "serviceMembers_listDataFreshness", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of datafreshness details for a server.", "schema": { "$ref": "#/definitions/DataFreshnessDetails" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the export status.", "x-ms-examples": { "serviceMembers_listExportStatus": { "$ref": "./examples/Server_ExportStatus.json" } }, "operationId": "serviceMembers_listExportStatus", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of export statuses.", "schema": { "$ref": "#/definitions/ExportStatuses" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the global configuration.", "x-ms-examples": { "serviceMembers_listGlobalConfiguration": { "$ref": "./examples/GlobalConfiguration.json" } }, "operationId": "serviceMembers_listGlobalConfiguration", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server id.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of global configurations.", "schema": { "$ref": "#/definitions/GlobalConfigurations" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}": { "get": { "tags": [ "Metrics" ], "description": "Gets the server related metrics for a given metric and group combination.", "x-ms-examples": { "serviceMembers_getMetrics": { "$ref": "./examples/Server_MetricSets.json" } }, "operationId": "serviceMembers_getMetrics", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "metricName", "in": "path", "description": "The metric name", "required": true, "type": "string" }, { "name": "groupName", "in": "path", "description": "The group name", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server id.", "required": true, "type": "string", "format": "uuid" }, { "name": "groupKey", "in": "query", "description": "The group key", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "description": "The start date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "The end date.", "required": false, "type": "string", "format": "date-time" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of metric sets for a given metric.", "schema": { "$ref": "#/definitions/MetricSets" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration": { "get": { "tags": [ "ServiceMembers" ], "description": "Gets the service configuration.", "x-ms-examples": { "serviceMembers_getServiceConfiguration": { "$ref": "./examples/ServiceConfiguration.json" } }, "operationId": "serviceMembers_getServiceConfiguration", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The server Id.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The service configuration.", "schema": { "$ref": "#/definitions/ServiceConfiguration" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}": { "get": { "tags": [ "Services" ], "description": "Checks if the tenant, to which a service is registered, is listed as allowed to use a feature.", "x-ms-examples": { "services_getTenantWhitelisting": { "$ref": "./examples/TenantWhitelisting.json" } }, "operationId": "services_getTenantWhitelisting", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "featureName", "in": "path", "description": "The name of the feature.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Indicates if a tenant is listed as allowed for a feature or not.", "schema": { "$ref": "#/definitions/Result" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris": { "get": { "tags": [ "Reports" ], "description": "Gets all Risky IP report URIs for the last 7 days.", "x-ms-examples": { "services_listAllRiskyIpDownloadReport": { "$ref": "./examples/RiskyIpDownload.json" } }, "operationId": "services_listAllRiskyIpDownloadReport", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Risky IP report URIs for the last 7 days.", "schema": { "$ref": "#/definitions/RiskyIPBlobUris" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri": { "post": { "tags": [ "Reports" ], "description": "Initiate the generation of a new Risky IP report. Returns the URI for the new one.", "x-ms-examples": { "services_listCurrentRiskyIpDownloadReport": { "$ref": "./examples/RiskyIpDownload.json" } }, "operationId": "services_listCurrentRiskyIpDownloadReport", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The URI of the Risky IP report that was requested.", "schema": { "$ref": "#/definitions/RiskyIPBlobUris" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}": { "get": { "tags": [ "Metrics" ], "description": "Gets the list of connectors and run profile names.", "x-ms-examples": { "serviceMembers_getConnectorMetadata": { "$ref": "./examples/ConnectorMetadata.json" } }, "operationId": "serviceMembers_getConnectorMetadata", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "serviceMemberId", "in": "path", "description": "The service member id.", "required": true, "type": "string", "format": "uuid" }, { "name": "metricName", "in": "path", "description": "The name of the metric.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Gets the list of connectors and run profile names for the given service and service member.", "schema": { "$ref": "#/definitions/ConnectorMetadata" } } } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregates": { "get": { "tags": [ "Reports" ], "description": "Gets the IP address aggregates for a given service.", "x-ms-examples": { "list_IPAddressAggregatesByService": { "$ref": "./examples/IpAddressAggregates.json" } }, "operationId": "list_IPAddressAggregatesByService", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "skiptoken", "in": "query", "description": "A continuationtoken value returned in paginated result to load different pages.", "required": false, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "The list of IP addresses.", "schema": { "$ref": "#/definitions/IPAddressAggregates" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/ipAddressAggregateSettings": { "get": { "tags": [ "Reports" ], "description": "Gets the IP address aggregate settings.", "x-ms-examples": { "list_IPAddressAggregateSettings": { "$ref": "./examples/IpAddressAggregateSettings.json" } }, "operationId": "list_IPAddressAggregateSettings", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "IP address aggregate settings.", "schema": { "$ref": "#/definitions/IPAddressAggregateSetting" } } } }, "patch": { "tags": [ "Configuration" ], "description": "Updates the IP address aggregate settings alert thresholds.", "x-ms-examples": { "update_IPAddressAggregateSettings": { "$ref": "./examples/IpAddressAggregateSettingsUpdate.json" } }, "operationId": "update_IPAddressAggregateSettings", "parameters": [ { "name": "serviceName", "in": "path", "description": "The name of the service.", "required": true, "type": "string" }, { "name": "IPAddressAggregateSetting", "in": "body", "description": "The IP address aggregate setting object.", "required": true, "schema": { "$ref": "#/definitions/IPAddressAggregateSetting" } }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "IP AddressAggregate Settings.", "schema": { "$ref": "#/definitions/IPAddressAggregateSetting" } } } } } }, "definitions": { "AddsConfiguration": { "description": "The list of key value properties.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "totalCount": { "description": "The total count of configuration.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "AdditionalInformation": { "description": "The additional information for a property.", "type": "object", "properties": { "titleName": { "description": "The title name for the property.", "type": "string" }, "titleValue": { "description": "The title value for the property.", "type": "string" }, "properties": { "description": "The list of properties which are included in the additional information.", "type": "object", "items": { "$ref": "#/definitions/Item" } }, "hasProperties": { "description": "Indicates if properties are present or not.", "type": "boolean" } } }, "AddsServiceMember": { "description": "The server details for ADDS service.", "type": "object", "properties": { "domainName": { "description": "The domain name.", "type": "string" }, "siteName": { "description": "The site name.", "type": "string" }, "addsRoles": { "description": "The list of ADDS roles.", "type": "array", "items": { "type": "string" } }, "gcReachable": { "description": "Indicates if the global catalog for this domain is reachable or not.", "type": "boolean" }, "isAdvertising": { "description": "Indicates if the Dc is advertising or not.", "type": "boolean" }, "pdcReachable": { "description": "Indicates if the primary domain controller is reachable or not.", "type": "boolean" }, "sysvolState": { "description": "Indicates if the SYSVOL state is healthy or not.", "type": "boolean" }, "dcTypes": { "description": "The list of domain controller types.", "type": "array", "items": { "type": "string" } }, "serviceMemberId": { "description": "The id of the server.", "type": "string" }, "serviceId": { "description": "The service id to whom this server belongs.", "type": "string" }, "tenantId": { "description": "The tenant id to whom this server belongs.", "type": "string" }, "activeAlerts": { "description": "The total number of alerts that are currently active for the server.", "type": "integer" }, "additionalInformation": { "description": "The additional information, if any, for the server.", "type": "string" }, "createdDate": { "description": "The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.", "type": "string", "format": "date-time" }, "dimensions": { "description": "The server specific configuration related dimensions.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "disabled": { "description": "Indicates if the server is disabled or not. ", "type": "boolean" }, "disabledReason": { "description": "The reason for disabling the server.", "type": "integer" }, "installedQfes": { "description": "The list of installed QFEs for the server.", "type": "array", "items": { "$ref": "#/definitions/Hotfix" } }, "lastDisabled": { "description": "The date and time , in UTC, when the server was last disabled.", "type": "string", "format": "date-time" }, "lastReboot": { "description": "The date and time, in UTC, when the server was last rebooted.", "type": "string", "format": "date-time" }, "lastServerReportedMonitoringLevelChange": { "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", "type": "string", "format": "date-time" }, "lastUpdated": { "description": "The date and time, in UTC, when the server properties were last updated.", "type": "string", "format": "date-time" }, "machineId": { "description": "The id of the machine.", "type": "string" }, "machineName": { "description": "The name of the server.", "type": "string" }, "monitoringConfigurationsComputed": { "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "monitoringConfigurationsCustomized": { "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "osName": { "description": "The name of the operating system installed in the machine.", "type": "string" }, "osVersion": { "description": "The version of the operating system installed in the machine.", "type": "string" }, "properties": { "description": "Server specific properties.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "recommendedQfes": { "description": "The list of recommended hotfixes for the server.", "type": "array", "items": { "$ref": "#/definitions/Hotfix" } }, "resolvedAlerts": { "description": "The total count of alerts that are resolved for this server.", "type": "integer" }, "role": { "description": "The service role that is being monitored in the server.", "type": "string" }, "serverReportedMonitoringLevel": { "description": "The monitoring level reported by the server.", "type": "string", "enum": [ "Partial", "Full", "Off" ], "x-ms-enum": { "name": "MonitoringLevel", "modelAsString": false } }, "status": { "description": "The health status of the server.", "type": "string" } } }, "AddsServiceMembers": { "description": "The list of ADDS service members.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/AddsServiceMember" } }, "totalCount": { "description": "The total count of service members.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "Agent": { "description": "The agent details.", "type": "object", "properties": { "tenantId": { "description": "The tenant Id.", "type": "string" }, "machineId": { "description": "The machine Id.", "type": "string" }, "credential": { "description": "The agent credential details.", "type": "object", "items": { "$ref": "#/definitions/Credential" } }, "machineName": { "description": "The machine name.", "type": "string" }, "agentVersion": { "description": "The agent version.", "type": "string" }, "createdDate": { "description": "The date and time, in UTC, when the agent was created.", "type": "string", "format": "date-time" }, "key": { "description": " The connector hash key.", "type": "string" } } }, "Alert": { "description": " The alert details indicating an issue with service or server.", "type": "object", "properties": { "alertId": { "description": "The alert Id.", "type": "string", "format": "uuid" }, "level": { "description": "The alert level which indicates the severity of the alert.", "type": "string", "enum": [ "Warning", "Error", "PreWarning" ], "x-ms-enum": { "name": "Level", "modelAsString": true } }, "state": { "description": "The alert state which can be either active or resolved with multiple resolution types.", "type": "string", "enum": [ "Active", "ResolvedByPositiveResult", "ResolvedManually", "ResolvedByTimer", "ResolvedByStateChange" ], "x-ms-enum": { "name": "State", "modelAsString": true } }, "shortName": { "description": "The alert short name.", "type": "string" }, "displayName": { "description": "The display name for the alert.", "type": "string" }, "description": { "description": "The alert description.", "type": "string" }, "remediation": { "description": "The alert remediation.", "type": "string" }, "relatedLinks": { "description": "The help links to get more information related to the alert.", "type": "array", "items": { "$ref": "#/definitions/HelpLink" } }, "scope": { "description": "The scope of the alert. Indicates if it is a service or a server related alert.", "type": "string" }, "additionalInformation": { "description": "Additional information related to the alert.", "type": "array", "items": { "$ref": "#/definitions/AdditionalInformation" } }, "createdDate": { "description": "The date and time,in UTC,when the alert was created.", "type": "string", "format": "date-time" }, "resolvedDate": { "description": "The date and time, in UTC, when the alert was resolved.", "type": "string", "format": "date-time" }, "lastUpdated": { "description": "The date and time, in UTC, when the alert was last updated.", "type": "string", "format": "date-time" }, "monitorRoleType": { "description": "The monitoring role type for which the alert was raised.", "type": "string" }, "activeAlertProperties": { "description": "The active alert properties.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "resolvedAlertProperties": { "description": "The resolved alert properties.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "tenantId": { "description": "The tenant Id.", "type": "string", "format": "uuid" }, "serviceId": { "description": "The service Id.", "type": "string", "format": "uuid" }, "serviceMemberId": { "description": "The server Id.", "type": "string", "format": "uuid" } } }, "AlertFeedback": { "description": "The alert feedback details.", "type": "object", "properties": { "level": { "description": "The alert level which indicates the severity of the alert.", "type": "string" }, "state": { "description": "The alert state which can be either active or resolved with multiple resolution types.", "type": "string" }, "shortName": { "description": "The alert short name.", "type": "string" }, "feedback": { "description": "The feedback for the alert which indicates if the customer likes or dislikes the alert.", "type": "string" }, "comment": { "description": "Additional comments related to the alert.", "type": "string" }, "consentedToShare": { "description": "Indicates if the alert feedback can be shared from product team.", "type": "boolean" }, "serviceMemberId": { "description": "The server Id of the alert.", "type": "string" }, "createdDate": { "description": "The date and time,in UTC,when the alert was created.", "type": "string", "format": "date-time" } } }, "AlertFeedbacks": { "description": "The list of alert feedback.", "type": "object", "properties": { "value": { "type": "array", "description": "The value returned by the operation.", "items": { "$ref": "#/definitions/AlertFeedback" } } } }, "Alerts": { "description": "The list of alerts for a service.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Alert" } }, "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "totalCount": { "description": "The total count of alert elements.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "AssociatedObject": { "description": "Object that hold sync object details.", "type": "object", "properties": { "displayName": { "description": "The display name of the object.", "type": "string" }, "distinguishedName": { "description": "The distinguished name of the object.", "type": "string" }, "lastDirSyncTime": { "description": "The last dirSync time.", "type": "string", "format": "date-time" }, "mail": { "description": "The email of the object.", "type": "string" }, "objectGuid": { "description": "The object guid.", "type": "string" }, "objectType": { "description": "The object type.", "type": "string" }, "onpremisesUserPrincipalName": { "description": "The On-premises UPN.", "type": "string" }, "proxyAddresses": { "description": "The proxy addresses.", "type": "string" }, "sourceAnchor": { "description": "The source anchor.", "type": "string" }, "sourceOfAuthority": { "description": "The source of authority.", "type": "string" }, "timeOccurred": { "description": " The time of the error.", "type": "string", "format": "date-time" }, "userPrincipalName": { "description": " The UPN.", "type": "string" } } }, "AttributeDelta": { "description": "The delta attributes.", "type": "object", "properties": { "values": { "description": "The delta values.", "type": "array", "items": { "$ref": "#/definitions/ValueDelta" } }, "name": { "description": "The name of the attribute delta.", "type": "string" }, "operationType": { "description": "The attribute delta operation type.", "type": "string", "enum": [ "Undefined", "Add", "Replace", "Update", "Delete" ], "x-ms-enum": { "name": "AttributeDeltaOperationType", "modelAsString": true } }, "valueType": { "description": "The value type.", "type": "string", "enum": [ "Undefined", "Dn", "Binary", "String", "Integer", "Boolean" ], "x-ms-enum": { "name": "ValueType", "modelAsString": true } }, "multiValued": { "description": "Indicates if the attribute delta is multivalued or not.", "type": "boolean" } } }, "AttributeMapping": { "description": "The attribute mapping details.", "type": "object", "properties": { "mappingSource": { "description": "The mapping source.", "$ref": "#/definitions/AttributeMppingSource" }, "type": { "description": "The attribute mapping type.", "type": "string", "enum": [ "Constant", "Direct", "DnPart", "Script" ], "x-ms-enum": { "name": "AttributeMappingType", "modelAsString": true } }, "destinationAttribute": { "description": "The destination attribute.", "type": "string" }, "contextId": { "description": "The context Id.", "type": "string" } } }, "AttributeMppingSource": { "description": "The attribute mapping source.", "type": "object", "properties": { "sourceAttribute": { "description": "The source attribute.", "type": "array", "items": { "type": "string" } }, "dnPart": { "description": "The value for dn part.", "type": "integer" }, "scriptContext": { "description": "The script context.", "type": "string" }, "constantValue": { "description": "The constant value.", "type": "string" } } }, "ChangeNotReimported": { "description": "The changes which are not re-imported.", "type": "object", "properties": { "delta": { "description": "The delta changes that is not re-imported.", "$ref": "#/definitions/ChangeNotReimportedDelta" }, "entry": { "description": "The object entry in a change that is not re-imported.", "$ref": "#/definitions/ChangeNotReimportedEntry" } } }, "ChangeNotReimportedDelta": { "description": "The delta in a change that is not re-imported.", "type": "object", "properties": { "anchor": { "description": "The anchor.", "type": "string" }, "dnAttributes": { "description": "The delta attributes for distinguished names.", "type": "array", "items": { "$ref": "#/definitions/AttributeDelta" } }, "attributes": { "description": "The attributes.", "type": "array", "items": { "$ref": "#/definitions/AttributeDelta" } }, "operationType": { "description": "The operation type.", "type": "string", "enum": [ "Undefined", "None", "Add", "Replace", "Update", "Delete", "Obsolete", "DeleteAdd" ], "x-ms-enum": { "name": "DeltaOperationType", "modelAsString": true } } } }, "ChangeNotReimportedEntry": { "description": "The object entry in a change that is not re-imported.", "type": "object", "properties": { "anchor": { "description": "The anchor.", "type": "string" }, "parentAnchor": { "description": "The parent anchor.", "type": "string" }, "primaryObjectClass": { "description": "The primary object class.", "type": "string" }, "objectClasses": { "description": "The list of object classes.", "type": "array", "items": { "type": "string" } }, "dnAttributes": { "description": "The delta attributes for distinguished names.", "type": "array", "items": { "$ref": "#/definitions/AttributeDelta" } }, "attributes": { "description": "The attributes.", "type": "array", "items": { "$ref": "#/definitions/AttributeDelta" } }, "dn": { "description": "The distinguished name.", "type": "string" } } }, "Connector": { "description": "The connect details.", "type": "object", "properties": { "connectorId": { "description": "The connector Id.", "type": "string" }, "id": { "description": "The connector Id.", "type": "string" }, "name": { "description": "The connector name.", "type": "string" }, "version": { "description": "The connector version", "type": "integer" }, "type": { "description": "The connector type.", "type": "string" }, "description": { "description": "The connector description.", "type": "string" }, "schemaXml": { "description": "The schema xml for the connector.", "type": "string" }, "passwordManagementSettings": { "description": "The password management settings of the connector.", "type": "object", "items": { "$ref": "#/definitions/PasswordManagementSettings" } }, "passwordHashSyncConfiguration": { "description": "The password hash synchronization configuration of the connector.", "type": "object", "items": { "$ref": "#/definitions/PasswordHashSyncConfiguration" } }, "timeCreated": { "description": "The date and time when this connector was created.", "type": "string", "format": "date-time" }, "timeLastModified": { "description": "The date and time when this connector was last modified.", "type": "string", "format": "date-time" }, "partitions": { "description": "The partitions of the connector.", "type": "array", "items": { "$ref": "#/definitions/Partition" } }, "runProfiles": { "description": "The run profiles of the connector.", "type": "array", "items": { "$ref": "#/definitions/RunProfile" } }, "classesIncluded": { "description": "The class inclusion list of the connector.", "type": "array", "items": { "type": "string" } }, "attributesIncluded": { "description": "The attribute inclusion list of the connector.", "type": "array", "items": { "type": "string" } } } }, "Connectors": { "description": "The list of connects for a service.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Connector" } } } }, "ConnectorConnectionError": { "description": "The connector connection error.", "type": "object", "properties": { "id": { "description": "The error Id.", "type": "string" }, "runStepResultId": { "description": "The run step result Id.", "type": "string" }, "connectorId": { "description": "The connector Id.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" }, "errorCode": { "description": "The error code.", "type": "string" }, "message": { "description": "The message for the connection error.", "type": "string" }, "timeOccured": { "description": "The time when the connection error occurred.", "type": "string", "format": "date-time" }, "server": { "description": "The server where the connection error happened.", "type": "string" } } }, "ConnectorConnectionErrors": { "description": "The list of connector connection errors.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ConnectorConnectionError" } } } }, "ConnectorMetadata": { "description": "Gets the list of connectors and run profile names.", "type": "object", "properties": { "connectors": { "description": "The list of connectors.", "type": "array", "items": { "$ref": "#/definitions/ConnectorMetadataDetails" } }, "runProfileNames": { "description": "The list of run profile names.", "type": "array", "items": { "type": "string" } } } }, "ConnectorMetadataDetails": { "description": "Details of the connector.", "type": "object", "properties": { "connectorId": { "description": "The Connector Id.", "type": "string" }, "connectorDisplayName": { "description": "The Connector Display Name", "type": "string" } } }, "ConnectorObjectError": { "description": "The connector object error.", "type": "object", "properties": { "id": { "description": "The error Id.", "type": "string" }, "runStepResultId": { "description": "The run step result Id.", "type": "string" }, "connectorId": { "description": "The connector Id.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" }, "errorCode": { "description": "The error code.", "type": "string" }, "message": { "description": "The message for the object error.", "type": "string" }, "entryNumber": { "description": "The entry number for object error occurred.", "type": "integer" }, "lineNumber": { "description": "The line number for the object error.", "type": "integer" }, "columnNumber": { "description": "The column number for the object error.", "type": "integer" }, "dn": { "description": "The distinguished name of the object.", "type": "string" }, "anchor": { "description": "The name for the anchor of the object.", "type": "string" }, "attributeName": { "description": "The attribute name of the object.", "type": "string" }, "serverErrorDetail": { "description": "The server side error details.", "type": "string" }, "values": { "description": "The value corresponding to attribute name.", "type": "array", "items": { "type": "string" } } } }, "ConnectorObjectErrors": { "description": "The list of connector object errors.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ConnectorObjectError" } } } }, "Credential": { "description": "The credential for a given server.", "type": "object", "properties": { "identifier": { "description": "The credential identifier.", "type": "string" }, "type": { "description": "The type of credential.", "type": "string" }, "credentialData": { "description": "The credential data.", "type": "array", "items": { "type": "string" } } } }, "Credentials": { "description": "The list of agent credentials.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Credential" } } } }, "DataFreshnessDetails": { "description": "The data freshness details for the server.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Item" } } } }, "Dimension": { "description": "The connector object error.", "type": "object", "properties": { "health": { "description": "The health status for the domain controller.", "type": "string", "enum": [ "Healthy", "Warning", "Error", "NotMonitored", "Missing" ], "x-ms-enum": { "name": "HealthStatus", "modelAsString": true } }, "simpleProperties": { "description": "List of service specific configuration properties.", "type": "object", "items": { "$ref": "#/definitions/Item" } }, "activeAlerts": { "description": "The count of alerts that are currently active for the service.", "type": "integer" }, "additionalInformation": { "description": "The additional information related to the service.", "type": "string" }, "lastUpdated": { "description": "The date or time , in UTC, when the service properties were last updated.", "type": "string", "format": "date-time" }, "displayName": { "description": "The display name of the service.", "type": "string" }, "resolvedAlerts": { "description": "The total count of alerts that has been resolved for the service.", "type": "integer" }, "signature": { "description": "The signature of the service.", "type": "string" }, "type": { "description": "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.", "type": "string" } } }, "Dimensions": { "description": "The list of dimensions.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Dimension" } }, "totalCount": { "description": "The total count of dimensions.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "Display": { "description": "Displays the details related to operations supported by Azure Active Directory Connect Health.", "type": "object", "properties": { "description": { "description": " The description for the operation.", "type": "string" }, "operation": { "description": "The details of the operation.", "type": "string" }, "provider": { "description": "The provider name.", "type": "string" } } }, "ErrorCount": { "description": "The error count details.", "type": "object", "properties": { "errorBucket": { "description": "The error bucket.", "type": "string" }, "count": { "description": "The error count.", "type": "integer" }, "truncated": { "description": "Indicates if the error count is truncated or not.", "type": "boolean" } } }, "ErrorCounts": { "description": "The list of error counts.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ErrorCount" } } } }, "ErrorDetail": { "description": "The error details.", "type": "object", "properties": { "description": { "description": "The error description.", "type": "string" }, "kbUrl": { "description": "The knowledge base article url which contains more information about the error.", "type": "string" }, "detail": { "description": "Additional details related to the error.", "type": "string" }, "objectsWithSyncError": { "description": "The list of objects with sync errors.", "$ref": "#/definitions/ObjectWithSyncError" }, "objectWithSyncError": { "description": " The object with sync error.", "$ref": "#/definitions/MergedExportError" } } }, "ExportError": { "description": "The export error details.", "type": "object", "properties": { "id": { "description": "The error Id.", "type": "string" }, "runStepResultId": { "description": "The run step result Id.", "type": "string" }, "connectorId": { "description": "The connector Id.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" }, "errorCode": { "description": "The error code.", "type": "string" }, "message": { "description": "The export error message.", "type": "string" }, "serverErrorDetail": { "description": "The server error detail.", "type": "string" }, "timeFirstOccured": { "description": "The date and time when the export error first occurred.", "type": "string", "format": "date-time" }, "retryCount": { "description": "The retry count.", "type": "integer" }, "csObjectId": { "description": "The cloud object Id.", "type": "string" }, "dn": { "description": "The distinguished name.", "type": "string" }, "minLimit": { "description": "The minimum limit.", "type": "string" }, "maxLimit": { "description": "The maximum limit.", "type": "string" }, "cloudAnchor": { "description": "The name of the cloud anchor.", "type": "string" }, "attributeName": { "description": "The attribute name.", "type": "string" }, "attributeValue": { "description": "The attribute value.", "type": "string" }, "attributeMultiValue": { "description": "Indicates if the attribute is multi valued or not.", "type": "boolean" }, "objectIdConflict": { "description": "The object Id with which there was an attribute conflict.", "type": "string" }, "samAccountName": { "description": "The SAM account name.", "type": "string" }, "adObjectType": { "description": "The AD object type", "type": "string" }, "adObjectGuid": { "description": "The AD object guid.", "type": "string" }, "adDisplayName": { "description": "The display name for the AD object.", "type": "string" }, "adSourceOfAuthority": { "description": "The source of authority for the AD object.", "type": "string" }, "adSourceAnchor": { "description": "The AD source anchor.", "type": "string" }, "adUserPrincipalName": { "description": "The user principal name for the AD object.", "type": "string" }, "adDistinguishedName": { "description": "The distinguished name for the AD object.", "type": "string" }, "adMail": { "description": "The email for the AD object.", "type": "string" }, "timeOccured": { "description": "The date and time of occurrence.", "type": "string", "format": "date-time" }, "aadObjectType": { "description": "The AAD side object type.", "type": "string" }, "aadObjectGuid": { "description": "The AAD side object guid.", "type": "string" }, "aadDisplayName": { "description": "The AAD side display name", "type": "string" }, "aadSourceOfAuthority": { "description": "The AAD side source of authority for the object.", "type": "string" }, "aadUserPrincipalName": { "description": "The AAD side user principal name.", "type": "string" }, "aadDistinguishedName": { "description": "The AAD side distinguished name for the object.", "type": "string" }, "aadMail": { "description": "The AAD side email for the object.", "type": "string" }, "lastDirSyncTime": { "description": "The date and time of last sync run.", "type": "string", "format": "date-time" }, "modifiedAttributeValue": { "description": "The modified attribute value.", "type": "string" } } }, "ExportErrors": { "description": "The list of export errors.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ExportError" } } } }, "ErrorReportUsersEntry": { "description": "The bad password login attempt details.", "type": "object", "properties": { "userId": { "description": "The user ID value.", "type": "string" }, "ipAddress": { "description": "The IP address corresponding to the last error event.", "type": "string" }, "lastUpdated": { "description": "The date and time when the last error event was logged.", "type": "string", "format": "date-time" }, "uniqueIpAddresses": { "description": "The list of unique IP addresses.", "type": "string" }, "totalErrorAttempts": { "description": "The total count of specific error events.", "type": "integer" } } }, "ErrorReportUsersEntries": { "description": "The list of bad password log in attempt entries.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ErrorReportUsersEntry" } } } }, "ExportStatus": { "description": "The details of the export status.", "type": "object", "properties": { "serviceId": { "description": "The id of the service for whom the export status is being reported.", "type": "string", "format": "uuid" }, "serviceMemberId": { "description": "The server Id for whom the export status is being reported.", "type": "string", "format": "uuid" }, "endTime": { "description": "The date and time when the export ended.", "type": "string", "format": "date-time" }, "runStepResultId": { "description": "The run step result Id.", "type": "string" } } }, "ExportStatuses": { "description": "The list of export statuses.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ExportStatus" } }, "totalCount": { "description": "The total count of service elements.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "ExtensionErrorInfo": { "description": "The extension error details.", "type": "object", "properties": { "extensionName": { "description": "The extension name.", "type": "string" }, "extensionContext": { "description": "The extension context.", "type": "string" }, "callStack": { "description": "The call stack for the error.", "type": "string" } } }, "ForestSummary": { "description": "The forest summary for an ADDS domain.", "type": "object", "properties": { "forestName": { "description": "The forest name.", "type": "string" }, "domainCount": { "description": "The domain count.", "type": "integer" }, "siteCount": { "description": "The site count.", "type": "integer" }, "monitoredDcCount": { "description": "The number of domain controllers that are monitored by Azure Active Directory Connect Health.", "type": "integer" }, "totalDcCount": { "description": "The total domain controllers.", "type": "integer" }, "domains": { "description": "The list of domain controller names.", "type": "array", "items": { "type": "string" } }, "sites": { "description": "The list of site names.", "type": "array", "items": { "type": "string" } } } }, "GlobalConfiguration": { "description": "The global configuration settings.", "type": "object", "properties": { "version": { "description": "The version for the global configuration.", "type": "integer" }, "schemaXml": { "description": "The schema for the configuration.", "type": "string" }, "passwordSyncEnabled": { "description": "Indicates if password sync is enabled or not.", "type": "boolean" }, "numSavedPwdEvent": { "description": "The number of saved password events.", "type": "integer" }, "featureSet": { "description": "The list of additional feature sets.", "type": "array", "items": { "$ref": "#/definitions/Item" } } } }, "GlobalConfigurations": { "description": "The list of global configurations.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/GlobalConfiguration" } } } }, "HelpLink": { "description": "The help link which contains more information related to an alert.", "type": "object", "properties": { "title": { "description": "The title for the link.", "type": "string" }, "url": { "description": "The url for the help document.", "type": "string" } } }, "Hotfix": { "description": "The details of the hotfix installed in the server.", "type": "object", "properties": { "kbName": { "description": "The name of the hotfix KB.", "type": "string" }, "link": { "description": "The link to the KB Article.", "type": "string" }, "installedDate": { "description": "The date and time, in UTC, when the KB was installed in the server.", "type": "string", "format": "date-time" } } }, "Hotfixes": { "description": "The list of hotfixes installed in the server.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Hotfix" } } } }, "ImportErrors": { "description": "The list of import errors.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ImportError" } } } }, "ImportError": { "description": "The import error details.", "type": "object", "properties": { "id": { "description": "The error Id.", "type": "string" }, "runStepResultId": { "description": "The run step result Id.", "type": "string" }, "connectorId": { "description": "The connector Id.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" }, "timeOccurred": { "description": "The time when the import error occurred.", "type": "string", "format": "date-time" }, "timeFirstOccurred": { "description": "The time when the import error first occurred.", "type": "string", "format": "date-time" }, "retryCount": { "description": "The retry count.", "type": "integer" }, "algorithmStepType": { "description": "The operation type specific to error reporting.", "type": "string", "enum": [ "Undefined", "Staging", "ConnectorFilter", "Join", "Projection", "ImportFlow", "Provisioning", "ValidateConnectorFilter", "Deprovisioning", "ExportFlow", "MvDeletion", "Recall", "MvObjectTypeChange" ], "x-ms-enum": { "name": "AlgorithmStepType", "modelAsString": true } }, "changeNotReimported": { "description": "The change details that is not re-imported.", "$ref": "#/definitions/ChangeNotReimported" }, "extensionErrorInfo": { "description": "The extension error information.", "$ref": "#/definitions/ExtensionErrorInfo" }, "ruleErrorInfo": { "description": "The error details in legacy rule processing.", "$ref": "#/definitions/RuleErrorInfo" }, "csObjectId": { "description": "The object Id.", "type": "string" }, "dn": { "description": "The distinguished name.", "type": "string" } } }, "InboundReplicationNeighbor": { "description": "The replication summary for the domain controller inbound neighbor.", "type": "object", "properties": { "sourceDomainController": { "description": "The name of the source domain controller.", "type": "string" }, "consecutiveFailureCount": { "description": "The number of consecutive failure counts.", "type": "integer" }, "namingContext": { "description": "The naming context.", "type": "string" }, "status": { "description": "The health status for the domain controller", "type": "integer" }, "lastAttemptedSync": { "description": "The last time a sync was attempted on the domain controller.", "type": "string", "format": "date-time" }, "lastSuccessfulSync": { "description": "The last time when a successful sync happened.", "type": "string", "format": "date-time" }, "lastErrorCode": { "description": "The last error code.", "type": "integer" }, "lastErrorMessage": { "description": "The error message of the last error.", "type": "string" }, "errorTitle": { "description": "The error title.", "type": "string" }, "errorDescription": { "description": "The error description.", "type": "string" }, "fixLink": { "description": "The link for the fix of the error.", "type": "string" }, "fixDetails": { "description": "The details of the fix.", "type": "string" }, "additionalInfo": { "description": "The additional details.", "type": "string" } } }, "InboundReplicationNeighbors": { "description": "The list of replication summary for the domain controller inbound neighbor.", "type": "object", "properties": { "value": { "type": "array", "description": "The details of inbound replication neighbors.", "items": { "$ref": "#/definitions/InboundReplicationNeighbor" } } } }, "IPAddressAggregate": { "description": "The key value pair for properties.", "type": "object", "properties": { "id": { "description": "Unique ID for the entree", "type": "string" }, "tenantId": { "description": "The tenant ID", "type": "string" }, "serviceId": { "description": "The service ID", "type": "string" }, "ipAddress": { "description": "The IP address from where the attempted login originated from.", "type": "string" }, "timestamp": { "description": "When the event occurred", "type": "string" }, "firstAuditTimestamp": { "description": "The first audit timestamp", "type": "string" }, "lastAuditTimestamp": { "description": "The last audit timestamp", "type": "string" }, "extranetLockoutErrorCount": { "description": "The extranet lockout error count", "type": "integer" }, "badPasswordErrorCount": { "description": "The bad password error count", "type": "integer" }, "uniqueUsernamesAttemptedCount": { "description": "The unique usernames attempted", "type": "integer" }, "attemptCountThresholdIsExceeded": { "description": "A value indicating whether the attempt count threshold been exceeded", "type": "boolean" }, "timeSpan": { "description": "The duration of the event", "type": "string" }, "isWhitelistedIpAddress": { "description": "A value indicating whether the IP address has been listed as allowed.", "type": "boolean" }, "networkLocation": { "description": "The network location", "type": "string" }, "attemptCountThresholdOnTrigger": { "description": "The attempted count threshold on trigger.", "type": "integer" }, "attemptThresholdTypeOnTrigger": { "description": "The attempted threshold type on trigger.", "type": "string" }, "geographicLocation": { "description": "The geographic location.", "type": "string" } } }, "IPAddressAggregates": { "description": "IP address aggregates.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/IPAddressAggregate" } }, "nextLink": { "description": "URL to get the next set of IP Aggregate list results if there are any.", "type": "string" }, "totalCount": { "description": "The number of results.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "IPAddressAggregateSetting": { "description": "The key value pair for IP aggregate thresholds.", "type": "object", "properties": { "id": { "description": "Unique ID for the entree", "type": "string" }, "badPasswordAndExtranetLockoutCombinedDailyThreshold": { "description": "This threshold setting defines the per day trigger for a new event to be generated in the report.", "type": "integer" }, "badPasswordAndExtranetLockoutCombinedHourlyThreshold": { "description": "This threshold setting defines the per hour trigger for a new event to be generated in the report.", "type": "integer" }, "extranetLockoutDailyThreshold": { "description": "This threshold setting defines the per hour trigger for a new event to be generated in the report.", "type": "integer" }, "extranetLockoutHourlyThreshold": { "description": "This threshold setting defines the per hour trigger for a new event to be generated in the report.", "type": "integer" }, "emailNotificationEnabled": { "description": "A value indicating whether email notification has been enabled.", "type": "boolean" } } }, "Item": { "description": "The key value pair for properties.", "type": "object", "properties": { "key": { "description": "The key for the property.", "type": "string" }, "value": { "description": "The value for the key.", "type": "string" } } }, "Items": { "description": "The list of key value properties.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Item" } } } }, "MergedExportError": { "description": "The merged export error.", "type": "object", "properties": { "id": { "description": "The error Id.", "type": "string" }, "incomingObjectDisplayName": { "description": "The incoming object display name.", "type": "string" }, "incomingObjectType": { "description": "The incoming object type.", "type": "string" }, "userPrincipalName": { "description": "The user principal name", "type": "string" }, "type": { "description": "The type of the error.", "type": "string" }, "attributeName": { "description": "The attribute name.", "type": "string" }, "attributeValue": { "description": "The attribute value.", "type": "string" }, "timeOccurred": { "description": "The date and time when the error occurred.", "type": "string", "format": "date-time" }, "timeFirstOccurred": { "description": "The time when the error first occurred.", "type": "string", "format": "date-time" }, "csObjectId": { "description": " the cs object Id.", "type": "string" }, "dn": { "description": "the DN of the object.", "type": "string" }, "incomingObject": { "description": "The incoming object details.", "$ref": "#/definitions/AssociatedObject" }, "existingObject": { "description": "The existing object", "$ref": "#/definitions/AssociatedObject" }, "modifiedOrRemovedAttributeValue": { "description": "The modified or removed attribute value.", "type": "string" }, "runStepResultId": { "description": "The run step result Id.", "type": "string", "format": "uuid" }, "samAccountName": { "description": "The sam account name.", "type": "string" }, "serverErrorDetail": { "description": "The server error details.", "type": "string" }, "serviceId": { "description": "The service Id.", "type": "string", "format": "uuid" }, "serviceMemberId": { "description": "The server Id.", "type": "string", "format": "uuid" }, "mergedEntityId": { "description": "The merged entity Id.", "type": "string", "format": "uuid" }, "createdDate": { "description": "The date and time, in UTC, when the error was created.", "type": "string", "format": "date-time" }, "exportErrorStatus": { "description": "The export error status.", "type": "integer" } } }, "MergedExportErrors": { "description": "The list of export errors.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/MergedExportError" } } } }, "MetricGroup": { "description": " The metric group details.", "type": "object", "properties": { "key": { "description": "The key for the group.", "type": "string" }, "displayName": { "description": "The display name for the group.", "type": "string" }, "invisibleForUi": { "description": "indicates if the metric group is displayed in Azure Active Directory Connect Health UI.", "type": "boolean" } } }, "Metrics": { "description": "The list of metric items.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/Item" } }, "totalCount": { "description": "The total count of metrics.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "MetricMetadata": { "description": "The metric meta data", "type": "object", "properties": { "metricsProcessorClassName": { "description": "The name of the class which retrieve and process the metric.", "type": "string" }, "metricName": { "description": "The metric name", "type": "string" }, "groupings": { "description": "The groupings for the metrics.", "type": "array", "items": { "$ref": "#/definitions/MetricGroup" } }, "displayName": { "description": "The display name for the metric.", "type": "string" }, "valueKind": { "description": "Indicates if the metrics is a rate,value, percent or duration type.", "type": "string" }, "minValue": { "description": "The minimum value.", "type": "integer" }, "maxValue": { "description": "The maximum value.", "type": "integer" }, "kind": { "description": "Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.", "type": "string" }, "isDefault": { "description": "Indicates if the metric is a default metric or not.", "type": "boolean" }, "isPerfCounter": { "description": "Indicates if the metric is a performance counter metric or not.", "type": "boolean" }, "isDevOps": { "description": "Indicates if the metric is visible to DevOps or not.", "type": "boolean" } } }, "MetricMetadataList": { "description": "The list of metric metadata.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/MetricMetadata" } }, "totalCount": { "description": "The total count of service elements.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "MetricSet": { "description": " The set of metric values. Example of a MetricSet are Values of token requests for a Server1 or RelyingParty1.", "type": "object", "properties": { "setName": { "description": "The name of the set.", "type": "string" }, "values": { "description": "The list of the metric values.", "type": "array", "items": { "type": "integer" } } } }, "MetricSets": { "description": "The metrics data represented set.", "type": "object", "properties": { "sets": { "description": "The list of metric set.", "type": "array", "items": { "$ref": "#/definitions/MetricSet" } }, "timeStamps": { "description": "The list of timestamps for each metric in the metric set.", "type": "array", "items": { "type": "string", "format": "date-time" } } } }, "ModuleConfiguration": { "description": "The module configuration as required by the Agent service.", "type": "object", "properties": { "agentService": { "description": "The name of agent service.", "type": "string" }, "moduleName": { "description": "The name of the module for which the configuration is applicable.", "type": "string" }, "properties": { "description": "The key value pairs of properties required for configuration.", "type": "object", "additionalProperties": { "type": "string" } } } }, "ModuleConfigurations": { "description": "The list of module configurations.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ModuleConfiguration" } } } }, "ObjectWithSyncError": { "description": "The objects with sync errors.", "type": "object", "properties": { "sourceOfAuthority": { "description": "The source of authority.", "type": "string" }, "displayName": { "description": "The display name.", "type": "string" }, "objectType": { "description": "The object type.", "type": "string" }, "attributeName": { "description": "The attribute name.", "type": "string" }, "attributeValue": { "description": "The attribute value.", "type": "string" }, "modififedValue": { "description": "The modified value.", "type": "string" }, "userPrincipalName": { "description": "The user principal name.", "type": "string" }, "objectGuid": { "description": "The object guid.", "type": "string" }, "attributeMultiValues": { "description": "Indicates if the attribute is multi-valued or not.", "type": "boolean" }, "minLimit": { "description": "The minimum limit.", "type": "string" }, "maxLimit": { "description": "The maximum limit.", "type": "string" }, "distinguishedName": { "description": "The distinguished name.", "type": "string" }, "mail": { "description": "The email.", "type": "string" }, "timeOccured": { "description": "The date and time of occurrence.", "type": "string", "format": "date-time" }, "errorType": { "description": "The error type.", "type": "string" }, "sourceAnchor": { "description": "The source anchor.", "type": "string" } } }, "Operation": { "description": "The details of the operation.", "type": "object", "properties": { "name": { "description": "The name of the operation.", "type": "string" }, "display": { "description": "The display details for the operation.", "type": "object", "items": { "$ref": "#/definitions/Display" } } } }, "OperationListResponse": { "description": "Lists all of the available REST API operations for Azure Active Directory Connect Health.", "type": "object", "properties": { "nextLink": { "description": "URL to get the next set of operation list results if there are any.", "type": "string", "readOnly": true }, "value": { "description": "List of operations supported by the Microsoft.ADHybridHealthService resource provider.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Operation" } }, "totalCount": { "description": "The total count of operations.", "type": "integer" }, "continuationToken": { "description": "The continuation token to get next set of operations.", "type": "string" } } }, "Partition": { "description": "Describes the partition in Synchronization service.", "type": "object", "properties": { "id": { "description": "The partition Id.", "type": "string" }, "dn": { "description": "The distinguished name for the partition.", "type": "string" }, "enabled": { "description": "Indicates if the partition object is selected or not.", "type": "boolean" }, "timeCreated": { "description": "The date and time when the partition is created.", "type": "string", "format": "date-time" }, "timeLastModified": { "description": "The time and date when the partition was last modified.", "type": "string", "format": "date-time" }, "partitionScope": { "description": "The scope of the partition.", "$ref": "#/definitions/PartitionScope" }, "name": { "description": "The name of the partition.", "type": "string" }, "isDomain": { "description": "Indicates if the partition is a domain or not.", "type": "boolean" }, "type": { "description": "The partition type.", "type": "string" } } }, "PartitionScope": { "description": "The connector partition scope.", "type": "object", "properties": { "isDefault": { "description": "Indicates if the partition scope is default or not.", "type": "boolean" }, "objectClasses": { "description": "The in-scope object classes.", "type": "array", "items": { "type": "string" } }, "containersIncluded": { "description": "The list of containers included.", "type": "array", "items": { "type": "string" } }, "containersExcluded": { "description": "The list of containers excluded.", "type": "array", "items": { "type": "string" } } } }, "PasswordManagementSettings": { "description": "The password management settings.", "type": "object", "properties": { "enabled": { "description": "Indicates if the password extension is enabled.", "type": "boolean" }, "extensionFilePath": { "description": "The file path of the password management extension.", "type": "string" }, "connectTo": { "description": "Connection point of password management.", "type": "string" }, "connectionTimeout": { "description": "Connection timeout for password extension.", "type": "integer" }, "user": { "description": "User to execute password extension.", "type": "string" }, "supportedPasswordOperations": { "description": "The supported password operations.", "type": "string", "enum": [ "Undefined", "Set", "Change" ], "x-ms-enum": { "name": "PasswordOperationTypes", "modelAsString": true } }, "maximumRetryCount": { "description": "The maximum number of retries.", "type": "integer" }, "retryIntervalInSeconds": { "description": "The time between retries.", "type": "integer" }, "requiresSecureConnection": { "description": "Indicates if a secure connection is required for password management.", "type": "boolean" }, "unlockAccount": { "description": "Indicates if accounts should be unlocked when resetting password.", "type": "boolean" } } }, "PasswordHashSyncConfiguration": { "description": "The password has synchronization configuration settings.", "type": "object", "properties": { "enabled": { "description": "Indicates if the password hash synchronization configuration settings is enabled.", "type": "boolean" }, "target": { "description": "The target.", "type": "string" } } }, "ReplicationDetailsList": { "description": "The list of replication details.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ReplicationSummary" } }, "totalCount": { "description": "The total count of replication detail elements.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" }, "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" } } }, "ReplicationStatus": { "description": " Replication summary for a domain controller.", "type": "object", "properties": { "forestName": { "description": "The forest name.", "type": "string" }, "totalDcCount": { "description": "The total number of domain controllers for a given forest.", "type": "integer" }, "errorDcCount": { "description": "The total number of domain controllers with error in a given forest.", "type": "integer" } } }, "ReplicationSummary": { "description": "The replication summary for a domain controller.", "type": "object", "properties": { "targetServer": { "description": "The domain controller name.", "type": "string" }, "site": { "description": "The site name for a given domain controller.", "type": "string" }, "domain": { "description": "The domain name for a given domain controller.", "type": "string" }, "status": { "description": "The health status for a domain controller.", "type": "integer" }, "lastAttemptedSync": { "description": "The last time when a sync was attempted for a given domain controller.", "type": "string", "format": "date-time" }, "lastSuccessfulSync": { "description": "The time when the last successful sync happened for a given domain controller.", "type": "string", "format": "date-time" }, "inboundNeighborCollection": { "description": "List of individual domain controller neighbor's inbound replication status.", "type": "array", "items": { "$ref": "#/definitions/InboundReplicationNeighbor" } } } }, "ReplicationSummaryList": { "description": "The list of replication summary details.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ReplicationSummary" } } } }, "Result": { "description": "The result for an operation.", "type": "object", "properties": { "value": { "description": "The value.", "type": "boolean" } } }, "RiskyIPBlobUri": { "description": "The blob uri pointing to Risky IP Report.", "type": "object", "properties": { "tenantId": { "description": "The tenant id for whom the report belongs to.", "type": "string" }, "serviceId": { "description": "The service id for whom the report belongs to.", "type": "string" }, "resultSasUri": { "description": "The blob uri for the report.", "type": "string" }, "blobCreateDateTime": { "description": "Time at which the new Risky IP report was requested.", "type": "string", "format": "date-time" }, "jobCompletionTime": { "description": "Time at which the blob creation job for the new Risky IP report was completed.", "type": "string", "format": "date-time" }, "status": { "description": "Status of the Risky IP report generation.", "type": "string" } } }, "RiskyIPBlobUris": { "description": "The list containing blob uris.", "type": "object", "properties": { "value": { "description": "The list of blob uris.", "type": "array", "items": { "$ref": "#/definitions/RiskyIPBlobUri" } } } }, "RuleErrorInfo": { "description": "The error details in legacy rule processing.", "type": "object", "properties": { "attributeMapping": { "description": "The attribute mapping details.", "$ref": "#/definitions/AttributeMapping" }, "connectorId": { "description": "The connector Id.", "type": "string" }, "connectorName": { "description": "The connector name.", "type": "string" }, "csObjectId": { "description": "The object Id.", "type": "string" }, "dn": { "description": "The distinguished name.", "type": "string" } } }, "RunStep": { "description": "The run step for a run profile.", "type": "object", "properties": { "batchSize": { "description": "The batch size used by the run step.", "type": "integer" }, "objectProcessLimit": { "description": "The object processing limit.", "type": "integer" }, "objectDeleteLimit": { "description": "The object deletion limit.", "type": "integer" }, "pageSize": { "description": "The page size of the run step.", "type": "integer" }, "partitionId": { "description": "The Id of the partition that a current run step operation is executing.", "type": "string" }, "operationType": { "description": "The run step operation types.", "type": "integer" }, "timeout": { "description": "The operation timeout.", "type": "integer" } } }, "RunProfile": { "description": "Describes the run profile.", "type": "object", "properties": { "id": { "description": "The run profile Id.", "type": "string" }, "name": { "description": "The run profile name", "type": "string" }, "runSteps": { "description": "The run steps of the run profile.", "type": "array", "items": { "$ref": "#/definitions/RunStep" } } } }, "RunProfiles": { "description": "The list of run profiles.", "type": "object", "properties": { "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/RunProfile" } } } }, "ServiceConfiguration": { "description": "The service configuration", "type": "object", "properties": { "version": { "description": "The version of the sync service.", "type": "string" }, "serviceType": { "description": "The service type of the server.", "type": "integer" }, "serviceAccount": { "description": "The service account.", "type": "string" }, "sqlServer": { "description": "The SQL server information.", "type": "string" }, "sqlVersion": { "description": "The SQL version.", "type": "string" }, "sqlEdition": { "description": "The SQL edition", "type": "string" }, "sqlInstance": { "description": "The SQL instance details.", "type": "string" }, "sqlDatabaseName": { "description": "The SQL database.", "type": "string" }, "sqlDatabaseSize": { "description": "The SQL database size.", "type": "integer" } } }, "ServiceProperties": { "description": "The service properties for a given service.", "type": "object", "properties": { "id": { "description": "The id of the service.", "type": "string" }, "activeAlerts": { "description": "The count of alerts that are currently active for the service.", "type": "integer" }, "additionalInformation": { "description": "The additional information related to the service.", "type": "string" }, "createdDate": { "description": "The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.", "type": "string", "format": "date-time" }, "customNotificationEmails": { "description": "The list of additional emails that are configured to receive notifications about the service.", "type": "array", "items": { "type": "string" } }, "disabled": { "description": "Indicates if the service is disabled or not.", "type": "boolean" }, "displayName": { "description": "The display name of the service.", "type": "string" }, "health": { "description": "The health of the service.", "type": "string" }, "lastDisabled": { "description": "The date and time, in UTC, when the service was last disabled.", "type": "string", "format": "date-time" }, "lastUpdated": { "description": "The date or time , in UTC, when the service properties were last updated.", "type": "string", "format": "date-time" }, "monitoringConfigurationsComputed": { "description": "The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", "type": "object", "items": { "$ref": "#/definitions/Items" } }, "monitoringConfigurationsCustomized": { "description": "The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", "type": "object", "items": { "$ref": "#/definitions/Items" } }, "notificationEmailEnabled": { "description": "Indicates if email notification is enabled or not.", "type": "boolean" }, "notificationEmailEnabledForGlobalAdmins": { "description": "Indicates if email notification is enabled for global administrators of the tenant.", "type": "boolean" }, "notificationEmailsEnabledForGlobalAdmins": { "description": "Indicates if email notification is enabled for global administrators of the tenant.", "type": "boolean" }, "notificationEmails": { "description": "The list of emails to whom service notifications will be sent.", "type": "array", "items": { "type": "string" } }, "originalDisabledState": { "description": "Gets the original disable state.", "type": "boolean" }, "resolvedAlerts": { "description": "The total count of alerts that has been resolved for the service.", "type": "integer" }, "serviceId": { "description": "The id of the service.", "type": "string" }, "serviceName": { "description": "The name of the service.", "type": "string" }, "signature": { "description": "The signature of the service.", "type": "string" }, "simpleProperties": { "description": "List of service specific configuration properties.", "type": "object", "items": { "$ref": "#/definitions/Items" } }, "tenantId": { "description": "The id of the tenant to which the service is registered to.", "type": "string" }, "type": { "description": "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.", "type": "string" } } }, "Services": { "description": "The list of services for a given onboarded tenant.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ServiceProperties" } }, "totalCount": { "description": "The total count of service elements.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "ServiceMember": { "description": "The server properties for a given service.", "type": "object", "properties": { "serviceMemberId": { "description": "The id of the server.", "type": "string" }, "serviceId": { "description": "The service id to whom this server belongs.", "type": "string" }, "tenantId": { "description": "The tenant id to whom this server belongs.", "type": "string" }, "activeAlerts": { "description": "The total number of alerts that are currently active for the server.", "type": "integer" }, "additionalInformation": { "description": "The additional information, if any, for the server.", "type": "string" }, "createdDate": { "description": "The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.", "type": "string", "format": "date-time" }, "dimensions": { "description": "The server specific configuration related dimensions.", "type": "object", "items": { "$ref": "#/definitions/Item" } }, "disabled": { "description": "Indicates if the server is disabled or not. ", "type": "boolean" }, "disabledReason": { "description": "The reason for disabling the server.", "type": "integer" }, "installedQfes": { "description": "The list of installed QFEs for the server.", "type": "object", "items": { "$ref": "#/definitions/Hotfix" } }, "lastDisabled": { "description": "The date and time , in UTC, when the server was last disabled.", "type": "string", "format": "date-time" }, "lastReboot": { "description": "The date and time, in UTC, when the server was last rebooted.", "type": "string", "format": "date-time" }, "lastServerReportedMonitoringLevelChange": { "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", "type": "string", "format": "date-time" }, "lastUpdated": { "description": "The date and time, in UTC, when the server properties were last updated.", "type": "string", "format": "date-time" }, "machineId": { "description": "The id of the machine.", "type": "string" }, "machineName": { "description": "The name of the server.", "type": "string" }, "monitoringConfigurationsComputed": { "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", "type": "object", "items": { "$ref": "#/definitions/Item" } }, "monitoringConfigurationsCustomized": { "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", "type": "object", "items": { "$ref": "#/definitions/Item" } }, "osName": { "description": "The name of the operating system installed in the machine.", "type": "string" }, "osVersion": { "description": "The version of the operating system installed in the machine.", "type": "string" }, "properties": { "description": "Server specific properties.", "type": "object", "items": { "$ref": "#/definitions/Item" } }, "recommendedQfes": { "description": "The list of recommended hotfixes for the server.", "type": "object", "items": { "$ref": "#/definitions/Hotfix" } }, "resolvedAlerts": { "description": "The total count of alerts that are resolved for this server.", "type": "integer" }, "role": { "description": "The service role that is being monitored in the server.", "type": "string" }, "serverReportedMonitoringLevel": { "description": "The monitoring level reported by the server.", "type": "string", "enum": [ "Partial", "Full", "Off" ], "x-ms-enum": { "name": "MonitoringLevel", "modelAsString": false } }, "status": { "description": "The health status of the server.", "type": "string" } } }, "ServiceMembers": { "description": "The list of servers that are onboarded for a given service.", "type": "object", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { "description": "The value returned by the operation.", "type": "array", "items": { "$ref": "#/definitions/ServiceMember" } }, "totalCount": { "description": "The total count of service elements.", "type": "integer" }, "continuationToken": { "description": "The continuation token for paginated calls.", "type": "string" } } }, "TabularExportError": { "description": "The details for export error.", "type": "object", "properties": { "serviceId": { "description": "The service Id.", "type": "string", "format": "uuid" }, "serviceMemberId": { "description": "The server Id.", "type": "string", "format": "uuid" }, "mergedEntityId": { "description": "The merged entity Id.", "type": "string", "format": "uuid" }, "tabularExportErrorData": { "description": "The export error data.", "type": "string" } } }, "Tenant": { "description": "The details of the onboarded tenant.", "type": "object", "properties": { "tenantId": { "type": "string", "description": "The Id of the tenant." }, "aadLicense": { "type": "string", "description": "The Azure Active Directory license of the tenant." }, "aadPremium": { "type": "boolean", "description": "Indicate if the tenant has Azure Active Directory Premium license or not." }, "agentAutoUpdate": { "type": "boolean", "description": "Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features." }, "alertSuppressionTimeInMins": { "type": "integer", "description": "The time in minutes after which an alert will be auto-suppressed." }, "consentedToMicrosoftDevOps": { "type": "boolean", "description": "Indicates if the tenant data can be seen by Microsoft through Azure portal." }, "countryLetterCode": { "type": "string", "description": "The country letter code of the tenant." }, "createdDate": { "type": "string", "format": "date-time", "description": "The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health." }, "devOpsTtl": { "type": "string", "format": "date-time", "description": "The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal." }, "disabled": { "type": "boolean", "description": "Indicates if the tenant is disabled in Azure Active Directory Connect Health." }, "disabledReason": { "type": "integer", "description": "The reason due to which the tenant was disabled in Azure Active Directory Connect Health." }, "globalAdminsEmail": { "type": "array", "items": { "type": "string" }, "description": "The list of global administrators for the tenant." }, "initialDomain": { "type": "string", "description": "The initial domain of the tenant." }, "lastDisabled": { "type": "string", "format": "date-time", "description": "The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health." }, "lastVerified": { "type": "string", "format": "date-time", "description": "The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified." }, "onboardingAllowed": { "type": "boolean", "description": "Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health." }, "onboarded": { "type": "boolean", "description": "Indicates if the tenant is already onboarded to Azure Active Directory Connect Health." }, "pksCertificate": { "type": "object", "description": "The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health." }, "privatePreviewTenant": { "type": "boolean", "description": "Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features." }, "tenantInQuarantine": { "type": "boolean", "description": "Indicates if data collection for this tenant is disabled or not." }, "tenantName": { "type": "string", "description": "The name of the tenant." } } }, "TenantOnboardingDetails": { "description": "The tenant onboarding details.", "type": "object", "properties": { "tenantOnboarded": { "description": "Indicates if the tenant is onboarded to Azure Active Directory Connect Health or not.", "type": "boolean" }, "onboardingDisplayUrl": { "description": "The display url, to help tenant navigate or onboard to Azure Active Directory Connect Health blade, based on tenant onboarding status.", "type": "string" } } }, "UserPreference": { "description": " The user preference for a given feature.", "type": "object", "properties": { "metricNames": { "description": "The name of the metric.", "type": "array", "items": { "type": "string" } } } }, "ValueDelta": { "description": "The value of the delta.", "type": "object", "properties": { "operationType": { "description": "The operation type.", "type": "string", "enum": [ "Undefined", "Add", "Update", "Delete" ], "x-ms-enum": { "name": "ValueDeltaOperationType", "modelAsString": true } }, "value": { "description": "The value of the delta.", "type": "string" } } } }, "parameters": { "apiVersionParameter": { "name": "api-version", "in": "query", "description": "The version of the API to be used with the client request.", "required": true, "type": "string" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ] }