Microsoft Azure
Microsoft Azure MeshApplications API

The MeshApplications API from Microsoft Azure — 3 operation(s) for meshapplications.
Documentation GitHub OpenAPI
OpenAPI Specification

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
    - 

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-meshapplications-api-openapi.yml
Microsoft Azure MeshApplications API

Documentation

Specifications

Other Resources

OpenAPI Specification
