openapi-directory/api/azure.com/adhybridhealthservice-ADHybridHealthService.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"REST APIs for Azure Active Directory Connect Health","title":"ADHybridHealthService","version":"2014-01-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"adhybridhealthservice-ADHybridHealthService","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.ADHybridHealthService/addsservices":{"get":{"description":"Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.","operationId":"addsServices_list","parameters":[{"description":"The service property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"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.","in":"query","name":"serviceType","required":false,"schema":{"type":"string"}},{"description":"The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.","in":"query","name":"skipCount","required":false,"schema":{"type":"integer"}},{"description":"The take count , which specifies the number of elements that can be returned from a sequence.","in":"query","name":"takeCount","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":" The list of Active Directory Domain Controller services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Services"},"examples":{"addsServices_list":{"$ref":"#/components/examples/addsServices_list"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}},"post":{"description":"Onboards a service for a given tenant in Azure Active Directory Connect Health.","operationId":"addsServices_add","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ServiceProperties"},"responses":{"200":{"description":"Adds the Active Directory Domain Controller Services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProperties"},"examples":{"addsServices_add":{"$ref":"#/components/examples/addsServices_add"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck":{"get":{"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.","operationId":"addsServices_listPremiumServices","parameters":[{"description":"The service property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"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.","in":"query","name":"serviceType","required":false,"schema":{"type":"string"}},{"description":"The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.","in":"query","name":"skipCount","required":false,"schema":{"type":"integer"}},{"description":"The take count , which specifies the number of elements that can be returned from a sequence.","in":"query","name":"takeCount","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of premium services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Services"},"examples":{"addsServices_listPremiumServices":{"$ref":"#/components/examples/addsServices_listPremiumServices"}}}}}},"tags":["Services"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}":{"delete":{"description":"Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.","operationId":"addsServices_delete","parameters":[{"description":"The name of the service which needs to be deleted.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_delete":{"value":"SampleServiceName"}}},{"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.","in":"query","name":"confirm","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the service."}},"tags":["Services"]},"get":{"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.","operationId":"addsServices_get","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_get":{"value":"sampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The Active Directory Domain Controller service as specified by the serviceName property. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProperties"},"examples":{"addsServices_get":{"$ref":"#/components/examples/addsServices_get"}}}}}},"tags":["Services"]},"patch":{"description":"Updates an Active Directory Domain Service properties of an onboarded service.","operationId":"addsServices_update","parameters":[{"description":"The name of the service which needs to be deleted.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_update":{"value":"sampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ServiceProperties"},"responses":{"200":{"description":"Successfully updated service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProperties"},"examples":{"addsServices_update":{"$ref":"#/components/examples/addsServices_update"}}}}}},"tags":["Services"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers":{"get":{"description":"Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.","operationId":"adDomainServiceMembers_list","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"adDomainServiceMembers_list":{"value":"sampleServiceName"}}},{"description":"The server property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Indicates if the result should be grouped by site or not.","in":"query","name":"isGroupbySite","required":true,"schema":{"type":"boolean"},"examples":{"adDomainServiceMembers_list":{"value":true}}},{"description":"The custom query.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"The next partition key to query for.","in":"query","name":"nextPartitionKey","required":true,"x-ms-enum":{"modelAsString":true,"name":"nextPartitionKey"},"schema":{"type":"string","enum":[" "]},"examples":{"adDomainServiceMembers_list":{"value":" "}}},{"description":"The next row key to query for.","in":"query","name":"nextRowKey","required":true,"x-ms-enum":{"modelAsString":true,"name":"nextRowKey"},"schema":{"type":"string","enum":[" "]},"examples":{"adDomainServiceMembers_list":{"value":" "}}},{"description":"The take count , which specifies the number of elements that can be returned from a sequence.","in":"query","name":"takeCount","required":false,"schema":{"type":"integer"},"examples":{"adDomainServiceMembers_list":{"value":1}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of Active Directory Domain Servers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddsServiceMembers"},"examples":{"adDomainServiceMembers_list":{"$ref":"#/components/examples/adDomainServiceMembers_list"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers":{"get":{"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.","operationId":"addsServiceMembers_list","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServiceMembers_list":{"value":"sampleServiceName"}}},{"description":"The server property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of Active Directory Domain Servers. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddsServiceMembers"},"examples":{"addsServiceMembers_list":{"$ref":"#/components/examples/addsServiceMembers_list"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts":{"get":{"description":"Gets the alerts for a given Active Directory Domain Service.","operationId":"alerts_listAddsAlerts","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"alerts_listAddsAlerts":{"value":"sampleServiceName"}}},{"description":"The alert property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The alert state to query for.","in":"query","name":"state","required":false,"schema":{"type":"string"},"examples":{"alerts_listAddsAlerts":{"value":"Active"}}},{"description":"The start date to query for.","in":"query","name":"from","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The end date till when to query for.","in":"query","name":"to","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of alerts for the given service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts"},"examples":{"alerts_listAddsAlerts":{"$ref":"#/components/examples/alerts_listAddsAlerts"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration":{"get":{"description":"Gets the service configurations.","operationId":"configuration_listAddsConfigurations","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"configuration_listAddsConfigurations":{"value":"SampleServiceName"}}},{"description":"The grouping for configurations.","in":"query","name":"grouping","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The Active Directory Domain Controller service configuration. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddsConfiguration"},"examples":{"configuration_listAddsConfigurations":{"$ref":"#/components/examples/configuration_listAddsConfigurations"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}":{"get":{"description":"Gets the dimensions for a given dimension type in a server.","operationId":"dimensions_listAddsDimensions","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"dimensions_listAddsDimensions":{"value":"sampleServiceName"}}},{"description":"The dimension type.","in":"path","name":"dimension","required":true,"schema":{"type":"string"},"examples":{"dimensions_listAddsDimensions":{"value":"SmapleDimension"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of dimensions for a server. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dimensions"},"examples":{"dimensions_listAddsDimensions":{"$ref":"#/components/examples/dimensions_listAddsDimensions"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference":{"delete":{"description":"Deletes the user preferences for a given feature.","operationId":"addsServicesUserPreference_delete","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServicesUserPreference_delete":{"value":"sampleServiceName"}}},{"description":"The name of the feature.","in":"path","name":"featureName","required":true,"schema":{"type":"string"},"examples":{"addsServicesUserPreference_delete":{"value":"SampleFeatureName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the user preference settings. "}},"tags":["Adds"]},"get":{"description":"Gets the user preferences for a given feature.","operationId":"addsServicesUserPreference_get","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServicesUserPreference_get":{"value":"sampleServiceName"}}},{"description":"The name of the feature.","in":"path","name":"featureName","required":true,"schema":{"type":"string"},"examples":{"addsServicesUserPreference_get":{"value":"SampleFeatureName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The user preference settings. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreference"},"examples":{"addsServicesUserPreference_get":{"$ref":"#/components/examples/addsServicesUserPreference_get"}}}}}},"tags":["Adds"]},"post":{"description":"Adds the user preferences for a given feature.","operationId":"addsServicesUserPreference_add","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServicesUserPreference_add":{"value":"sampleServiceName"}}},{"description":"The name of the feature.","in":"path","name":"featureName","required":true,"schema":{"type":"string"},"examples":{"addsServicesUserPreference_add":{"value":"SampleFeatureName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPreference"}}},"description":"The user preference setting.","required":true},"responses":{"200":{"description":" Successfully added the user preference settings. "}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary":{"get":{"description":"Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.","operationId":"addsServices_getForestSummary","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_getForestSummary":{"value":"sampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of forest summary for the service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForestSummary"},"examples":{"addsServices_getForestSummary":{"$ref":"#/components/examples/addsServices_getForestSummary"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata":{"get":{"description":"Gets the service related metrics information.","operationId":"addsServices_listMetricMetadata","parameters":[{"description":"The metric metadata property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricMetadata":{"value":"SampleName"}}},{"description":"Indicates if only performance counter metrics are requested.","in":"query","name":"perfCounter","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of metric metadata for a service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricMetadataList"},"examples":{"addsServices_listMetricMetadata":{"$ref":"#/components/examples/addsServices_listMetricMetadata"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}":{"get":{"description":"Gets the service related metric information.","operationId":"addsServices_getMetricMetadata","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_getMetricMetadata":{"value":"SampleName"}}},{"description":"The metric name","in":"path","name":"metricName","required":true,"schema":{"type":"string"},"examples":{"addsServices_getMetricMetadata":{"value":"SampleMetricName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":" The metric metadata for the service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricMetadata"},"examples":{"addsServices_getMetricMetadata":{"$ref":"#/components/examples/addsServices_getMetricMetadata"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}":{"get":{"description":"Gets the service related metrics for a given metric and group combination.","operationId":"addsServices_getMetricMetadataForGroup","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_getMetricMetadataForGroup":{"value":"SampleName"}}},{"description":"The metric name","in":"path","name":"metricName","required":true,"schema":{"type":"string"},"examples":{"addsServices_getMetricMetadataForGroup":{"value":"SamplemetricName"}}},{"description":"The group name","in":"path","name":"groupName","required":true,"schema":{"type":"string"},"examples":{"addsServices_getMetricMetadataForGroup":{"value":"SampleGroupName"}}},{"description":"The group key","in":"query","name":"groupKey","required":false,"schema":{"type":"string"}},{"description":"The start date.","in":"query","name":"fromDate","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The end date.","in":"query","name":"toDate","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The metric sets for a given service and group. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricSets"},"examples":{"addsServices_getMetricMetadataForGroup":{"$ref":"#/components/examples/addsServices_getMetricMetadataForGroup"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}":{"get":{"description":"Gets the server related metrics for a given metric and group combination.","operationId":"addsService_getMetrics","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsService_getMetrics":{"value":"SampleName"}}},{"description":"The metric name","in":"path","name":"metricName","required":true,"schema":{"type":"string"},"examples":{"addsService_getMetrics":{"value":"SamplemetricName"}}},{"description":"The group name","in":"path","name":"groupName","required":true,"schema":{"type":"string"},"examples":{"addsService_getMetrics":{"value":"SampleGroupName"}}},{"description":"The group key","in":"query","name":"groupKey","required":false,"schema":{"type":"string"}},{"description":"The start date.","in":"query","name":"fromDate","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The end date.","in":"query","name":"toDate","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The metric sets for the service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricSets"},"examples":{"addsService_getMetrics":{"$ref":"#/components/examples/addsService_getMetrics"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average":{"get":{"description":"Gets the average of the metric values for a given metric and group combination.","operationId":"addsServices_listMetricsAverage","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricsAverage":{"value":"SampleName"}}},{"description":"The metric name","in":"path","name":"metricName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricsAverage":{"value":"SampleMetricName"}}},{"description":"The group name","in":"path","name":"groupName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricsAverage":{"value":"SampleGroupName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of metrics. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"},"examples":{"addsServices_listMetricsAverage":{"$ref":"#/components/examples/addsServices_listMetricsAverage"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum":{"get":{"description":"Gets the sum of the metric values for a given metric and group combination.","operationId":"addsServices_listMetricsSum","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricsSum":{"value":"SampleName"}}},{"description":"The metric name","in":"path","name":"metricName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricsSum":{"value":"SampleMetricName"}}},{"description":"The group name","in":"path","name":"groupName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listMetricsSum":{"value":"SampleGroupName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of aum of the metric values for a given service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"},"examples":{"addsServices_listMetricsSum":{"$ref":"#/components/examples/addsServices_listMetricsSum"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails":{"get":{"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.","operationId":"addsServices_listReplicationDetails","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listReplicationDetails":{"value":"SampleName"}}},{"description":"The server property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Indicates if InboundReplicationNeighbor details are required or not.","in":"query","name":"withDetails","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of replication details for a service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationDetailsList"},"examples":{"addsServices_listReplicationDetails":{"$ref":"#/components/examples/addsServices_listReplicationDetails"}}}}}},"tags":["Adds"],"x-ms-pageable":{}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus":{"get":{"description":"Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.","operationId":"addsServicesReplicationStatus_get","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServicesReplicationStatus_get":{"value":"SampleName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The replication status for a service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationStatus"},"examples":{"addsServicesReplicationStatus_get":{"$ref":"#/components/examples/addsServicesReplicationStatus_get"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary":{"get":{"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.","operationId":"addsServices_listReplicationSummary","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listReplicationSummary":{"value":"SampleName"}}},{"description":"The server property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Indicates if the result should be grouped by site or not.","in":"query","name":"isGroupbySite","required":true,"schema":{"type":"boolean"},"examples":{"addsServices_listReplicationSummary":{"value":true}}},{"description":"The custom query.","in":"query","name":"query","required":true,"schema":{"type":"string"},"examples":{"addsServices_listReplicationSummary":{"value":"SampleQuery"}}},{"description":"The next partition key to query for.","in":"query","name":"nextPartitionKey","required":true,"x-ms-enum":{"modelAsString":true,"name":"nextPartitionKey"},"schema":{"type":"string","enum":[" "]},"examples":{"addsServices_listReplicationSummary":{"value":" "}}},{"description":"The next row key to query for.","in":"query","name":"nextRowKey","required":true,"x-ms-enum":{"modelAsString":true,"name":"nextRowKey"},"schema":{"type":"string","enum":[" "]},"examples":{"addsServices_listReplicationSummary":{"value":" "}}},{"description":"The take count , which specifies the number of elements that can be returned from a sequence.","in":"query","name":"takeCount","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of replication summary for a service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationSummaryList"},"examples":{"addsServices_listReplicationSummary":{"$ref":"#/components/examples/addsServices_listReplicationSummary"}}}}}},"tags":["Adds"],"x-ms-pageable":{}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers":{"get":{"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.","operationId":"addsServicesServiceMembers_list","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServicesServiceMembers_list":{"value":"sampleServiceName"}}},{"description":"The server property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The server specific dimension.","in":"query","name":"dimensionType","required":false,"schema":{"type":"string"}},{"description":"The value of the dimension.","in":"query","name":"dimensionSignature","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of service members for a given service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceMembers"},"examples":{"addsServicesServiceMembers_list":{"$ref":"#/components/examples/addsServicesServiceMembers_list"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}},"post":{"description":"Onboards  a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.","operationId":"addsServicesServiceMembers_add","parameters":[{"description":"The name of the service under which the server is to be onboarded.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServicesServiceMembers_add":{"value":"sampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ServiceMember"},"responses":{"200":{"description":"Successfully added the service member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceMember"},"examples":{"addsServicesServiceMembers_add":{"$ref":"#/components/examples/addsServicesServiceMembers_add"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}":{"delete":{"description":"Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.","operationId":"addsServiceMembers_delete","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServiceMembers_delete":{"value":"SampleServiceName"}}},{"description":"The server Id.","in":"path","name":"serviceMemberId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"addsServiceMembers_delete":{"value":"SampleServiceMemberId"}}},{"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.","in":"query","name":"confirm","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the service member."}},"tags":["Adds"]},"get":{"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.","operationId":"addsServiceMembers_get","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServiceMembers_get":{"value":"sampleServiceName"}}},{"description":"The server Id.","in":"path","name":"serviceMemberId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"addsServiceMembers_get":{"value":"SampleServiceMemberId"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The service member details for a given service. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceMember"},"examples":{"addsServiceMembers_get":{"$ref":"#/components/examples/addsServiceMembers_get"}}}}}},"tags":["Adds"]}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts":{"get":{"description":"Gets the details of an alert for a given Active Directory Domain Controller service and server combination.","operationId":"addsServices_listServerAlerts","parameters":[{"description":"The server Id for which the alert details needs to be queried.","in":"path","name":"serviceMemberId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"addsServices_listServerAlerts":{"value":"SampleServiceMemberId"}}},{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServices_listServerAlerts":{"value":"sampleServiceName"}}},{"description":"The alert property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The alert state to query for.","in":"query","name":"state","required":false,"schema":{"type":"string"},"examples":{"addsServices_listServerAlerts":{"value":"Active"}}},{"description":"The start date to query for.","in":"query","name":"from","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The end date till when to query for.","in":"query","name":"to","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of server alerts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts"},"examples":{"addsServices_listServerAlerts":{"$ref":"#/components/examples/addsServices_listServerAlerts"}}}}}},"tags":["Adds"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials":{"get":{"description":"Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.","operationId":"addsServiceMembers_listCredentials","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"addsServiceMembers_listCredentials":{"value":"sampleServiceName"}}},{"description":"The property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The server Id.","in":"path","name":"serviceMemberId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"addsServiceMembers_listCredentials":{"value":"SampleServiceMemberId"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of server credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credentials"},"examples":{"addsServiceMembers_listCredentials":{"$ref":"#/components/examples/addsServiceMembers_listCredentials"}}}}}},"tags":["Adds"],"x-ms-pageable":{}}},"/providers/Microsoft.ADHybridHealthService/configuration":{"get":{"description":"Gets the details of a tenant onboarded to Azure Active Directory Connect Health.","operationId":"configuration_get","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The tenant details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"},"examples":{"configuration_get":{"$ref":"#/components/examples/configuration_get"}}}}}},"tags":["Configuration"]},"patch":{"description":"Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.","operationId":"configuration_update","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"}}},"description":"The tenant object with the properties set to the updated value.","required":true},"responses":{"200":{"description":"Successfully updated the tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"},"examples":{"configuration_update":{"$ref":"#/components/examples/configuration_update"}}}}}},"tags":["Configuration"]},"post":{"description":"Onboards a tenant in Azure Active Directory Connect Health.","operationId":"configuration_add","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Successfully added the tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tenant"},"examples":{"configuration_add":{"$ref":"#/components/examples/configuration_add"}}}}}},"tags":["Configuration"]}},"/providers/Microsoft.ADHybridHealthService/operations":{"get":{"description":"Lists the available Azure Data Factory API operations.","operationId":"operations_list","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResponse"},"examples":{"operations_list":{"$ref":"#/components/examples/operations_list"}}}}}},"tags":["operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps":{"get":{"description":"Checks if the user is enabled for Dev Ops access.","operationId":"reports_getDevOps","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Indicates if the user is Dev Ops or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"},"examples":{"reports_getDevOps":{"$ref":"#/components/examples/reports_getDevOps"}}}}}},"tags":["DevOps"]}},"/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors":{"get":{"description":"Gets the connector details for a service.","operationId":"serviceMembers_listConnectors","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"serviceMembers_listConnectors":{"value":"sampleServiceName"}}},{"description":"The server Id.","in":"path","name":"serviceMemberId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"serviceMembers_listConnectors":{"value":"SampleServiceMemberId"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of connector details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connectors"},"examples":{"serviceMembers_listConnectors":{"$ref":"#/components/examples/serviceMembers_listConnectors"}}}}}},"tags":["ServiceMembers"],"x-ms-pageable":{}}},"/providers/Microsoft.ADHybridHealthService/services":{"get":{"description":"Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.","operationId":"services_list","parameters":[{"description":"The service property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"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.","in":"query","name":"serviceType","required":false,"schema":{"type":"string"}},{"description":"The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.","in":"query","name":"skipCount","required":false,"schema":{"type":"integer"}},{"description":"The take count , which specifies the number of elements that can be returned from a sequence.","in":"query","name":"takeCount","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Services"},"examples":{"services_list":{"$ref":"#/components/examples/services_list"}}}}}},"tags":["Services"],"x-ms-pageable":{"nextLinkName":"nextLink"}},"post":{"description":"Onboards a service for a given tenant in Azure Active Directory Connect Health.","operationId":"services_add","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ServiceProperties"},"responses":{"200":{"description":"Successfully added the service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProperties"},"examples":{"services_add":{"$ref":"#/components/examples/services_add"}}}}}},"tags":["Services"]}},"/providers/Microsoft.ADHybridHealthService/services/premiumCheck":{"get":{"description":"Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.","operationId":"services_listPremium","parameters":[{"description":"The service property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"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.","in":"query","name":"serviceType","required":false,"schema":{"type":"string"}},{"description":"The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.","in":"query","name":"skipCount","required":false,"schema":{"type":"integer"}},{"description":"The take count , which specifies the number of elements that can be returned from a sequence.","in":"query","name":"takeCount","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of premium services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Services"},"examples":{"services_listPremium":{"$ref":"#/components/examples/services_listPremium"}}}}}},"tags":["Services"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/services/{serviceName}":{"delete":{"description":"Deletes a service which is onboarded to Azure Active Directory Connect Health.","operationId":"services_delete","parameters":[{"description":"The name of the service which needs to be deleted.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_delete":{"value":"SampleServiceName"}}},{"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.","in":"query","name":"confirm","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"204":{"description":"Successfully deleted the service."}},"tags":["Services"]},"get":{"description":"Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.","operationId":"services_get","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_get":{"value":"sampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProperties"},"examples":{"services_get":{"$ref":"#/components/examples/services_get"}}}}}},"tags":["Services"]},"patch":{"description":"Updates the service properties of an onboarded service.","operationId":"services_update","parameters":[{"description":"The name of the service which needs to be deleted.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_update":{"value":"sampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ServiceProperties"},"responses":{"200":{"description":"Successfully updated the service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProperties"},"examples":{"services_update":{"$ref":"#/components/examples/services_update"}}}}}},"tags":["Services"]}},"/providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}":{"get":{"description":"Checks if the tenant, to which a service is registered, is whitelisted to use a feature.","operationId":"services_getTenantWhitelisting","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_getTenantWhitelisting":{"value":"sampleServiceName"}}},{"description":"The name of the feature.","in":"path","name":"featureName","required":true,"schema":{"type":"string"},"examples":{"services_getTenantWhitelisting":{"value":"SampleFeatureName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Indicates if a tenant is whitelisted for a feature or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"},"examples":{"services_getTenantWhitelisting":{"$ref":"#/components/examples/services_getTenantWhitelisting"}}}}}},"tags":["Services"]}},"/providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts":{"get":{"description":"Gets the alerts for a given service.","operationId":"services_listAlerts","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_listAlerts":{"value":"sampleServiceName"}}},{"description":"The alert property filter to apply.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The alert state to query for.","in":"query","name":"state","required":false,"schema":{"type":"string"},"examples":{"services_listAlerts":{"value":"Active"}}},{"description":"The start date to query for.","in":"query","name":"from","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The end date till when to query for.","in":"query","name":"to","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of alerts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts"},"examples":{"services_listAlerts":{"$ref":"#/components/examples/services_listAlerts"}}}}}},"tags":["Alerts"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}":{"get":{"description":"Checks if the service has all the pre-requisites met to use a feature.","operationId":"services_getFeatureAvailibility","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_getFeatureAvailibility":{"value":"sampleServiceName"}}},{"description":"The name of the feature.","in":"path","name":"featureName","required":true,"schema":{"type":"string"},"examples":{"services_getFeatureAvailibility":{"value":"SampleFeatureName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Indicates if the feature is available or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"},"examples":{"services_getFeatureAvailibility":{"$ref":"#/components/examples/services_getFeatureAvailibility"}}}}}},"tags":["Services"]}},"/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts":{"get":{"description":"Gets the count of latest AAD export errors.","operationId":"services_listExportErrors","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_listExportErrors":{"value":"SampleServiceName"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"The list of export errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCounts"},"examples":{"services_listExportErrors":{"$ref":"#/components/examples/services_listExportErrors"}}}}}},"tags":["Services"],"x-ms-pageable":{}}},"/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2":{"get":{"description":" Gets the categorized export errors.","operationId":"services_listExportErrorsV2","parameters":[{"description":"The name of the service.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"},"examples":{"services_listExportErrorsV2":{"value":"SampleName"}}},{"description":"The error category to query for.","in":"query","na