The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
AzureClustersClient(AzureClustersClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AzureClustersClient const &
|
AzureClustersClient(AzureClustersClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AzureClustersClient &&
|
AzureClustersClient(std::shared_ptr< AzureClustersConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AzureClustersConnection >
|
opts |
Options
|
Operators
operator=(AzureClustersClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AzureClustersClient const &
|
Returns | |
---|---|
Type | Description |
AzureClustersClient & |
operator=(AzureClustersClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AzureClustersClient &&
|
Returns | |
---|---|
Type | Description |
AzureClustersClient & |
Functions
CreateAzureClient(std::string const &, google::cloud::gkemulticloud::v1::AzureClient const &, std::string const &, Options)
Creates a new 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 resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location where this AzureClient resource will be created. |
azure_client |
google::cloud::gkemulticloud::v1::AzureClient const &
Required. The specification of the AzureClient to create. |
azure_client_id |
std::string const &
Required. A client provided ID the resource. Must be unique within the parent resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureClient > > |
A |
CreateAzureClient(google::cloud::gkemulticloud::v1::CreateAzureClientRequest const &, Options)
Creates a new 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 resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::CreateAzureClientRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureClient > > |
A |
GetAzureClient(std::string const &, Options)
Describes a specific AzureClient resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AzureClient resource to describe. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureClient > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureClient) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAzureClient(google::cloud::gkemulticloud::v1::GetAzureClientRequest const &, Options)
Describes a specific AzureClient resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GetAzureClientRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureClient > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureClient) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAzureClients(std::string const &, Options)
Lists all AzureClient resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location which owns this collection of AzureClient resources. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AzureClient > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAzureClients(google::cloud::gkemulticloud::v1::ListAzureClientsRequest, Options)
Lists all AzureClient resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::ListAzureClientsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AzureClient > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteAzureClient(std::string const &, Options)
Deletes a specific 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 resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name the AzureClient to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
DeleteAzureClient(google::cloud::gkemulticloud::v1::DeleteAzureClientRequest const &, Options)
Deletes a specific 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 resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::DeleteAzureClientRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
CreateAzureCluster(std::string const &, google::cloud::gkemulticloud::v1::AzureCluster const &, std::string const &, Options)
Creates a new AzureCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location where this AzureCluster resource will be created. |
azure_cluster |
google::cloud::gkemulticloud::v1::AzureCluster const &
Required. The specification of the AzureCluster to create. |
azure_cluster_id |
std::string const &
Required. A client provided ID the resource. Must be unique within the parent resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureCluster > > |
A |
CreateAzureCluster(google::cloud::gkemulticloud::v1::CreateAzureClusterRequest const &, Options)
Creates a new AzureCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::CreateAzureClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureCluster > > |
A |
UpdateAzureCluster(google::cloud::gkemulticloud::v1::AzureCluster const &, google::protobuf::FieldMask const &, Options)
Updates an AzureCluster.
Parameters | |
---|---|
Name | Description |
azure_cluster |
google::cloud::gkemulticloud::v1::AzureCluster const &
Required. The AzureCluster resource to update. |
update_mask |
google::protobuf::FieldMask const &
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:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureCluster > > |
A |
UpdateAzureCluster(google::cloud::gkemulticloud::v1::UpdateAzureClusterRequest const &, Options)
Updates an AzureCluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::UpdateAzureClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureCluster > > |
A |
GetAzureCluster(std::string const &, Options)
Describes a specific AzureCluster resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AzureCluster resource to describe. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureCluster > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAzureCluster(google::cloud::gkemulticloud::v1::GetAzureClusterRequest const &, Options)
Describes a specific AzureCluster resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GetAzureClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureCluster > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAzureClusters(std::string const &, Options)
Lists all AzureCluster resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent location which owns this collection of AzureCluster resources. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AzureCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAzureClusters(google::cloud::gkemulticloud::v1::ListAzureClustersRequest, Options)
Lists all AzureCluster resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::ListAzureClustersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AzureCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteAzureCluster(std::string const &, Options)
Deletes a specific AzureCluster resource.
Fails if the cluster has one or more associated AzureNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name the AzureCluster to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
DeleteAzureCluster(google::cloud::gkemulticloud::v1::DeleteAzureClusterRequest const &, Options)
Deletes a specific AzureCluster resource.
Fails if the cluster has one or more associated AzureNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::DeleteAzureClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
GenerateAzureAccessToken(google::cloud::gkemulticloud::v1::GenerateAzureAccessTokenRequest const &, Options)
Generates a short-lived access token to authenticate to a given AzureCluster resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GenerateAzureAccessTokenRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::GenerateAzureAccessTokenResponse > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAzureAccessTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAzureNodePool(std::string const &, google::cloud::gkemulticloud::v1::AzureNodePool const &, std::string const &, Options)
Creates a new AzureNodePool, attached to a given AzureCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The AzureCluster resource where this node pool will be created. |
azure_node_pool |
google::cloud::gkemulticloud::v1::AzureNodePool const &
Required. The specification of the AzureNodePool to create. |
azure_node_pool_id |
std::string const &
Required. A client provided ID the resource. Must be unique within the parent resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureNodePool > > |
A |
CreateAzureNodePool(google::cloud::gkemulticloud::v1::CreateAzureNodePoolRequest const &, Options)
Creates a new AzureNodePool, attached to a given AzureCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::CreateAzureNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureNodePool > > |
A |
UpdateAzureNodePool(google::cloud::gkemulticloud::v1::AzureNodePool const &, google::protobuf::FieldMask const &, Options)
Updates an AzureNodePool.
Parameters | |
---|---|
Name | Description |
azure_node_pool |
google::cloud::gkemulticloud::v1::AzureNodePool const &
Required. The AzureNodePool resource to update. |
update_mask |
google::protobuf::FieldMask const &
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:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureNodePool > > |
A |
UpdateAzureNodePool(google::cloud::gkemulticloud::v1::UpdateAzureNodePoolRequest const &, Options)
Updates an AzureNodePool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::UpdateAzureNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::AzureNodePool > > |
A |
GetAzureNodePool(std::string const &, Options)
Describes a specific AzureNodePool resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AzureNodePool resource to describe. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureNodePool > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureNodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAzureNodePool(google::cloud::gkemulticloud::v1::GetAzureNodePoolRequest const &, Options)
Describes a specific AzureNodePool resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GetAzureNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureNodePool > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureNodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAzureNodePools(std::string const &, Options)
Lists all AzureNodePool resources on a given AzureCluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AzureNodePool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAzureNodePools(google::cloud::gkemulticloud::v1::ListAzureNodePoolsRequest, Options)
Lists all AzureNodePool resources on a given AzureCluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::ListAzureNodePoolsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkemulticloud::v1::AzureNodePool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteAzureNodePool(std::string const &, Options)
Deletes a specific AzureNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name the AzureNodePool to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
DeleteAzureNodePool(google::cloud::gkemulticloud::v1::DeleteAzureNodePoolRequest const &, Options)
Deletes a specific AzureNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::DeleteAzureNodePoolRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > > |
A |
GetAzureServerConfig(std::string const &, Options)
Returns information, such as supported Azure regions and Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the AzureServerConfig resource to describe. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureServerConfig > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAzureServerConfig(google::cloud::gkemulticloud::v1::GetAzureServerConfigRequest const &, Options)
Returns information, such as supported Azure regions and Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkemulticloud::v1::GetAzureServerConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkemulticloud::v1::AzureServerConfig > |
the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |