apms

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

Overview

Name	apms
Type	Resource
Id	azure.spring_apps.apms

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the APM.

Name	Datatype	Description
properties	object	Properties of an APM

list

Success. The response describes the list of APMs.

Name	Datatype	Description
properties	object	Properties of an APM

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, apmName		Get the APM by name.
list	select	subscriptionId, resourceGroupName, serviceName		Get collection of APMs.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, apmName		Create or update an APM.
delete	delete	subscriptionId, resourceGroupName, serviceName, apmName		Operation to delete an APM

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
apmName	string	The name of the APM
resourceGroupName	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.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the APM by name.

SELECT
properties
FROM azure.spring_apps.apms
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apmName = '{{ apmName }}' -- required
;

list

Get collection of APMs.

SELECT
properties
FROM azure.spring_apps.apms
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

INSERT examples

create_or_update

Create or update an APM.

INSERT INTO azure.spring_apps.apms (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
apmName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ apmName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: apms
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the apms resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the apms resource.
    - name: serviceName
      value: string
      description: Required parameter for the apms resource.
    - name: apmName
      value: string
      description: Required parameter for the apms resource.
    - name: properties
      value: object
      description: |
        Properties of an APM

DELETE examples

delete

Operation to delete an APM

DELETE FROM azure.spring_apps.apms
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apmName = '{{ apmName }}' --required
;