---
title: "Creates a Service Fabric compose deployment."
method: PUT
path: "/ComposeDeployments/$/Create"
tags: ["Compose Deployment"]
---

# Creates a Service Fabric compose deployment.

`PUT /ComposeDeployments/$/Create`

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.

## Query parameters

- `api-version` '6.0-preview', required
- `timeout` integer

## Request body

- CreateComposeDeploymentDescription — Defines description for creating a Service Fabric compose deployment.
  - `DeploymentName` string, required — The name of the deployment.
  - `ComposeFileContent` string, required — The content of the compose file that describes the deployment to create.
  - `RegistryCredential` RegistryCredential — Credential information to connect to container registry.
    - `RegistryUserName` string — The user name to connect to container registry.
    - `RegistryPassword` string — The password for supplied username to connect to container registry.
    - `PasswordEncrypted` boolean — Indicates that supplied container registry password is encrypted.

## Response `202`

A successful operation will return 202 status code.

## Other responses

- `default` — The detailed error response.

---

[API](https://skmtc.net/azure/apis/service-fabric-client-apis.md) · [All operations](https://skmtc.net/azure/apis/service-fabric-client-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/service-fabric-client-apis/versions/6df9f2f4d542/schema)