1. class
  2. Google
  3. \
  4. Service
  5. \
  6. ManagedServiceforMicrosoftActiveDirectoryConsumerAPI
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsManagedidentitiesGlobalPeerings

ProjectsLocationsManagedidentitiesGlobalPeerings

class ProjectsLocationsManagedidentitiesGlobalPeerings extends Resource (View source)

The "peerings" collection of methods.

Typical usage is:

 $managedidentitiesService = new Google\Service\ManagedServiceforMicrosoftActiveDirectoryConsumerAPI(...);
 $peerings = $managedidentitiesService->projects_locations_global_peerings;

Methods

Operation
create(string $parent, Peering $postBody, array $optParams = [])

Creates a Peering for Managed AD instance. (peerings.create)

Operation
delete(string $name, array $optParams = [])

Deletes identified Peering. (peerings.delete)

Peering
get(string $name, array $optParams = [])

Gets details of a single Peering. (peerings.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (peerings.getIamPolicy)

ListPeeringsResponse
listProjectsLocationsManagedidentitiesGlobalPeerings(string $parent, array $optParams = [])

Lists Peerings in a given project.

Operation
patch(string $name, Peering $postBody, array $optParams = [])

Updates the labels for specified Peering. (peerings.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (peerings.setIamPolicy)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

at line 52
Operation create(string $parent, Peering $postBody, array $optParams = [])

Creates a Peering for Managed AD instance. (peerings.create)

Parameters

string $parent

Required. Resource project name and location using the form: projects/{project_id}/locations/global
Peering $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 67
Operation delete(string $name, array $optParams = [])

Deletes identified Peering. (peerings.delete)

Parameters

string $name

Required. Peering resource name using the form: projects/{project_id}/locations/global/peerings/{peering_id}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 82
Peering get(string $name, array $optParams = [])

Gets details of a single Peering. (peerings.get)

Parameters

string $name

Required. Peering resource name using the form: projects/{project_id}/locations/global/peerings/{peering_id}
array $optParams

Optional parameters.

Return Value

Peering

Exceptions

Exception

at line 113
Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (peerings.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 143
ListPeeringsResponse listProjectsLocationsManagedidentitiesGlobalPeerings(string $parent, array $optParams = [])

Lists Peerings in a given project.

(peerings.listProjectsLocationsManagedidentitiesGlobalPeerings)

Parameters

string $parent

Required. The resource name of the peering location using the form: projects/{project_id}/locations/global
array $optParams

Optional parameters.

Return Value

ListPeeringsResponse

Exceptions

Exception

at line 164
Operation patch(string $name, Peering $postBody, array $optParams = [])

Updates the labels for specified Peering. (peerings.patch)

Parameters

string $name

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}.
Peering $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 184
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (peerings.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 206
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (peerings.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception