swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Reports API schemes: - https tags: - name: Reports paths: /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: microsoftAzureServicesListuserbadpasswordreport 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 summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Reports Badpassword Details User /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: microsoftAzureServicesListallriskyipdownloadreport 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 summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Reports Riskyip Bloburis /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: microsoftAzureServicesListcurrentriskyipdownloadreport 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 summary: Microsoft Azure Post Providers Microsoft Adhybridhealthservice Services Servicename Reports Riskyip Generatebloburi /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: microsoftAzureListIpaddressaggregatesbyservice 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 summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Ipaddressaggregates /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: microsoftAzureListIpaddressaggregatesettings 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' summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Ipaddressaggregatesettings ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports/{reportName} : get: tags: - Reports operationId: microsoftAzureReportsGet description: Get information about a report associated with a configuration profile assignment run x-ms-examples: Get a report for a configuration profile assignment: $ref: ./examples/getReport.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - name: configurationProfileAssignmentName in: path required: true type: string description: The configuration profile assignment name. - name: reportName in: path required: true type: string description: The report name. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/VmNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The report was returned successfully. schema: $ref: '#/definitions/Report' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse produces: - application/json consumes: - application/json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachines Vmname Providers Microsoft Automanage Configurationprofileassignments Configurationprofileassignmentname Reports Reportname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports : get: tags: - Reports operationId: microsoftAzureReportsListbyconfigurationprofileassignments description: Retrieve a list of reports within a given configuration profile assignment x-ms-examples: List reports by configuration profiles assignment: $ref: ./examples/listReportsByconfigurationProfileAssignment.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - name: configurationProfileAssignmentName in: path required: true type: string description: The configuration profile assignment name. - $ref: '#/parameters/VmNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. List of reports. schema: $ref: '#/definitions/ReportList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null produces: - application/json consumes: - application/json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachines Vmname Providers Microsoft Automanage Configurationprofileassignments Configurationprofileassignmentname Reports /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/reports/assets:snapshot: post: consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: body required: true schema: $ref: '#/definitions/ReportAssetSnapshotRequest' responses: '200': description: OK schema: $ref: '#/definitions/ReportAssetSnapshotResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Reports operationId: microsoftAzureReportsSnapshot summary: Microsoft Azure Retrieve The Most Recent Snapshot Of Asset Summary Values For The Snapshot Request x-ms-examples: Reports: $ref: ./examples/Reports_Snapshot.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/reports/assets:summarize: post: consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: body required: true schema: $ref: '#/definitions/ReportAssetSummaryRequest' responses: '200': description: OK schema: $ref: '#/definitions/ReportAssetSummaryResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Reports operationId: microsoftAzureReportsSummarize summary: Microsoft Azure Retrieve Asset Summary Details For The Summary Request x-ms-examples: Reports: $ref: ./examples/Reports_Summarize.json description: Needs a more full description created. /reports/assets:getBillable: post: operationId: microsoftAzureReportsGetbillable tags: - Reports description: Get billable assets summary for the workspace. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ReportBillableAssetSummaryResult' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Reports_GetBillable: $ref: ./examples/Reports_GetBillable_MaximumSet_Gen.json summary: Microsoft Azure Post Reports Assets:getbillable /reports/assets:getSnapshot: post: operationId: microsoftAzureReportsGetsnapshot tags: - Reports description: Get the most recent snapshot of asset summary values for the snapshot request. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: body in: body required: true schema: $ref: '#/definitions/ReportAssetSnapshotRequest_2' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ReportAssetSnapshotResult' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Reports_GetSnapshot: $ref: ./examples/Reports_GetSnapshot_MaximumSet_Gen.json summary: Microsoft Azure Post Reports Assets:getsnapshot /reports/assets:getSummary: post: operationId: microsoftAzureReportsGetsummary tags: - Reports description: Get asset summary details for the summary request. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: body in: body required: true schema: $ref: '#/definitions/ReportAssetSummaryRequest_2' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ReportAssetSummaryResult' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Reports_GetSummary: $ref: ./examples/Reports_GetSummary_MaximumSet_Gen.json summary: Microsoft Azure Post Reports Assets:getsummary ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/LatencyScorecard : get: tags: - Reports summary: Microsoft Azure Gets A Latency Scorecard For A Given Experiment operationId: microsoftAzureReportsGetlatencyscorecards produces: - application/json parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ProfileNameParameter' - $ref: '#/parameters/ExperimentNameParameter' - in: query name: endDateTimeUTC type: string description: The end DateTime of the Latency Scorecard in UTC required: false - in: query name: country type: string description: The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html required: false - in: query name: aggregationInterval type: string description: The aggregation interval of the Latency Scorecard enum: - Daily - Weekly - Monthly x-ms-enum: name: latencyScorecardAggregationInterval modelAsString: true required: true responses: '200': description: successful operation schema: $ref: '#/definitions/LatencyScorecard' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Gets a Latency Scorecard for a given Experiment: $ref: ./examples/NetworkExperimentGetLatencyScorecard.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/Timeseries : get: tags: - Reports summary: Microsoft Azure Gets A Timeseries For A Given Experiment operationId: microsoftAzureReportsGettimeseries produces: - application/json parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ProfileNameParameter' - $ref: '#/parameters/ExperimentNameParameter' - in: query name: startDateTimeUTC type: string format: date-time description: The start DateTime of the Timeseries in UTC required: true - in: query name: endDateTimeUTC type: string format: date-time description: The end DateTime of the Timeseries in UTC required: true - in: query name: aggregationInterval type: string description: The aggregation interval of the Timeseries enum: - Hourly - Daily x-ms-enum: name: timeseriesAggregationInterval modelAsString: true required: true - in: query name: timeseriesType type: string description: The type of Timeseries enum: - MeasurementCounts - LatencyP50 - LatencyP75 - LatencyP95 x-ms-enum: name: timeseriesType modelAsString: true required: true - in: query name: endpoint type: string description: The specific endpoint required: false - in: query name: country type: string description: The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html responses: '200': description: successful operation schema: $ref: '#/definitions/Timeseries' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Gets a Timeseries for a given Experiment: $ref: ./examples/NetworkExperimentGetTimeseries.json description: Needs a more full description created. definitions: Azure.Core.uuid: type: string format: uuid description: Universally Unique Identifier AssetState: type: string description: The state of assets enum: - candidate - confirmed - dismissed - candidateInvestigate - associatedPartner - associatedThirdparty - archived x-ms-enum: name: AssetState modelAsString: true 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' AssetPageResult: type: object description: The page of assets that match the provided metric. properties: totalElements: type: integer format: int64 description: The total number of items available in the full result set. mark: type: string description: The cursor mark to be used on the next request. Not set if using paging. nextLink: type: string description: The link to access the next page of results. Not set if at the end of the result set. value: type: array description: The items in the current page of results. items: $ref: '#/definitions/AssetResource' ReportAssetSummaryRequest: properties: filters: items: type: string type: array groupBy: type: string labelName: type: string metricCategories: items: type: string type: array metrics: items: type: string type: array segmentBy: type: string type: object ErrorDetail: description: This is the top-level error object whose code matches the x-ms-error-code response header properties: code: description: This is one of a server-defined set of error codes. type: string details: description: This is an array of details about specific errors that led to this reported error. items: $ref: '#/definitions/ErrorDetail' type: array innererror: $ref: '#/definitions/InnerError' message: description: This is a human-readable representation of the error. type: string target: description: This is the error target. type: string required: - code - message type: object LabelResource: properties: color: type: string displayName: type: string id: type: string name: type: string type: type: string uuid: type: string type: object Report: description: Definition of the report. type: object properties: properties: title: Properties x-ms-client-flatten: true $ref: '#/definitions/AssignmentReportProperties' description: The properties for the report. systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData readOnly: true description: Azure Resource Manager metadata containing createdBy and modifiedBy information. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource 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 AssetSummaryResponse: properties: count: format: int64 type: integer description: type: string displayName: type: string filter: type: string labelName: type: string link: type: string metric: type: string metricCategory: type: string updatedAt: format: date-time type: string type: object AssetPageResponse: properties: content: items: $ref: '#/definitions/AssetResponse' type: array first: type: boolean last: type: boolean mark: type: string nextLink: type: string number: format: int32 type: integer numberOfElements: format: int32 type: integer size: format: int32 type: integer totalElements: format: int64 type: integer totalPages: format: int32 type: integer type: object ReportBillableAssetBreakdownKind: type: string description: The kind of billable asset. enum: - domain - host - ipAddress x-ms-enum: name: ReportBillableAssetBreakdownKind modelAsString: true ReportAssetSummaryRequest_2: type: object description: 'A request body used to retrieve summary asset information. One and only one collection of summary identifiers must be provided: filters, metrics, or metricCategories.' properties: metricCategories: type: array description: Categories to retrieve risk reporting data for. items: type: string metrics: type: array description: Metrics to retrieve risk reporting data for. items: type: string filters: type: array description: Query filters to apply to the asset summary. items: type: string groupBy: type: string description: A parameter to group the assets by (first level facet field), only used when the chosen summary identifier is filters. segmentBy: type: string description: A parameter to segment the assets by (second level facet field), only used when the chosen summary identifier is filters. labelName: type: string description: Currently unused. AuditTrailItem: properties: displayName: type: string id: type: string kind: enum: - as - contact - domain - host - ipAddress - ipBlock - page - sslCert type: string x-ms-enum: modelAsString: true name: auditTrailItemKind name: type: string reason: type: string type: object AssetResource: type: object description: The items in the current page of results. properties: kind: type: string description: Discriminator property for AssetResource. id: type: string description: The system generated unique id for the resource. readOnly: true name: type: string description: The caller provided unique name for the resource. displayName: type: string description: The name that can be used for display purposes. uuid: $ref: '#/definitions/Azure.Core.uuid' description: Global UUID for the asset. createdDate: type: string format: date-time description: The date this asset was first added to this workspace. updatedDate: type: string format: date-time description: The date this asset was last updated for this workspace. state: $ref: '#/definitions/AssetState' externalId: type: string description: An optional customer provided identifier for this asset. labels: type: array description: Customer labels assigned to this asset. items: type: string wildcard: type: boolean description: An indicator of whether this asset represents a wildcard rollup of assets on this domain. discoGroupName: type: string description: The name of the DiscoGroup that brought added this asset to the workspace. auditTrail: type: array description: The history of how this asset was pulled into the workspace through the discovery process. items: $ref: '#/definitions/AuditTrailItem_2' reason: type: string discriminator: kind required: - kind - id LatencyScorecard: description: Defines the LatencyScorecard properties: properties: description: The properties of a latency scorecard $ref: '#/definitions/LatencyScorecardProperties' x-ms-client-flatten: true allOf: - $ref: ./network.json#/definitions/Resource Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message ReportResource: description: Details about the resource processed by the configuration profile assignment type: object properties: name: type: string readOnly: true description: Name of the resource. id: type: string readOnly: true description: ARM id of the resource. type: type: string readOnly: true description: Type of the resource. status: type: string readOnly: true description: Status of the resource. error: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail readOnly: true description: Error message, if any, returned when deploying the resource. 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 LatencyScorecardProperties: description: Defines a the properties of a Latency Scorecard type: object properties: id: description: The unique identifier of the Latency Scorecard type: string readOnly: true name: description: The name of the Latency Scorecard type: string readOnly: true description: description: The description of the Latency Scorecard type: string readOnly: true endpointA: description: The A endpoint in the scorecard type: string readOnly: true endpointB: description: The B endpoint in the scorecard type: string readOnly: true startDateTimeUTC: description: The start time of the Latency Scorecard in UTC type: string format: date-time readOnly: true endDateTimeUTC: description: The end time of the Latency Scorecard in UTC type: string format: date-time readOnly: true country: description: The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html type: string readOnly: true latencyMetrics: description: The latency metrics of the Latency Scorecard type: array items: $ref: '#/definitions/LatencyMetric' ReportAssetSummaryResult: type: object properties: assetSummaries: type: array description: The collection of asset summaries. items: $ref: '#/definitions/AssetSummaryResult' x-ms-identifiers: [] Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error ErrorResponse_2: description: Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message. type: object properties: code: description: Error code. readOnly: true type: string message: description: Error message indicating why the operation failed. readOnly: true type: string ReportBillableAssetSummaryResult: type: object properties: assetSummaries: type: array items: $ref: '#/definitions/ReportBillableAssetSnapshotResult' x-ms-identifiers: [] TimeseriesProperties: description: Defines the properties of a timeseries type: object properties: endpoint: type: string description: The endpoint associated with the Timeseries data point startDateTimeUTC: type: string description: The start DateTime of the Timeseries in UTC endDateTimeUTC: type: string description: The end DateTime of the Timeseries in UTC aggregationInterval: type: string description: The aggregation interval of the Timeseries enum: - Hourly - Daily x-ms-enum: name: aggregationInterval modelAsString: true timeseriesType: type: string description: The type of Timeseries enum: - MeasurementCounts - LatencyP50 - LatencyP75 - LatencyP95 x-ms-enum: name: timeseriesType modelAsString: true country: type: string description: The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html timeseriesData: description: The set of data points for the timeseries type: array items: $ref: '#/definitions/TimeseriesDataPoint' ReportAssetSummaryResponse: properties: assetSummaries: items: $ref: '#/definitions/AssetSummaryResponse' type: array type: object ReportAssetSnapshotResult: type: object description: A snapshot of assets captured daily for the provided metric. Asset details only contain primary properties. Detailed asset data can be retrieved from the asset endpoints. properties: displayName: type: string description: The name of the metric. metric: type: string description: The unique metric name. labelName: type: string description: The customer label that was filtered on, if one was provided. updatedAt: type: string format: date-time description: The last time this asset data was updated on this metric. description: type: string description: A description of what the metric represents. assets: $ref: '#/definitions/AssetPageResult' description: The page of assets that match the provided metric. ReportBillableAssetSnapshotResult: type: object properties: date: type: string format: date description: The date these assets were billed on. total: type: integer format: int64 description: The total number of billable assets for this date. assetBreakdown: type: array description: The breakdown of billable asset counts for each asset type. items: $ref: '#/definitions/ReportBillableAssetBreakdown' x-ms-identifiers: [] AssignmentReportProperties: description: Data related to the report detail. type: object properties: startTime: type: string description: Start time of the configuration profile assignment processing. endTime: type: string description: End time of the configuration profile assignment processing. lastModifiedTime: type: string readOnly: true description: Last modified time of the configuration profile assignment processing. duration: type: string readOnly: true description: Duration of the configuration profile assignment processing. type: type: string readOnly: true description: Type of the configuration profile assignment processing (Initial/Consistency). status: type: string readOnly: true description: The status of the configuration profile assignment. configurationProfile: type: string readOnly: true description: The configurationProfile linked to the assignment. resources: type: array readOnly: true items: $ref: '#/definitions/ReportResource' description: List of resources processed by the configuration profile assignment. error: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail readOnly: true description: Error message, if any, returned by the configuration profile assignment processing. reportFormatVersion: type: string readOnly: true description: Version of the report format ReportList: description: The response of the list report operation. type: object properties: value: type: array items: $ref: '#/definitions/Report' description: Result of the list report operation. 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 ReportBillableAssetBreakdown: type: object description: The breakdown of billable asset counts for each asset type. properties: kind: $ref: '#/definitions/ReportBillableAssetBreakdownKind' description: The kind of billable asset. count: type: integer format: int64 description: The number of assets of this type. 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 ReportAssetSnapshotResponse: properties: assets: $ref: '#/definitions/AssetPageResponse' description: type: string displayName: type: string labelName: type: string metric: type: string updatedAt: format: date-time type: string type: object ReportAssetSnapshotRequest_2: type: object description: A request body used to retrieve an asset report snapshot. properties: metric: type: string description: The metric to retrieve a snapshot for. labelName: type: string description: The name of the label to retrieve a snapshot for. size: type: integer format: int32 description: The number of assets per page. page: type: integer format: int32 description: The page to retrieve. Timeseries: description: Defines the Timeseries properties: properties: description: The properties of a Timeseries $ref: '#/definitions/TimeseriesProperties' x-ms-client-flatten: true allOf: - $ref: ./network.json#/definitions/Resource TimeseriesDataPoint: description: Defines a timeseries datapoint used in a timeseries type: object properties: dateTimeUTC: description: The DateTime of the Timeseries data point in UTC type: string value: description: The Value of the Timeseries data point type: number DiscoRunResponse: properties: completedDate: description: The date for when the disco run was completed in the microservice. format: date-time type: string excludes: description: The list of excludes used for the disco run, aka assets to exclude from the discovery algorithm. items: $ref: '#/definitions/AssetId' type: array newAssetsFoundCount: description: The count of the new assets that were found this disco run, aka that are labeled with this runs id at this time format: int64 type: integer seeds: description: The list of seeds used for the disco run. items: $ref: '#/definitions/AssetId' type: array startedDate: description: The date for when the disco run was actually started in the microservice. format: date-time type: string state: description: The State of the disco run enum: - pending - running - completed - failed type: string x-ms-enum: modelAsString: true name: discoRunResponseState submittedDate: description: The date for when the disco run was created in the microservice. format: date-time type: string tier: description: The tier which will affect the algorithm used for the disco run. type: string totalAssetsFoundCount: description: The total count of assets that were found this disco run. format: int64 type: integer type: object AssetId: description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm. properties: displayName: type: string id: type: string kind: enum: - as - contact - domain - host - ipAddress - ipBlock - page - sslCert type: string x-ms-enum: modelAsString: true name: assetIdKind name: type: string type: object Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. AssetResponse: properties: auditTrail: items: $ref: '#/definitions/AuditTrailItem' type: array createdDate: format: date-time type: string discoGroup: $ref: '#/definitions/DiscoGroupResponse' discoRun: $ref: '#/definitions/DiscoRunResponse' displayName: type: string externalId: type: string id: type: string kind: enum: - as - contact - domain - host - ipAddress - ipBlock - page - sslCert type: string x-ms-enum: modelAsString: true name: assetResponseKind labels: items: $ref: '#/definitions/LabelResource' type: array name: type: string reason: type: string state: enum: - candidate - confirmed - dismissed - candidateInvestigate - associatedPartner - associatedThirdparty - archived type: string x-ms-enum: modelAsString: true name: assetResponseState updatedDate: format: date-time type: string uuid: format: uuid type: string wildcard: type: boolean type: object discriminator: kind required: - kind 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 ErrorResponse: properties: error: $ref: '#/definitions/ErrorDetail' required: - error type: object AssetSummaryResult: type: object description: The collection of asset summaries. properties: displayName: type: string description: The name of the summary response. Depending on the request time this will either be the asset filter, risk category, or risk metric. description: type: string description: The description of the summary response. Filters don't have a description. updatedAt: type: string format: date-time description: The last time risk categories or risk metrics were captured. Set to the current time for asset filter requests, which always pull the live asset data. metricCategory: type: string description: If the request is for a metric category, this will contain the requested unique category name. metric: type: string description: If the request is for a metric, this will contain the requested unique metric name. filter: type: string description: If the request is for an asset filter, this will contain the corresponding filter. labelName: type: string description: An optional label used to filter requests results. count: type: integer format: int64 description: The count of assets matching the request parameters. link: type: string description: The link to the corresponding asset details. children: type: array description: The corresponding child entities. For metric categories this will contain metrics. For filters with groupBy and segmentBy this will contain facets. items: $ref: '#/definitions/AssetSummaryResult' x-ms-identifiers: [] DiscoGroupResponse: properties: createdDate: description: The date for the disco group was created. format: date-time type: string description: description: The description for a disco group. type: string displayName: type: string excludes: description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm. items: $ref: '#/definitions/AssetId' type: array frequencyMilliseconds: description: The frequency at which the disco group is supposed to be rerun in milliseconds. format: int64 type: integer id: type: string latestRunDate: description: The date for the latest run of this disco group, null if the group has never been run. format: date-time type: string name: type: string seeds: description: The list of seeds used for the disco group runs. items: $ref: '#/definitions/AssetId' type: array tier: description: The tier for the disco group which will affect the algorithm used for the disco runs in this group. type: string totalAssetsFoundCount: description: The total count of assets that were found for this disco group, aka that are labeled with this groups id at this time. format: int64 type: integer type: object RiskyIPBlobUris: description: The list containing blob uris. type: object properties: value: description: The list of blob uris. type: array items: $ref: '#/definitions/RiskyIPBlobUri' InnerError: description: This is an object containing more specific information than the current object about the error. properties: code: description: This is a more specific error code than was provided by the containing error.. type: string type: object LatencyMetric: description: Defines the properties of a latency metric used in the latency scorecard type: object properties: name: description: The name of the Latency Metric type: string readOnly: true endDateTimeUTC: description: The end time of the Latency Scorecard in UTC type: string readOnly: true aValue: description: The metric value of the A endpoint type: number readOnly: true bValue: description: The metric value of the B endpoint type: number readOnly: true delta: description: The difference in value between endpoint A and B type: number readOnly: true deltaPercent: description: The percent difference between endpoint A and B type: number readOnly: true aCLower95CI: description: The lower end of the 95% confidence interval for endpoint A type: number readOnly: true aHUpper95CI: description: The upper end of the 95% confidence interval for endpoint A type: number readOnly: true bCLower95CI: description: The lower end of the 95% confidence interval for endpoint B type: number readOnly: true bUpper95CI: description: The upper end of the 95% confidence interval for endpoint B type: number readOnly: true AuditTrailItemKind: type: string description: The kind of asset. enum: - as - contact - domain - host - ipAddress - ipBlock - page - sslCert x-ms-enum: name: AuditTrailItemKind modelAsString: true AuditTrailItem_2: type: object description: The history of how this asset was pulled into the workspace through the discovery process. properties: id: type: string description: The system generated unique id for the resource. name: type: string description: The caller provided unique name for the resource. displayName: type: string description: The name that can be used for display purposes. kind: $ref: '#/definitions/AuditTrailItemKind' description: The kind of asset. reason: type: string description: An explanation of why this audit trail node was discovered from the previous node. ReportAssetSnapshotRequest: properties: labelName: type: string metric: type: string page: format: int32 type: integer size: format: int32 type: integer type: object parameters: ProfileNameParameter: name: profileName in: path required: true type: string pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$ x-ms-parameter-location: method description: The Profile identifier associated with the Tenant and Partner ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$ minLength: 1 maxLength: 80 x-ms-parameter-location: method description: Name of the Resource group within the Azure subscription. ExperimentNameParameter: name: experimentName in: path required: true type: string pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$ x-ms-parameter-location: method description: The Experiment identifier associated with the Experiment apiVersionParameter: name: api-version in: query description: The version of the API to be used with the client request. required: true type: string WorkspaceNameParameter: description: The name of the Workspace. in: path name: workspaceName required: true type: string x-ms-parameter-location: method Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion VmNameParameter: name: vmName in: path required: true type: string description: The name of the virtual machine. x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'