Google Cloud Managed Identities V1beta1 Client - Class ManagedIdentitiesServiceClient (1.3.5)

Reference documentation and code samples for the Google Cloud Managed Identities V1beta1 Client class ManagedIdentitiesServiceClient.

Service Description:

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();
try {
    $formattedName = $managedIdentitiesServiceClient->domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');
    $trust = new Trust();
    $operationResponse = $managedIdentitiesServiceClient->attachTrust($formattedName, $trust);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $managedIdentitiesServiceClient->attachTrust($formattedName, $trust);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $managedIdentitiesServiceClient->resumeOperation($operationName, 'attachTrust');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $managedIdentitiesServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ ManagedIdentities \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

attachTrust

Adds an AD trust to a domain.

Parameters
Name Description
name string

Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
trust Google\Cloud\ManagedIdentities\V1beta1\Trust

Required. The domain trust resource.
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Cloud\ManagedIdentities\V1beta1\Trust;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource domain name, project name and location using the form:
 *                              `projects/{project_id}/locations/global/domains/{domain_name}`
 *                              Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 */
function attach_trust_sample(string $formattedName): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $trust = new Trust();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->attachTrust($formattedName, $trust);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Domain $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');

    attach_trust_sample($formattedName);
}

createMicrosoftAdDomain

Creates a Microsoft AD domain.

Parameters
Name Description
parent string

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

Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions:

  • Must contain only lowercase letters, numbers, periods and hyphens.
  • Must start with a letter.
  • Must contain between 2-64 characters.
  • Must end with a number or a letter.
  • Must not start with period.
  • First segment length (mydomain form example above) shouldn't exceed 15 chars.
  • The last segment cannot be fully numeric.
  • Must be unique within the customer project.
domain Google\Cloud\ManagedIdentities\V1beta1\Domain

Required. A Managed Identity domain resource.
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedParent        The resource project name and location using the form:
 *                                       `projects/{project_id}/locations/global`
 *                                       Please see {@see ManagedIdentitiesServiceClient::locationName()} for help formatting this field.
 * @param string $domainName             A domain name, e.g. mydomain.myorg.com, with the following restrictions:
 *                                       * Must contain only lowercase letters, numbers, periods and hyphens.
 *                                       * Must start with a letter.
 *                                       * Must contain between 2-64 characters.
 *                                       * Must end with a number or a letter.
 *                                       * Must not start with period.
 *                                       * First segment length (mydomain form example above) shouldn't exceed
 *                                       15 chars.
 *                                       * The last segment cannot be fully numeric.
 *                                       * Must be unique within the customer project.
 * @param string $domainReservedIpRange  The CIDR range of internal addresses that are reserved for this
 *                                       domain. Reserved networks must be /24 or larger. Ranges must be
 *                                       unique and non-overlapping with existing subnets in
 *                                       [Domain].[authorized_networks].
 * @param string $domainLocationsElement Locations where domain needs to be provisioned.
 *                                       [regions][compute/docs/regions-zones/]
 *                                       e.g. us-west1 or us-east4
 *                                       Service supports up to 4 locations at once. Each location will use a /26
 *                                       block.
 */
function create_microsoft_ad_domain_sample(
    string $formattedParent,
    string $domainName,
    string $domainReservedIpRange,
    string $domainLocationsElement
): void {
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $domainLocations = [$domainLocationsElement,];
    $domain = (new Domain())
        ->setReservedIpRange($domainReservedIpRange)
        ->setLocations($domainLocations);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->createMicrosoftAdDomain(
            $formattedParent,
            $domainName,
            $domain
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Domain $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ManagedIdentitiesServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $domainName = '[DOMAIN_NAME]';
    $domainReservedIpRange = '[RESERVED_IP_RANGE]';
    $domainLocationsElement = '[LOCATIONS]';

    create_microsoft_ad_domain_sample(
        $formattedParent,
        $domainName,
        $domainReservedIpRange,
        $domainLocationsElement
    );
}

deleteDomain

Deletes a domain.

Parameters
Name Description
name string

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

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName The domain resource name using the form:
 *                              `projects/{project_id}/locations/global/domains/{domain_name}`
 *                              Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 */
function delete_domain_sample(string $formattedName): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->deleteDomain($formattedName);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');

    delete_domain_sample($formattedName);
}

detachTrust

Removes an AD trust.

Parameters
Name Description
name string

Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
trust Google\Cloud\ManagedIdentities\V1beta1\Trust

Required. The domain trust resource to removed.
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Cloud\ManagedIdentities\V1beta1\Trust;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource domain name, project name, and location using the form:
 *                              `projects/{project_id}/locations/global/domains/{domain_name}`
 *                              Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 */
function detach_trust_sample(string $formattedName): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $trust = new Trust();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->detachTrust($formattedName, $trust);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Domain $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');

    detach_trust_sample($formattedName);
}

getDomain

Gets information about a domain.

Parameters
Name Description
name string

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

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\ManagedIdentities\V1beta1\Domain
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;

/**
 * @param string $formattedName The domain resource name using the form:
 *                              `projects/{project_id}/locations/global/domains/{domain_name}`
 *                              Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 */
function get_domain_sample(string $formattedName): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Domain $response */
        $response = $managedIdentitiesServiceClient->getDomain($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');

    get_domain_sample($formattedName);
}

listDomains

Lists domains in a project.

Parameters
Name Description
parent string

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

Optional.
↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter string

Optional. A filter specifying constraints of a list operation. For example, Domain.fqdn="mydomain.myorginization".
↳ orderBy string

Optional. Specifies the ordering of results. See Sorting order for more information.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;

