compose_deployments

Creates, updates, deletes, gets or lists a compose_deployments resource.

Overview

Name	compose_deployments
Type	Resource
Id	azure.service_fabric_dataplane.compose_deployments

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_compose_deployment	insert	endpoint, DeploymentName, ComposeFileContent	timeout	Creates a Service Fabric compose deployment. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
timeout	integer (int64)	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.

INSERT examples

create_compose_deployment

Creates a Service Fabric compose deployment. 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.

INSERT INTO azure.service_fabric_dataplane.compose_deployments (
DeploymentName,
ComposeFileContent,
RegistryCredential,
endpoint,
timeout
)
SELECT 
'{{ DeploymentName }}' /* required */,
'{{ ComposeFileContent }}' /* required */,
'{{ RegistryCredential }}',
'{{ endpoint }}',
'{{ timeout }}'
;

Manifest

# Description fields are for documentation purposes
- name: compose_deployments
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the compose_deployments resource.
  - name: DeploymentName
    value: "{{ DeploymentName }}"
  - name: ComposeFileContent
    value: "{{ ComposeFileContent }}"
  - name: RegistryCredential
    description: |
      Credential information to connect to container registry.
    value:
      RegistryUserName: "{{ RegistryUserName }}"
      RegistryPassword: "{{ RegistryPassword }}"
      PasswordEncrypted: {{ PasswordEncrypted }}
  - name: timeout
    value: "{{ timeout }}"
    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.
    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.