applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	azure.managed_applications.applications

Fields

The following fields are returned by SELECT queries:

get

OK - Returns the managed application.

Name	Datatype	Description
identity	object	The identity of the resource.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. (pattern: ^[-\w._,()]+$)
managedBy	string	ID of the resource that manages this resource.
plan	object	The plan information.
properties	object	The managed application properties.
sku	object	The SKU of the resource.

list_allowed_upgrade_plans

OK - Returns an array of managed identity tokens.

Name	Datatype	Description
name	string	A user defined name of the 3rd Party Artifact that is being procured.
product	string	The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
promotionCode	string	A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
publisher	string	The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
version	string	The version of the desired product/artifact.

list_by_resource_group

OK - Returns an array of applications.

Name	Datatype	Description
identity	object	The identity of the resource.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. (pattern: ^[-\w._,()]+$)
managedBy	string	ID of the resource that manages this resource.
plan	object	The plan information.
properties	object	The managed application properties.
sku	object	The SKU of the resource.

list_by_subscription

OK - Returns an array of applications.

Name	Datatype	Description
identity	object	The identity of the resource.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. (pattern: ^[-\w._,()]+$)
managedBy	string	ID of the resource that manages this resource.
plan	object	The plan information.
properties	object	The managed application properties.
sku	object	The SKU of the resource.

get_by_id

OK - Returns the managed application.

Name	Datatype	Description
identity	object	The identity of the resource.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. (pattern: ^[-\w._,()]+$)
managedBy	string	ID of the resource that manages this resource.
plan	object	The plan information.
properties	object	The managed application properties.
sku	object	The SKU of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, applicationName		Gets the managed application.
list_allowed_upgrade_plans	select	subscriptionId, resourceGroupName, applicationName		List allowed upgrade plans for application.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the applications within a resource group.
list_by_subscription	select	subscriptionId		Lists all the applications within a subscription.
get_by_id	select	applicationId		Gets the managed application.
create_or_update	insert	subscriptionId, resourceGroupName, applicationName, data__properties, data__kind		Creates or updates a managed application.
update	update	subscriptionId, resourceGroupName, applicationName		Updates an existing managed application.
delete	delete	subscriptionId, resourceGroupName, applicationName		Deletes the managed application.
delete_by_id	delete	applicationId		Deletes the managed application.
update_by_id	exec	applicationId		Updates an existing managed application.
refresh_permissions	exec	subscriptionId, resourceGroupName, applicationName		Refresh Permissions for application.

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
applicationId	string	The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name}
applicationName	string	The name of the managed application.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the managed application.

SELECT
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.managed_applications.applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationName = '{{ applicationName }}' -- required
;

list_allowed_upgrade_plans

List allowed upgrade plans for application.

SELECT
name,
product,
promotionCode,
publisher,
version
FROM azure.managed_applications.applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationName = '{{ applicationName }}' -- required
;

list_by_resource_group

Lists all the applications within a resource group.

SELECT
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.managed_applications.applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all the applications within a subscription.

SELECT
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.managed_applications.applications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

get_by_id

Gets the managed application.

SELECT
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.managed_applications.applications
WHERE applicationId = '{{ applicationId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed application.

INSERT INTO azure.managed_applications.applications (
data__properties,
data__plan,
data__kind,
data__identity,
data__managedBy,
data__sku,
subscriptionId,
resourceGroupName,
applicationName
)
SELECT 
'{{ properties }}' /* required */,
'{{ plan }}',
'{{ kind }}' /* required */,
'{{ identity }}',
'{{ managedBy }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ applicationName }}'
RETURNING
identity,
kind,
managedBy,
plan,
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: applications
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the applications resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the applications resource.
    - name: applicationName
      value: string
      description: Required parameter for the applications resource.
    - name: properties
      value: object
      description: |
        The managed application properties.
    - name: plan
      value: object
      description: |
        The plan information.
    - name: kind
      value: string
      description: |
        The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog.
    - name: identity
      value: object
      description: |
        The identity of the resource.
    - name: managedBy
      value: string
      description: |
        ID of the resource that manages this resource.
    - name: sku
      value: object
      description: |
        The SKU of the resource.

UPDATE examples

update

Updates an existing managed application.

UPDATE azure.managed_applications.applications
SET 
data__properties = '{{ properties }}',
data__plan = '{{ plan }}',
data__kind = '{{ kind }}',
data__identity = '{{ identity }}',
data__managedBy = '{{ managedBy }}',
data__sku = '{{ sku }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationName = '{{ applicationName }}' --required
RETURNING
identity,
kind,
managedBy,
plan,
properties,
sku;

DELETE examples

delete

Deletes the managed application.

DELETE FROM azure.managed_applications.applications
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationName = '{{ applicationName }}' --required
;

delete_by_id

Deletes the managed application.

DELETE FROM azure.managed_applications.applications
WHERE applicationId = '{{ applicationId }}' --required
;

Lifecycle Methods

update_by_id

Updates an existing managed application.

EXEC azure.managed_applications.applications.update_by_id 
@applicationId='{{ applicationId }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"plan": "{{ plan }}", 
"kind": "{{ kind }}", 
"identity": "{{ identity }}", 
"managedBy": "{{ managedBy }}", 
"sku": "{{ sku }}"
}'
;

refresh_permissions

Refresh Permissions for application.

EXEC azure.managed_applications.applications.refresh_permissions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@applicationName='{{ applicationName }}' --required
;