application_definitions

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

Overview

Name	application_definitions
Type	Resource
Id	azure.managed_applications.application_definitions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
artifacts	array	The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition.
authorizations	array	The managed application provider authorizations.
createUiDefinition	object	The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string.
deploymentPolicy	object	The managed application deployment policy.
description	string	The managed application definition description.
displayName	string	The managed application definition display name.
isEnabled	boolean	A value indicating whether the package is enabled or not.
location	string	Resource location.
lockLevel	string	The managed application lock level. Required. Known values are: "CanNotDelete", "ReadOnly", and "None".
lockingPolicy	object	The managed application locking policy.
mainTemplate	object	The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string.
managedBy	string	ID of the resource that manages this resource.
managementPolicy	object	The managed application management policy that determines publisher's access to the managed resource group.
notificationPolicy	object	The managed application notification policy.
packageFileUri	string	The managed application definition package file Uri. Use this element.
policies	array	The managed application provider policies.
sku	object	The SKU of the resource.
storageAccountId	string	The storage account id for bring your own storage scenario.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
artifacts	array	The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition.
authorizations	array	The managed application provider authorizations.
createUiDefinition	object	The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string.
deploymentPolicy	object	The managed application deployment policy.
description	string	The managed application definition description.
displayName	string	The managed application definition display name.
isEnabled	boolean	A value indicating whether the package is enabled or not.
location	string	Resource location.
lockLevel	string	The managed application lock level. Required. Known values are: "CanNotDelete", "ReadOnly", and "None".
lockingPolicy	object	The managed application locking policy.
mainTemplate	object	The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string.
managedBy	string	ID of the resource that manages this resource.
managementPolicy	object	The managed application management policy that determines publisher's access to the managed resource group.
notificationPolicy	object	The managed application notification policy.
packageFileUri	string	The managed application definition package file Uri. Use this element.
policies	array	The managed application provider policies.
sku	object	The SKU of the resource.
storageAccountId	string	The storage account id for bring your own storage scenario.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
artifacts	array	The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition.
authorizations	array	The managed application provider authorizations.
createUiDefinition	object	The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string.
deploymentPolicy	object	The managed application deployment policy.
description	string	The managed application definition description.
displayName	string	The managed application definition display name.
isEnabled	boolean	A value indicating whether the package is enabled or not.
location	string	Resource location.
lockLevel	string	The managed application lock level. Required. Known values are: "CanNotDelete", "ReadOnly", and "None".
lockingPolicy	object	The managed application locking policy.
mainTemplate	object	The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string.
managedBy	string	ID of the resource that manages this resource.
managementPolicy	object	The managed application management policy that determines publisher's access to the managed resource group.
notificationPolicy	object	The managed application notification policy.
packageFileUri	string	The managed application definition package file Uri. Use this element.
policies	array	The managed application provider policies.
sku	object	The SKU of the resource.
storageAccountId	string	The storage account id for bring your own storage scenario.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	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	resource_group_name, application_definition_name, subscription_id		Gets the managed application definition.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the managed application definitions in a resource group.
list_by_subscription	select	subscription_id		Lists all the application definitions within a subscription.
create_or_update	insert	resource_group_name, application_definition_name, subscription_id, properties		Creates or updates a managed application definition.
update	update	resource_group_name, application_definition_name, subscription_id		Updates the managed application definition.
create_or_update	replace	resource_group_name, application_definition_name, subscription_id, properties		Creates or updates a managed application definition.
delete	delete	resource_group_name, application_definition_name, subscription_id		Deletes the managed application definition.

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
application_definition_name	string	The name of the managed application definition. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the managed application definition.

SELECT
id,
name,
artifacts,
authorizations,
createUiDefinition,
deploymentPolicy,
description,
displayName,
isEnabled,
location,
lockLevel,
lockingPolicy,
mainTemplate,
managedBy,
managementPolicy,
notificationPolicy,
packageFileUri,
policies,
sku,
storageAccountId,
systemData,
tags,
type
FROM azure.managed_applications.application_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_definition_name = '{{ application_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the managed application definitions in a resource group.

SELECT
id,
name,
artifacts,
authorizations,
createUiDefinition,
deploymentPolicy,
description,
displayName,
isEnabled,
location,
lockLevel,
lockingPolicy,
mainTemplate,
managedBy,
managementPolicy,
notificationPolicy,
packageFileUri,
policies,
sku,
storageAccountId,
systemData,
tags,
type
FROM azure.managed_applications.application_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all the application definitions within a subscription.

SELECT
id,
name,
artifacts,
authorizations,
createUiDefinition,
deploymentPolicy,
description,
displayName,
isEnabled,
location,
lockLevel,
lockingPolicy,
mainTemplate,
managedBy,
managementPolicy,
notificationPolicy,
packageFileUri,
policies,
sku,
storageAccountId,
systemData,
tags,
type
FROM azure.managed_applications.application_definitions
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed application definition.

INSERT INTO azure.managed_applications.application_definitions (
location,
tags,
managedBy,
sku,
properties,
resource_group_name,
application_definition_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ managedBy }}',
'{{ sku }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ application_definition_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
managedBy,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: application_definitions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the application_definitions resource.
  - name: application_definition_name
    value: "{{ application_definition_name }}"
    description: Required parameter for the application_definitions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the application_definitions resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      ID of the resource that manages this resource.
  - name: sku
    description: |
      The SKU of the resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      model: "{{ model }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      lockLevel: "{{ lockLevel }}"
      displayName: "{{ displayName }}"
      isEnabled: {{ isEnabled }}
      authorizations:
        - principalId: "{{ principalId }}"
          roleDefinitionId: "{{ roleDefinitionId }}"
      artifacts:
        - name: "{{ name }}"
          uri: "{{ uri }}"
          type: "{{ type }}"
      description: "{{ description }}"
      packageFileUri: "{{ packageFileUri }}"
      storageAccountId: "{{ storageAccountId }}"
      mainTemplate: "{{ mainTemplate }}"
      createUiDefinition: "{{ createUiDefinition }}"
      notificationPolicy:
        notificationEndpoints:
          - uri: "{{ uri }}"
      lockingPolicy:
        allowedActions:
          - "{{ allowedActions }}"
        allowedDataActions:
          - "{{ allowedDataActions }}"
      deploymentPolicy:
        deploymentMode: "{{ deploymentMode }}"
      managementPolicy:
        mode: "{{ mode }}"
      policies:
        - name: "{{ name }}"
          policyDefinitionId: "{{ policyDefinitionId }}"
          parameters: "{{ parameters }}"

UPDATE examples

update

Updates the managed application definition.

UPDATE azure.managed_applications.application_definitions
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_definition_name = '{{ application_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
managedBy,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a managed application definition.

REPLACE azure.managed_applications.application_definitions
SET 
location = '{{ location }}',
tags = '{{ tags }}',
managedBy = '{{ managedBy }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_definition_name = '{{ application_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
managedBy,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the managed application definition.

DELETE FROM azure.managed_applications.application_definitions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND application_definition_name = '{{ application_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;