gateway_certificate_authority

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

Overview

Name	gateway_certificate_authority
Type	Resource
Id	azure.api_management.gateway_certificate_authority

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.
isTrusted	boolean	Determines whether certificate authority is trusted.
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_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.
isTrusted	boolean	Determines whether certificate authority is trusted.
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, service_name, gateway_id, certificate_id, subscription_id		Get assigned Gateway Certificate Authority details.
list_by_service	select	resource_group_name, service_name, gateway_id, subscription_id	$filter, $top, $skip	Lists the collection of Certificate Authorities for the specified Gateway entity.
create_or_update	insert	resource_group_name, service_name, gateway_id, certificate_id, subscription_id		Assign Certificate entity to Gateway entity as Certificate Authority.
create_or_update	replace	resource_group_name, service_name, gateway_id, certificate_id, subscription_id		Assign Certificate entity to Gateway entity as Certificate Authority.
delete	delete	resource_group_name, service_name, gateway_id, certificate_id, subscription_id		Remove relationship between Certificate Authority and Gateway entity.
get_entity_tag	exec	resource_group_name, service_name, gateway_id, certificate_id, subscription_id		Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.

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
certificate_id	string	Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.
gateway_id	string	Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'. 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
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | eq, ne | |. 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.

SELECT examples

get

Get assigned Gateway Certificate Authority details.

SELECT
id,
name,
isTrusted,
systemData,
type
FROM azure.api_management.gateway_certificate_authority
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND certificate_id = '{{ certificate_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists the collection of Certificate Authorities for the specified Gateway entity.

SELECT
id,
name,
isTrusted,
systemData,
type
FROM azure.api_management.gateway_certificate_authority
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Assign Certificate entity to Gateway entity as Certificate Authority.

INSERT INTO azure.api_management.gateway_certificate_authority (
properties,
resource_group_name,
service_name,
gateway_id,
certificate_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ gateway_id }}',
'{{ certificate_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: gateway_certificate_authority
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gateway_certificate_authority resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the gateway_certificate_authority resource.
  - name: gateway_id
    value: "{{ gateway_id }}"
    description: Required parameter for the gateway_certificate_authority resource.
  - name: certificate_id
    value: "{{ certificate_id }}"
    description: Required parameter for the gateway_certificate_authority resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gateway_certificate_authority resource.
  - name: properties
    description: |
      Gateway certificate authority details.
    value:
      isTrusted: {{ isTrusted }}

REPLACE examples

create_or_update

Assign Certificate entity to Gateway entity as Certificate Authority.

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

DELETE examples

delete

Remove relationship between Certificate Authority and Gateway entity.

DELETE FROM azure.api_management.gateway_certificate_authority
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND certificate_id = '{{ certificate_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.

EXEC azure.api_management.gateway_certificate_authority.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@certificate_id='{{ certificate_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;