springbootsites

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

Overview

Name	springbootsites
Type	Resource
Id	azure_extras.spring_app_discovery.springbootsites

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedLocation	object	The extended location definition.
location	string	The geo-location where the resource lives. Required.
masterSiteId	string	The master site ID from Azure Migrate.
migrateProjectId	string	The migrate project ID from Azure Migrate.
provisioningState	string	The resource provisioning state. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", and "Deleting".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedLocation	object	The extended location definition.
location	string	The geo-location where the resource lives. Required.
masterSiteId	string	The master site ID from Azure Migrate.
migrateProjectId	string	The migrate project ID from Azure Migrate.
provisioningState	string	The resource provisioning state. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", and "Deleting".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedLocation	object	The extended location definition.
location	string	The geo-location where the resource lives. Required.
masterSiteId	string	The master site ID from Azure Migrate.
migrateProjectId	string	The migrate project ID from Azure Migrate.
provisioningState	string	The resource provisioning state. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", and "Deleting".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, springbootsites_name, subscription_id		Get a springbootsites resource.
list_by_resource_group	select	resource_group_name, subscription_id		List springbootsites resource by resourceGroup.
list_by_subscription	select	subscription_id		List springbootsites resource by subscription.
create_or_update	insert	resource_group_name, springbootsites_name, subscription_id, location		Create a springbootsites resource.
update	update	resource_group_name, springbootsites_name, subscription_id, location		Update a springbootsites resource.
create_or_update	replace	resource_group_name, springbootsites_name, subscription_id, location		Create a springbootsites resource.
delete	delete	resource_group_name, springbootsites_name, subscription_id		Delete a springbootsites resource.
trigger_refresh_site	exec	resource_group_name, springbootsites_name, subscription_id		Trigger refresh springbootsites action.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
springbootsites_name	string	The springbootsites name. Required.
subscription_id	string

SELECT examples

get

Get a springbootsites resource.

SELECT
id,
name,
extendedLocation,
location,
masterSiteId,
migrateProjectId,
provisioningState,
systemData,
tags,
type
FROM azure_extras.spring_app_discovery.springbootsites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND springbootsites_name = '{{ springbootsites_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List springbootsites resource by resourceGroup.

SELECT
id,
name,
extendedLocation,
location,
masterSiteId,
migrateProjectId,
provisioningState,
systemData,
tags,
type
FROM azure_extras.spring_app_discovery.springbootsites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List springbootsites resource by subscription.

SELECT
id,
name,
extendedLocation,
location,
masterSiteId,
migrateProjectId,
provisioningState,
systemData,
tags,
type
FROM azure_extras.spring_app_discovery.springbootsites
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a springbootsites resource.

INSERT INTO azure_extras.spring_app_discovery.springbootsites (
tags,
location,
properties,
extendedLocation,
resource_group_name,
springbootsites_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ springbootsites_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: springbootsites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the springbootsites resource.
  - name: springbootsites_name
    value: "{{ springbootsites_name }}"
    description: Required parameter for the springbootsites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the springbootsites resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The springbootsites resource definition.
    value:
      masterSiteId: "{{ masterSiteId }}"
      migrateProjectId: "{{ migrateProjectId }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location definition.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Update a springbootsites resource.

UPDATE azure_extras.spring_app_discovery.springbootsites
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND springbootsites_name = '{{ springbootsites_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a springbootsites resource.

REPLACE azure_extras.spring_app_discovery.springbootsites
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND springbootsites_name = '{{ springbootsites_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a springbootsites resource.

DELETE FROM azure_extras.spring_app_discovery.springbootsites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND springbootsites_name = '{{ springbootsites_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

trigger_refresh_site

Trigger refresh springbootsites action.

EXEC azure_extras.spring_app_discovery.springbootsites.trigger_refresh_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@springbootsites_name='{{ springbootsites_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;