apms

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

Overview

Name	apms
Type	Resource
Id	azure_extras.app_platform.apms

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	object	Non-sensitive properties for the APM.
provisioningState	string	State of the APM. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
secrets	object	Sensitive properties for the APM.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	object	Non-sensitive properties for the APM.
provisioningState	string	State of the APM. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
secrets	object	Sensitive properties for the APM.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, apm_name, subscription_id		Get the APM by name.
list	select	resource_group_name, service_name, subscription_id		Get collection of APMs.
create_or_update	insert	resource_group_name, service_name, apm_name, subscription_id		Create or update an APM.
create_or_update	replace	resource_group_name, service_name, apm_name, subscription_id		Create or update an APM.
delete	delete	resource_group_name, service_name, apm_name, subscription_id		Operation to delete an APM.
list_secret_keys	exec	resource_group_name, service_name, apm_name, subscription_id		List keys of APM sensitive properties.

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
apm_name	string	The name of the APM. Required.
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the APM by name.

SELECT
id,
name,
properties,
provisioningState,
secrets,
systemData,
type
FROM azure_extras.app_platform.apms
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND apm_name = '{{ apm_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get collection of APMs.

SELECT
id,
name,
properties,
provisioningState,
secrets,
systemData,
type
FROM azure_extras.app_platform.apms
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an APM.

INSERT INTO azure_extras.app_platform.apms (
properties,
resource_group_name,
service_name,
apm_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ apm_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: apms
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the apms resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the apms resource.
  - name: apm_name
    value: "{{ apm_name }}"
    description: Required parameter for the apms resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the apms resource.
  - name: properties
    description: |
      Properties of an APM.
    value:
      type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"
      properties: "{{ properties }}"
      secrets: "{{ secrets }}"

REPLACE examples

create_or_update

Create or update an APM.

REPLACE azure_extras.app_platform.apms
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND apm_name = '{{ apm_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Operation to delete an APM.

DELETE FROM azure_extras.app_platform.apms
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND apm_name = '{{ apm_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_secret_keys

List keys of APM sensitive properties.

EXEC azure_extras.app_platform.apms.list_secret_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@apm_name='{{ apm_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;