Class AzureClustersClient (0.1.1) 

AzureClustersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gke_multicloud_v1.services.azure_clusters.transports.base.AzureClustersTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
AzureClustersTransportThe transport used by the client instance.

Methods

AzureClustersClient

AzureClustersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.gke_multicloud_v1.services.azure_clusters.transports.base.AzureClustersTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the azure clusters client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, AzureClustersTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

azure_client_path

azure_client_path(project: str, location: str, azure_client: str)

Returns a fully-qualified azure_client string.

azure_cluster_path

azure_cluster_path(project: str, location: str, azure_cluster: str)

Returns a fully-qualified azure_cluster string.

azure_node_pool_path

azure_node_pool_path(
    project: str, location: str, azure_cluster: str, azure_node_pool: str
)

Returns a fully-qualified azure_node_pool string.

azure_server_config_path

azure_server_config_path(project: str, location: str)

Returns a fully-qualified azure_server_config string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_azure_client

create_azure_client(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.CreateAzureClientRequest, dict]] = None, *, parent: Optional[str] = None, azure_client: Optional[google.cloud.gke_multicloud_v1.types.azure_resources.AzureClient] = None, azure_client_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new xref_AzureClient 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 Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

from google.cloud import gke_multicloud_v1

def sample_create_azure_client():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    azure_client = gke_multicloud_v1.AzureClient()
    azure_client.tenant_id = "tenant_id_value"
    azure_client.application_id = "application_id_value"

    request = gke_multicloud_v1.CreateAzureClientRequest(
        parent="parent_value",
        azure_client=azure_client,
        azure_client_id="azure_client_id_value",
    )

    # Make the request
    operation = client.create_azure_client(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.CreateAzureClientRequest, dict]

The request object. Request message for AzureClusters.CreateAzureClient method.

parent str

Required. The parent location where this AzureClient resource will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

azure_client google.cloud.gke_multicloud_v1.types.AzureClient

Required. The specification of the AzureClient to create. This corresponds to the azure_client field on the request instance; if request is provided, this should not be set.

azure_client_id str

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AzureClient resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 40 characters. This corresponds to the azure_client_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be AzureClient AzureClient resources hold client authentication information needed by the Anthos Multi-Cloud API to manage Azure resources on your Azure subscription. When an AzureCluster is created, an AzureClient resource needs to be provided and all operations on Azure resources associated to that cluster will authenticate to Azure services using the given client. AzureClient resources are immutable and cannot be modified upon creation. Each AzureClient resource is bound to a single Azure Active Directory Application and tenant.

create_azure_cluster

create_azure_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.CreateAzureClusterRequest, dict]] = None, *, parent: Optional[str] = None, azure_cluster: Optional[google.cloud.gke_multicloud_v1.types.azure_resources.AzureCluster] = None, azure_cluster_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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

from google.cloud import gke_multicloud_v1

def sample_create_azure_cluster():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    azure_cluster = gke_multicloud_v1.AzureCluster()
    azure_cluster.azure_region = "azure_region_value"
    azure_cluster.resource_group_id = "resource_group_id_value"
    azure_cluster.azure_client = "azure_client_value"
    azure_cluster.networking.virtual_network_id = "virtual_network_id_value"
    azure_cluster.networking.pod_address_cidr_blocks = ['pod_address_cidr_blocks_value_1', 'pod_address_cidr_blocks_value_2']
    azure_cluster.networking.service_address_cidr_blocks = ['service_address_cidr_blocks_value_1', 'service_address_cidr_blocks_value_2']
    azure_cluster.control_plane.version = "version_value"
    azure_cluster.control_plane.ssh_config.authorized_key = "authorized_key_value"
    azure_cluster.authorization.admin_users.username = "username_value"

    request = gke_multicloud_v1.CreateAzureClusterRequest(
        parent="parent_value",
        azure_cluster=azure_cluster,
        azure_cluster_id="azure_cluster_id_value",
    )

    # Make the request
    operation = client.create_azure_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.CreateAzureClusterRequest, dict]

The request object. Request message for AzureClusters.CreateAzureCluster method.

parent str

