swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector MeshApplications API schemes: - https tags: - name: MeshApplications paths: /Resources/Applications/{applicationResourceName}: put: operationId: microsoftAzureMeshapplicationCreateorupdate x-ms-examples: CreateOrUpdateMeshApplication: $ref: ./examples/Resources/Applications/create_update.json CreateOrUpdateMeshApplicationWithAutoScale: $ref: ./examples/Resources/Applications/create_update.autoscale.json summary: Microsoft Azure Creates Or Updates A Application Resource description: Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties. parameters: - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam' - $ref: '#/parameters/ApplicationResourceNameRequiredPathParam' - $ref: '#/parameters/ApplicationResourceDescriptionRequiredBodyParam' tags: - MeshApplications responses: '200': description: OK schema: $ref: '#/definitions/ApplicationResourceDescription' '201': description: Created schema: $ref: '#/definitions/ApplicationResourceDescription' '202': description: Accepted default: description: Error schema: $ref: '#/definitions/FabricError' get: operationId: microsoftAzureMeshapplicationGet x-ms-examples: GetApplicationResource: $ref: ./examples/Resources/Applications/get.json summary: Microsoft Azure Gets The Application Resource With The Given Name description: Gets the information about the Application resource with the given name. The information include the description and other properties of the Application. parameters: - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam' - $ref: '#/parameters/ApplicationResourceNameRequiredPathParam' tags: - MeshApplications responses: '200': description: OK schema: $ref: '#/definitions/ApplicationResourceDescription' default: description: Error schema: $ref: '#/definitions/FabricError' delete: operationId: microsoftAzureMeshapplicationDelete x-ms-examples: DeleteApplicationResource: $ref: ./examples/Resources/Applications/delete.json summary: Microsoft Azure Deletes The Application Resource description: Deletes the Application resource identified by the name. parameters: - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam' - $ref: '#/parameters/ApplicationResourceNameRequiredPathParam' tags: - MeshApplications responses: '200': description: OK '202': description: Accepted '204': description: No Content - the specified application was not found. default: description: Error schema: $ref: '#/definitions/FabricError' /Resources/Applications: get: operationId: microsoftAzureMeshapplicationList x-ms-examples: ListMeshApplications: $ref: ./examples/Resources/Applications/list.json summary: Microsoft Azure Lists All The Application Resources description: Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application. parameters: - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam' tags: - MeshApplications responses: '200': description: OK schema: $ref: '#/definitions/PagedApplicationResourceDescriptionList' default: description: Error schema: $ref: '#/definitions/FabricError' /Resources/Applications/{applicationResourceName}/$/GetUpgradeProgress: get: operationId: microsoftAzureMeshapplicationGetupgradeprogress x-ms-examples: GetApplicationResourceUpgrade: $ref: ./examples/Resources/Applications/get_upgrade.json summary: Microsoft Azure Gets The Progress Of The Latest Upgrade Performed On This Application Resource description: Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade state information of the Application resource. parameters: - $ref: '#/parameters/ApiVersion_7-0_RequiredQueryParam' - $ref: '#/parameters/ApplicationResourceNameRequiredPathParam' tags: - MeshApplications responses: '200': description: OK schema: $ref: '#/definitions/ApplicationResourceUpgradeProgressInfo' default: description: Error schema: $ref: '#/definitions/FabricError' definitions: Setting: description: Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". properties: type: $ref: '#/definitions/SettingType' description: The type of the setting being given in value name: description: The name of the setting. type: string value: description: The value of the setting, will be processed based on the type provided. type: string VolumeReference: description: Describes a reference to a volume resource. type: object properties: name: type: string description: Name of the volume being referenced. readOnly: type: boolean description: The flag indicating whether the volume is read only. Default is 'false'. destinationPath: type: string description: The path within the container at which the volume should be mounted. Only valid path characters are allowed. required: - name - destinationPath ApplicationScopedVolumeCreationParameters: description: Describes parameters for creating application-scoped volumes. type: object discriminator: kind properties: kind: $ref: '#/definitions/ApplicationScopedVolumeKind' description: Specifies the application-scoped volume kind. description: description: User readable description of the volume. type: string required: - kind 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 ProbeHttpGet: description: Http probe for the container. properties: port: description: Port to access for probe. type: integer path: description: Path to access on the HTTP request. type: string host: description: Host IP to connect to. type: string httpHeaders: description: Headers to set in the request. type: array items: $ref: '#/definitions/ProbeHttpGetHeaders' scheme: type: string description: Scheme for the http probe. Can be Http or Https. enum: - http - https x-ms-enum: name: scheme modelAsString: true values: - value: http description: Indicates that the probe is http. - value: https description: Indicates that the probe is https. No cert validation. required: - port UserAssignedIdentityMap: type: object description: Defines a map that contains user assigned identities. additionalProperties: $ref: '#/definitions/IdentityItemDescription' NetworkRef: description: Describes a network reference in a service. properties: name: type: string description: Name of the network endpointRefs: description: A list of endpoints that are exposed on this network. type: array items: $ref: '#/definitions/EndpointRef' ServiceUpgradeProgress: description: Information about how many replicas are completed or pending for a specific service during upgrade. properties: ServiceName: type: string description: Name of the Service resource. CompletedReplicaCount: type: string description: The number of replicas that completes the upgrade in the service. PendingReplicaCount: type: string description: The number of replicas that are waiting to be upgraded in the service. RollingUpgradeMode: type: string description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. enum: - Invalid - UnmonitoredAuto - UnmonitoredManual - Monitored default: Monitored x-ms-enum: name: RollingUpgradeMode modelAsString: true values: - value: Invalid description: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: UnmonitoredAuto description: The upgrade will proceed automatically without performing any health monitoring. The value is 1 - value: UnmonitoredManual description: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2 - value: Monitored description: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3 ExecutionPolicy: type: object discriminator: type description: The execution policy of the service properties: type: $ref: '#/definitions/ExecutionPolicyType' description: Enumerates the execution policy types for services. required: - type IdentityDescription: description: Information describing the identities associated with this application. properties: tokenServiceEndpoint: type: string description: the endpoint for the token service managing this identity type: type: string description: the types of identities associated with this resource; currently restricted to 'SystemAssigned and UserAssigned' tenantId: type: string description: the identifier of the tenant containing the application's identity. principalId: type: string description: the object identifier of the Service Principal of the identity associated with this resource. userAssignedIdentities: $ref: '#/definitions/UserAssignedIdentityMap' description: represents user assigned identities map. required: - type AutoScalingTriggerKind: type: string description: Enumerates the triggers for auto scaling. enum: - AverageLoad x-ms-enum: name: AutoScalingTriggerKind modelAsString: true values: - value: AverageLoad description: Indicates that scaling should be performed based on average load of all replicas in the service. ApplicationResourceName: type: string description: Name of the Application resource. ApplicationProperties: description: Describes properties of a application resource. properties: description: type: string description: User readable description of the application. services: type: array description: Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource. items: $ref: '#/definitions/ServiceResourceDescription' diagnostics: $ref: '#/definitions/DiagnosticsDescription' description: Describes the diagnostics definition and usage for an application resource. debugParams: description: Internal - used by Visual Studio to setup the debugging session on the local development environment. type: string serviceNames: readOnly: true description: Names of the services in the application. type: array items: type: string status: readOnly: true $ref: '#/definitions/ResourceStatus' description: Status of the application. statusDetails: readOnly: true type: string description: Gives additional information about the current status of the application. healthState: readOnly: true $ref: '#/definitions/HealthState' description: Describes the health state of an application resource. unhealthyEvaluation: readOnly: true type: string description: When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy. ServiceProperties: description: Describes properties of a service resource. properties: description: type: string description: User readable description of the service. replicaCount: type: integer description: The number of replicas of the service to create. Defaults to 1 if not specified. executionPolicy: $ref: '#/definitions/ExecutionPolicy' description: The execution policy of the service autoScalingPolicies: type: array items: $ref: '#/definitions/AutoScalingPolicy' description: Auto scaling policies status: readOnly: true $ref: '#/definitions/ResourceStatus' description: Status of the service. statusDetails: readOnly: true type: string description: Gives additional information about the current status of the service. healthState: readOnly: true $ref: '#/definitions/HealthState' description: Describes the health state of an application resource. unhealthyEvaluation: readOnly: true type: string description: When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. identityRefs: description: The service identity list. type: array items: $ref: '#/definitions/ServiceIdentity' dnsName: type: string description: Dns name of the service. HealthState: type: string description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. enum: - Invalid - Ok - Warning - Error - Unknown x-ms-enum: name: HealthState modelAsString: true values: - value: Invalid description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero. - value: Ok description: Indicates the health state is okay. The value is 1. - value: Warning description: Indicates the health state is at a warning level. The value is 2. - value: Error description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3. - value: Unknown description: Indicates an unknown health status. The value is 65535. ExecutionPolicyType: type: string description: Enumerates the execution policy types for services. enum: - Default - RunToCompletion x-ms-enum: name: ExecutionPolicyType modelAsString: true values: - value: Default description: Indicates the default execution policy, always restart the service if an exit occurs. - value: RunToCompletion description: Indicates that the service will perform its desired operation and complete successfully. If the service encounters failure, it will restarted based on restart policy specified. If the service completes its operation successfully, it will not be restarted again. EndpointRef: description: Describes a reference to a service endpoint. properties: name: type: string description: Name of the endpoint. ImageRegistryCredential: description: Image registry credential. properties: server: type: string description: Docker image registry server, without protocol such as `http` and `https`. username: type: string description: The username for the private registry. passwordType: $ref: '#/definitions/ImageRegistryPasswordType' description: The type of the image registry password being given in password password: type: string description: The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. Will be processed based on the type provided. required: - server - username ProbeHttpGetHeaders: description: Http headers. properties: name: description: The name of the header. type: string value: description: The value of the header. type: string required: - name - value DiagnosticsDescription: description: Describes the diagnostics options available properties: sinks: description: List of supported sinks that can be referenced. type: array items: $ref: '#/definitions/DiagnosticsSinkProperties' enabled: description: Status of whether or not sinks are enabled. type: boolean defaultSinkRefs: description: The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. type: array items: type: string DiagnosticsSinkProperties: description: Properties of a DiagnosticsSink. discriminator: kind properties: kind: $ref: '#/definitions/DiagnosticsSinkKind' description: The kind of DiagnosticsSink. name: description: Name of the sink. This value is referenced by DiagnosticsReferenceDescription type: string description: description: A description of the sink. type: string required: - kind AutoScalingMechanismKind: type: string description: Enumerates the mechanisms for auto scaling. enum: - AddRemoveReplica x-ms-enum: name: AutoScalingMechanismKind modelAsString: true values: - value: AddRemoveReplica description: Indicates that scaling should be performed by adding or removing replicas. IdentityItemDescription: description: Describes a single user-assigned identity associated with the application. type: object properties: principalId: type: string description: the object identifier of the Service Principal which this identity represents. clientId: type: string description: the client identifier of the Service Principal which this identity represents. ContainerLabel: description: Describes a container label. properties: name: description: The name of the container label. type: string value: description: The value of the container label. type: string required: - name - value ResourceStatus: description: Status of the resource. type: string enum: - Unknown - Ready - Upgrading - Creating - Deleting - Failed x-ms-enum: name: ResourceStatus modelAsString: true values: - value: Unknown description: Indicates the resource status is unknown. The value is zero. - value: Ready description: Indicates the resource is ready. The value is 1. - value: Upgrading description: Indicates the resource is upgrading. The value is 2. - value: Creating description: Indicates the resource is being created. The value is 3. - value: Deleting description: Indicates the resource is being deleted. The value is 4. - value: Failed description: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. DiagnosticsSinkKind: type: string description: The kind of DiagnosticsSink. enum: - Invalid - AzureInternalMonitoringPipeline x-ms-enum: name: DiagnosticsSinkKind modelAsString: true values: - value: Invalid description: Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type. - value: AzureInternalMonitoringPipeline description: Diagnostics settings for Geneva. ResourceRequirements: description: This type describes the resource requirements for a container or a service. properties: requests: $ref: '#/definitions/ResourceRequests' description: Describes the requested resources for a given container. limits: $ref: '#/definitions/ResourceLimits' description: Describes the maximum limits on the resources for a given container. required: - requests EndpointProperties: description: Describes a container endpoint. properties: name: description: The name of the endpoint. type: string port: description: Port used by the container. type: integer required: - name ProbeTcpSocket: description: Tcp port to probe inside the container. properties: port: description: Port to access for probe. type: integer required: - port 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 ReliableCollectionsRef: description: Specifying this parameter adds support for reliable collections properties: name: description: Name of ReliableCollection resource. Right now it's not used and you can use any string. type: string doNotPersistState: description: False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache. type: boolean required: - name ServiceIdentity: description: Map service identity friendly name to an application identity. properties: name: description: The identity friendly name. type: string identityRef: description: The application identity name. type: string ResourceLimits: description: This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. properties: memoryInGB: description: The memory limit in GB. type: number format: double cpu: description: CPU limits in cores. At present, only full cores are supported. type: number format: double 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. ApplicationResourceUpgradeProgressInfo: description: This type describes an application resource upgrade. properties: Name: type: string description: Name of the Application resource. TargetApplicationTypeVersion: type: string description: The target application version for the application upgrade. StartTimestampUtc: type: string description: The estimated UTC datetime when the upgrade started. UpgradeState: $ref: '#/definitions/ApplicationResourceUpgradeState' description: The state of the application resource upgrade. PercentCompleted: type: string description: The estimated percent of replicas are completed in the upgrade. ServiceUpgradeProgress: $ref: '#/definitions/ServiceUpgradeProgressList' description: List of service upgrade progresses. RollingUpgradeMode: $ref: '#/definitions/RollingUpgradeMode' description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. UpgradeDuration: type: string description: The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. default: PT0H2M0S ApplicationUpgradeStatusDetails: type: string description: Additional detailed information about the status of the pending upgrade. UpgradeReplicaSetCheckTimeoutInSeconds: type: integer format: int64 description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). default: 42949672925 FailureTimestampUtc: type: string description: The estimated UTC datetime when the upgrade failed and FailureAction was executed. EnvironmentVariable: description: Describes an environment variable for the container. properties: type: $ref: '#/definitions/EnvironmentVariableType' description: The type of the environment variable being given in value name: description: The name of the environment variable. type: string value: description: The value of the environment variable, will be processed based on the type provided. type: string 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 PagedApplicationResourceDescriptionList: type: object description: The list of application resources. 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. Items: type: array description: One page of the list. items: $ref: '#/definitions/ApplicationResourceDescription' AutoScalingMechanism: type: object discriminator: kind description: Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism. properties: kind: $ref: '#/definitions/AutoScalingMechanismKind' description: The type of auto scaling mechanism. required: - kind DiagnosticsRef: description: Reference to sinks in DiagnosticsDescription. properties: enabled: description: Status of whether or not sinks are enabled. type: boolean sinkRefs: description: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. type: array items: type: string ApplicationResourceUpgradeState: type: string description: The state of the application resource upgrade. enum: - Invalid - ProvisioningTarget - RollingForward - UnprovisioningCurrent - CompletedRollforward - RollingBack - UnprovisioningTarget - CompletedRollback - Failed x-ms-enum: name: ApplicationResourceUpgradeState modelAsString: true values: - value: Invalid description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is 0. - value: ProvisioningTarget description: The upgrade is in the progress of provisioning target application type version. The value is 1. - value: RollingForward description: The upgrade is rolling forward to the target version but is not complete yet. The value is 2. - value: UnprovisioningCurrent description: The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 3. - value: CompletedRollforward description: The upgrade has finished rolling forward. The value is 4. - value: RollingBack description: The upgrade is rolling back to the previous version but is not complete yet. The value is 5. - value: UnprovisioningTarget description: The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 6. - value: CompletedRollback description: The upgrade has finished rolling back. The value is 7. - value: Failed description: The upgrade has failed and is unable to execute FailureAction. The value is 8. SettingType: type: string description: The type of the setting being given in value default: ClearText enum: - ClearText - KeyVaultReference - SecretValueReference x-ms-enum: name: SettingType modelAsString: true values: - value: ClearText description: The setting in clear text, will not be processed in any way and passed in as is - value: KeyVaultReference description: The URI to a KeyVault secret version, will be resolved using the application's managed identity (this type is only valid if the app was assigned a managed identity) before getting passed in - value: SecretValueReference description: The reference to a SecretValue resource, will be resolved before getting passed in ServiceResourceProperties: description: This type describes properties of a service resource. allOf: - $ref: '#/definitions/ServiceReplicaProperties' - $ref: '#/definitions/ServiceProperties' ContainerInstanceView: description: Runtime information of a container instance. properties: restartCount: type: integer description: The number of times the container has been restarted. currentState: $ref: '#/definitions/ContainerState' description: Current container instance state. previousState: $ref: '#/definitions/ContainerState' description: Previous container instance state. events: description: The events of this container instance. type: array items: $ref: '#/definitions/ContainerEvent' ContainerState: description: The container state. properties: state: type: string description: The state of this container startTime: type: string format: date-time description: Date/time when the container state started. exitCode: type: string description: The container exit code. finishTime: type: string format: date-time description: Date/time when the container state finished. detailStatus: description: Human-readable status of this state. type: string EnvironmentVariableType: type: string description: The type of the environment variable being given in value default: ClearText enum: - ClearText - KeyVaultReference - SecretValueReference x-ms-enum: name: EnvironmentVariableType modelAsString: true values: - value: ClearText description: The environment variable in clear text, will not be processed in any way and passed in as is - value: KeyVaultReference description: The URI to a KeyVault secret version, will be resolved using the application's managed identity (this type is only valid if the app was assigned a managed identity) before getting passed in - value: SecretValueReference description: The reference to a SecretValue resource, will be resolved before getting passed in OperatingSystemType: type: string description: The operation system required by the code in service. enum: - Linux - Windows x-ms-enum: name: OperatingSystemType modelAsString: true values: - value: Linux description: The required operating system is Linux. - value: Windows description: The required operating system is Windows. ResourceRequests: description: This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. properties: memoryInGB: description: The memory request in GB for this container. type: number format: double cpu: description: Requested number of CPU cores. At present, only full cores are supported. type: number format: double required: - memoryInGB - cpu ApplicationScopedVolumeKind: description: Specifies the application-scoped volume kind. type: string enum: - ServiceFabricVolumeDisk x-ms-enum: name: ApplicationScopedVolumeKind modelAsString: true values: - value: ServiceFabricVolumeDisk description: Provides Service Fabric High Availability Volume Disk ServiceResourceDescription: description: This type describes a service resource. properties: name: $ref: '#/definitions/ServiceResourceName' description: Name of the Service resource. properties: x-ms-client-flatten: true $ref: '#/definitions/ServiceResourceProperties' description: This type describes properties of a service resource. required: - name - properties ServiceResourceName: type: string description: Name of the Service resource. AutoScalingTrigger: type: object discriminator: kind description: Describes the trigger for performing auto scaling operation. properties: kind: $ref: '#/definitions/AutoScalingTriggerKind' description: The type of auto scaling trigger required: - kind ServiceReplicaProperties: description: Describes the properties of a service replica. properties: osType: $ref: '#/definitions/OperatingSystemType' description: The operation system required by the code in service. codePackages: description: Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). type: array items: $ref: '#/definitions/ContainerCodePackageProperties' networkRefs: type: array description: The names of the private networks that this service needs to be part of. items: $ref: '#/definitions/NetworkRef' diagnostics: $ref: '#/definitions/DiagnosticsRef' description: Reference to sinks in DiagnosticsDescription. required: - osType - codePackages ContainerCodePackageProperties: description: Describes a container and its runtime properties. properties: name: description: The name of the code package. type: string image: description: The Container image to use. type: string imageRegistryCredential: $ref: '#/definitions/ImageRegistryCredential' description: Image registry credential. entryPoint: description: Override for the default entry point in the container. type: string commands: description: Command array to execute within the container in exec form. type: array items: type: string environmentVariables: description: The environment variables to set in this container type: array items: $ref: '#/definitions/EnvironmentVariable' settings: description: The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". type: array items: $ref: '#/definitions/Setting' labels: description: The labels to set in this container. type: array items: $ref: '#/definitions/ContainerLabel' endpoints: description: The endpoints exposed by this container. type: array items: $ref: '#/definitions/EndpointProperties' resources: description: The resources required by this container. $ref: '#/definitions/ResourceRequirements' volumeRefs: description: Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime. type: array items: $ref: '#/definitions/VolumeReference' volumes: description: Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime. type: array items: $ref: '#/definitions/ApplicationScopedVolume' diagnostics: $ref: '#/definitions/DiagnosticsRef' description: Reference to sinks in DiagnosticsDescription. reliableCollectionsRefs: description: A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details. type: array items: $ref: '#/definitions/ReliableCollectionsRef' instanceView: readOnly: true $ref: '#/definitions/ContainerInstanceView' description: Runtime information of a container instance. livenessProbe: description: An array of liveness probes for a code package. It determines when to restart a code package. type: array items: $ref: '#/definitions/Probe' readinessProbe: description: An array of readiness probes for a code package. It determines when to unpublish an endpoint. type: array items: $ref: '#/definitions/Probe' required: - name - image - resources Probe: description: Probes have a number of fields that you can use to control their behavior. properties: initialDelaySeconds: type: integer description: The initial delay in seconds to start executing probe once codepackage has started. default: 0 periodSeconds: type: integer description: Periodic seconds to execute probe. default: 10 timeoutSeconds: type: integer description: Period after which probe is considered as failed if it hasn't completed successfully. default: 1 successThreshold: type: integer description: The count of successful probe executions after which probe is considered success. default: 1 failureThreshold: type: integer description: The count of failures after which probe is considered failed. default: 3 exec: $ref: '#/definitions/ProbeExec' description: Exec command to run inside the container. httpGet: $ref: '#/definitions/ProbeHttpGet' description: Http probe for the container. tcpSocket: $ref: '#/definitions/ProbeTcpSocket' description: Tcp port to probe inside the container. ContainerEvent: description: A container event. properties: name: type: string description: The name of the container event. count: type: integer description: The count of the event. firstTimestamp: type: string description: Date/time of the first event. lastTimestamp: type: string description: Date/time of the last event. message: type: string description: The event message type: type: string description: The event type. AutoScalingPolicy: description: Describes the auto scaling policy type: object properties: name: description: The name of the auto scaling policy. type: string trigger: $ref: '#/definitions/AutoScalingTrigger' description: Determines when auto scaling operation will be invoked. mechanism: $ref: '#/definitions/AutoScalingMechanism' description: The mechanism that is used to scale when auto scaling operation is invoked. required: - name - trigger - mechanism ProbeExec: description: Exec command to run inside the container. properties: command: description: Comma separated command to run inside the container for example "sh, -c, echo hello world". type: string required: - command ImageRegistryPasswordType: type: string description: The type of the image registry password being given in password default: ClearText enum: - ClearText - KeyVaultReference - SecretValueReference x-ms-enum: name: ImageRegistryPasswordType modelAsString: true values: - value: ClearText description: The image registry password in clear text, will not be processed in any way and used directly - value: KeyVaultReference description: The URI to a KeyVault secret version, will be resolved using the application's managed identity (this type is only valid if the app was assigned a managed identity) before getting used - value: SecretValueReference description: The reference to a SecretValue resource, will be resolved before getting used ApplicationResourceDescription: description: This type describes a application resource. properties: name: $ref: '#/definitions/ApplicationResourceName' description: Name of the Application resource. properties: x-ms-client-flatten: true $ref: '#/definitions/ApplicationProperties' description: Describes properties of a application resource. identity: $ref: '#/definitions/IdentityDescription' description: Describes the identity of the application. required: - name - properties ServiceUpgradeProgressList: type: array description: List of service upgrade progresses. items: $ref: '#/definitions/ServiceUpgradeProgress' ApplicationScopedVolume: description: Describes a volume whose lifetime is scoped to the application's lifetime. allOf: - $ref: '#/definitions/VolumeReference' properties: creationParameters: $ref: '#/definitions/ApplicationScopedVolumeCreationParameters' description: Describes parameters for creating application-scoped volumes. required: - creationParameters parameters: ApiVersion_7-0_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '7.0' required: true default: '7.0' description: 'The version of the API. This parameter is required and its value must be ''7.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 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_7-0_RequiredQueryParam modelAsString: true values: - value: '7.0' description: The 7.0 version of the API. ApiVersion_6-4-Preview_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - 6.4-preview required: true default: 6.4-preview description: The version of the API. This parameter is required and its value must be '6.4-preview'. x-ms-enum: name: ApiVersion_6-4-Preview_RequiredQueryParam modelAsString: true values: - value: 6.4-preview description: The version number for the preview functionality of 6.4 runtime ApplicationResourceDescriptionRequiredBodyParam: name: applicationResourceDescription in: body description: Description for creating a Application resource. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/ApplicationResourceDescription' ApplicationResourceNameRequiredPathParam: name: applicationResourceName in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The identity of the application. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'