/**
 * @param string $formattedParent The resource name of the domain location using the form:
 *                                `projects/{project_id}/locations/global`
 *                                Please see {@see ManagedIdentitiesServiceClient::locationName()} for help formatting this field.
 */
function list_domains_sample(string $formattedParent): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $managedIdentitiesServiceClient->listDomains($formattedParent);

        /** @var Domain $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ManagedIdentitiesServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_domains_sample($formattedParent);
}

reconfigureTrust

Updates the DNS conditional forwarder.

Parameters
Name Description
name string

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

Required. The fully-qualified target domain name which will be in trust with current domain.
targetDnsIpAddresses string[]

Required. The target DNS server IP addresses to resolve the remote domain involved in the trust.
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Rpc\Status;

/**
 * @param string $formattedName               The resource domain name, project name and location using the form:
 *                                            `projects/{project_id}/locations/global/domains/{domain_name}`
 *                                            Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 * @param string $targetDomainName            The fully-qualified target domain name which will be in trust with current
 *                                            domain.
 * @param string $targetDnsIpAddressesElement The target DNS server IP addresses to resolve the remote domain involved
 *                                            in the trust.
 */
function reconfigure_trust_sample(
    string $formattedName,
    string $targetDomainName,
    string $targetDnsIpAddressesElement
): void {
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $targetDnsIpAddresses = [$targetDnsIpAddressesElement,];

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->reconfigureTrust(
            $formattedName,
            $targetDomainName,
            $targetDnsIpAddresses
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Domain $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');
    $targetDomainName = '[TARGET_DOMAIN_NAME]';
    $targetDnsIpAddressesElement = '[TARGET_DNS_IP_ADDRESSES]';

    reconfigure_trust_sample($formattedName, $targetDomainName, $targetDnsIpAddressesElement);
}

resetAdminPassword

Resets a domain's administrator password.

Parameters
Name Description
name string

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

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\ManagedIdentities\V1beta1\ResetAdminPasswordResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Cloud\ManagedIdentities\V1beta1\ResetAdminPasswordResponse;

/**
 * @param string $formattedName The domain resource name using the form:
 *                              `projects/{project_id}/locations/global/domains/{domain_name}`
 *                              Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 */
function reset_admin_password_sample(string $formattedName): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var ResetAdminPasswordResponse $response */
        $response = $managedIdentitiesServiceClient->resetAdminPassword($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');

    reset_admin_password_sample($formattedName);
}

updateDomain

Updates the metadata and configuration of a domain.

Parameters
Name Description
updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include fields from Domain:

  • labels
  • locations
  • authorized_networks
  • audit_logs_enabled
domain Google\Cloud\ManagedIdentities\V1beta1\Domain

Required. Domain message with updated fields. Only supported fields specified in update_mask are updated.
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $domainReservedIpRange  The CIDR range of internal addresses that are reserved for this
 *                                       domain. Reserved networks must be /24 or larger. Ranges must be
 *                                       unique and non-overlapping with existing subnets in
 *                                       [Domain].[authorized_networks].
 * @param string $domainLocationsElement Locations where domain needs to be provisioned.
 *                                       [regions][compute/docs/regions-zones/]
 *                                       e.g. us-west1 or us-east4
 *                                       Service supports up to 4 locations at once. Each location will use a /26
 *                                       block.
 */
function update_domain_sample(string $domainReservedIpRange, string $domainLocationsElement): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $updateMask = new FieldMask();
    $domainLocations = [$domainLocationsElement,];
    $domain = (new Domain())
        ->setReservedIpRange($domainReservedIpRange)
        ->setLocations($domainLocations);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->updateDomain($updateMask, $domain);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Domain $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $domainReservedIpRange = '[RESERVED_IP_RANGE]';
    $domainLocationsElement = '[LOCATIONS]';

    update_domain_sample($domainReservedIpRange, $domainLocationsElement);
}

validateTrust

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

Parameters
Name Description
name string

Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}
trust Google\Cloud\ManagedIdentities\V1beta1\Trust

Required. The domain trust to validate trust state for.
optionalArgs array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\OperationResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedIdentities\V1beta1\Domain;
use Google\Cloud\ManagedIdentities\V1beta1\ManagedIdentitiesServiceClient;
use Google\Cloud\ManagedIdentities\V1beta1\Trust;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource domain name, project name, and location using the form:
 *                              `projects/{project_id}/locations/global/domains/{domain_name}`
 *                              Please see {@see ManagedIdentitiesServiceClient::domainName()} for help formatting this field.
 */
function validate_trust_sample(string $formattedName): void
{
    // Create a client.
    $managedIdentitiesServiceClient = new ManagedIdentitiesServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $trust = new Trust();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedIdentitiesServiceClient->validateTrust($formattedName, $trust);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Domain $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ManagedIdentitiesServiceClient::domainName('[PROJECT]', '[LOCATION]', '[DOMAIN]');

    validate_trust_sample($formattedName);
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation
methodName string

The name of the method used to start the operation
Returns
Type Description
Google\ApiCore\OperationResponse

static::domainName

Formats a string containing the fully-qualified path to represent a domain resource.

Parameters
Name Description
project string
location string
domain string
Returns
Type Description
string The formatted domain resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name Description
project string
location string
Returns
Type Description
string The formatted location resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • domain: projects/{project}/locations/{location}/domains/{domain}
  • location: projects/{project}/locations/{location}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string
template string

Optional name of template to match
Returns
Type Description
array An associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.managedidentities.v1beta1.ManagedIdentitiesService'

The name of the service.

SERVICE_ADDRESS

Value: 'managedidentities.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.