Required. The parent location where this AzureCluster resource will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

azure_cluster google.cloud.gke_multicloud_v1.types.AzureCluster

Required. The specification of the AzureCluster to create. This corresponds to the azure_cluster field on the request instance; if request is provided, this should not be set.

azure_cluster_id str

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AzureCluster resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 40 characters. This corresponds to the azure_cluster_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be AzureCluster An Anthos cluster running on Azure.

create_azure_node_pool

create_azure_node_pool(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.CreateAzureNodePoolRequest, dict]] = None, *, parent: Optional[str] = None, azure_node_pool: Optional[google.cloud.gke_multicloud_v1.types.azure_resources.AzureNodePool] = None, azure_node_pool_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new xref_AzureNodePool, attached to a given xref_AzureCluster.

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

from google.cloud import gke_multicloud_v1

def sample_create_azure_node_pool():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    azure_node_pool = gke_multicloud_v1.AzureNodePool()
    azure_node_pool.version = "version_value"
    azure_node_pool.config.ssh_config.authorized_key = "authorized_key_value"
    azure_node_pool.subnet_id = "subnet_id_value"
    azure_node_pool.autoscaling.min_node_count = 1489
    azure_node_pool.autoscaling.max_node_count = 1491
    azure_node_pool.max_pods_constraint.max_pods_per_node = 1798

    request = gke_multicloud_v1.CreateAzureNodePoolRequest(
        parent="parent_value",
        azure_node_pool=azure_node_pool,
        azure_node_pool_id="azure_node_pool_id_value",
    )

    # Make the request
    operation = client.create_azure_node_pool(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.CreateAzureNodePoolRequest, dict]

The request object. Response message for AzureClusters.CreateAzureNodePool method.

parent str

Required. The AzureCluster resource where this node pool will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

azure_node_pool google.cloud.gke_multicloud_v1.types.AzureNodePool

Required. The specification of the AzureNodePool to create. This corresponds to the azure_node_pool field on the request instance; if request is provided, this should not be set.

azure_node_pool_id str

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AzureNodePool resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 40 characters. This corresponds to the azure_node_pool_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be AzureNodePool An Anthos node pool running on Azure.

delete_azure_client

delete_azure_client(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.DeleteAzureClientRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a specific xref_AzureClient 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 Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

from google.cloud import gke_multicloud_v1

def sample_delete_azure_client():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.DeleteAzureClientRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_azure_client(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.DeleteAzureClientRequest, dict]

The request object. Request message for AzureClusters.DeleteAzureClient method.

name str

Required. The resource name the AzureClient to delete. AzureClient names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_azure_cluster

delete_azure_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.DeleteAzureClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a specific xref_AzureCluster resource.

Fails if the cluster has one or more associated xref_AzureNodePool resources.

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

from google.cloud import gke_multicloud_v1

def sample_delete_azure_cluster():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.DeleteAzureClusterRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_azure_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.DeleteAzureClusterRequest, dict]

The request object. Request message for Clusters.DeleteAzureCluster method.

name str

Required. The resource name the AzureCluster to delete. AzureCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on GCP resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_azure_node_pool

