swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector EventsStore API schemes: - https tags: - name: EventsStore paths: /EventsStore/Cluster/Events: get: summary: Microsoft Azure Gets All Cluster Related Events description: The response is list of ClusterEvent objects. operationId: microsoftAzureGetclustereventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Cluster-related events: $ref: ./examples/GetClusterEventList.json responses: '200': description: List of events objects with base type ClusterEvent. schema: $ref: '#/definitions/ClusterEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Containers/Events: get: summary: Microsoft Azure Gets All Containers Related Events description: The response is list of ContainerInstanceEvent objects. operationId: microsoftAzureGetcontainerseventlist parameters: - $ref: '#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore responses: '200': description: List of events objects with base type ContainerInstanceEvent. schema: $ref: '#/definitions/ContainerInstanceEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Nodes/{nodeName}/$/Events: get: summary: Microsoft Azure Gets A Node Related Events description: The response is list of NodeEvent objects. operationId: microsoftAzureGetnodeeventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/NodeNameRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Node-related events: $ref: ./examples/GetNodeEventList.json responses: '200': description: List of events objects with base type NodeEvent. schema: $ref: '#/definitions/NodeEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Nodes/Events: get: summary: Microsoft Azure Gets All Nodes Related Events description: The response is list of NodeEvent objects. operationId: microsoftAzureGetnodeseventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Nodes-related events: $ref: ./examples/GetNodesEventList.json responses: '200': description: List of events objects with base type NodeEvent. schema: $ref: '#/definitions/NodeEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Applications/{applicationId}/$/Events: get: summary: Microsoft Azure Gets An Application Related Events description: The response is list of ApplicationEvent objects. operationId: microsoftAzureGetapplicationeventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Application-related events: $ref: ./examples/GetApplicationEventList.json responses: '200': description: List of events objects with base type ApplicationEvent. schema: $ref: '#/definitions/ApplicationEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Applications/Events: get: summary: Microsoft Azure Gets All Applications Related Events description: The response is list of ApplicationEvent objects. operationId: microsoftAzureGetapplicationseventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Applications-related events: $ref: ./examples/GetApplicationsEventList.json responses: '200': description: List of events objects with base type ApplicationEvent. schema: $ref: '#/definitions/ApplicationEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Services/{serviceId}/$/Events: get: summary: Microsoft Azure Gets A Service Related Events description: The response is list of ServiceEvent objects. operationId: microsoftAzureGetserviceeventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Service-related events: $ref: ./examples/GetServiceEventList.json responses: '200': description: List of events objects with base type ServiceEvent. schema: $ref: '#/definitions/ServiceEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Services/Events: get: summary: Microsoft Azure Gets All Services Related Events description: The response is list of ServiceEvent objects. operationId: microsoftAzureGetserviceseventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Services-related events: $ref: ./examples/GetServicesEventList.json responses: '200': description: List of events objects with base type ServiceEvent. schema: $ref: '#/definitions/ServiceEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Partitions/{partitionId}/$/Events: get: summary: Microsoft Azure Gets A Partition Related Events description: The response is list of PartitionEvent objects. operationId: microsoftAzureGetpartitioneventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Partition-related events: $ref: ./examples/GetPartitionEventList.json responses: '200': description: List of events objects with base type PartitionEvent. schema: $ref: '#/definitions/PartitionEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Partitions/Events: get: summary: Microsoft Azure Gets All Partitions Related Events description: The response is list of PartitionEvent objects. operationId: microsoftAzureGetpartitionseventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Partitions-related events: $ref: ./examples/GetPartitionsEventList.json responses: '200': description: List of events objects with base type PartitionEvent. schema: $ref: '#/definitions/PartitionEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events: get: summary: Microsoft Azure Gets A Partition Replica Related Events description: The response is list of ReplicaEvent objects. operationId: microsoftAzureGetpartitionreplicaeventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ReplicaIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Partition Replica-related events: $ref: ./examples/GetReplicaEventList.json responses: '200': description: List of events objects with base type ReplicaEvent. schema: $ref: '#/definitions/ReplicaEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/Partitions/{partitionId}/$/Replicas/Events: get: summary: Microsoft Azure Gets All Replicas Related Events For A Partition description: The response is list of ReplicaEvent objects. operationId: microsoftAzureGetpartitionreplicaseventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/StartTimeUtcRequiredQueryParam' - $ref: '#/parameters/EndTimeUtcRequiredQueryParam' - $ref: '#/parameters/EventsTypesFilterOptionalQueryParam' - $ref: '#/parameters/ExcludeAnalysisEventsOptionalQueryParam' - $ref: '#/parameters/SkipCorrelationLookupOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Partition Replicas-related events: $ref: ./examples/GetReplicasEventList.json responses: '200': description: List of events objects with base type ReplicaEvent. schema: $ref: '#/definitions/ReplicaEventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events: get: summary: Microsoft Azure Gets All Correlated Events For A Given Event description: The response is list of FabricEvents. operationId: microsoftAzureGetcorrelatedeventlist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/EventInstanceIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - EventsStore x-ms-examples: Get Correlated events: $ref: ./examples/GetCorrelatedEventList.json responses: '200': description: List of events objects with base type FabricEvent. schema: $ref: '#/definitions/EventList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' definitions: ApplicationEvent: description: Represents the base for all Application Events. allOf: - $ref: '#/definitions/FabricEvent' properties: ApplicationId: $ref: '#/definitions/ApplicationId' description: 'The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.' required: - ApplicationId x-ms-discriminator-value: ApplicationEvent FabricErrorError: description: Error object containing error code and error message. properties: Code: $ref: '#/definitions/FabricErrorCodes' description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" Message: type: string description: Error message. required: - Code ClusterEvent: description: Represents the base for all Cluster Events. allOf: - $ref: '#/definitions/FabricEvent' x-ms-discriminator-value: ClusterEvent PartitionId: type: string format: uuid description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. NodeEventList: description: A list of NodeEvent objects. type: array items: $ref: '#/definitions/NodeEvent' ApplicationId: type: string description: 'The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.' ReplicaEventList: description: A list of ReplicaEvent objects. type: array items: $ref: '#/definitions/ReplicaEvent' ApplicationEventList: description: A list of ApplicationEvent objects. type: array items: $ref: '#/definitions/ApplicationEvent' ClusterEventList: description: A list of ClusterEvent objects. type: array items: $ref: '#/definitions/ClusterEvent' ServiceEventList: description: A list of ServiceEvent objects. type: array items: $ref: '#/definitions/ServiceEvent' FabricEvent: discriminator: Kind description: Represents the base for all Fabric Events. properties: Kind: $ref: '#/definitions/FabricEventKind' description: The kind of FabricEvent. EventInstanceId: type: string format: uuid description: The identifier for the FabricEvent instance. Category: type: string description: The category of event. TimeStamp: type: string format: date-time description: The time event was logged. HasCorrelatedEvents: type: boolean description: Shows there is existing related events available. required: - Kind - EventInstanceId - TimeStamp ServiceEvent: description: Represents the base for all Service Events. allOf: - $ref: '#/definitions/FabricEvent' properties: ServiceId: $ref: '#/definitions/ServiceId' description: 'The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1\~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' required: - ServiceId x-ms-discriminator-value: ServiceEvent ReplicaId_Integer: type: integer format: int64 description: Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id. EventList: description: A list of FabricEvent objects. type: array items: $ref: '#/definitions/FabricEvent' FabricErrorCodes: type: string description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" enum: - FABRIC_E_INVALID_PARTITION_KEY - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR - FABRIC_E_INVALID_ADDRESS - FABRIC_E_APPLICATION_NOT_UPGRADING - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR - FABRIC_E_FABRIC_NOT_UPGRADING - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR - FABRIC_E_INVALID_CONFIGURATION - FABRIC_E_INVALID_NAME_URI - FABRIC_E_PATH_TOO_LONG - FABRIC_E_KEY_TOO_LARGE - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED - FABRIC_E_INVALID_ATOMIC_GROUP - FABRIC_E_VALUE_EMPTY - FABRIC_E_NODE_NOT_FOUND - FABRIC_E_APPLICATION_TYPE_NOT_FOUND - FABRIC_E_APPLICATION_NOT_FOUND - FABRIC_E_SERVICE_TYPE_NOT_FOUND - FABRIC_E_SERVICE_DOES_NOT_EXIST - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND - FABRIC_E_PARTITION_NOT_FOUND - FABRIC_E_REPLICA_DOES_NOT_EXIST - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND - FABRIC_E_DIRECTORY_NOT_FOUND - FABRIC_E_FABRIC_VERSION_NOT_FOUND - FABRIC_E_FILE_NOT_FOUND - FABRIC_E_NAME_DOES_NOT_EXIST - FABRIC_E_PROPERTY_DOES_NOT_EXIST - FABRIC_E_ENUMERATION_COMPLETED - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND - FABRIC_E_KEY_NOT_FOUND - FABRIC_E_HEALTH_ENTITY_NOT_FOUND - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS - FABRIC_E_APPLICATION_ALREADY_EXISTS - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS - FABRIC_E_SERVICE_ALREADY_EXISTS - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS - FABRIC_E_APPLICATION_TYPE_IN_USE - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS - FABRIC_E_FABRIC_VERSION_IN_USE - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS - FABRIC_E_NAME_ALREADY_EXISTS - FABRIC_E_NAME_NOT_EMPTY - FABRIC_E_PROPERTY_CHECK_FAILED - FABRIC_E_SERVICE_METADATA_MISMATCH - FABRIC_E_SERVICE_TYPE_MISMATCH - FABRIC_E_HEALTH_STALE_REPORT - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED - FABRIC_E_NODE_HAS_NOT_STOPPED_YET - FABRIC_E_INSTANCE_ID_MISMATCH - FABRIC_E_VALUE_TOO_LARGE - FABRIC_E_NO_WRITE_QUORUM - FABRIC_E_NOT_PRIMARY - FABRIC_E_NOT_READY - FABRIC_E_RECONFIGURATION_PENDING - FABRIC_E_SERVICE_OFFLINE - E_ABORT - FABRIC_E_COMMUNICATION_ERROR - FABRIC_E_OPERATION_NOT_COMPLETE - FABRIC_E_TIMEOUT - FABRIC_E_NODE_IS_UP - E_FAIL - FABRIC_E_BACKUP_IS_ENABLED - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH - FABRIC_E_INVALID_FOR_STATELESS_SERVICES - FABRIC_E_BACKUP_NOT_ENABLED - FABRIC_E_BACKUP_POLICY_NOT_EXISTING - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING - FABRIC_E_BACKUP_IN_PROGRESS - FABRIC_E_RESTORE_IN_PROGRESS - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING - FABRIC_E_INVALID_SERVICE_SCALING_POLICY - E_INVALIDARG - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND - FABRIC_E_VOLUME_ALREADY_EXISTS - FABRIC_E_VOLUME_NOT_FOUND - SerializationError - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR x-ms-enum: name: FabricErrorCodes modelAsString: true values: - value: FABRIC_E_INVALID_PARTITION_KEY - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR - value: FABRIC_E_INVALID_ADDRESS - value: FABRIC_E_APPLICATION_NOT_UPGRADING - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR - value: FABRIC_E_FABRIC_NOT_UPGRADING - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR - value: FABRIC_E_INVALID_CONFIGURATION - value: FABRIC_E_INVALID_NAME_URI - value: FABRIC_E_PATH_TOO_LONG - value: FABRIC_E_KEY_TOO_LARGE - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED - value: FABRIC_E_INVALID_ATOMIC_GROUP - value: FABRIC_E_VALUE_EMPTY - value: FABRIC_E_NODE_NOT_FOUND - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND - value: FABRIC_E_APPLICATION_NOT_FOUND - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND - value: FABRIC_E_SERVICE_DOES_NOT_EXIST - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND - value: FABRIC_E_PARTITION_NOT_FOUND - value: FABRIC_E_REPLICA_DOES_NOT_EXIST - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND - value: FABRIC_E_DIRECTORY_NOT_FOUND - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND - value: FABRIC_E_FILE_NOT_FOUND - value: FABRIC_E_NAME_DOES_NOT_EXIST - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST - value: FABRIC_E_ENUMERATION_COMPLETED - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND - value: FABRIC_E_KEY_NOT_FOUND - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS - value: FABRIC_E_SERVICE_ALREADY_EXISTS - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_TYPE_IN_USE - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS - value: FABRIC_E_FABRIC_VERSION_IN_USE - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS - value: FABRIC_E_NAME_ALREADY_EXISTS - value: FABRIC_E_NAME_NOT_EMPTY - value: FABRIC_E_PROPERTY_CHECK_FAILED - value: FABRIC_E_SERVICE_METADATA_MISMATCH - value: FABRIC_E_SERVICE_TYPE_MISMATCH - value: FABRIC_E_HEALTH_STALE_REPORT - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET - value: FABRIC_E_INSTANCE_ID_MISMATCH - value: FABRIC_E_VALUE_TOO_LARGE - value: FABRIC_E_NO_WRITE_QUORUM - value: FABRIC_E_NOT_PRIMARY - value: FABRIC_E_NOT_READY - value: FABRIC_E_RECONFIGURATION_PENDING - value: FABRIC_E_SERVICE_OFFLINE - value: E_ABORT - value: FABRIC_E_COMMUNICATION_ERROR - value: FABRIC_E_OPERATION_NOT_COMPLETE - value: FABRIC_E_TIMEOUT - value: FABRIC_E_NODE_IS_UP - value: E_FAIL - value: FABRIC_E_BACKUP_IS_ENABLED - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES - value: FABRIC_E_BACKUP_NOT_ENABLED - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING - value: FABRIC_E_BACKUP_IN_PROGRESS - value: FABRIC_E_RESTORE_IN_PROGRESS - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY - value: E_INVALIDARG - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND - value: FABRIC_E_VOLUME_ALREADY_EXISTS - value: FABRIC_E_VOLUME_NOT_FOUND - value: SerializationError - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR PartitionEventList: description: A list of PartitionEvent objects. type: array items: $ref: '#/definitions/PartitionEvent' FabricError: description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful. properties: Error: $ref: '#/definitions/FabricErrorError' description: Error object containing error code and error message. required: - Error FabricEventKind: type: string description: The kind of FabricEvent. enum: - ClusterEvent - ContainerInstanceEvent - NodeEvent - ApplicationEvent - ServiceEvent - PartitionEvent - ReplicaEvent - PartitionAnalysisEvent - ApplicationCreated - ApplicationDeleted - ApplicationNewHealthReport - ApplicationHealthReportExpired - ApplicationUpgradeCompleted - ApplicationUpgradeDomainCompleted - ApplicationUpgradeRollbackCompleted - ApplicationUpgradeRollbackStarted - ApplicationUpgradeStarted - DeployedApplicationNewHealthReport - DeployedApplicationHealthReportExpired - ApplicationProcessExited - ApplicationContainerInstanceExited - NodeAborted - NodeAddedToCluster - NodeClosed - NodeDeactivateCompleted - NodeDeactivateStarted - NodeDown - NodeNewHealthReport - NodeHealthReportExpired - NodeOpenSucceeded - NodeOpenFailed - NodeRemovedFromCluster - NodeUp - PartitionNewHealthReport - PartitionHealthReportExpired - PartitionReconfigured - PartitionPrimaryMoveAnalysis - ServiceCreated - ServiceDeleted - ServiceNewHealthReport - ServiceHealthReportExpired - DeployedServicePackageNewHealthReport - DeployedServicePackageHealthReportExpired - StatefulReplicaNewHealthReport - StatefulReplicaHealthReportExpired - StatelessReplicaNewHealthReport - StatelessReplicaHealthReportExpired - ClusterNewHealthReport - ClusterHealthReportExpired - ClusterUpgradeCompleted - ClusterUpgradeDomainCompleted - ClusterUpgradeRollbackCompleted - ClusterUpgradeRollbackStarted - ClusterUpgradeStarted - ChaosStopped - ChaosStarted - ChaosCodePackageRestartScheduled - ChaosReplicaRemovalScheduled - ChaosPartitionSecondaryMoveScheduled - ChaosPartitionPrimaryMoveScheduled - ChaosReplicaRestartScheduled - ChaosNodeRestartScheduled x-ms-enum: name: FabricEventKind modelAsString: true values: - value: ClusterEvent - value: ContainerInstanceEvent - value: NodeEvent - value: ApplicationEvent - value: ServiceEvent - value: PartitionEvent - value: ReplicaEvent - value: PartitionAnalysisEvent - value: ApplicationCreated - value: ApplicationDeleted - value: ApplicationNewHealthReport - value: ApplicationHealthReportExpired - value: ApplicationUpgradeCompleted - value: ApplicationUpgradeDomainCompleted - value: ApplicationUpgradeRollbackCompleted - value: ApplicationUpgradeRollbackStarted - value: ApplicationUpgradeStarted - value: DeployedApplicationNewHealthReport - value: DeployedApplicationHealthReportExpired - value: ApplicationProcessExited - value: ApplicationContainerInstanceExited - value: NodeAborted - value: NodeAddedToCluster - value: NodeClosed - value: NodeDeactivateCompleted - value: NodeDeactivateStarted - value: NodeDown - value: NodeNewHealthReport - value: NodeHealthReportExpired - value: NodeOpenSucceeded - value: NodeOpenFailed - value: NodeRemovedFromCluster - value: NodeUp - value: PartitionNewHealthReport - value: PartitionHealthReportExpired - value: PartitionReconfigured - value: PartitionPrimaryMoveAnalysis - value: ServiceCreated - value: ServiceDeleted - value: ServiceNewHealthReport - value: ServiceHealthReportExpired - value: DeployedServicePackageNewHealthReport - value: DeployedServicePackageHealthReportExpired - value: StatefulReplicaNewHealthReport - value: StatefulReplicaHealthReportExpired - value: StatelessReplicaNewHealthReport - value: StatelessReplicaHealthReportExpired - value: ClusterNewHealthReport - value: ClusterHealthReportExpired - value: ClusterUpgradeCompleted - value: ClusterUpgradeDomainCompleted - value: ClusterUpgradeRollbackCompleted - value: ClusterUpgradeRollbackStarted - value: ClusterUpgradeStarted - value: ChaosStopped - value: ChaosStarted - value: ChaosCodePackageRestartScheduled - value: ChaosReplicaRemovalScheduled - value: ChaosPartitionSecondaryMoveScheduled - value: ChaosPartitionPrimaryMoveScheduled - value: ChaosReplicaRestartScheduled - value: ChaosNodeRestartScheduled ContainerInstanceEventList: description: A list of ContainerInstanceEvent objects. type: array items: $ref: '#/definitions/ContainerInstanceEvent' ServiceId: type: string description: 'The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1\~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' ReplicaEvent: description: Represents the base for all Replica Events. allOf: - $ref: '#/definitions/FabricEvent' properties: PartitionId: $ref: '#/definitions/PartitionId' description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. ReplicaId: $ref: '#/definitions/ReplicaId_Integer' description: Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id. required: - PartitionId - ReplicaId x-ms-discriminator-value: ReplicaEvent NodeName: type: string description: The name of a Service Fabric node. ContainerInstanceEvent: description: Represents the base for all Container Events. allOf: - $ref: '#/definitions/FabricEvent' x-ms-discriminator-value: ContainerInstanceEvent NodeEvent: description: Represents the base for all Node Events. allOf: - $ref: '#/definitions/FabricEvent' properties: NodeName: $ref: '#/definitions/NodeName' description: The name of a Service Fabric node. required: - NodeName x-ms-discriminator-value: NodeEvent PartitionEvent: description: Represents the base for all Partition Events. allOf: - $ref: '#/definitions/FabricEvent' properties: PartitionId: $ref: '#/definitions/PartitionId' description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. required: - PartitionId x-ms-discriminator-value: PartitionEvent parameters: EventsTypesFilterOptionalQueryParam: name: EventsTypesFilter in: query x-ms-parameter-location: method type: string required: false description: This is a comma separated string specifying the types of FabricEvents that should only be included in the response. SkipCorrelationLookupOptionalQueryParam: name: SkipCorrelationLookup in: query x-ms-parameter-location: method type: boolean required: false description: This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. PartitionIdRequiredPathParam: name: partitionId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string format: uuid required: true description: The identity of the partition. ReplicaIdRequiredPathParam: name: replicaId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The identifier of the replica. ApiVersion_6-4_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.4' required: true default: '6.4' description: 'The version of the API. This parameter is required and its value must be ''6.4''. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_6-4_RequiredQueryParam modelAsString: true values: - value: '6.4' description: The 6.4 version of the API. NodeNameRequiredPathParam: name: nodeName in: path x-ms-parameter-location: method type: string required: true description: The name of the node. StartTimeUtcRequiredQueryParam: name: StartTimeUtc in: query x-ms-parameter-location: method type: string required: true description: The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. TimeoutOptionalQueryParam: name: timeout in: query x-ms-parameter-location: method type: integer format: int64 required: false minimum: 1 maximum: 4294967295 default: 60 description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. ApiVersion_6-2-Preview_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - 6.2-preview required: true default: 6.2-preview description: The version of the API. This parameter is required and its value must be '6.2-preview'. x-ms-enum: name: ApiVersion_6-2-Preview_RequiredQueryParam modelAsString: true values: - value: 6.2-preview description: The version number for the preview functionality of 6.2 runtime EventInstanceIdRequiredPathParam: name: eventInstanceId in: path x-ms-parameter-location: method type: string required: true description: The EventInstanceId. ServiceIdRequiredPathParam: name: serviceId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: 'The identity of the service. This ID is typically the full name of the service without the ''fabric:'' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' ApplicationIdRequiredPathParam: name: applicationId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: 'The identity of the application. This is typically the full name of the application without the ''fabric:'' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.' EndTimeUtcRequiredQueryParam: name: EndTimeUtc in: query x-ms-parameter-location: method type: string required: true description: The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. ExcludeAnalysisEventsOptionalQueryParam: name: ExcludeAnalysisEvents in: query x-ms-parameter-location: method type: boolean required: false description: This param disables the retrieval of AnalysisEvents if true is passed. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'