peerings

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

Overview

Name	peerings
Type	Resource
Id	google.managedidentities.peerings

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Unique name of the peering in this scope including projects and location using the form: projects/{project_id}/locations/global/peerings/{peering_id}.
authorizedNetwork	string	Required. The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.
createTime	string (google-datetime)	Output only. The time the instance was created.
domainResource	string	Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: projects/{project_id}/locations/global/domains/{domain_name}
labels	object	Optional. Resource labels to represent user-provided metadata.
state	string	Output only. The current state of this Peering.
statusMessage	string	Output only. Additional information about the current status of this peering, if available.
updateTime	string (google-datetime)	Output only. Last update time.

list

Successful response

Name	Datatype	Description
name	string	Output only. Unique name of the peering in this scope including projects and location using the form: projects/{project_id}/locations/global/peerings/{peering_id}.
authorizedNetwork	string	Required. The full names of the Google Compute Engine networks to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.
createTime	string (google-datetime)	Output only. The time the instance was created.
domainResource	string	Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: projects/{project_id}/locations/global/domains/{domain_name}
labels	object	Optional. Resource labels to represent user-provided metadata.
state	string	Output only. The current state of this Peering.
statusMessage	string	Output only. Additional information about the current status of this peering, if available.
updateTime	string (google-datetime)	Output only. Last update time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, peeringsId		Gets details of a single Peering.
list	select	projectsId	pageSize, pageToken, filter, orderBy	Lists Peerings in a given project.
create	insert	projectsId	peeringId	Creates a Peering for Managed AD instance.
patch	update	projectsId, peeringsId	updateMask	Updates the labels for specified Peering.
delete	delete	projectsId, peeringsId		Deletes identified Peering.

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

SELECT examples

get

Gets details of a single Peering.

SELECT
name,
authorizedNetwork,
createTime,
domainResource,
labels,
state,
statusMessage,
updateTime
FROM google.managedidentities.peerings
WHERE projectsId = '{{ projectsId }}' -- required
AND peeringsId = '{{ peeringsId }}' -- required;

list

Lists Peerings in a given project.

SELECT
name,
authorizedNetwork,
createTime,
domainResource,
labels,
state,
statusMessage,
updateTime
FROM google.managedidentities.peerings
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a Peering for Managed AD instance.

INSERT INTO google.managedidentities.peerings (
data__labels,
data__authorizedNetwork,
data__domainResource,
projectsId,
peeringId
)
SELECT 
'{{ labels }}',
'{{ authorizedNetwork }}',
'{{ domainResource }}',
'{{ projectsId }}',
'{{ peeringId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: peerings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the peerings resource.
    - name: labels
      value: object
      description: >
        Optional. Resource labels to represent user-provided metadata.
        
    - name: authorizedNetwork
      value: string
      description: >
        Required. The full names of the Google Compute Engine [networks](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.
        
    - name: domainResource
      value: string
      description: >
        Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: `projects/{project_id}/locations/global/domains/{domain_name}`
        
    - name: peeringId
      value: string

UPDATE examples

patch

Updates the labels for specified Peering.

UPDATE google.managedidentities.peerings
SET 
data__labels = '{{ labels }}',
data__authorizedNetwork = '{{ authorizedNetwork }}',
data__domainResource = '{{ domainResource }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND peeringsId = '{{ peeringsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes identified Peering.

DELETE FROM google.managedidentities.peerings
WHERE projectsId = '{{ projectsId }}' --required
AND peeringsId = '{{ peeringsId }}' --required;