workspace_named_value

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

Overview

Name	workspace_named_value
Type	Resource
Id	azure.api_management.workspace_named_value

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. Required.
keyVault	object	KeyVault location details of the namedValue.
provisioningState	string	The provisioning state.
secret	boolean	Determines whether the value is a secret and should be encrypted or not. Default value is false.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	array	Optional tags that when provided can be used to filter the NamedValue list.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
value	string	Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. Required.
keyVault	object	KeyVault location details of the namedValue.
provisioningState	string	The provisioning state.
secret	boolean	Determines whether the value is a secret and should be encrypted or not. Default value is false.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	array	Optional tags that when provided can be used to filter the NamedValue list.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
value	string	Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Gets the details of the named value specified by its identifier.
list_by_service	select	resource_group_name, service_name, workspace_id, subscription_id	$filter, $top, $skip, isKeyVaultRefreshFailed	Lists a collection of named values defined within a workspace in a service instance.
create_or_update	insert	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Creates or updates named value.
update	update	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Updates the specific named value.
create_or_update	replace	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Creates or updates named value.
delete	delete	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Deletes specific named value from the workspace in an API Management service instance.
get_entity_tag	exec	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Gets the entity state (Etag) version of the named value specified by its identifier.
list_value	exec	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		Gets the secret of the named value specified by its identifier.
refresh_secret	exec	resource_group_name, service_name, workspace_id, named_value_id, subscription_id		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
named_value_id	string	Identifier of the NamedValue. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.
isKeyVaultRefreshFailed	string	Query parameter to fetch named value entities based on refresh status. Known values are: "true" and "false". Default value is None.

SELECT examples

get

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

SELECT
id,
name,
displayName,
keyVault,
provisioningState,
secret,
systemData,
tags,
type,
value
FROM azure.api_management.workspace_named_value
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND named_value_id = '{{ named_value_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

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

SELECT
id,
name,
displayName,
keyVault,
provisioningState,
secret,
systemData,
tags,
type,
value
FROM azure.api_management.workspace_named_value
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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.workspace_named_value (
properties,
resource_group_name,
service_name,
workspace_id,
named_value_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ named_value_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_named_value
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_named_value resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the workspace_named_value resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace_named_value resource.
  - name: named_value_id
    value: "{{ named_value_id }}"
    description: Required parameter for the workspace_named_value resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_named_value resource.
  - name: properties
    description: |
      NamedValue entity contract properties for PUT operation.
    value:
      tags:
        - "{{ tags }}"
      secret: {{ secret }}
      displayName: "{{ displayName }}"
      value: "{{ value }}"
      keyVault:
        secretIdentifier: "{{ secretIdentifier }}"
        identityClientId: "{{ identityClientId }}"

UPDATE examples

update

Updates the specific named value.

UPDATE azure.api_management.workspace_named_value
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND named_value_id = '{{ named_value_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates named value.

REPLACE azure.api_management.workspace_named_value
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND named_value_id = '{{ named_value_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specific named value from the workspace in an API Management service instance.

DELETE FROM azure.api_management.workspace_named_value
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND named_value_id = '{{ named_value_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the named value specified by its identifier.

EXEC azure.api_management.workspace_named_value.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@named_value_id='{{ named_value_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_value

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

EXEC azure.api_management.workspace_named_value.list_value 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@named_value_id='{{ named_value_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

refresh_secret

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

EXEC azure.api_management.workspace_named_value.refresh_secret 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@named_value_id='{{ named_value_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;