class ProjectsLocationsManagedidentitiesGlobalDomains extends Resource (View source)

The "domains" collection of methods.

Typical usage is:

 $managedidentitiesService = new Google\Service\ManagedServiceforMicrosoftActiveDirectoryConsumerAPI(...);
 $domains = $managedidentitiesService->projects_locations_global_domains;

Methods

attachTrust(string $name, AttachTrustRequest $postBody, array $optParams = [])

Adds an AD trust to a domain. (domains.attachTrust)

checkMigrationPermission(string $domain, CheckMigrationPermissionRequest $postBody, array $optParams = [])

CheckMigrationPermission API gets the current state of DomainMigration (domains.checkMigrationPermission)

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

Creates a Microsoft AD domain. (domains.create)

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

Deletes a domain. (domains.delete)

detachTrust(string $name, DetachTrustRequest $postBody, array $optParams = [])

Removes an AD trust. (domains.detachTrust)

disableMigration(string $domain, DisableMigrationRequest $postBody, array $optParams = [])

Disable Domain Migration (domains.disableMigration)

domainJoinMachine(string $domain, DomainJoinMachineRequest $postBody, array $optParams = [])

DomainJoinMachine API joins a Compute Engine VM to the domain (domains.domainJoinMachine)

enableMigration(string $domain, EnableMigrationRequest $postBody, array $optParams = [])

Enable Domain Migration (domains.enableMigration)

extendSchema(string $domain, ExtendSchemaRequest $postBody, array $optParams = [])

Extend Schema for Domain (domains.extendSchema)

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

Gets information about a domain. (domains.get)

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. (domains.getIamPolicy)

getLdapssettings(string $name, array $optParams = [])

Gets the domain ldaps settings. (domains.getLdapssettings)

listProjectsLocationsManagedidentitiesGlobalDomains(string $parent, array $optParams = [])

Lists domains in a project.

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

Updates the metadata and configuration of a domain. (domains.patch)

reconfigureTrust(string $name, ReconfigureTrustRequest $postBody, array $optParams = [])

Updates the DNS conditional forwarder. (domains.reconfigureTrust)

resetAdminPassword(string $name, ResetAdminPasswordRequest $postBody, array $optParams = [])

Resets a domain's administrator password. (domains.resetAdminPassword)

restore(string $name, RestoreDomainRequest $postBody, array $optParams = [])

RestoreDomain restores domain backup mentioned in the RestoreDomainRequest (domains.restore)

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. (domains.setIamPolicy)

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.

updateLdapssettings(string $name, LDAPSSettings $postBody, array $optParams = [])

Patches a single ldaps settings. (domains.updateLdapssettings)

validateTrust(string $name, ValidateTrustRequest $postBody, array $optParams = [])

Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.

Details

Operation attachTrust(string $name, AttachTrustRequest $postBody, array $optParams = [])

Adds an AD trust to a domain. (domains.attachTrust)

Parameters

string $name

Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

AttachTrustRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

CheckMigrationPermissionResponse checkMigrationPermission(string $domain, CheckMigrationPermissionRequest $postBody, array $optParams = [])

CheckMigrationPermission API gets the current state of DomainMigration (domains.checkMigrationPermission)

Parameters

string $domain

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

CheckMigrationPermissionRequest $postBody
array $optParams

Optional parameters.

Return Value

CheckMigrationPermissionResponse

Exceptions

Exception

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

Creates a Microsoft AD domain. (domains.create)

Parameters

string $parent

Required. The resource project name and location using the form: projects/{project_id}/locations/global

Domain $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a domain. (domains.delete)

Parameters

string $name

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation detachTrust(string $name, DetachTrustRequest $postBody, array $optParams = [])

Removes an AD trust. (domains.detachTrust)

Parameters

string $name

Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

DetachTrustRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation disableMigration(string $domain, DisableMigrationRequest $postBody, array $optParams = [])

Disable Domain Migration (domains.disableMigration)

Parameters

string $domain

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

DisableMigrationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

DomainJoinMachineResponse domainJoinMachine(string $domain, DomainJoinMachineRequest $postBody, array $optParams = [])

DomainJoinMachine API joins a Compute Engine VM to the domain (domains.domainJoinMachine)

Parameters

string $domain

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

DomainJoinMachineRequest $postBody
array $optParams

Optional parameters.

Return Value

DomainJoinMachineResponse

Exceptions

Exception

Operation enableMigration(string $domain, EnableMigrationRequest $postBody, array $optParams = [])

Enable Domain Migration (domains.enableMigration)

Parameters

string $domain

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

EnableMigrationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation extendSchema(string $domain, ExtendSchemaRequest $postBody, array $optParams = [])

Extend Schema for Domain (domains.extendSchema)

Parameters

string $domain

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

ExtendSchemaRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets information about a domain. (domains.get)

Parameters

string $name

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

array $optParams

Optional parameters.

Return Value

Domain

Exceptions

Exception

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. (domains.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

LDAPSSettings getLdapssettings(string $name, array $optParams = [])

Gets the domain ldaps settings. (domains.getLdapssettings)

Parameters

string $name

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

array $optParams

Optional parameters.

Return Value

LDAPSSettings

Exceptions

Exception

ListDomainsResponse listProjectsLocationsManagedidentitiesGlobalDomains(string $parent, array $optParams = [])

Lists domains in a project.

(domains.listProjectsLocationsManagedidentitiesGlobalDomains)

Parameters

string $parent

Required. The resource name of the domain location using the form: projects/{project_id}/locations/global

array $optParams

Optional parameters.

Return Value

ListDomainsResponse

Exceptions

Exception

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

Updates the metadata and configuration of a domain. (domains.patch)

Parameters

string $name

Required. The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.

Domain $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation reconfigureTrust(string $name, ReconfigureTrustRequest $postBody, array $optParams = [])

Updates the DNS conditional forwarder. (domains.reconfigureTrust)

Parameters

string $name

Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

ReconfigureTrustRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

ResetAdminPasswordResponse resetAdminPassword(string $name, ResetAdminPasswordRequest $postBody, array $optParams = [])

Resets a domain's administrator password. (domains.resetAdminPassword)

Parameters

string $name

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

ResetAdminPasswordRequest $postBody
array $optParams

Optional parameters.

Return Value

ResetAdminPasswordResponse

Exceptions

Exception

Operation restore(string $name, RestoreDomainRequest $postBody, array $optParams = [])

RestoreDomain restores domain backup mentioned in the RestoreDomainRequest (domains.restore)

Parameters

string $name

Required. Resource name for the domain to which the backup belongs

RestoreDomainRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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. (domains.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

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. (domains.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

Operation updateLdapssettings(string $name, LDAPSSettings $postBody, array $optParams = [])

Patches a single ldaps settings. (domains.updateLdapssettings)

Parameters

string $name

The resource name of the LDAPS settings. Uses the form: projects/{project}/locations/{location}/domains/{domain}.

LDAPSSettings $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation validateTrust(string $name, ValidateTrustRequest $postBody, array $optParams = [])

Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.

(domains.validateTrust)

Parameters

string $name

Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

ValidateTrustRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception