deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.spring_apps.deployments

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Deployment.

Name	Datatype	Description
properties	object	Properties of the Deployment resource
sku	object	Sku of the Deployment resource

list

Success. The response describes the list of Deployments in the App.

Name	Datatype	Description
properties	object	Properties of the Deployment resource
sku	object	Sku of the Deployment resource

list_for_cluster

Name	Datatype	Description
properties	object	Properties of the Deployment resource
sku	object	Sku of the Deployment resource

Methods

The following methods are available for this resource:

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

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
appName	string	The name of the App resource.
deploymentName	string	The name of the Deployment resource.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand expression to apply on the operation.
version	array	Version of the deployments to be listed

SELECT examples

get

Get a Deployment and its properties.

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

list

Handles requests to list all resources in an App.

SELECT
properties,
sku
FROM azure.spring_apps.deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND appName = '{{ appName }}' -- required
AND version = '{{ version }}'
AND $expand = '{{ $expand }}'
;

list_for_cluster

List deployments for a certain service

SELECT
properties,
sku
FROM azure.spring_apps.deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND version = '{{ version }}'
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Create a new Deployment or update an exiting Deployment.

INSERT INTO azure.spring_apps.deployments (
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
serviceName,
appName,
deploymentName
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ appName }}',
'{{ deploymentName }}'
RETURNING
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: deployments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the deployments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the deployments resource.
    - name: serviceName
      value: string
      description: Required parameter for the deployments resource.
    - name: appName
      value: string
      description: Required parameter for the deployments resource.
    - name: deploymentName
      value: string
      description: Required parameter for the deployments resource.
    - name: properties
      value: object
      description: |
        Properties of the Deployment resource
    - name: sku
      value: object
      description: |
        Sku of the Deployment resource

UPDATE examples

update

Operation to update an exiting Deployment.

UPDATE azure.spring_apps.deployments
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND appName = '{{ appName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
RETURNING
properties,
sku;

DELETE examples

delete

Operation to delete a Deployment.

DELETE FROM azure.spring_apps.deployments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND appName = '{{ appName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
;

Lifecycle Methods

start

Start the deployment.

EXEC azure.spring_apps.deployments.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required
;

stop

Stop the deployment.

EXEC azure.spring_apps.deployments.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required
;

restart

Restart the deployment.

EXEC azure.spring_apps.deployments.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required
;

enable_remote_debugging

Enable remote debugging.

EXEC azure.spring_apps.deployments.enable_remote_debugging 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required 
@@json=
'{
"port": {{ port }}
}'
;

disable_remote_debugging

Disable remote debugging.

EXEC azure.spring_apps.deployments.disable_remote_debugging 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required
;

generate_heap_dump

Generate Heap Dump

EXEC azure.spring_apps.deployments.generate_heap_dump 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required 
@@json=
'{
"appInstance": "{{ appInstance }}", 
"filePath": "{{ filePath }}", 
"duration": "{{ duration }}"
}'
;

generate_thread_dump

Generate Thread Dump

EXEC azure.spring_apps.deployments.generate_thread_dump 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required 
@@json=
'{
"appInstance": "{{ appInstance }}", 
"filePath": "{{ filePath }}", 
"duration": "{{ duration }}"
}'
;

start_jfr

Start JFR

EXEC azure.spring_apps.deployments.start_jfr 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@appName='{{ appName }}' --required, 
@deploymentName='{{ deploymentName }}' --required 
@@json=
'{
"appInstance": "{{ appInstance }}", 
"filePath": "{{ filePath }}", 
"duration": "{{ duration }}"
}'
;