swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Events API schemes: - https tags: - name: Events paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents : get: tags: - Events summary: Microsoft Azure Gets A List Of Events In The Migrate Project operationId: microsoftAzureEventsEnumerateevents parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/continuationToken' - $ref: '#/parameters/pageSize' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK schema: $ref: '#/definitions/EventCollection' deprecated: false x-ms-examples: MigrateEvents_List: $ref: ./examples/MigrateEvents_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents/{eventName} : get: tags: - Events summary: Microsoft Azure Gets An Event In The Migrate Project operationId: microsoftAzureEventsGetevent parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/eventName' responses: '200': description: OK schema: $ref: '#/definitions/MigrateEvent' deprecated: false x-ms-examples: MigrateEvents_Get: $ref: ./examples/MigrateEvents_Get.json description: Needs a more full description created. delete: tags: - Events summary: Microsoft Azure Delete The Migrate Event description: Delete the migrate event. Deleting non-existent migrate event is a no-operation. operationId: microsoftAzureEventsDeleteevent parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/eventName' responses: '200': description: OK deprecated: false x-ms-examples: MigrateEvents_Delete: $ref: ./examples/MigrateEvents_Delete.json /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events: get: tags: - Events operationId: microsoftAzureEventsListbysubscriptionid description: Lists service health events in the subscription. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/FilterParameter' - $ref: '#/parameters/QueryStartTimeParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The list of current service health events in the subscription schema: $ref: '#/definitions/events' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ListEventsBySubscriptionId: $ref: ./examples/Events_ListBySubscriptionId.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resourcehealth Events /providers/Microsoft.ResourceHealth/events: get: tags: - Events operationId: microsoftAzureEventsListbytenantid description: Lists current service health events in the tenant. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/FilterParameter' - $ref: '#/parameters/QueryStartTimeParameter' responses: '200': description: The list of service health events in the tenant schema: $ref: '#/definitions/events' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ListEventsByTenantId: $ref: ./examples/Events_ListByTenantId.json summary: Microsoft Azure Get Providers Microsoft Resourcehealth Events /{resourceUri}/providers/Microsoft.ResourceHealth/events: get: tags: - Events operationId: microsoftAzureEventsListbysingleresource description: Lists current service health events for given resource. parameters: - name: resourceUri in: path required: true type: string description: 'The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}' x-ms-skip-url-encoding: true - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/FilterParameter' responses: '200': description: The list of current service health events for given resource schema: $ref: '#/definitions/events' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ListEventsBySingleResource: $ref: ./examples/Events_ListBySingleResource.json summary: Microsoft Azure Get Resourceuri Providers Microsoft Resourcehealth Events /events/{eventId}/reward: post: tags: - Events summary: Microsoft Azure Post Reward description: Report reward between 0 and 1 that resulted from using the action specified in rewardActionId, for the specified event. operationId: microsoftAzureEventsReward consumes: - application/json produces: - application/json parameters: - name: eventId in: path description: The event id this reward applies to. required: true type: string maxLength: 256 - name: reward in: body description: The reward should be a floating point number, typically between 0 and 1. required: true schema: $ref: '#/definitions/RewardRequest' responses: '204': description: Success default: description: Invalid reward request. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Successful Events_Reward request: $ref: ./examples/Events_Reward.json /events/{eventId}/activate: post: tags: - Events summary: Microsoft Azure Activate Event description: Report that the specified event was actually used (e.g. by being displayed to the user) and a reward should be expected for it. operationId: microsoftAzureEventsActivate consumes: [] produces: - application/json parameters: - name: eventId in: path description: The event ID to be activated. required: true type: string maxLength: 256 responses: '204': description: Success default: description: Invalid activate event request. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Successful Events_Activate request: $ref: ./examples/Events_Activate.json ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events : post: tags: - Events summary: Microsoft Azure Batch Post Event Data description: Post event data to a specific Run Id. operationId: microsoftAzureEventsBatchpost consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: batchEventCommand in: body description: The batch of Event details. required: false schema: $ref: '#/definitions/BatchEventCommand' responses: '200': description: The batch of Events is posted successfully. schema: $ref: '#/definitions/BatchEventCommandResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_6' ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events : post: tags: - Events summary: Microsoft Azure Post Event Data description: Post event data to a specific Run Id. operationId: microsoftAzureEventsPost consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. required: true type: string - name: eventMessage in: body description: The Event details. required: false schema: $ref: '#/definitions/BaseEvent' responses: '200': description: The Event is posted successfully. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_6' definitions: BaseEvent: description: Base event is the envelope used to post event data to the Event controller type: object properties: timestamp: format: date-time type: string name: type: string data: type: object KeyValuePairBaseEventErrorResponse: type: object properties: key: $ref: '#/definitions/BaseEvent' readOnly: true value: $ref: '#/definitions/ErrorResponse_6' readOnly: true ErrorDetails: description: The error details. type: object properties: code: description: The error code. type: string message: description: The error message. type: string target: description: The target of the error (e.g., the name of the property in error). type: string PersonalizerError: description: The error object. required: - code - message type: object properties: code: description: Error Codes returned by Personalizer enum: - BadRequest - InvalidServiceConfiguration - InvalidLearningModeServiceConfiguration - InvalidPolicyConfiguration - InvalidPolicyContract - InvalidEvaluationContract - DuplicateCustomPolicyNames - NoLogsExistInDateRange - LogsSizeExceedAllowedLimit - InvalidRewardRequest - InvalidEventIdToActivate - InvalidRankRequest - InvalidExportLogsRequest - InvalidRequest - InvalidContainer - InvalidModelMetadata - ApprenticeModeNeverTurnedOn - MissingAppId - InvalidRewardWaitTime - InvalidMultiSlotApiAccess - ModelFileAccessDenied - ProblemTypeIncompatibleWithAutoOptimization - ResourceNotFound - FrontEndNotFound - EvaluationNotFound - LearningSettingsNotFound - EvaluationModelNotFound - LogsPropertiesNotFound - ModelRankingError - InternalServerError - RankNullResponse - UpdateConfigurationFailed - ModelResetFailed - ModelPublishFailed - ModelMetadataUpdateFailed - OperationNotAllowed type: string x-ms-enum: name: PersonalizerErrorCode modelAsString: true values: - value: BadRequest description: Request could not be understood by the server. - value: InvalidServiceConfiguration description: Invalid service configuration. - value: InvalidLearningModeServiceConfiguration description: Updating defaultReward, rewardWaitTime and rewardAggregation when changing learning mode from Online to Apprentice mode and vice versa is not allowed. Make the mode change and then change the additional settings with an additional API call. - value: InvalidPolicyConfiguration description: Invalid policy configuration. - value: InvalidPolicyContract description: Invalid policy contract. - value: InvalidEvaluationContract description: Invalid evaluation contract. - value: DuplicateCustomPolicyNames description: Custom policy names should be unique. - value: NoLogsExistInDateRange description: No logs exist in date range. - value: LogsSizeExceedAllowedLimit description: Total size of logs exceed allowed limit. - value: InvalidRewardRequest description: Invalid reward request. - value: InvalidEventIdToActivate description: Invalid activate event request. - value: InvalidRankRequest description: Invalid request. - value: InvalidExportLogsRequest description: Invalid request. - value: InvalidRequest description: Invalid request. - value: InvalidContainer description: SAS Uri must be the Uri to a container that has write permissions. - value: InvalidModelMetadata description: Invalid model metadata. - value: ApprenticeModeNeverTurnedOn description: Apprentice mode never turned on. - value: MissingAppId description: AppId is missing in the header. - value: InvalidRewardWaitTime description: Reward wait time should be between 5 seconds and 2 days - value: InvalidMultiSlotApiAccess description: Multi-slot feature is currently disabled. Please follow multi-slot Personalizer documentation to update your loop settings to enable multi-slot functionality. - value: ModelFileAccessDenied description: Key vault Key used for customer managed key cannot be accessed. - value: ProblemTypeIncompatibleWithAutoOptimization description: Auto-optimization is not compatible with multi-slot personalization. - value: ResourceNotFound description: Requested resource does not exist on the server. - value: FrontEndNotFound description: Front end not found. - value: EvaluationNotFound description: Offline Evaluation not found. - value: LearningSettingsNotFound description: Learning Settings not found in evaluation. - value: EvaluationModelNotFound description: Model not found in evaluation. - value: LogsPropertiesNotFound description: Log properties not found. - value: ModelRankingError description: Error while ranking actions using model. Please verify the learning settings are valid. - value: InternalServerError description: A generic error has occurred on the server. - value: RankNullResponse description: Rank call returned null response. - value: UpdateConfigurationFailed description: Failed to update configuration. - value: ModelResetFailed description: Model reset failed. - value: ModelPublishFailed description: Model publish failed. - value: ModelMetadataUpdateFailed description: Model metadata update failed. - value: OperationNotAllowed description: This operation is not allowed at this time. message: description: A message explaining the error reported by the service. type: string target: description: Error source element. type: string details: description: An array of details about specific errors that led to this reported error. type: array items: $ref: '#/definitions/PersonalizerError' innerError: $ref: '#/definitions/InternalError' RootError: description: The root error. type: object properties: code: description: 'The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.' type: string message: description: A human-readable representation of the error. type: string target: description: The target of the error (e.g., the name of the property in error). type: string details: description: The related errors that occurred during the request. uniqueItems: false type: array items: $ref: '#/definitions/ErrorDetails' innerError: $ref: '#/definitions/InnerErrorResponse' description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand. link: type: object description: Useful links for service health event. properties: type: type: string description: Type of link. enum: - Button - Hyperlink x-ms-enum: name: LinkTypeValues modelAsString: true displayText: type: object description: Display text of link. properties: value: type: string description: Display text of link. localizedValue: type: string description: Localized display text of link. extensionName: type: string description: It provides the name of portal extension to produce link for given service health event. bladeName: type: string description: It provides the name of portal extension blade to produce link for given service health event. parameters: type: object description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ErrorResponse_6: description: The error response. type: object properties: error: $ref: '#/definitions/RootError' description: The top level error that occurred. correlation: description: Dictionary containing correlation details for the error. type: object additionalProperties: type: string environment: description: The hosting environment. type: string location: description: The Azure region. type: string time: format: date-time description: The time in UTC. type: string impact: type: object description: Azure service impacted by the service health event. properties: impactedService: type: string description: Impacted service name. impactedRegions: type: array x-ms-identifiers: [] description: List regions impacted by the service health event. items: $ref: '#/definitions/impactedServiceRegion' event: type: object description: Service health event properties: properties: x-ms-client-flatten: true type: object description: Properties of event. properties: eventType: type: string description: Type of event. enum: - ServiceIssue - PlannedMaintenance - HealthAdvisory - RCA - EmergingIssues - SecurityAdvisory x-ms-enum: name: EventTypeValues modelAsString: true eventSubType: type: string description: Sub type of the event. Currently used to determine retirement communications for health advisory events enum: - Retirement x-ms-enum: name: EventSubTypeValues modelAsString: true eventSource: type: string description: Source of event. enum: - ResourceHealth - ServiceHealth x-ms-enum: name: EventSourceValues modelAsString: true status: type: string description: Current status of event. enum: - Active - Resolved x-ms-enum: name: EventStatusValues modelAsString: true title: type: string description: Title text of event. summary: type: string description: Summary text of event. header: type: string description: Header text of event. level: type: string description: Level of insight. enum: - Critical - Warning x-ms-enum: name: LevelValues modelAsString: true eventLevel: type: string description: Level of event. enum: - Critical - Error - Warning - Informational x-ms-enum: name: EventLevelValues modelAsString: true externalIncidentId: type: string description: The id of the Incident reason: type: string description: The reason for the Incident article: type: object description: Article of event. properties: articleContent: type: string description: Article content of event. articleId: type: string description: Article Id parameters: type: object description: It provides a map of parameter name and value links: type: array x-ms-identifiers: [] description: Useful links of event. items: $ref: '#/definitions/link' impactStartTime: type: string description: It provides the Timestamp for when the health impacting event started. format: date-time impactMitigationTime: type: string description: It provides the Timestamp for when the health impacting event resolved. format: date-time impact: type: array x-ms-identifiers: [] description: List services impacted by the service health event. items: $ref: '#/definitions/impact' recommendedActions: type: object description: Recommended actions of event. properties: message: type: string description: Recommended action title for the service health event. actions: type: array x-ms-identifiers: [] description: Recommended actions for the service health event. items: type: object description: Recommended action for the service health event. properties: groupId: type: integer format: int32 description: Recommended action group Id for the service health event. actionText: type: string description: Recommended action text localeCode: type: string description: Recommended action locale for the service health event. faqs: type: array x-ms-identifiers: [] description: Frequently asked questions for the service health event. items: $ref: '#/definitions/faq' isHIR: type: boolean description: It provides information if the event is High incident rate event or not. enableMicrosoftSupport: type: boolean description: Tells if we want to enable or disable Microsoft Support for this event. description: type: string description: Contains the communication message for the event, that could include summary, root cause and other details. platformInitiated: type: boolean description: Is true if the event is platform initiated. enableChatWithUs: type: boolean description: Tells if we want to enable or disable Microsoft Support for this event. priority: type: integer format: int32 description: Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved. lastUpdateTime: type: string description: It provides the Timestamp for when the health impacting event was last updated. format: date-time hirStage: type: string description: Stage for HIR Document additionalInformation: type: object description: Additional information properties: message: type: string description: Additional information Message duration: type: integer description: duration in seconds format: int32 impactType: type: string description: The type of the impact maintenanceId: type: string description: Unique identifier for planned maintenance event. maintenanceType: type: string description: The type of planned maintenance event. argQuery: type: string description: Azure Resource Graph query to fetch the affected resources from their existing Azure Resource Graph locations. allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource MigrateEvent: description: MigrateEvent REST resource. type: object properties: id: description: Gets or sets the relative URL to get to this REST resource. type: string name: description: Gets or sets the name of this REST resource. type: string type: description: Gets the type of this REST resource. type: string readOnly: true properties: $ref: '#/definitions/MigrateEventProperties' description: Gets or sets the properties of the event. ErrorResponse_2: description: Used to return an error to the client required: - error type: object properties: error: $ref: '#/definitions/PersonalizerError' update: type: object description: Update for service health event. properties: summary: type: string description: Summary text for the given update for the service health event. updateDateTime: type: string description: It provides the Timestamp for the given update for the service health event. format: date-time EventCollection: description: Collection of events. type: object properties: value: description: Gets or sets the machines. type: array items: $ref: '#/definitions/MigrateEvent' nextLink: description: Gets or sets the value of nextLink. type: string faq: type: object description: Frequently asked question for the service health event properties: question: type: string description: FAQ question for the service health event. answer: type: string description: FAQ answer for the service health event. localeCode: type: string description: FAQ locale for the service health event. events: type: object properties: value: type: array x-ms-identifiers: [] items: $ref: '#/definitions/event' description: The list of event. nextLink: type: string description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. required: - value description: The List events operation response. MigrateEventProperties: description: Properties of the error resource. type: object properties: instanceType: description: Gets the Instance type. type: string readOnly: true errorCode: description: Gets or sets the error code. type: string errorMessage: description: Gets or sets the error message. type: string recommendation: description: Gets or sets the recommendation for the error. type: string possibleCauses: description: Gets or sets the possible causes for the error. type: string solution: description: Gets or sets the solution for which the error is being reported. type: string clientRequestId: description: Gets or sets the client request Id of the payload for which the event is being reported. type: string discriminator: instanceType RewardRequest: description: Reward given to a rank response. required: - value type: object properties: value: format: float description: Reward to be assigned to an action. Value is a float calculated by your application, typically between 0 and 1, and must be between -1 and 1. type: number ErrorResponse: description: Error details. type: object properties: code: description: The error code. type: string readOnly: true message: description: The error message. type: string readOnly: true details: description: The error details. type: string readOnly: true impactedServiceRegion: type: object description: Azure region impacted by the service health event. properties: impactedRegion: type: string description: Impacted region name. status: type: string description: Current status of event in the region. enum: - Active - Resolved x-ms-enum: name: EventStatusValues modelAsString: true impactedSubscriptions: type: array x-ms-identifiers: [] description: List subscription impacted by the service health event. items: type: string description: Subscription impacted by the service health event. impactedTenants: type: array x-ms-identifiers: [] description: List tenant impacted by the service health event. items: type: string description: Tenant impacted by the service health event. lastUpdateTime: type: string description: It provides the Timestamp for when the last update for the service health event. format: date-time updates: type: array x-ms-identifiers: [] description: List of updates for given service health event. items: $ref: '#/definitions/update' BatchEventCommandResult: type: object properties: errors: uniqueItems: false type: array items: $ref: '#/definitions/KeyValuePairBaseEventErrorResponse' InternalError: description: An object containing more specific information than the parent object about the error. type: object properties: code: description: Detailed error code. type: string innererror: $ref: '#/definitions/InternalError' BatchEventCommand: type: object properties: events: uniqueItems: false type: array items: $ref: '#/definitions/BaseEvent' InnerErrorResponse: description: A nested structure of errors. type: object properties: code: description: The error code. type: string innerError: $ref: '#/definitions/InnerErrorResponse' description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand. parameters: migrateProjectName: name: migrateProjectName description: Name of the Azure Migrate project. type: string in: path x-ms-parameter-location: method required: true acceptLanguage: description: Standard request header. Used by service to respond to client in appropriate language. name: Accept-Language type: string in: header x-ms-parameter-location: client resourceGroupName: name: resourceGroupName description: Name of the Azure Resource Group that migrate project is part of. type: string in: path x-ms-parameter-location: method required: true resourceGroupNameParameter: name: resourceGroupName in: path description: The Name of the resource group in which the workspace is located. required: true type: string x-ms-parameter-location: method workspaceNameParameter: name: workspaceName in: path description: The name of the workspace. required: true type: string x-ms-parameter-location: method api-version: name: api-version description: Standard request header. Used by service to identify API version used by client. type: string in: query required: true enum: - 2018-09-01-preview FilterParameter: name: $filter in: query required: false type: string description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN x-ms-parameter-location: method continuationToken: name: continuationToken description: The continuation token. type: string in: query required: false x-ms-parameter-location: method subscriptionId: name: subscriptionId description: Azure Subscription Id in which migrate project was created. type: string in: path required: true eventName: name: eventName description: Unique name of an event within a migrate project. type: string in: path x-ms-parameter-location: method required: true subscriptionIdParameter: name: subscriptionId in: path description: The Azure Subscription ID. required: true type: string format: uuid x-ms-parameter-location: method pageSize: name: pageSize description: The number of items to be returned in a single page. This value is honored only if it is less than the 100. type: integer in: query required: false x-ms-parameter-location: method QueryStartTimeParameter: name: queryStartTime in: query required: false type: string description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'