deployments

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

Overview

Name	deployments
Type	Resource
Id	azure_extras.app_platform.deployments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
active	boolean	Indicates whether the Deployment is active.
deploymentSettings	object	Deployment settings of the Deployment.
instances	array	Collection of instances belong to the Deployment.
provisioningState	string	Provisioning state of the Deployment. Known values are: "Creating", "Updating", "Succeeded", and "Failed".
sku	object	Sku of the Deployment resource.
source	object	Uploaded source information of the deployment.
status	string	Status of the Deployment. Known values are: "Stopped" and "Running".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
active	boolean	Indicates whether the Deployment is active.
deploymentSettings	object	Deployment settings of the Deployment.
instances	array	Collection of instances belong to the Deployment.
provisioningState	string	Provisioning state of the Deployment. Known values are: "Creating", "Updating", "Succeeded", and "Failed".
sku	object	Sku of the Deployment resource.
source	object	Uploaded source information of the deployment.
status	string	Status of the Deployment. Known values are: "Stopped" and "Running".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list_for_cluster

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
active	boolean	Indicates whether the Deployment is active.
deploymentSettings	object	Deployment settings of the Deployment.
instances	array	Collection of instances belong to the Deployment.
provisioningState	string	Provisioning state of the Deployment. Known values are: "Creating", "Updating", "Succeeded", and "Failed".
sku	object	Sku of the Deployment resource.
source	object	Uploaded source information of the deployment.
status	string	Status of the Deployment. Known values are: "Stopped" and "Running".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, app_name, deployment_name, subscription_id		Get a Deployment and its properties.
list	select	resource_group_name, service_name, app_name, subscription_id		Handles requests to list all resources in an App.
list_for_cluster	select	resource_group_name, service_name, subscription_id	$expand	List deployments for a certain service.
create_or_update	insert	resource_group_name, service_name, app_name, deployment_name, subscription_id		Create a new Deployment or update an exiting Deployment.
update	update	resource_group_name, service_name, app_name, deployment_name, subscription_id		Operation to update an exiting Deployment.
create_or_update	replace	resource_group_name, service_name, app_name, deployment_name, subscription_id		Create a new Deployment or update an exiting Deployment.
delete	delete	resource_group_name, service_name, app_name, deployment_name, subscription_id		Operation to delete a Deployment.
get_remote_debugging_config	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Get remote debugging config.
get_log_file_url	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Get deployment log file URL.
start	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Start the deployment.
stop	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Stop the deployment.
restart	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Restart the deployment.
enable_remote_debugging	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Enable remote debugging.
disable_remote_debugging	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Disable remote debugging.
generate_heap_dump	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Generate Heap Dump.
generate_thread_dump	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		Generate Thread Dump.
start_jfr	exec	resource_group_name, service_name, app_name, deployment_name, subscription_id		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
app_name	string	The name of the App resource. Required.
deployment_name	string	The name of the Deployment resource. Required.
resource_group_name	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. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string
$expand	string	The expand expression to apply on the operation. Default value is None.

SELECT examples

get

Get a Deployment and its properties.

SELECT
id,
name,
active,
deploymentSettings,
instances,
provisioningState,
sku,
source,
status,
systemData,
type
FROM azure_extras.app_platform.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handles requests to list all resources in an App.

SELECT
id,
name,
active,
deploymentSettings,
instances,
provisioningState,
sku,
source,
status,
systemData,
type
FROM azure_extras.app_platform.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND app_name = '{{ app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_for_cluster

List deployments for a certain service.

SELECT
id,
name,
active,
deploymentSettings,
instances,
provisioningState,
sku,
source,
status,
systemData,
type
FROM azure_extras.app_platform.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Create a new Deployment or update an exiting Deployment.

