gateway_certificate_authorities

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

Overview

Name	gateway_certificate_authorities
Type	Resource
Id	azure.api_management.gateway_certificate_authorities

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Gateway Certificate Authority entity.

Name	Datatype	Description
properties	object	Gateway certificate authority details.

list_by_service

Collection of Gateway Certificate Authority entities.

Name	Datatype	Description
properties	object	Gateway certificate authority details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, gatewayId, certificateId, subscriptionId		Get assigned Gateway Certificate Authority details.
list_by_service	select	resourceGroupName, serviceName, gatewayId, subscriptionId	$filter, $top, $skip	Lists the collection of Certificate Authorities for the specified Gateway entity.
create_or_update	insert	resourceGroupName, serviceName, gatewayId, certificateId, subscriptionId	If-Match	Assign Certificate entity to Gateway entity as Certificate Authority.
delete	delete	resourceGroupName, serviceName, gatewayId, certificateId, If-Match, subscriptionId		Remove relationship between Certificate Authority and Gateway entity.

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.
certificateId	string	Identifier of the certificate entity. Must be unique in the current API Management service instance.
gatewayId	string	Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
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>| name | filter | eq, ne | |</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.

SELECT examples

get

Get assigned Gateway Certificate Authority details.

SELECT
properties
FROM azure.api_management.gateway_certificate_authorities
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayId = '{{ gatewayId }}' -- required
AND certificateId = '{{ certificateId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

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

SELECT
properties
FROM azure.api_management.gateway_certificate_authorities
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayId = '{{ gatewayId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_authorities (
data__properties,
resourceGroupName,
serviceName,
gatewayId,
certificateId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ gatewayId }}',
'{{ certificateId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: gateway_certificate_authorities
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateway_certificate_authorities resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateway_certificate_authorities resource.
    - name: gatewayId
      value: string
      description: Required parameter for the gateway_certificate_authorities resource.
    - name: certificateId
      value: string
      description: Required parameter for the gateway_certificate_authorities resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the gateway_certificate_authorities resource.
    - name: properties
      value: object
      description: |
        Gateway certificate authority details.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Remove relationship between Certificate Authority and Gateway entity.

DELETE FROM azure.api_management.gateway_certificate_authorities
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND gatewayId = '{{ gatewayId }}' --required
AND certificateId = '{{ certificateId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;