deployments_at_tenant_scopes

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

Overview

Name	deployments_at_tenant_scopes
Type	Resource
Id	azure.resources.deployments_at_tenant_scopes

Fields

The following fields are returned by SELECT queries:

get

OK - Returns information about the deployment, including provisioning status.

Name	Datatype	Description
id	string	The ID of the deployment.
name	string	The name of the deployment.
location	string	the location of the deployment.
properties	object	Deployment properties.
tags	object	Deployment tags
type	string	The type of the deployment.

list

OK - Returns an array of deployments.

Name	Datatype	Description
id	string	The ID of the deployment.
name	string	The name of the deployment.
location	string	the location of the deployment.
properties	object	Deployment properties.
tags	object	Deployment tags
type	string	The type of the deployment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deploymentName		Gets a deployment.
list	select		$filter, $top	Get all the deployments at the tenant scope.
create_or_update	insert	deploymentName, data__location, data__properties		You can provide the template and parameters directly in the request or link to JSON files.
delete	delete	deploymentName		A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

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
deploymentName	string	The name of the deployment.
$filter	string	The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
$top	integer (int32)	The number of results to get. If null is passed, returns all deployments.

SELECT examples

get

Gets a deployment.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.resources.deployments_at_tenant_scopes
WHERE deploymentName = '{{ deploymentName }}' -- required
;

list

Get all the deployments at the tenant scope.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.resources.deployments_at_tenant_scopes
WHERE $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

You can provide the template and parameters directly in the request or link to JSON files.

INSERT INTO azure.resources.deployments_at_tenant_scopes (
data__location,
data__properties,
data__tags,
deploymentName
)
SELECT 
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ deploymentName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployments_at_tenant_scopes
  props:
    - name: deploymentName
      value: string
      description: Required parameter for the deployments_at_tenant_scopes resource.
    - name: location
      value: string
      description: |
        The location to store the deployment data.
    - name: properties
      value: object
      description: |
        The deployment properties.
    - name: tags
      value: object
      description: |
        Deployment tags

DELETE examples

delete

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

DELETE FROM azure.resources.deployments_at_tenant_scopes
WHERE deploymentName = '{{ deploymentName }}' --required
;