dns_peerings
Creates, updates, deletes, gets or lists a dns_peerings
resource.
Overview
Name | dns_peerings |
Type | Resource |
Id | google.datafusion.dns_peerings |
Fields
The following fields are returned by SELECT
queries:
- list
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} |
description | string | Optional. Optional description of the dns zone. |
domain | string | Required. The dns name suffix of the zone. |
targetNetwork | string | Optional. Optional target network to which dns peering should happen. |
targetProject | string | Optional. Optional target project to which dns peering should happen. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list | select | projectsId , locationsId , instancesId | pageSize , pageToken | Lists DNS peerings for a given resource. |
create | insert | projectsId , locationsId , instancesId | dnsPeeringId | Creates DNS peering on the given resource. |
delete | delete | projectsId , locationsId , instancesId , dnsPeeringsId | Deletes DNS peering on the given resource. |
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 |
---|---|---|
dnsPeeringsId | string | |
instancesId | string | |
locationsId | string | |
projectsId | string | |
dnsPeeringId | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT
examples
- list
Lists DNS peerings for a given resource.
SELECT
name,
description,
domain,
targetNetwork,
targetProject
FROM google.datafusion.dns_peerings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
INSERT
examples
- create
- Manifest
Creates DNS peering on the given resource.
INSERT INTO google.datafusion.dns_peerings (
data__name,
data__domain,
data__description,
data__targetProject,
data__targetNetwork,
projectsId,
locationsId,
instancesId,
dnsPeeringId
)
SELECT
'{{ name }}',
'{{ domain }}',
'{{ description }}',
'{{ targetProject }}',
'{{ targetNetwork }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instancesId }}',
'{{ dnsPeeringId }}'
RETURNING
name,
description,
domain,
targetNetwork,
targetProject
;
# Description fields are for documentation purposes
- name: dns_peerings
props:
- name: projectsId
value: string
description: Required parameter for the dns_peerings resource.
- name: locationsId
value: string
description: Required parameter for the dns_peerings resource.
- name: instancesId
value: string
description: Required parameter for the dns_peerings resource.
- name: name
value: string
description: >
Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering}
- name: domain
value: string
description: >
Required. The dns name suffix of the zone.
- name: description
value: string
description: >
Optional. Optional description of the dns zone.
- name: targetProject
value: string
description: >
Optional. Optional target project to which dns peering should happen.
- name: targetNetwork
value: string
description: >
Optional. Optional target network to which dns peering should happen.
- name: dnsPeeringId
value: string
DELETE
examples
- delete
Deletes DNS peering on the given resource.
DELETE FROM google.datafusion.dns_peerings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND dnsPeeringsId = '{{ dnsPeeringsId }}' --required;