Class v1.AzureClustersClient (0.1.4)

The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure. v1

Package

@google-cloud/gkemulticloud

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of AzureClustersClient.

Parameters

Name	Description
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 AzureClustersClient({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;

azureClustersStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [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

awsClusterPath(project, location, awsCluster)

awsClusterPath(project: string, location: string, awsCluster: string): string;

Return a fully-qualified awsCluster resource name string.

Parameters

Name	Description
project	`string`
location	`string`
awsCluster	`string`

Returns

Type	Description
string	{string} Resource name string.

awsNodePoolPath(project, location, awsCluster, awsNodePool)

awsNodePoolPath(project: string, location: string, awsCluster: string, awsNodePool: string): string;

Return a fully-qualified awsNodePool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
awsCluster	`string`
awsNodePool	`string`

Returns

Type	Description
string	{string} Resource name string.

awsServerConfigPath(project, location)

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

Return a fully-qualified awsServerConfig resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

azureClientPath(project, location, azureClient)

azureClientPath(project: string, location: string, azureClient: string): string;

Return a fully-qualified azureClient resource name string.

Parameters

Name	Description
project	`string`
location	`string`
azureClient	`string`

Returns

Type	Description
string	{string} Resource name string.

azureClusterPath(project, location, azureCluster)

azureClusterPath(project: string, location: string, azureCluster: string): string;

Return a fully-qualified azureCluster resource name string.

Parameters

Name	Description
project	`string`
location	`string`
azureCluster	`string`

Returns

Type	Description
string	{string} Resource name string.

azureNodePoolPath(project, location, azureCluster, azureNodePool)

azureNodePoolPath(project: string, location: string, azureCluster: string, azureNodePool: string): string;

Return a fully-qualified azureNodePool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
azureCluster	`string`
azureNodePool	`string`

Returns

Type	Description
string	{string} Resource name string.

azureServerConfigPath(project, location)

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

Return a fully-qualified azureServerConfig resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

checkCreateAzureClientProgress(name)

checkCreateAzureClientProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureClient, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureClient, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 parent location where this AzureClient google.cloud.gkemulticloud.v1.AzureClient  resource
   *  will be created.
   *  Location names are formatted as `projects/

checkCreateAzureClusterProgress(name)

checkCreateAzureClusterProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 parent location where this AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource
   *  will be created.
   *  Location names are formatted as `projects/

checkCreateAzureNodePoolProgress(name)

checkCreateAzureNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource where this node pool will be created.
   *  Location names are formatted as `projects/

checkDeleteAzureClientProgress(name)

checkDeleteAzureClientProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 name the AzureClient google.cloud.gkemulticloud.v1.AzureClient  to delete.
   *  AzureClient google.cloud.gkemulticloud.v1.AzureClient  names are formatted as
   *  `projects/

checkDeleteAzureClusterProgress(name)

checkDeleteAzureClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 name the AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  to delete.
   *  `AzureCluster` names are formatted as
   *  `projects/

checkDeleteAzureNodePoolProgress(name)

checkDeleteAzureNodePoolProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 name the AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool  to delete.
   *  `AzureNodePool` names are formatted as
   *  `projects/

checkUpdateAzureClusterProgress(name)

checkUpdateAzureClusterProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource to update.
   */
  // const azureCluster = {}
  /**
   *  If set, only validate the request, but do not actually update the cluster.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AzureCluster google.cloud.gkemulticloud.v1.AzureCluster:
   *   *   `description`.
   *   *   `annotations`.
   *   *   `azureClient`.
   *   *   `control_plane.version`.
   *   *   `control_plane.vm_size`.
   *   *   `authorization.admin_users`.
   *   *   `control_plane.root_volume.size_gib`.
   *   *   `logging_config`
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AzureClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AzureClustersClient();

  async function callUpdateAzureCluster() {
    // Construct request
    const request = {
      azureCluster,
      updateMask,
    };

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

  callUpdateAzureCluster();

checkUpdateAzureNodePoolProgress(name)

checkUpdateAzureNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AzureNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>	{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 AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool  resource to update.
   */
  // const azureNodePool = {}
  /**
   *  If set, only validate the request, but don't actually update the node pool.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool:
   *   *.  `annotations`.
   *   *   `version`.
   *   *   `autoscaling.min_node_count`.
   *   *   `autoscaling.max_node_count`.
   *   *   `config.vm_size`.
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AzureClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AzureClustersClient();

  async function callUpdateAzureNodePool() {
    // Construct request
    const request = {
      azureNodePool,
      updateMask,
    };

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

  callUpdateAzureNodePool();

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

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createAzureClient(request, options)

createAzureClient(request?: protos.google.cloud.gkemulticloud.v1.ICreateAzureClientRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new resource on a given Google Cloud project and region.

AzureClient resources hold client authentication information needed by the Anthos Multicloud API to manage Azure resources on your Azure subscription on your behalf.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureClientRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 parent location where this AzureClient google.cloud.gkemulticloud.v1.AzureClient  resource
   *  will be created.
   *  Location names are formatted as `projects/

createAzureClient(request, options, callback)

createAzureClient(request: protos.google.cloud.gkemulticloud.v1.ICreateAzureClientRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureClientRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAzureClient(request, callback)

createAzureClient(request: protos.google.cloud.gkemulticloud.v1.ICreateAzureClientRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureClientRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAzureCluster(request, options)

createAzureCluster(request?: protos.google.cloud.gkemulticloud.v1.ICreateAzureClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new resource on a given GCP project and region.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureClusterRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 parent location where this AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource
   *  will be created.
   *  Location names are formatted as `projects/

createAzureCluster(request, options, callback)

createAzureCluster(request: protos.google.cloud.gkemulticloud.v1.ICreateAzureClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureClusterRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAzureCluster(request, callback)

createAzureCluster(request: protos.google.cloud.gkemulticloud.v1.ICreateAzureClusterRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureClusterRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAzureNodePool(request, options)

createAzureNodePool(request?: protos.google.cloud.gkemulticloud.v1.ICreateAzureNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new , attached to a given .

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureNodePoolRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource where this node pool will be created.
   *  Location names are formatted as `projects/

createAzureNodePool(request, options, callback)

createAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.ICreateAzureNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureNodePoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAzureNodePool(request, callback)

createAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.ICreateAzureNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.ICreateAzureNodePoolRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAzureClient(request, options)

deleteAzureClient(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAzureClientRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a specific resource.

If the client is used by one or more clusters, deletion will fail and a FAILED_PRECONDITION error will be returned.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureClientRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 name the AzureClient google.cloud.gkemulticloud.v1.AzureClient  to delete.
   *  AzureClient google.cloud.gkemulticloud.v1.AzureClient  names are formatted as
   *  `projects/

deleteAzureClient(request, options, callback)

deleteAzureClient(request: protos.google.cloud.gkemulticloud.v1.IDeleteAzureClientRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureClientRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAzureClient(request, callback)

deleteAzureClient(request: protos.google.cloud.gkemulticloud.v1.IDeleteAzureClientRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureClientRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAzureCluster(request, options)

deleteAzureCluster(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAzureClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a specific resource.

Fails if the cluster has one or more associated resources.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureClusterRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 name the AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  to delete.
   *  `AzureCluster` names are formatted as
   *  `projects/

deleteAzureCluster(request, options, callback)

deleteAzureCluster(request: protos.google.cloud.gkemulticloud.v1.IDeleteAzureClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureClusterRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAzureCluster(request, callback)

deleteAzureCluster(request: protos.google.cloud.gkemulticloud.v1.IDeleteAzureClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureClusterRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAzureNodePool(request, options)

deleteAzureNodePool(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAzureNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a specific resource.

If successful, the response contains a newly created resource that can be described to track the status of the operation.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureNodePoolRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 name the AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool  to delete.
   *  `AzureNodePool` names are formatted as
   *  `projects/

deleteAzureNodePool(request, options, callback)

deleteAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.IDeleteAzureNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureNodePoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAzureNodePool(request, callback)

deleteAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.IDeleteAzureNodePoolRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IDeleteAzureNodePoolRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateAzureAccessToken(request, options)

generateAzureAccessToken(request?: protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenResponse,
        (protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest | undefined),
        {} | undefined
    ]>;

Generates a short-lived access token to authenticate to a given resource.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenResponse, (protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest \| undefined), {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [GenerateAzureAccessTokenResponse]. 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 name of the AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource to authenticate to.
   *  `AzureCluster` names are formatted as
   *  `projects/

generateAzureAccessToken(request, options, callback)

generateAzureAccessToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateAzureAccessToken(request, callback)

generateAzureAccessToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAzureAccessTokenRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureClient(request, options)

getAzureClient(request?: protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureClient,
        protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest | undefined,
        {} | undefined
    ]>;

Describes a specific resource.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AzureClient]. 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 name of the AzureClient google.cloud.gkemulticloud.v1.AzureClient  resource to describe.
   *  AzureClient google.cloud.gkemulticloud.v1.AzureClient  names are formatted as
   *  `projects/

getAzureClient(request, options, callback)

getAzureClient(request: protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureClient(request, callback)

getAzureClient(request: protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureClient, protos.google.cloud.gkemulticloud.v1.IGetAzureClientRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureCluster(request, options)

getAzureCluster(request?: protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureCluster,
        protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest | undefined,
        {} | undefined
    ]>;

Describes a specific resource.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AzureCluster]. 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 name of the AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource to describe.
   *  `AzureCluster` names are formatted as
   *  `projects/

getAzureCluster(request, options, callback)

getAzureCluster(request: protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureCluster(request, callback)

getAzureCluster(request: protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IGetAzureClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureNodePool(request, options)

getAzureNodePool(request?: protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureNodePool,
        protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest | undefined,
        {} | undefined
    ]>;

Describes a specific resource.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AzureNodePool]. 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 name of the AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool  resource to describe.
   *  `AzureNodePool` names are formatted as
   *  `projects/

getAzureNodePool(request, options, callback)

getAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureNodePool(request, callback)

getAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IGetAzureNodePoolRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureServerConfig(request, options)

getAzureServerConfig(request?: protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureServerConfig,
        (protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest | undefined),
        {} | undefined
    ]>;

Returns information, such as supported Azure regions and Kubernetes versions, on a given Google Cloud location.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureServerConfig, (protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest \| undefined), {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AzureServerConfig]. 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 name of the AzureServerConfig google.cloud.gkemulticloud.v1.AzureServerConfig  resource to describe.
   *  `AzureServerConfig` names are formatted as
   *  `projects/

getAzureServerConfig(request, options, callback)

getAzureServerConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAzureServerConfig(request, callback)

getAzureServerConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAzureServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest`
callback	`Callback<protos.google.cloud.gkemulticloud.v1.IAzureServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAzureServerConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
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

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listAzureClients(request, options)

listAzureClients(request?: protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureClient[],
        protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest | null,
        protos.google.cloud.gkemulticloud.v1.IListAzureClientsResponse
    ]>;

Lists all resources on a given Google Cloud project and region.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureClient[], protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest | null, protos.google.cloud.gkemulticloud.v1.IListAzureClientsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [AzureClient]. 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 listAzureClientsAsync() 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.

listAzureClients(request, options, callback)

listAzureClients(request: protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClientsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAzureClient>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClientsResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAzureClient>`

Returns

Type	Description
void

listAzureClients(request, callback)

listAzureClients(request: protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClientsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAzureClient>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClientsResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAzureClient>`

Returns

Type	Description
void

listAzureClientsAsync(request, options)

listAzureClientsAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAzureClient>;

Equivalent to listAzureClients, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAzureClient>

{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 [AzureClient]. 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 parent location which owns this collection of
   *  AzureClient google.cloud.gkemulticloud.v1.AzureClient  resources.
   *  Location names are formatted as `projects/

listAzureClientsStream(request, options)

listAzureClientsStream(request?: protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClientsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [AzureClient] 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 listAzureClientsAsync() 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.

listAzureClusters(request, options)

listAzureClusters(request?: protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureCluster[],
        protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest | null,
        protos.google.cloud.gkemulticloud.v1.IListAzureClustersResponse
    ]>;

Lists all resources on a given Google Cloud project and region.

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureCluster[], protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest | null, protos.google.cloud.gkemulticloud.v1.IListAzureClustersResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [AzureCluster]. 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 listAzureClustersAsync() 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.

listAzureClusters(request, options, callback)

listAzureClusters(request: protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAzureCluster>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClustersResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAzureCluster>`

Returns

Type	Description
void

listAzureClusters(request, callback)

listAzureClusters(request: protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAzureCluster>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAzureClustersResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAzureCluster>`

Returns

Type	Description
void

listAzureClustersAsync(request, options)

listAzureClustersAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAzureCluster>;

Equivalent to listAzureClusters, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAzureCluster>

{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 [AzureCluster]. 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 parent location which owns this collection of
   *  AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resources.
   *  Location names are formatted as `projects/

listAzureClustersStream(request, options)

listAzureClustersStream(request?: protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureClustersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [AzureCluster] 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 listAzureClustersAsync() 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.

listAzureNodePools(request, options)

listAzureNodePools(request?: protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkemulticloud.v1.IAzureNodePool[],
        protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest | null,
        protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsResponse
    ]>;

Lists all resources on a given .

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.gkemulticloud.v1.IAzureNodePool[], protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest | null, protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [AzureNodePool]. 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 listAzureNodePoolsAsync() 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.

listAzureNodePools(request, options, callback)

listAzureNodePools(request: protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAzureNodePool>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAzureNodePool>`

Returns

Type	Description
void

listAzureNodePools(request, callback)

listAzureNodePools(request: protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAzureNodePool>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest`
callback	`PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsResponse \| null \| undefined, protos.google.cloud.gkemulticloud.v1.IAzureNodePool>`

Returns

Type	Description
void

listAzureNodePoolsAsync(request, options)

listAzureNodePoolsAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAzureNodePool>;

Equivalent to listAzureNodePools, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAzureNodePool>

{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 [AzureNodePool]. 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 parent `AzureCluster` which owns this collection of
   *  AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool  resources.
   *  `AzureCluster` names are formatted as
   *  `projects/

listAzureNodePoolsStream(request, options)

listAzureNodePoolsStream(request?: protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IListAzureNodePoolsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [AzureNodePool] 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 listAzureNodePoolsAsync() 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

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchAwsClusterFromAwsClusterName(awsClusterName)

matchAwsClusterFromAwsClusterName(awsClusterName: string): string | number;

Parse the aws_cluster from AwsCluster resource.

Parameter

Name	Description
awsClusterName	`string` A fully-qualified path representing AwsCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the aws_cluster.

matchAwsClusterFromAwsNodePoolName(awsNodePoolName)

matchAwsClusterFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the aws_cluster from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the aws_cluster.

matchAwsNodePoolFromAwsNodePoolName(awsNodePoolName)

matchAwsNodePoolFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the aws_node_pool from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the aws_node_pool.

matchAzureClientFromAzureClientName(azureClientName)

matchAzureClientFromAzureClientName(azureClientName: string): string | number;

Parse the azure_client from AzureClient resource.

Parameter

Name	Description
azureClientName	`string` A fully-qualified path representing AzureClient resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_client.

matchAzureClusterFromAzureClusterName(azureClusterName)

matchAzureClusterFromAzureClusterName(azureClusterName: string): string | number;

Parse the azure_cluster from AzureCluster resource.

Parameter

Name	Description
azureClusterName	`string` A fully-qualified path representing AzureCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_cluster.

matchAzureClusterFromAzureNodePoolName(azureNodePoolName)

matchAzureClusterFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the azure_cluster from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_cluster.

matchAzureNodePoolFromAzureNodePoolName(azureNodePoolName)

matchAzureNodePoolFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the azure_node_pool from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the azure_node_pool.

matchLocationFromAwsClusterName(awsClusterName)

matchLocationFromAwsClusterName(awsClusterName: string): string | number;

Parse the location from AwsCluster resource.

Parameter

Name	Description
awsClusterName	`string` A fully-qualified path representing AwsCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAwsNodePoolName(awsNodePoolName)

matchLocationFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the location from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAwsServerConfigName(awsServerConfigName)

matchLocationFromAwsServerConfigName(awsServerConfigName: string): string | number;

Parse the location from AwsServerConfig resource.

Parameter

Name	Description
awsServerConfigName	`string` A fully-qualified path representing AwsServerConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAzureClientName(azureClientName)

matchLocationFromAzureClientName(azureClientName: string): string | number;

Parse the location from AzureClient resource.

Parameter

Name	Description
azureClientName	`string` A fully-qualified path representing AzureClient resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAzureClusterName(azureClusterName)

matchLocationFromAzureClusterName(azureClusterName: string): string | number;

Parse the location from AzureCluster resource.

Parameter

Name	Description
azureClusterName	`string` A fully-qualified path representing AzureCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAzureNodePoolName(azureNodePoolName)

matchLocationFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the location from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAzureServerConfigName(azureServerConfigName)

matchLocationFromAzureServerConfigName(azureServerConfigName: string): string | number;

Parse the location from AzureServerConfig resource.

Parameter

Name	Description
azureServerConfigName	`string` A fully-qualified path representing AzureServerConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchProjectFromAwsClusterName(awsClusterName)

matchProjectFromAwsClusterName(awsClusterName: string): string | number;

Parse the project from AwsCluster resource.

Parameter

Name	Description
awsClusterName	`string` A fully-qualified path representing AwsCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAwsNodePoolName(awsNodePoolName)

matchProjectFromAwsNodePoolName(awsNodePoolName: string): string | number;

Parse the project from AwsNodePool resource.

Parameter

Name	Description
awsNodePoolName	`string` A fully-qualified path representing AwsNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAwsServerConfigName(awsServerConfigName)

matchProjectFromAwsServerConfigName(awsServerConfigName: string): string | number;

Parse the project from AwsServerConfig resource.

Parameter

Name	Description
awsServerConfigName	`string` A fully-qualified path representing AwsServerConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAzureClientName(azureClientName)

matchProjectFromAzureClientName(azureClientName: string): string | number;

Parse the project from AzureClient resource.

Parameter

Name	Description
azureClientName	`string` A fully-qualified path representing AzureClient resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAzureClusterName(azureClusterName)

matchProjectFromAzureClusterName(azureClusterName: string): string | number;

Parse the project from AzureCluster resource.

Parameter

Name	Description
azureClusterName	`string` A fully-qualified path representing AzureCluster resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAzureNodePoolName(azureNodePoolName)

matchProjectFromAzureNodePoolName(azureNodePoolName: string): string | number;

Parse the project from AzureNodePool resource.

Parameter

Name	Description
azureNodePoolName	`string` A fully-qualified path representing AzureNodePool resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAzureServerConfigName(azureServerConfigName)

matchProjectFromAzureServerConfigName(azureServerConfigName: string): string | number;

Parse the project from AzureServerConfig resource.

Parameter

Name	Description
azureServerConfigName	`string` A fully-qualified path representing AzureServerConfig resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

updateAzureCluster(request, options)

updateAzureCluster(request?: protos.google.cloud.gkemulticloud.v1.IUpdateAzureClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an .

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAzureClusterRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 AzureCluster google.cloud.gkemulticloud.v1.AzureCluster  resource to update.
   */
  // const azureCluster = {}
  /**
   *  If set, only validate the request, but do not actually update the cluster.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AzureCluster google.cloud.gkemulticloud.v1.AzureCluster:
   *   *   `description`.
   *   *   `annotations`.
   *   *   `azureClient`.
   *   *   `control_plane.version`.
   *   *   `control_plane.vm_size`.
   *   *   `authorization.admin_users`.
   *   *   `control_plane.root_volume.size_gib`.
   *   *   `logging_config`
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AzureClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AzureClustersClient();

  async function callUpdateAzureCluster() {
    // Construct request
    const request = {
      azureCluster,
      updateMask,
    };

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

  callUpdateAzureCluster();

updateAzureCluster(request, options, callback)

updateAzureCluster(request: protos.google.cloud.gkemulticloud.v1.IUpdateAzureClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAzureClusterRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAzureCluster(request, callback)

updateAzureCluster(request: protos.google.cloud.gkemulticloud.v1.IUpdateAzureClusterRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAzureClusterRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAzureNodePool(request, options)

updateAzureNodePool(request?: protos.google.cloud.gkemulticloud.v1.IUpdateAzureNodePoolRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an .

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAzureNodePoolRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, 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 AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool  resource to update.
   */
  // const azureNodePool = {}
  /**
   *  If set, only validate the request, but don't actually update the node pool.
   */
  // const validateOnly = true
  /**
   *  Required. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field can only include these
   *  fields from AzureNodePool google.cloud.gkemulticloud.v1.AzureNodePool:
   *   *.  `annotations`.
   *   *   `version`.
   *   *   `autoscaling.min_node_count`.
   *   *   `autoscaling.max_node_count`.
   *   *   `config.vm_size`.
   */
  // const updateMask = {}

  // Imports the Gkemulticloud library
  const {AzureClustersClient} = require('@google-cloud/gkemulticloud').v1;

  // Instantiates a client
  const gkemulticloudClient = new AzureClustersClient();

  async function callUpdateAzureNodePool() {
    // Construct request
    const request = {
      azureNodePool,
      updateMask,
    };

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

  callUpdateAzureNodePool();

updateAzureNodePool(request, options, callback)

updateAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.IUpdateAzureNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAzureNodePoolRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAzureNodePool(request, callback)

updateAzureNodePool(request: protos.google.cloud.gkemulticloud.v1.IUpdateAzureNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkemulticloud.v1.IUpdateAzureNodePoolRequest`
callback	`Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAzureNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void