applications

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

Overview

Name	applications
Type	Resource
Id	azure.resource.applications

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationDefinitionId	string	The fully qualified path of managed application definition Id.
artifacts	array	The collection of managed application artifacts.
authorizations	array	The read-only authorizations property that is retrieved from the application package.
billingDetails	object	The managed application billing details.
createdBy	object	The client entity that created the JIT request.
customerSupport	object	The read-only customer support property that is retrieved from the application package.
identity	object	The identity of the resource.
jitAccessPolicy	object	The managed application Jit access policy.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. Required.
location	string	Resource location.
managedBy	string	ID of the resource that manages this resource.
managedResourceGroupId	string	The managed resource group Id.
managementMode	string	The managed application management mode. Known values are: "NotSpecified", "Unmanaged", and "Managed".
outputs	object	Name and value pairs that define the managed application outputs.
parameters	object	Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string.
plan	object	The plan information.
provisioningState	string	The managed application provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
publisherTenantId	string	The publisher tenant Id.
sku	object	The SKU of the resource.
supportUrls	object	The read-only support URLs property that is retrieved from the application package.
tags	object	Resource tags.
type	string	Resource type.
updatedBy	object	The client entity that last updated the JIT request.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationDefinitionId	string	The fully qualified path of managed application definition Id.
artifacts	array	The collection of managed application artifacts.
authorizations	array	The read-only authorizations property that is retrieved from the application package.
billingDetails	object	The managed application billing details.
createdBy	object	The client entity that created the JIT request.
customerSupport	object	The read-only customer support property that is retrieved from the application package.
identity	object	The identity of the resource.
jitAccessPolicy	object	The managed application Jit access policy.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. Required.
location	string	Resource location.
managedBy	string	ID of the resource that manages this resource.
managedResourceGroupId	string	The managed resource group Id.
managementMode	string	The managed application management mode. Known values are: "NotSpecified", "Unmanaged", and "Managed".
outputs	object	Name and value pairs that define the managed application outputs.
parameters	object	Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string.
plan	object	The plan information.
provisioningState	string	The managed application provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
publisherTenantId	string	The publisher tenant Id.
sku	object	The SKU of the resource.
supportUrls	object	The read-only support URLs property that is retrieved from the application package.
tags	object	Resource tags.
type	string	Resource type.
updatedBy	object	The client entity that last updated the JIT request.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationDefinitionId	string	The fully qualified path of managed application definition Id.
artifacts	array	The collection of managed application artifacts.
authorizations	array	The read-only authorizations property that is retrieved from the application package.
billingDetails	object	The managed application billing details.
createdBy	object	The client entity that created the JIT request.
customerSupport	object	The read-only customer support property that is retrieved from the application package.
identity	object	The identity of the resource.
jitAccessPolicy	object	The managed application Jit access policy.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. Required.
location	string	Resource location.
managedBy	string	ID of the resource that manages this resource.
managedResourceGroupId	string	The managed resource group Id.
managementMode	string	The managed application management mode. Known values are: "NotSpecified", "Unmanaged", and "Managed".
outputs	object	Name and value pairs that define the managed application outputs.
parameters	object	Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string.
plan	object	The plan information.
provisioningState	string	The managed application provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
publisherTenantId	string	The publisher tenant Id.
sku	object	The SKU of the resource.
supportUrls	object	The read-only support URLs property that is retrieved from the application package.
tags	object	Resource tags.
type	string	Resource type.
updatedBy	object	The client entity that last updated the JIT request.

get_by_id

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationDefinitionId	string	The fully qualified path of managed application definition Id.
artifacts	array	The collection of managed application artifacts.
authorizations	array	The read-only authorizations property that is retrieved from the application package.
billingDetails	object	The managed application billing details.
createdBy	object	The client entity that created the JIT request.
customerSupport	object	The read-only customer support property that is retrieved from the application package.
identity	object	The identity of the resource.
jitAccessPolicy	object	The managed application Jit access policy.
kind	string	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. Required.
location	string	Resource location.
managedBy	string	ID of the resource that manages this resource.
managedResourceGroupId	string	The managed resource group Id.
managementMode	string	The managed application management mode. Known values are: "NotSpecified", "Unmanaged", and "Managed".
outputs	object	Name and value pairs that define the managed application outputs.
parameters	object	Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string.
plan	object	The plan information.
provisioningState	string	The managed application provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating".
publisherTenantId	string	The publisher tenant Id.
sku	object	The SKU of the resource.
supportUrls	object	The read-only support URLs property that is retrieved from the application package.
tags	object	Resource tags.
type	string	Resource type.
updatedBy	object	The client entity that last updated the JIT request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, application_name, subscription_id		Gets the managed application.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the applications within a resource group.
list_by_subscription	select	subscription_id		Gets all the applications within a subscription.
get_by_id	select	application_id		Gets the managed application.
create_or_update	insert	resource_group_name, application_name, subscription_id, kind		Creates a new managed application.
create_or_update_by_id	insert	application_id, kind		Creates a new managed application.
update	update	resource_group_name, application_name, subscription_id		Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.
update_by_id	update	application_id, kind		Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.
create_or_update	replace	resource_group_name, application_name, subscription_id, kind		Creates a new managed application.
create_or_update_by_id	replace	application_id, kind		Creates a new managed application.
delete	delete	resource_group_name, application_name, subscription_id		Deletes the managed application.
delete_by_id	delete	application_id		Deletes the managed application.
refresh_permissions	exec	resource_group_name, application_name, subscription_id		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
application_id	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}. Required.
application_name	string	The name of the managed application. 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.

