az sf compose

Manage and deploy applications created from Docker Compose.

Commands

az sf compose create Creates a Service Fabric application from a Compose file.
az sf compose list Gets the list of compose applications created in the Service Fabric cluster.
az sf compose remove Deletes an existing Service Fabric compose application from cluster.
az sf compose status Gets information about a Service Fabric compose application.

az sf compose create

Creates a Service Fabric application from a Compose file.

az sf compose create --application-id
--compose-file
[--encrypted]
[--repo-pass]
[--repo-user]
[--timeout]

Required Parameters

--application-id

The id of application to create from Compose file. This is typically the full id of the application including "fabric:" URI scheme.

--compose-file

Path to the Compose file to use.

Optional Parameters

--encrypted

If true, indicate to use an encrypted password rather than prompting for a plaintext one.

--repo-pass

Encrypted container repository password.

--repo-user

Container repository user name if needed for authentication.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf compose list

Gets the status about the compose applications 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 application. If the applications 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.

az sf compose list [--continuation-token]
[--max-results]
[--timeout]

Optional Parameters

--continuation-token

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.

--max-results

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 queries includes as much results as possible that fit in the return message.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf compose remove

Deletes an existing Service Fabric compose application. An application must be created before it can be deleted.

az sf compose remove --application-id
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

Optional Parameters

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf compose status

Returns the status of compose application 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 application.

az sf compose status --application-id
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

Optional Parameters

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60