subscription_levels

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

Overview

Name	subscription_levels
Type	Resource
Id	azure_extras.saas.subscription_levels

Fields

The following fields are returned by SELECT queries:

get

Request successful. The request returns the resulting SaaS resource.

Name	Datatype	Description
id	string	The resource uri
name	string	The name of the resource
properties	object	saas resource properties
tags	object	the resource tags.
type	string	Resource type.

list_by_resource_group

Request successful. The request returns the resulting SaaS resources.

Name	Datatype	Description
id	string	The resource uri
name	string	The name of the resource
properties	object	saas resource properties
tags	object	the resource tags.
type	string	Resource type.

list_by_azure_subscription

Request successful. The request returns the resulting SaaS resources.

Name	Datatype	Description
id	string	The resource uri
name	string	The name of the resource
properties	object	saas resource properties
tags	object	the resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Gets information about the specified Subscription Level SaaS.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets information about all the Subscription Level SaaS in a certain resource group.
list_by_azure_subscription	select	subscriptionId		Gets information about all the Subscription Level SaaS in a certain Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName		Creates or updates a SaaS resource.
update	update	subscriptionId, resourceGroupName, resourceName		Updates a SaaS Subscription Level resource.
delete	delete	subscriptionId, resourceGroupName, resourceName		Deletes the specified SaaS.
validate_move_resources	exec	subscriptionId, resourceGroupName		Validate whether a specified Subscription Level SaaS can be moved.
move_resources	exec	subscriptionId, resourceGroupName		Move a specified Subscription Level SaaS.

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.
resourceName	string	The name of the resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified Subscription Level SaaS.

SELECT
id,
name,
properties,
tags,
type
FROM azure_extras.saas.subscription_levels
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Gets information about all the Subscription Level SaaS in a certain resource group.

SELECT
id,
name,
properties,
tags,
type
FROM azure_extras.saas.subscription_levels
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_azure_subscription

Gets information about all the Subscription Level SaaS in a certain Azure subscription.

SELECT
id,
name,
properties,
tags,
type
FROM azure_extras.saas.subscription_levels
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a SaaS resource.

INSERT INTO azure_extras.saas.subscription_levels (
data__name,
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ name }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: subscription_levels
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the subscription_levels resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the subscription_levels resource.
    - name: resourceName
      value: string
      description: Required parameter for the subscription_levels resource.
    - name: name
      value: string
      description: |
        The resource name
    - name: tags
      value: object
      description: |
        the resource tags.
    - name: location
      value: string
      description: |
        Resource location. Only value allowed for SaaS is 'global'
    - name: properties
      value: object
      description: |
        properties for creation saas

UPDATE examples

update

Updates a SaaS Subscription Level resource.

UPDATE azure_extras.saas.subscription_levels
SET 
data__name = '{{ name }}',
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified SaaS.

DELETE FROM azure_extras.saas.subscription_levels
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;

Lifecycle Methods

validate_move_resources

Validate whether a specified Subscription Level SaaS can be moved.

EXEC azure_extras.saas.subscription_levels.validate_move_resources 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"targetResourceGroup": "{{ targetResourceGroup }}", 
"resources": "{{ resources }}"
}'
;

move_resources

Move a specified Subscription Level SaaS.

EXEC azure_extras.saas.subscription_levels.move_resources 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"targetResourceGroup": "{{ targetResourceGroup }}", 
"resources": "{{ resources }}"
}'
;