swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Property Management API schemes: - https tags: - name: Property Management paths: /Names/$/Create: post: summary: Microsoft Azure Creates A Service Fabric Name description: Creates the specified Service Fabric name. operationId: microsoftAzureCreatename parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameDescriptionRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Create new name: $ref: examples/CreateName-1.json tags: - Property Management responses: '201': description: A successful response means that the name has been created. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Names/{nameId}: get: summary: Microsoft Azure Returns Whether The Service Fabric Name Exists description: Returns whether the specified Service Fabric name exists. operationId: microsoftAzureGetnameexistsinfo parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Property Management responses: '200': description: A successful response means that the Service Fabric name exists. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' delete: summary: Microsoft Azure Deletes A Service Fabric Name description: Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail. operationId: microsoftAzureDeletename parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Property Management responses: '200': description: A successful response means that the Service Fabric name has been deleted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Names/{nameId}/$/GetSubNames: get: summary: Microsoft Azure Enumerates All The Service Fabric Names Under A Given Name description: Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail. operationId: microsoftAzureGetsubnameinfolist parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/RecursiveOptionalQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Get sub names: $ref: examples/GetSubNameInfoList-1.json Recursively search sub names: $ref: examples/GetSubNameInfoList-2.json Page using continuation token: $ref: examples/GetSubNameInfoList-3.json tags: - Property Management responses: '200': description: A paged list of Service Fabric names. schema: $ref: '#/definitions/PagedSubNameInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Names/{nameId}/$/GetProperties: get: summary: Microsoft Azure Gets Information On All Service Fabric Properties Under A Given Name description: A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties. operationId: microsoftAzureGetpropertyinfolist parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/IncludeValuesOptionalQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Get property info list: $ref: examples/GetPropertyInfoList-1.json Get property info list with values: $ref: examples/GetPropertyInfoList-2.json Page using continuation token: $ref: examples/GetPropertyInfoList-3.json tags: - Property Management responses: '200': description: A paged list of Service Fabric properties. schema: $ref: '#/definitions/PagedPropertyInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Names/{nameId}/$/GetProperty: put: summary: Microsoft Azure Creates Or Updates A Service Fabric Property description: Creates or updates the specified Service Fabric property under a given name. operationId: microsoftAzurePutproperty parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/PropertyDescriptionRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Put property: $ref: examples/PutProperty-1.json Put custom property: $ref: examples/PutProperty-2.json tags: - Property Management responses: '200': description: A successful response means that the property has been created or updated. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' get: summary: Microsoft Azure Gets The Specified Service Fabric Property description: Gets the specified Service Fabric property under a given name. This will always return both value and metadata. operationId: microsoftAzureGetpropertyinfo parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/PropertyNameRequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Get property info: $ref: examples/GetPropertyInfo-1.json tags: - Property Management responses: '200': description: Details on the Service Fabric property. schema: $ref: '#/definitions/PropertyInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' delete: summary: Microsoft Azure Deletes The Specified Service Fabric Property description: Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted. operationId: microsoftAzureDeleteproperty parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/PropertyNameRequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Property Management responses: '200': description: A successful response means that the property has been deleted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Names/{nameId}/$/GetProperties/$/SubmitBatch: post: summary: Microsoft Azure Submits A Property Batch description: Submits a batch of property operations. Either all or none of the operations will be committed. operationId: microsoftAzureSubmitpropertybatch parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/NameIdRequiredPathParam' - $ref: '#/parameters/PropertyBatchDescriptionListRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' x-ms-examples: Property batch operation: $ref: examples/SubmitPropertyBatch-1.json tags: - Property Management responses: '200': description: A successful response means that the property batch succeeded. schema: $ref: '#/definitions/SuccessfulPropertyBatchInfo' '409': description: A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were committed. schema: $ref: '#/definitions/FailedPropertyBatchInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' definitions: FailedPropertyBatchInfo: description: Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure. allOf: - $ref: '#/definitions/PropertyBatchInfo' x-ms-discriminator-value: Failed properties: ErrorMessage: type: string description: The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch. OperationIndex: type: integer description: The index of the unsuccessful operation in the property batch. PropertyDescription: description: Description of a Service Fabric property. properties: PropertyName: $ref: '#/definitions/PropertyName' description: The name of the Service Fabric property. CustomTypeId: $ref: '#/definitions/PropertyCustomTypeId' description: The property's custom type ID. Using this property, the user is able to tag the type of the value of the property. Value: $ref: '#/definitions/PropertyValue' description: Describes a Service Fabric property value. required: - PropertyName - Value 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 PropertyBatchOperation: discriminator: Kind description: Represents the base type for property operations that can be put into a batch and submitted. properties: Kind: $ref: '#/definitions/PropertyBatchOperationKind' description: The kind of property batch operation, determined by the operation to be performed. The following are the possible values. PropertyName: $ref: '#/definitions/PropertyName' description: The name of the Service Fabric property. required: - Kind - PropertyName SuccessfulPropertyBatchInfo: description: Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any "Get" operations in the batch. allOf: - $ref: '#/definitions/PropertyBatchInfo' x-ms-discriminator-value: Successful properties: Properties: additionalProperties: $ref: '#/definitions/PropertyInfo' description: A map containing the properties that were requested through any "Get" property batch operations. The key represents the index of the "Get" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map. PropertyBatchOperationKind: type: string description: The kind of property batch operation, determined by the operation to be performed. The following are the possible values. enum: - Invalid - Put - Get - CheckExists - CheckSequence - Delete - CheckValue x-ms-enum: name: PropertyBatchOperationKind modelAsString: true values: - value: Invalid description: Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Put description: The operation will create or edit a property. The value is 1. - value: Get description: The operation will get a property. The value is 2. - value: CheckExists description: The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3. - value: CheckSequence description: The operation will ensure that the sequence number is equal to the provided value. The value is 4. - value: Delete description: The operation will delete a property. The value is 5. - value: CheckValue description: The operation will ensure that the value of a property is equal to the provided value. The value is 7. FabricName: type: string description: The Service Fabric name, including the 'fabric:' URI scheme. PropertyBatchDescriptionList: description: Describes a list of property batch operations to be executed. Either all or none of the operations will be committed. properties: Operations: type: array items: $ref: '#/definitions/PropertyBatchOperation' description: A list of the property batch operations to be executed. 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 ContinuationToken: type: string description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. PagedSubNameInfoList: description: A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. IsConsistent: type: boolean description: Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false. SubNames: type: array description: List of the child names. items: $ref: '#/definitions/FabricName' 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 PropertyValueKind: type: string description: The kind of property, determined by the type of data. Following are the possible values. enum: - Invalid - Binary - Int64 - Double - String - Guid x-ms-enum: name: PropertyValueKind modelAsString: true values: - value: Invalid description: Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Binary description: The data inside the property is a binary blob. The value is 1. - value: Int64 description: The data inside the property is an int64. The value is 2. - value: Double description: The data inside the property is a double. The value is 3. - value: String description: The data inside the property is a string. The value is 4. - value: Guid description: The data inside the property is a guid. The value is 5. PagedPropertyInfoList: description: The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. IsConsistent: type: boolean description: Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false. Properties: type: array description: List of property information. items: $ref: '#/definitions/PropertyInfo' PropertyBatchInfoKind: type: string description: The kind of property batch info, determined by the results of a property batch. The following are the possible values. enum: - Invalid - Successful - Failed x-ms-enum: name: PropertyBatchInfoKind modelAsString: true values: - value: Invalid description: Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type. - value: Successful description: The property batch succeeded. - value: Failed description: The property batch failed. NameDescription: description: Describes a Service Fabric name. properties: Name: $ref: '#/definitions/FabricName' description: The Service Fabric name, including the 'fabric:' URI scheme. required: - Name PropertyValue: discriminator: Kind description: Describes a Service Fabric property value. properties: Kind: $ref: '#/definitions/PropertyValueKind' description: The kind of property, determined by the type of data. Following are the possible values. required: - Kind PropertyMetadata: description: The metadata associated with a property, including the property's name. properties: TypeId: $ref: '#/definitions/PropertyValueKind' description: The kind of property, determined by the type of data. Following are the possible values. CustomTypeId: $ref: '#/definitions/PropertyCustomTypeId' description: The property's custom type ID. Parent: $ref: '#/definitions/FabricName' description: The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists. SizeInBytes: type: integer description: The length of the serialized property value. LastModifiedUtcTimestamp: type: string format: date-time description: Represents when the Property was last modified. Only write operations will cause this field to be updated. SequenceNumber: type: string description: The version of the property. Every time a property is modified, its sequence number is increased. PropertyName: type: string description: The name of the Service Fabric property. PropertyBatchInfo: discriminator: Kind description: Information about the results of a property batch. properties: Kind: $ref: '#/definitions/PropertyBatchInfoKind' description: The kind of property batch info, determined by the results of a property batch. The following are the possible values. required: - Kind PropertyInfo: description: Information about a Service Fabric property. properties: Name: $ref: '#/definitions/PropertyName' description: The name of the Service Fabric property. Value: $ref: '#/definitions/PropertyValue' description: Describes a Service Fabric property value. Metadata: $ref: '#/definitions/PropertyMetadata' description: The metadata associated with a property, including the property's name. required: - Name - Metadata PropertyCustomTypeId: type: string description: The property's custom type ID. Using this property, the user is able to tag the type of the value of the property. parameters: PropertyBatchDescriptionListRequiredBodyParam: name: PropertyBatchDescriptionList in: body description: Describes the property batch operations to be submitted. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/PropertyBatchDescriptionList' NameIdRequiredPathParam: name: nameId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The Service Fabric name, without the 'fabric:' URI scheme. PropertyNameRequiredQueryParam: name: PropertyName description: Specifies the name of the property to get. in: query x-ms-parameter-location: method type: string required: true 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. IncludeValuesOptionalQueryParam: name: IncludeValues description: Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata. in: query x-ms-parameter-location: method type: boolean required: false default: false ApiVersion_6-0_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.0' required: true default: '6.0' description: 'The version of the API. This parameter is required and its value must be ''6.0''. 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 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 accept 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, but if the runtime is 6.1, in order to make it easier to write the clients, 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-0_RequiredQueryParam modelAsString: true values: - value: '6.0' description: The 6.0 version of the API. NameDescriptionRequiredBodyParam: name: NameDescription in: body description: Describes the Service Fabric name to be created. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/NameDescription' RecursiveOptionalQueryParam: name: Recursive description: Allows specifying that the search performed should be recursive. in: query x-ms-parameter-location: method type: boolean required: false default: false ContinuationTokenOptionalQueryParam: name: ContinuationToken in: query x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: false description: The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded. PropertyDescriptionRequiredBodyParam: name: PropertyDescription in: body description: Describes the Service Fabric property to be created. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/PropertyDescription' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'