api_keys

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

Overview

Name	api_keys
Type	Resource
Id	azure_isv.nginx.api_keys

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.
endDateTime	string (date-time)	The time after which this Dataplane API Key is no longer valid.
hint	string	The first three characters of the secret text to help identify it in use. This property is read-only.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
endDateTime	string (date-time)	The time after which this Dataplane API Key is no longer valid.
hint	string	The first three characters of the secret text to help identify it in use. This property is read-only.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, deployment_name, api_key_name, subscription_id		Get the specified API Key of the given Nginx deployment.
list	select	resource_group_name, deployment_name, subscription_id		List all API Keys of the given Nginx deployment.
create_or_update	insert	resource_group_name, deployment_name, api_key_name, subscription_id		Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint.
create_or_update	replace	resource_group_name, deployment_name, api_key_name, subscription_id		Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint.
delete	delete	resource_group_name, deployment_name, api_key_name, subscription_id		Delete API key for Nginx deployment.

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
api_key_name	string	The resource name of the API key. Required.
deployment_name	string	The name of targeted NGINX deployment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the specified API Key of the given Nginx deployment.

SELECT
id,
name,
endDateTime,
hint,
systemData,
type
FROM azure_isv.nginx.api_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND api_key_name = '{{ api_key_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all API Keys of the given Nginx deployment.

SELECT
id,
name,
endDateTime,
hint,
systemData,
type
FROM azure_isv.nginx.api_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint.

INSERT INTO azure_isv.nginx.api_keys (
properties,
resource_group_name,
deployment_name,
api_key_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ deployment_name }}',
'{{ api_key_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_keys
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_keys resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the api_keys resource.
  - name: api_key_name
    value: "{{ api_key_name }}"
    description: Required parameter for the api_keys resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_keys resource.
  - name: properties
    description: |
      Nginx Deployment Api Key Request Properties.
    value:
      secretText: "{{ secretText }}"
      endDateTime: "{{ endDateTime }}"

REPLACE examples

create_or_update

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint.

REPLACE azure_isv.nginx.api_keys
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND api_key_name = '{{ api_key_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete API key for Nginx deployment.

DELETE FROM azure_isv.nginx.api_keys
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND api_key_name = '{{ api_key_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;