dns_authorizations

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

Overview

Name	dns_authorizations
Type	Resource
Id	google.certificatemanager.dns_authorizations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.
createTime	string (google-datetime)	Output only. The creation timestamp of a DnsAuthorization.
description	string	Optional. One or more paragraphs of text description of a DnsAuthorization.
dnsResourceRecord	object	Output only. DNS Resource Record that needs to be added to DNS configuration. (id: DnsResourceRecord)
domain	string	Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for example.com can be used to issue certificates for example.com and *.example.com.
labels	object	Optional. Set of labels associated with a DnsAuthorization.
type	string	Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
updateTime	string (google-datetime)	Output only. The last update timestamp of a DnsAuthorization.

list

Successful response

Name	Datatype	Description
name	string	Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.
createTime	string (google-datetime)	Output only. The creation timestamp of a DnsAuthorization.
description	string	Optional. One or more paragraphs of text description of a DnsAuthorization.
dnsResourceRecord	object	Output only. DNS Resource Record that needs to be added to DNS configuration. (id: DnsResourceRecord)
domain	string	Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for example.com can be used to issue certificates for example.com and *.example.com.
labels	object	Optional. Set of labels associated with a DnsAuthorization.
type	string	Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
updateTime	string (google-datetime)	Output only. The last update timestamp of a DnsAuthorization.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, dnsAuthorizationsId		Gets details of a single DnsAuthorization.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists DnsAuthorizations in a given project and location.
create	insert	projectsId, locationsId	dnsAuthorizationId	Creates a new DnsAuthorization in a given project and location.
patch	update	projectsId, locationsId, dnsAuthorizationsId	updateMask	Updates a DnsAuthorization.
delete	delete	projectsId, locationsId, dnsAuthorizationsId		Deletes a single DnsAuthorization.

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
dnsAuthorizationsId	string
locationsId	string
projectsId	string
dnsAuthorizationId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single DnsAuthorization.

SELECT
name,
createTime,
description,
dnsResourceRecord,
domain,
labels,
type,
updateTime
FROM google.certificatemanager.dns_authorizations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dnsAuthorizationsId = '{{ dnsAuthorizationsId }}' -- required;

list

Lists DnsAuthorizations in a given project and location.

SELECT
name,
createTime,
description,
dnsResourceRecord,
domain,
labels,
type,
updateTime
FROM google.certificatemanager.dns_authorizations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new DnsAuthorization in a given project and location.

INSERT INTO google.certificatemanager.dns_authorizations (
data__name,
data__labels,
data__description,
data__domain,
data__type,
projectsId,
locationsId,
dnsAuthorizationId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ domain }}',
'{{ type }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dnsAuthorizationId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: dns_authorizations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the dns_authorizations resource.
    - name: locationsId
      value: string
      description: Required parameter for the dns_authorizations resource.
    - name: name
      value: string
      description: >
        Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.
        
    - name: labels
      value: object
      description: >
        Optional. Set of labels associated with a DnsAuthorization.
        
    - name: description
      value: string
      description: >
        Optional. One or more paragraphs of text description of a DnsAuthorization.
        
    - name: domain
      value: string
      description: >
        Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for `example.com` can be used to issue certificates for `example.com` and `*.example.com`.
        
    - name: type
      value: string
      description: >
        Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
        
      valid_values: ['TYPE_UNSPECIFIED', 'FIXED_RECORD', 'PER_PROJECT_RECORD']
    - name: dnsAuthorizationId
      value: string

UPDATE examples

patch

Updates a DnsAuthorization.

UPDATE google.certificatemanager.dns_authorizations
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__domain = '{{ domain }}',
data__type = '{{ type }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dnsAuthorizationsId = '{{ dnsAuthorizationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single DnsAuthorization.

DELETE FROM google.certificatemanager.dns_authorizations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dnsAuthorizationsId = '{{ dnsAuthorizationsId }}' --required;