Documentation

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Resource_ProjectsLocationsManagedidentitiesGlobalDomains extends Google_Service_Resource
in package

Application

The "domains" collection of methods.

Typical usage is: $managedidentitiesService = new Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI(...); $domains = $managedidentitiesService->domains;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
attachTrust() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Adds an AD trust to a domain. (domains.attachTrust)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Creates a Microsoft AD domain. (domains.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Deletes a domain. (domains.delete)
detachTrust() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Removes an AD trust. (domains.detachTrust)
get() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain: Gets information about a domain. (domains.get)
getIamPolicy() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Policy: 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)
listProjectsLocationsManagedidentitiesGlobalDomains() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ListDomainsResponse: Lists domains in a project.
patch() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Updates the metadata and configuration of a domain. (domains.patch)
reconfigureTrust() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Updates the DNS conditional forwarder. (domains.reconfigureTrust)
resetAdminPassword() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ResetAdminPasswordResponse: Resets a domain's administrator password. (domains.resetAdminPassword)
setIamPolicy() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Policy: 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() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_TestIamPermissionsResponse: 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.
validateTrust() : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation: Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

attachTrust()

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


    public
                attachTrust(string $name, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_AttachTrustRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

Parameters

$name : string: Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_AttachTrustRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a Microsoft AD domain. (domains.create)


    public
                create(string $parent, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

Parameters

$parent : string: Required. The resource project name and location using the form: projects/{project_id}/locations/global
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a domain. (domains.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

Parameters

$name : string: Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

detachTrust()

Removes an AD trust. (domains.detachTrust)


    public
                detachTrust(string $name, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_DetachTrustRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

Parameters

$name : string: Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_DetachTrustRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

get()

Gets information about a domain. (domains.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain

Parameters

$name : string: Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain —

getIamPolicy()

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)


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Policy —

listProjectsLocationsManagedidentitiesGlobalDomains()

Lists domains in a project.


    public
                listProjectsLocationsManagedidentitiesGlobalDomains(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ListDomainsResponse

(domains.listProjectsLocationsManagedidentitiesGlobalDomains)

Parameters

$parent : string: Required. The resource name of the domain location using the form: projects/{project_id}/locations/global
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ListDomainsResponse —

patch()

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


    public
                patch(string $name, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

Parameters

$name : string: Required. The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Domain
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

reconfigureTrust()

Updates the DNS conditional forwarder. (domains.reconfigureTrust)


    public
                reconfigureTrust(string $name, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ReconfigureTrustRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

Parameters

$name : string: Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ReconfigureTrustRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

resetAdminPassword()

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


    public
                resetAdminPassword(string $name, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ResetAdminPasswordRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ResetAdminPasswordResponse

Parameters

$name : string: Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ResetAdminPasswordRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ResetAdminPasswordResponse —

setIamPolicy()

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)


    public
                setIamPolicy(string $resource, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Policy —

testIamPermissions()

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.


    public
                testIamPermissions(string $resource, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_TestIamPermissionsResponse

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

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_TestIamPermissionsResponse —

validateTrust()

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


    public
                validateTrust(string $name, Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ValidateTrustRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation

(domains.validateTrust)

Parameters

$name : string: Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
$postBody : Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_ValidateTrustRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ManagedServiceforMicrosoftActiveDirectoryConsumerAPI_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —