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

The following fields are returned by SELECT queries:

get

The response body contains the specified named value entity. No secrets included

Name	Datatype	Description
properties	object	NamedValue entity contract properties.

list

The response body contains the specified named value secret.

Name	Datatype	Description
value	string	This is secret value of the NamedValue entity.

list_by_service

A Collection of the named value entities for the specified API Management service instance.

Name	Datatype	Description
properties	object	NamedValue entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, namedValueId, subscriptionId		Gets the details of the named value specified by its identifier.
list	select	resourceGroupName, serviceName, namedValueId, subscriptionId		Gets the secret of the named value specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip, isKeyVaultRefreshFailed	Lists a collection of named values defined within a service instance.
create_or_update	insert	resourceGroupName, serviceName, namedValueId, subscriptionId	If-Match	Creates or updates named value.
update	update	resourceGroupName, serviceName, namedValueId, If-Match, subscriptionId		Updates the specific named value.
delete	delete	resourceGroupName, serviceName, namedValueId, If-Match, subscriptionId		Deletes specific named value from the API Management service instance.
refresh_secret	exec	resourceGroupName, serviceName, namedValueId, subscriptionId		Refresh the secret of the named value specified by its identifier.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
namedValueId	string	Identifier of the NamedValue.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.
isKeyVaultRefreshFailed	boolean	When set to true, the response contains only named value entities which failed refresh.

SELECT examples

get

Gets the details of the named value specified by its identifier.

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

list

Gets the secret of the named value specified by its identifier.

SELECT
value
FROM azure.api_management.named_values
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND namedValueId = '{{ namedValueId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

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

SELECT
properties
FROM azure.api_management.named_values
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND isKeyVaultRefreshFailed = '{{ isKeyVaultRefreshFailed }}'
;

INSERT examples

create_or_update

Creates or updates named value.

INSERT INTO azure.api_management.named_values (
data__properties,
resourceGroupName,
serviceName,
namedValueId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ namedValueId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: named_values
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the named_values resource.
    - name: serviceName
      value: string
      description: Required parameter for the named_values resource.
    - name: namedValueId
      value: string
      description: Required parameter for the named_values resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the named_values resource.
    - name: properties
      value: object
      description: |
        NamedValue entity contract properties for PUT operation.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Updates the specific named value.

UPDATE azure.api_management.named_values
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND namedValueId = '{{ namedValueId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes specific named value from the API Management service instance.

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

Lifecycle Methods

refresh_secret

Refresh the secret of the named value specified by its identifier.

EXEC azure.api_management.named_values.refresh_secret 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@namedValueId='{{ namedValueId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;