deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.spring_apps.deployments

Fields

vw_deployments

Name	Datatype	Description
active	text	field from the properties object
appName	text	field from the properties object
deploymentName	text	field from the properties object
deployment_settings	text	field from the properties object
instances	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
sku	text	Sku of Azure Spring Apps
source	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object

deployments

Name	Datatype	Description
properties	object	Deployment resource properties payload
sku	object	Sku of Azure Spring Apps

Methods

Name	Accessible by	Required Params	Description
get	SELECT	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Get a Deployment and its properties.
list	SELECT	appName, resourceGroupName, serviceName, subscriptionId	Handles requests to list all resources in an App.
list_for_cluster	SELECT	resourceGroupName, serviceName, subscriptionId	List deployments for a certain service
create_or_update	INSERT	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Create a new Deployment or update an exiting Deployment.
delete	DELETE	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Operation to delete a Deployment.
update	UPDATE	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Operation to update an exiting Deployment.
disable_remote_debugging	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Disable remote debugging.
enable_remote_debugging	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Enable remote debugging.
generate_heap_dump	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Generate Heap Dump
generate_thread_dump	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Generate Thread Dump
restart	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Restart the deployment.
start	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Start the deployment.
start_jfr	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Start JFR
stop	EXEC	appName, deploymentName, resourceGroupName, serviceName, subscriptionId	Stop the deployment.

SELECT examples

List deployments for a certain service

vw_deployments

SELECT
active,
appName,
deploymentName,
deployment_settings,
instances,
provisioning_state,
resourceGroupName,
serviceName,
sku,
source,
status,
subscriptionId
FROM azure.spring_apps.vw_deployments
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

deployments

SELECT
properties,
sku
FROM azure.spring_apps.deployments
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new deployments resource.

All Properties

/*+ create */
INSERT INTO azure.spring_apps.deployments (
appName,
deploymentName,
resourceGroupName,
serviceName,
subscriptionId,
properties,
sku
)
SELECT 
'{{ appName }}',
'{{ deploymentName }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: source
          value:
            - name: type
              value: string
            - name: version
              value: string
        - name: deploymentSettings
          value:
            - name: resourceRequests
              value:
                - name: cpu
                  value: string
                - name: memory
                  value: string
            - name: environmentVariables
              value: object
            - name: apms
              value: []
            - name: addonConfigs
              value: object
            - name: livenessProbe
              value:
                - name: probeAction
                  value:
                    - name: type
                      value: string
                - name: disableProbe
                  value: boolean
                - name: initialDelaySeconds
                  value: integer
                - name: periodSeconds
                  value: integer
                - name: timeoutSeconds
                  value: integer
                - name: failureThreshold
                  value: integer
                - name: successThreshold
                  value: integer
            - name: terminationGracePeriodSeconds
              value: integer
            - name: scale
              value:
                - name: minReplicas
                  value: integer
                - name: maxReplicas
                  value: integer
                - name: rules
                  value:
                    - - name: name
                        value: string
                      - name: azureQueue
                        value:
                          - name: queueName
                            value: string
                          - name: queueLength
                            value: integer
                          - name: auth
                            value:
                              - - name: secretRef
                                  value: string
                                - name: triggerParameter
                                  value: string
                      - name: custom
                        value:
                          - name: type
                            value: string
                          - name: metadata
                            value: object
                          - name: auth
                            value:
                              - - name: secretRef
                                  value: string
                                - name: triggerParameter
                                  value: string
                      - name: http
                        value:
                          - name: metadata
                            value: object
                          - name: auth
                            value:
                              - - name: secretRef
                                  value: string
                                - name: triggerParameter
                                  value: string
                      - name: tcp
                        value:
                          - name: metadata
                            value: object
                          - name: auth
                            value:
                              - - name: secretRef
                                  value: string
                                - name: triggerParameter
                                  value: string
            - name: containerProbeSettings
              value:
                - name: disableProbe
                  value: boolean
        - name: provisioningState
          value: string
        - name: status
          value: string
        - name: active
          value: boolean
        - name: instances
          value:
            - - name: name
                value: string
              - name: status
                value: string
              - name: reason
                value: string
              - name: discoveryStatus
                value: string
              - name: startTime
                value: string
              - name: zone
                value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer

UPDATE example

Updates a deployments resource.

/*+ update */
UPDATE azure.spring_apps.deployments
SET 
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
appName = '{{ appName }}'
AND deploymentName = '{{ deploymentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified deployments resource.

/*+ delete */
DELETE FROM azure.spring_apps.deployments
WHERE appName = '{{ appName }}'
AND deploymentName = '{{ deploymentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';