{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector Compose Deployment API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "Compose Deployment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Creates A Service Fabric Compose Deployment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/ComposeDeployments/$/Create",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API."
        },
        {
          "info": {
            "name": "Microsoft Azure Gets Information About A Service Fabric Compose Deployment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/ComposeDeployments/:deploymentName",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'."
              },
              {
                "name": "deploymentName",
                "value": "",
                "type": "path",
                "description": "The identity of the deployment."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment."
        },
        {
          "info": {
            "name": "Microsoft Azure Gets The List Of Compose Deployments Created In The Service Fabric Cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/ComposeDeployments",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'."
              },
              {
                "name": "ContinuationToken",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "MaxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments 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."
        },
        {
          "info": {
            "name": "Microsoft Azure Gets Details For The Latest Upgrade Performed On This Service Fabric Compose Deployment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/ComposeDeployments/:deploymentName/$/GetUpgradeProgress",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'."
              },
              {
                "name": "deploymentName",
                "value": "",
                "type": "path",
                "description": "The identity of the deployment."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues."
        },
        {
          "info": {
            "name": "Microsoft Azure Deletes An Existing Service Fabric Compose Deployment From Cluster",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/ComposeDeployments/:deploymentName/$/Delete",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'."
              },
              {
                "name": "deploymentName",
                "value": "",
                "type": "path",
                "description": "The identity of the deployment."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Deletes an existing Service Fabric compose deployment."
        },
        {
          "info": {
            "name": "Microsoft Azure Starts Upgrading A Compose Deployment In The Service Fabric Cluster",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/ComposeDeployments/:deploymentName/$/Upgrade",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'."
              },
              {
                "name": "deploymentName",
                "value": "",
                "type": "path",
                "description": "The identity of the deployment."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid."
        },
        {
          "info": {
            "name": "Microsoft Azure Starts Rolling Back A Compose Deployment Upgrade In The Service Fabric Cluster",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/ComposeDeployments/:deploymentName/$/RollbackUpgrade",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query",
                "description": "The version of the API. This parameter is required and its value must be '6.4-preview'."
              },
              {
                "name": "deploymentName",
                "value": "",
                "type": "path",
                "description": "The identity of the deployment."
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Rollback a service fabric compose deployment upgrade."
        }
      ]
    }
  ],
  "bundled": true
}