named_values

Creates, updates, deletes, gets or lists a named_values resource.

Overview

Name	named_values
Type	Resource
Id	azure.api_management.named_values

Fields

vw_named_values

Name	Datatype	Description
display_name	text	field from the properties object
key_vault	text	field from the properties object
namedValueId	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
secret	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	field from the properties object
value	text	field from the properties object

named_values

Name	Datatype	Description
properties	object	NamedValue Contract properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	namedValueId, resourceGroupName, serviceName, subscriptionId	Gets the details of the named value specified by its identifier.
list	SELECT	namedValueId, resourceGroupName, serviceName, subscriptionId	Gets the secret of the named value specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of named values defined within a service instance.
create_or_update	INSERT	namedValueId, resourceGroupName, serviceName, subscriptionId	Creates or updates named value.
delete	DELETE	If-Match, namedValueId, resourceGroupName, serviceName, subscriptionId	Deletes specific named value from the API Management service instance.
update	UPDATE	If-Match, namedValueId, resourceGroupName, serviceName, subscriptionId	Updates the specific named value.
refresh_secret	EXEC	namedValueId, resourceGroupName, serviceName, subscriptionId	Refresh the secret of the named value specified by its identifier.

SELECT examples

Lists a collection of named values defined within a service instance.

vw_named_values

SELECT
display_name,
key_vault,
namedValueId,
provisioning_state,
resourceGroupName,
secret,
serviceName,
subscriptionId,
tags,
value
FROM azure.api_management.vw_named_values
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

named_values

SELECT
properties
FROM azure.api_management.named_values
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new named_values resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.named_values (
namedValueId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ namedValueId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: value
          value: string
        - name: keyVault
          value:
            - name: secretIdentifier
              value: string
            - name: identityClientId
              value: string
        - name: tags
          value:
            - string
        - name: secret
          value: boolean

UPDATE example

Updates a named_values resource.

/*+ update */
UPDATE azure.api_management.named_values
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND namedValueId = '{{ namedValueId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified named_values resource.

/*+ delete */
DELETE FROM azure.api_management.named_values
WHERE If-Match = '{{ If-Match }}'
AND namedValueId = '{{ namedValueId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';