Class v1beta1.ManagedIdentitiesServiceClient (2.2.2)

v1beta1

Package

@google-cloud/managed-identities

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of ManagedIdentitiesServiceClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof gax.fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ManagedIdentitiesServiceClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

managedIdentitiesServiceStub

managedIdentitiesServiceStub?: Promise<{
        [name: string]: Function;
    }>;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

attachTrust(request, options)

attachTrust(request?: protos.google.cloud.managedidentities.v1beta1.IAttachTrustRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Adds an AD trust to a domain.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IAttachTrustRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The domain trust resource.
   */
  // const trust = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callAttachTrust() {
    // Construct request
    const request = {
      name,
      trust,
    };

    // Run request
    const [operation] = await managedidentitiesClient.attachTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callAttachTrust();

attachTrust(request, options, callback)

attachTrust(request: protos.google.cloud.managedidentities.v1beta1.IAttachTrustRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IAttachTrustRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

attachTrust(request, callback)

attachTrust(request: protos.google.cloud.managedidentities.v1beta1.IAttachTrustRequest, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IAttachTrustRequest
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

checkAttachTrustProgress(name)

checkAttachTrustProgress(name: string): Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by attachTrust().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The domain trust resource.
   */
  // const trust = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callAttachTrust() {
    // Construct request
    const request = {
      name,
      trust,
    };

    // Run request
    const [operation] = await managedidentitiesClient.attachTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callAttachTrust();

checkCreateMicrosoftAdDomainProgress(name)

checkCreateMicrosoftAdDomainProgress(name: string): Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by createMicrosoftAdDomain().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource project name and location using the form:
   *  `projects/{project_id}/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const domainName = 'abc123'
  /**
   *  Required. A Managed Identity domain resource.
   */
  // const domain = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callCreateMicrosoftAdDomain() {
    // Construct request
    const request = {
      parent,
      domainName,
      domain,
    };

    // Run request
    const [operation] = await managedidentitiesClient.createMicrosoftAdDomain(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateMicrosoftAdDomain();

checkDeleteDomainProgress(name)

checkDeleteDomainProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by deleteDomain().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The domain resource name using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callDeleteDomain() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await managedidentitiesClient.deleteDomain(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDomain();

checkDetachTrustProgress(name)

checkDetachTrustProgress(name: string): Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by detachTrust().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name, and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The domain trust resource to removed.
   */
  // const trust = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callDetachTrust() {
    // Construct request
    const request = {
      name,
      trust,
    };

    // Run request
    const [operation] = await managedidentitiesClient.detachTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDetachTrust();

checkReconfigureTrustProgress(name)

checkReconfigureTrustProgress(name: string): Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by reconfigureTrust().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The fully-qualified target domain name which will be in trust with current
   *  domain.
   */
  // const targetDomainName = 'abc123'
  /**
   *  Required. The target DNS server IP addresses to resolve the remote domain involved
   *  in the trust.
   */
  // const targetDnsIpAddresses = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callReconfigureTrust() {
    // Construct request
    const request = {
      name,
      targetDomainName,
      targetDnsIpAddresses,
    };

    // Run request
    const [operation] = await managedidentitiesClient.reconfigureTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReconfigureTrust();

checkUpdateDomainProgress(name)

checkUpdateDomainProgress(name: string): Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by updateDomain().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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 google.cloud.managedidentities.v1beta1.Domain:
   *   * `labels`
   *   * `locations`
   *   * `authorized_networks`
   *   * `audit_logs_enabled`
   */
  // const updateMask = {}
  /**
   *  Required. Domain message with updated fields. Only supported fields specified in
   *  update_mask are updated.
   */
  // const domain = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callUpdateDomain() {
    // Construct request
    const request = {
      updateMask,
      domain,
    };

    // Run request
    const [operation] = await managedidentitiesClient.updateDomain(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateDomain();

checkValidateTrustProgress(name)

checkValidateTrustProgress(name: string): Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>;

Check the status of the long running operation returned by validateTrust().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.managedidentities.v1beta1.Domain, protos.google.cloud.managedidentities.v1beta1.OpMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name, and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The domain trust to validate trust state for.
   */
  // const trust = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callValidateTrust() {
    // Construct request
    const request = {
      name,
      trust,
    };

    // Run request
    const [operation] = await managedidentitiesClient.validateTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callValidateTrust();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createMicrosoftAdDomain(request, options)

createMicrosoftAdDomain(request?: protos.google.cloud.managedidentities.v1beta1.ICreateMicrosoftAdDomainRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Microsoft AD domain.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.ICreateMicrosoftAdDomainRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource project name and location using the form:
   *  `projects/{project_id}/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const domainName = 'abc123'
  /**
   *  Required. A Managed Identity domain resource.
   */
  // const domain = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callCreateMicrosoftAdDomain() {
    // Construct request
    const request = {
      parent,
      domainName,
      domain,
    };

    // Run request
    const [operation] = await managedidentitiesClient.createMicrosoftAdDomain(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateMicrosoftAdDomain();

createMicrosoftAdDomain(request, options, callback)

createMicrosoftAdDomain(request: protos.google.cloud.managedidentities.v1beta1.ICreateMicrosoftAdDomainRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.ICreateMicrosoftAdDomainRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMicrosoftAdDomain(request, callback)

createMicrosoftAdDomain(request: protos.google.cloud.managedidentities.v1beta1.ICreateMicrosoftAdDomainRequest, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.ICreateMicrosoftAdDomainRequest
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDomain(request, options)

deleteDomain(request?: protos.google.cloud.managedidentities.v1beta1.IDeleteDomainRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a domain.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IDeleteDomainRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The domain resource name using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callDeleteDomain() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await managedidentitiesClient.deleteDomain(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDomain();

deleteDomain(request, options, callback)

deleteDomain(request: protos.google.cloud.managedidentities.v1beta1.IDeleteDomainRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IDeleteDomainRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDomain(request, callback)

deleteDomain(request: protos.google.cloud.managedidentities.v1beta1.IDeleteDomainRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IDeleteDomainRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

detachTrust(request, options)

detachTrust(request?: protos.google.cloud.managedidentities.v1beta1.IDetachTrustRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Removes an AD trust.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IDetachTrustRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name, and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The domain trust resource to removed.
   */
  // const trust = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callDetachTrust() {
    // Construct request
    const request = {
      name,
      trust,
    };

    // Run request
    const [operation] = await managedidentitiesClient.detachTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDetachTrust();

detachTrust(request, options, callback)

detachTrust(request: protos.google.cloud.managedidentities.v1beta1.IDetachTrustRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IDetachTrustRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

detachTrust(request, callback)

detachTrust(request: protos.google.cloud.managedidentities.v1beta1.IDetachTrustRequest, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IDetachTrustRequest
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

domainPath(project, location, domain)

domainPath(project: string, location: string, domain: string): string;

Return a fully-qualified domain resource name string.

Parameters
NameDescription
project string
location string
domain string
Returns
TypeDescription
string

{string} Resource name string.

getDomain(request, options)

getDomain(request?: protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest, options?: CallOptions): Promise<[
        protos.google.cloud.managedidentities.v1beta1.IDomain,
        (protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest | undefined),
        {} | undefined
    ]>;

Gets information about a domain.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.managedidentities.v1beta1.IDomain, (protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The domain resource name using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callGetDomain() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await managedidentitiesClient.getDomain(request);
    console.log(response);
  }

  callGetDomain();

getDomain(request, options, callback)

getDomain(request: protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest, options: CallOptions, callback: Callback<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest
options CallOptions
callback Callback<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDomain(request, callback)

getDomain(request: protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest, callback: Callback<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest
callback Callback<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IGetDomainRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listDomains(request, options)

listDomains(request?: protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.managedidentities.v1beta1.IDomain[],
        protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest | null,
        protos.google.cloud.managedidentities.v1beta1.IListDomainsResponse
    ]>;

Lists domains in a project.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.managedidentities.v1beta1.IDomain[], protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest | null, protos.google.cloud.managedidentities.v1beta1.IListDomainsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDomainsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDomains(request, options, callback)

listDomains(request: protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, protos.google.cloud.managedidentities.v1beta1.IListDomainsResponse | null | undefined, protos.google.cloud.managedidentities.v1beta1.IDomain>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, protos.google.cloud.managedidentities.v1beta1.IListDomainsResponse | null | undefined, protos.google.cloud.managedidentities.v1beta1.IDomain>
Returns
TypeDescription
void

listDomains(request, callback)

listDomains(request: protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, callback: PaginationCallback<protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, protos.google.cloud.managedidentities.v1beta1.IListDomainsResponse | null | undefined, protos.google.cloud.managedidentities.v1beta1.IDomain>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest
callback PaginationCallback<protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, protos.google.cloud.managedidentities.v1beta1.IListDomainsResponse | null | undefined, protos.google.cloud.managedidentities.v1beta1.IDomain>
Returns
TypeDescription
void

listDomainsAsync(request, options)

listDomainsAsync(request?: protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.managedidentities.v1beta1.IDomain>;

Equivalent to listDomains, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.managedidentities.v1beta1.IDomain>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the domain location using the form:
   *  `projects/{project_id}/locations/global`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of items to return.
   *  If not specified, a default value of 1000 will be used.
   *  Regardless of the page_size value, the response may include a partial list.
   *  Callers should rely on a response's
   *  next_page_token google.cloud.managedidentities.v1beta1.ListDomainsResponse.next_page_token 
   *  to determine if there are additional results to list.
   */
  // const pageSize = 1234
  /**
   *  The `next_page_token` value returned from a previous ListDomainsRequest
   *  request, if any.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter specifying constraints of a list operation.
   *  For example, `Domain.fqdn="mydomain.myorginization"`.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specifies the ordering of results. See
   *  Sorting
   *  order (https://cloud.google.com/apis/design/design_patterns#sorting_order)
   *  for more information.
   */
  // const orderBy = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callListDomains() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await managedidentitiesClient.listDomainsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDomains();

listDomainsStream(request, options)

listDomainsStream(request?: protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IListDomainsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDomainsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchDomainFromDomainName(domainName)

matchDomainFromDomainName(domainName: string): string | number;

Parse the domain from Domain resource.

Parameter
NameDescription
domainName string

A fully-qualified path representing Domain resource.

Returns
TypeDescription
string | number

{string} A string representing the domain.

matchLocationFromDomainName(domainName)

matchLocationFromDomainName(domainName: string): string | number;

Parse the location from Domain resource.

Parameter
NameDescription
domainName string

A fully-qualified path representing Domain resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromDomainName(domainName)

matchProjectFromDomainName(domainName: string): string | number;

Parse the project from Domain resource.

Parameter
NameDescription
domainName string

A fully-qualified path representing Domain resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

reconfigureTrust(request, options)

reconfigureTrust(request?: protos.google.cloud.managedidentities.v1beta1.IReconfigureTrustRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the DNS conditional forwarder.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IReconfigureTrustRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The fully-qualified target domain name which will be in trust with current
   *  domain.
   */
  // const targetDomainName = 'abc123'
  /**
   *  Required. The target DNS server IP addresses to resolve the remote domain involved
   *  in the trust.
   */
  // const targetDnsIpAddresses = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callReconfigureTrust() {
    // Construct request
    const request = {
      name,
      targetDomainName,
      targetDnsIpAddresses,
    };

    // Run request
    const [operation] = await managedidentitiesClient.reconfigureTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReconfigureTrust();

reconfigureTrust(request, options, callback)

reconfigureTrust(request: protos.google.cloud.managedidentities.v1beta1.IReconfigureTrustRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IReconfigureTrustRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

reconfigureTrust(request, callback)

reconfigureTrust(request: protos.google.cloud.managedidentities.v1beta1.IReconfigureTrustRequest, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IReconfigureTrustRequest
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resetAdminPassword(request, options)

resetAdminPassword(request?: protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest, options?: CallOptions): Promise<[
        protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordResponse,
        (protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest | undefined),
        {} | undefined
    ]>;

Resets a domain's administrator password.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordResponse, (protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The domain resource name using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callResetAdminPassword() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await managedidentitiesClient.resetAdminPassword(request);
    console.log(response);
  }

  callResetAdminPassword();

resetAdminPassword(request, options, callback)

resetAdminPassword(request: protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest, options: CallOptions, callback: Callback<protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordResponse, protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest
options CallOptions
callback Callback<protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordResponse, protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

resetAdminPassword(request, callback)

resetAdminPassword(request: protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest, callback: Callback<protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordResponse, protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest
callback Callback<protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordResponse, protos.google.cloud.managedidentities.v1beta1.IResetAdminPasswordRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDomain(request, options)

updateDomain(request?: protos.google.cloud.managedidentities.v1beta1.IUpdateDomainRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the metadata and configuration of a domain.

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IUpdateDomainRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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 google.cloud.managedidentities.v1beta1.Domain:
   *   * `labels`
   *   * `locations`
   *   * `authorized_networks`
   *   * `audit_logs_enabled`
   */
  // const updateMask = {}
  /**
   *  Required. Domain message with updated fields. Only supported fields specified in
   *  update_mask are updated.
   */
  // const domain = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callUpdateDomain() {
    // Construct request
    const request = {
      updateMask,
      domain,
    };

    // Run request
    const [operation] = await managedidentitiesClient.updateDomain(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateDomain();

updateDomain(request, options, callback)

updateDomain(request: protos.google.cloud.managedidentities.v1beta1.IUpdateDomainRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IUpdateDomainRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDomain(request, callback)

updateDomain(request: protos.google.cloud.managedidentities.v1beta1.IUpdateDomainRequest, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IUpdateDomainRequest
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

validateTrust(request, options)

validateTrust(request?: protos.google.cloud.managedidentities.v1beta1.IValidateTrustRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

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

Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IValidateTrustRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource domain name, project name, and location using the form:
   *  `projects/{project_id}/locations/global/domains/{domain_name}`
   */
  // const name = 'abc123'
  /**
   *  Required. The domain trust to validate trust state for.
   */
  // const trust = {}

  // Imports the Managedidentities library
  const {ManagedIdentitiesServiceClient} = require('@google-cloud/managed-identities').v1beta1;

  // Instantiates a client
  const managedidentitiesClient = new ManagedIdentitiesServiceClient();

  async function callValidateTrust() {
    // Construct request
    const request = {
      name,
      trust,
    };

    // Run request
    const [operation] = await managedidentitiesClient.validateTrust(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callValidateTrust();

validateTrust(request, options, callback)

validateTrust(request: protos.google.cloud.managedidentities.v1beta1.IValidateTrustRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IValidateTrustRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

validateTrust(request, callback)

validateTrust(request: protos.google.cloud.managedidentities.v1beta1.IValidateTrustRequest, callback: Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.managedidentities.v1beta1.IValidateTrustRequest
callback Callback<LROperation<protos.google.cloud.managedidentities.v1beta1.IDomain, protos.google.cloud.managedidentities.v1beta1.IOpMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void