delete_azure_node_pool(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.DeleteAzureNodePoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a specific xref_AzureNodePool resource.

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

from google.cloud import gke_multicloud_v1

def sample_delete_azure_node_pool():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.DeleteAzureNodePoolRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_azure_node_pool(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.DeleteAzureNodePoolRequest, dict]

The request object. Delete message for AzureClusters.DeleteNodePool method.

name str

Required. The resource name the AzureNodePool to delete. AzureNodePool names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
AzureClustersClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
AzureClustersClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
AzureClustersClientThe constructed client.

generate_azure_access_token

generate_azure_access_token(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.GenerateAzureAccessTokenRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import gke_multicloud_v1

def sample_generate_azure_access_token():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GenerateAzureAccessTokenRequest(
        azure_cluster="azure_cluster_value",
    )

    # Make the request
    response = client.generate_azure_access_token(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.GenerateAzureAccessTokenRequest, dict]

The request object. Request message for AzureClusters.GenerateAzureAccessToken method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.types.GenerateAzureAccessTokenResponseResponse message for AzureClusters.GenerateAzureAccessToken method.

get_azure_client

get_azure_client(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.GetAzureClientRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Describes a specific xref_AzureClient resource.

from google.cloud import gke_multicloud_v1

def sample_get_azure_client():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAzureClientRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_azure_client(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.GetAzureClientRequest, dict]

The request object. Request message for AzureClusters.GetAzureClient method.

name str

Required. The name of the AzureClient resource to describe. AzureClient names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.types.AzureClientAzureClient resources hold client authentication information needed by the Anthos Multi-Cloud API to manage Azure resources on your Azure subscription. When an AzureCluster is created, an AzureClient resource needs to be provided and all operations on Azure resources associated to that cluster will authenticate to Azure services using the given client. AzureClient resources are immutable and cannot be modified upon creation. Each AzureClient resource is bound to a single Azure Active Directory Application and tenant.

get_azure_cluster

get_azure_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.GetAzureClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Describes a specific xref_AzureCluster resource.

from google.cloud import gke_multicloud_v1

def sample_get_azure_cluster():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAzureClusterRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_azure_cluster(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.GetAzureClusterRequest, dict]

The request object. Request message for AzureClusters.GetAzureCluster method.

name str

Required. The name of the AzureCluster resource to describe. AzureCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on GCP resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.types.AzureClusterAn Anthos cluster running on Azure.

get_azure_node_pool

get_azure_node_pool(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.GetAzureNodePoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Describes a specific xref_AzureNodePool resource.

from google.cloud import gke_multicloud_v1

def sample_get_azure_node_pool():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAzureNodePoolRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_azure_node_pool(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.GetAzureNodePoolRequest, dict]

The request object. Request message for AzureClusters.GetAzureNodePool method.

name str

Required. The name of the AzureNodePool resource to describe. AzureNodePool names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.types.AzureNodePoolAn Anthos node pool running on Azure.

get_azure_server_config

get_azure_server_config(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.GetAzureServerConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import gke_multicloud_v1

def sample_get_azure_server_config():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAzureServerConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_azure_server_config(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.GetAzureServerConfigRequest, dict]

The request object. GetAzureServerConfigRequest gets the server config of GKE cluster on Azure.

name str

Required. The name of the AzureServerConfig resource to describe. AzureServerConfig names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.types.AzureServerConfigAzureServerConfig contains information about a Google Cloud location, such as supported Azure regions and Kubernetes versions.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

list_azure_clients

list_azure_clients(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.ListAzureClientsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import gke_multicloud_v1

def sample_list_azure_clients():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ListAzureClientsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_azure_clients(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.ListAzureClientsRequest, dict]

The request object. Request message for AzureClusters.ListAzureClients method.

parent str

Required. The parent location which owns this collection of AzureClient resources. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on GCP resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.services.azure_clusters.pagers.ListAzureClientsPagerResponse message for AzureClusters.ListAzureClients method. Iterating over this object will yield results and resolve additional pages automatically.

list_azure_clusters

list_azure_clusters(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.ListAzureClustersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import gke_multicloud_v1

def sample_list_azure_clusters():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ListAzureClustersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_azure_clusters(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.ListAzureClustersRequest, dict]

The request object. Request message for AzureClusters.ListAzureClusters method.

parent str

Required. The parent location which owns this collection of AzureCluster resources. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on GCP resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.services.azure_clusters.pagers.ListAzureClustersPagerResponse message for AzureClusters.ListAzureClusters method. Iterating over this object will yield results and resolve additional pages automatically.

list_azure_node_pools

list_azure_node_pools(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.ListAzureNodePoolsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all xref_AzureNodePool resources on a given xref_AzureCluster.

from google.cloud import gke_multicloud_v1

def sample_list_azure_node_pools():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ListAzureNodePoolsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_azure_node_pools(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.ListAzureNodePoolsRequest, dict]

The request object. Request message for AzureClusters.ListAzureNodePools method.

parent str

Required. The parent AzureCluster which owns this collection of AzureNodePool resources. AzureCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.gke_multicloud_v1.services.azure_clusters.pagers.ListAzureNodePoolsPagerResponse message for AzureClusters.ListAzureNodePools method. Iterating over this object will yield results and resolve additional pages automatically.

parse_azure_client_path

parse_azure_client_path(path: str)

Parses a azure_client path into its component segments.

parse_azure_cluster_path

parse_azure_cluster_path(path: str)

Parses a azure_cluster path into its component segments.

parse_azure_node_pool_path

parse_azure_node_pool_path(path: str)

Parses a azure_node_pool path into its component segments.

parse_azure_server_config_path

parse_azure_server_config_path(path: str)

Parses a azure_server_config path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

update_azure_cluster

update_azure_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.UpdateAzureClusterRequest, dict]] = None, *, azure_cluster: Optional[google.cloud.gke_multicloud_v1.types.azure_resources.AzureCluster] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an xref_AzureCluster.

from google.cloud import gke_multicloud_v1

def sample_update_azure_cluster():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    azure_cluster = gke_multicloud_v1.AzureCluster()
    azure_cluster.azure_region = "azure_region_value"
    azure_cluster.resource_group_id = "resource_group_id_value"
    azure_cluster.azure_client = "azure_client_value"
    azure_cluster.networking.virtual_network_id = "virtual_network_id_value"
    azure_cluster.networking.pod_address_cidr_blocks = ['pod_address_cidr_blocks_value_1', 'pod_address_cidr_blocks_value_2']
    azure_cluster.networking.service_address_cidr_blocks = ['service_address_cidr_blocks_value_1', 'service_address_cidr_blocks_value_2']
    azure_cluster.control_plane.version = "version_value"
    azure_cluster.control_plane.ssh_config.authorized_key = "authorized_key_value"
    azure_cluster.authorization.admin_users.username = "username_value"

    request = gke_multicloud_v1.UpdateAzureClusterRequest(
        azure_cluster=azure_cluster,
    )

    # Make the request
    operation = client.update_azure_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.UpdateAzureClusterRequest, dict]

The request object. Request message for AzureClusters.UpdateAzureCluster method.

azure_cluster google.cloud.gke_multicloud_v1.types.AzureCluster

Required. The AzureCluster resource to update. This corresponds to the azure_cluster field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

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: - description. - annotations. - azureClient. - control_plane.version. - control_plane.vm_size. - authorization.admin_users. - control_plane.root_volume.size_gib. - logging_config This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be AzureCluster An Anthos cluster running on Azure.

update_azure_node_pool

update_azure_node_pool(request: Optional[Union[google.cloud.gke_multicloud_v1.types.azure_service.UpdateAzureNodePoolRequest, dict]] = None, *, azure_node_pool: Optional[google.cloud.gke_multicloud_v1.types.azure_resources.AzureNodePool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an xref_AzureNodePool.

from google.cloud import gke_multicloud_v1

def sample_update_azure_node_pool():
    # Create a client
    client = gke_multicloud_v1.AzureClustersClient()

    # Initialize request argument(s)
    azure_node_pool = gke_multicloud_v1.AzureNodePool()
    azure_node_pool.version = "version_value"
    azure_node_pool.config.ssh_config.authorized_key = "authorized_key_value"
    azure_node_pool.subnet_id = "subnet_id_value"
    azure_node_pool.autoscaling.min_node_count = 1489
    azure_node_pool.autoscaling.max_node_count = 1491
    azure_node_pool.max_pods_constraint.max_pods_per_node = 1798

    request = gke_multicloud_v1.UpdateAzureNodePoolRequest(
        azure_node_pool=azure_node_pool,
    )

    # Make the request
    operation = client.update_azure_node_pool(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.gke_multicloud_v1.types.UpdateAzureNodePoolRequest, dict]

The request object. Request message for AzureClusters.UpdateAzureNodePool method.

azure_node_pool google.cloud.gke_multicloud_v1.types.AzureNodePool

Required. The AzureNodePool resource to update. This corresponds to the azure_node_pool field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

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: *. annotations. - version. - autoscaling.min_node_count. - autoscaling.max_node_count. - config.vm_size. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be AzureNodePool An Anthos node pool running on Azure.