SELECT
id,
name,
applicationDefinitionId,
artifacts,
authorizations,
billingDetails,
createdBy,
customerSupport,
identity,
jitAccessPolicy,
kind,
location,
managedBy,
managedResourceGroupId,
managementMode,
outputs,
parameters,
plan,
provisioningState,
publisherTenantId,
sku,
supportUrls,
tags,
type,
updatedBy
FROM azure.resource.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_name = '{{ application_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the applications within a resource group.

SELECT
id,
name,
applicationDefinitionId,
artifacts,
authorizations,
billingDetails,
createdBy,
customerSupport,
identity,
jitAccessPolicy,
kind,
location,
managedBy,
managedResourceGroupId,
managementMode,
outputs,
parameters,
plan,
provisioningState,
publisherTenantId,
sku,
supportUrls,
tags,
type,
updatedBy
FROM azure.resource.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all the applications within a subscription.

SELECT
id,
name,
applicationDefinitionId,
artifacts,
authorizations,
billingDetails,
createdBy,
customerSupport,
identity,
jitAccessPolicy,
kind,
location,
managedBy,
managedResourceGroupId,
managementMode,
outputs,
parameters,
plan,
provisioningState,
publisherTenantId,
sku,
supportUrls,
tags,
type,
updatedBy
FROM azure.resource.applications
WHERE subscription_id = '{{ subscription_id }}' -- required
;

get_by_id

Gets the managed application.

SELECT
id,
name,
applicationDefinitionId,
artifacts,
authorizations,
billingDetails,
createdBy,
customerSupport,
identity,
jitAccessPolicy,
kind,
location,
managedBy,
managedResourceGroupId,
managementMode,
outputs,
parameters,
plan,
provisioningState,
publisherTenantId,
sku,
supportUrls,
tags,
type,
updatedBy
FROM azure.resource.applications
WHERE application_id = '{{ application_id }}' -- required
;

INSERT examples

create_or_update

Creates a new managed application.

INSERT INTO azure.resource.applications (
location,
tags,
managedBy,
sku,
plan,
kind,
identity,
properties,
resource_group_name,
application_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ managedBy }}',
'{{ sku }}',
'{{ plan }}',
'{{ kind }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ application_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
tags,
type
;

create_or_update_by_id

Creates a new managed application.

INSERT INTO azure.resource.applications (
location,
tags,
managedBy,
sku,
plan,
kind,
identity,
properties,
application_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ managedBy }}',
'{{ sku }}',
'{{ plan }}',
'{{ kind }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ application_id }}'
RETURNING
id,
name,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the applications resource.
  - name: application_name
    value: "{{ application_name }}"
    description: Required parameter for the applications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the applications resource.
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the applications 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: plan
    description: |
      The plan information.
    value:
      name: "{{ name }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      promotionCode: "{{ promotionCode }}"
      version: "{{ version }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. Required.
  - name: identity
    description: |
      The identity of the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      managedResourceGroupId: "{{ managedResourceGroupId }}"
      applicationDefinitionId: "{{ applicationDefinitionId }}"
      parameters: "{{ parameters }}"
      jitAccessPolicy:
        jitAccessEnabled: {{ jitAccessEnabled }}
        jitApprovalMode: "{{ jitApprovalMode }}"
        jitApprovers:
          - id: "{{ id }}"
            type: "{{ type }}"
            displayName: "{{ displayName }}"
        maximumJitAccessDuration: "{{ maximumJitAccessDuration }}"

UPDATE examples

update

Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.

UPDATE azure.resource.applications
SET 
location = '{{ location }}',
tags = '{{ tags }}',
managedBy = '{{ managedBy }}',
sku = '{{ sku }}',
plan = '{{ plan }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
tags,
type;

update_by_id

Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.

UPDATE azure.resource.applications
SET 
location = '{{ location }}',
tags = '{{ tags }}',
managedBy = '{{ managedBy }}',
sku = '{{ sku }}',
plan = '{{ plan }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
application_id = '{{ application_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Creates a new managed application.

REPLACE azure.resource.applications
SET 
location = '{{ location }}',
tags = '{{ tags }}',
managedBy = '{{ managedBy }}',
sku = '{{ sku }}',
plan = '{{ plan }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
tags,
type;

create_or_update_by_id

Creates a new managed application.

REPLACE azure.resource.applications
SET 
location = '{{ location }}',
tags = '{{ tags }}',
managedBy = '{{ managedBy }}',
sku = '{{ sku }}',
plan = '{{ plan }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
application_id = '{{ application_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes the managed application.

DELETE FROM azure.resource.applications
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_by_id

Deletes the managed application.

DELETE FROM azure.resource.applications
WHERE application_id = '{{ application_id }}' --required
;

Lifecycle Methods

refresh_permissions

Refresh Permissions for application.

EXEC azure.resource.applications.refresh_permissions 
@resource_group_name='{{ resource_group_name }}' --required, 
@application_name='{{ application_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;