spaces

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

Overview

Name	spaces
Type	Resource
Id	azure.integration_environment.spaces

Fields

The following fields are returned by SELECT queries:

get

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

ARM operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, spaceName		Get a Space
list_by_resource_group	select	subscriptionId, resourceGroupName	top, skip, maxpagesize, filter, select, expand, orderby	List Space resources by resource group
list_by_subscription	select	subscriptionId		List Space resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, spaceName		Create a Space
patch	update	subscriptionId, resourceGroupName, spaceName		Update a Space
delete	delete	subscriptionId, resourceGroupName, spaceName		Delete a Space

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
spaceName	string	The name of the space
subscriptionId	string	The ID of the target subscription.
expand	array	Expand the indicated resources into the response.
filter	string	Filter the result list using the given expression.
maxpagesize	integer (int32)	The maximum number of result items per page.
orderby	array	Expressions that specify the order of returned results.
select	array	Select the specified fields to be included in the response.
skip	integer (int32)	The number of result items to skip.
top	integer (int32)	The number of result items to return.

SELECT examples

get

Get a Space

SELECT
location,
properties,
tags
FROM azure.integration_environment.spaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND spaceName = '{{ spaceName }}' -- required
;

list_by_resource_group

List Space resources by resource group

SELECT
location,
properties,
tags
FROM azure.integration_environment.spaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
AND filter = '{{ filter }}'
AND select = '{{ select }}'
AND expand = '{{ expand }}'
AND orderby = '{{ orderby }}'
;

list_by_subscription

List Space resources by subscription ID

SELECT
location,
properties,
tags
FROM azure.integration_environment.spaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a Space

INSERT INTO azure.integration_environment.spaces (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
spaceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ spaceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: spaces
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the spaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the spaces resource.
    - name: spaceName
      value: string
      description: Required parameter for the spaces resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

patch

Update a Space

UPDATE azure.integration_environment.spaces
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND spaceName = '{{ spaceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a Space

DELETE FROM azure.integration_environment.spaces
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND spaceName = '{{ spaceName }}' --required
;