INSERT INTO azure_extras.app_platform.deployments (
properties,
sku,
resource_group_name,
service_name,
app_name,
deployment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ app_name }}',
'{{ deployment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployments resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the deployments resource.
  - name: app_name
    value: "{{ app_name }}"
    description: Required parameter for the deployments resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the deployments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployments resource.
  - name: properties
    description: |
      Properties of the Deployment resource.
    value:
      source:
        type: "{{ type }}"
        version: "{{ version }}"
      deploymentSettings:
        resourceRequests:
          cpu: "{{ cpu }}"
          memory: "{{ memory }}"
        environmentVariables: "{{ environmentVariables }}"
        apms:
          - resourceId: "{{ resourceId }}"
        addonConfigs: "{{ addonConfigs }}"
        livenessProbe:
          probeAction:
            type: "{{ type }}"
          disableProbe: {{ disableProbe }}
          initialDelaySeconds: {{ initialDelaySeconds }}
          periodSeconds: {{ periodSeconds }}
          timeoutSeconds: {{ timeoutSeconds }}
          failureThreshold: {{ failureThreshold }}
          successThreshold: {{ successThreshold }}
        readinessProbe:
          probeAction:
            type: "{{ type }}"
          disableProbe: {{ disableProbe }}
          initialDelaySeconds: {{ initialDelaySeconds }}
          periodSeconds: {{ periodSeconds }}
          timeoutSeconds: {{ timeoutSeconds }}
          failureThreshold: {{ failureThreshold }}
          successThreshold: {{ successThreshold }}
        startupProbe:
          probeAction:
            type: "{{ type }}"
          disableProbe: {{ disableProbe }}
          initialDelaySeconds: {{ initialDelaySeconds }}
          periodSeconds: {{ periodSeconds }}
          timeoutSeconds: {{ timeoutSeconds }}
          failureThreshold: {{ failureThreshold }}
          successThreshold: {{ successThreshold }}
        terminationGracePeriodSeconds: {{ terminationGracePeriodSeconds }}
        containerProbeSettings:
          disableProbe: {{ disableProbe }}
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      active: {{ active }}
      instances:
        - name: "{{ name }}"
          status: "{{ status }}"
          reason: "{{ reason }}"
          discoveryStatus: "{{ discoveryStatus }}"
          startTime: "{{ startTime }}"
          zone: "{{ zone }}"
  - name: sku
    description: |
      Sku of the Deployment resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      capacity: {{ capacity }}

UPDATE examples

update

Operation to update an exiting Deployment.

UPDATE azure_extras.app_platform.deployments
SET 
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
sku,
systemData,
type;

REPLACE examples

create_or_update

Create a new Deployment or update an exiting Deployment.

REPLACE azure_extras.app_platform.deployments
SET 
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
sku,
systemData,
type;

DELETE examples

delete

Operation to delete a Deployment.

DELETE FROM azure_extras.app_platform.deployments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND app_name = '{{ app_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_remote_debugging_config

Get remote debugging config.

EXEC azure_extras.app_platform.deployments.get_remote_debugging_config 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_log_file_url

Get deployment log file URL.

EXEC azure_extras.app_platform.deployments.get_log_file_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Start the deployment.

EXEC azure_extras.app_platform.deployments.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stop the deployment.

EXEC azure_extras.app_platform.deployments.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restart

Restart the deployment.

EXEC azure_extras.app_platform.deployments.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_remote_debugging

Enable remote debugging.

EXEC azure_extras.app_platform.deployments.enable_remote_debugging 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"port": {{ port }}
}'
;

disable_remote_debugging

Disable remote debugging.

EXEC azure_extras.app_platform.deployments.disable_remote_debugging 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

generate_heap_dump

Generate Heap Dump.

EXEC azure_extras.app_platform.deployments.generate_heap_dump 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appInstance": "{{ appInstance }}", 
"filePath": "{{ filePath }}", 
"duration": "{{ duration }}"
}'
;

generate_thread_dump

Generate Thread Dump.

EXEC azure_extras.app_platform.deployments.generate_thread_dump 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appInstance": "{{ appInstance }}", 
"filePath": "{{ filePath }}", 
"duration": "{{ duration }}"
}'
;

start_jfr

Start JFR.

EXEC azure_extras.app_platform.deployments.start_jfr 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@app_name='{{ app_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"appInstance": "{{ appInstance }}", 
"filePath": "{{ filePath }}", 
"duration": "{{ duration }}"
}'
;