public sealed class InstancesClientImpl : InstancesClientReference documentation and code samples for the Compute Engine v1 API class InstancesClientImpl.
Instances client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.ComputeV1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The Instances API.
Constructors
InstancesClientImpl(InstancesClient, InstancesSettings, ILogger)
public InstancesClientImpl(Instances.InstancesClient grpcClient, InstancesSettings settings, ILogger logger)Constructs a client wrapper for the Instances service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | InstancesInstancesClientThe underlying gRPC client. |
settings | InstancesSettingsThe base InstancesSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
AddAccessConfigOperationsClient
public override OperationsClient AddAccessConfigOperationsClient { get; }The long-running operations client for AddAccessConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
AddResourcePoliciesOperationsClient
public override OperationsClient AddResourcePoliciesOperationsClient { get; }The long-running operations client for AddResourcePolicies.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
AttachDiskOperationsClient
public override OperationsClient AttachDiskOperationsClient { get; }The long-running operations client for AttachDisk.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
BulkInsertOperationsClient
public override OperationsClient BulkInsertOperationsClient { get; }The long-running operations client for BulkInsert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteAccessConfigOperationsClient
public override OperationsClient DeleteAccessConfigOperationsClient { get; }The long-running operations client for DeleteAccessConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteOperationsClient
public override OperationsClient DeleteOperationsClient { get; }The long-running operations client for Delete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DetachDiskOperationsClient
public override OperationsClient DetachDiskOperationsClient { get; }The long-running operations client for DetachDisk.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override Instances.InstancesClient GrpcClient { get; }The underlying gRPC Instances client
| Property Value | |
|---|---|
| Type | Description |
InstancesInstancesClient | |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
RemoveResourcePoliciesOperationsClient
public override OperationsClient RemoveResourcePoliciesOperationsClient { get; }The long-running operations client for RemoveResourcePolicies.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ResetOperationsClient
public override OperationsClient ResetOperationsClient { get; }The long-running operations client for Reset.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ResumeOperationsClient
public override OperationsClient ResumeOperationsClient { get; }The long-running operations client for Resume.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetDeletionProtectionOperationsClient
public override OperationsClient SetDeletionProtectionOperationsClient { get; }The long-running operations client for SetDeletionProtection.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetDiskAutoDeleteOperationsClient
public override OperationsClient SetDiskAutoDeleteOperationsClient { get; }The long-running operations client for SetDiskAutoDelete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetLabelsOperationsClient
public override OperationsClient SetLabelsOperationsClient { get; }The long-running operations client for SetLabels.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetMachineResourcesOperationsClient
public override OperationsClient SetMachineResourcesOperationsClient { get; }The long-running operations client for SetMachineResources.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetMachineTypeOperationsClient
public override OperationsClient SetMachineTypeOperationsClient { get; }The long-running operations client for SetMachineType.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetMetadataOperationsClient
public override OperationsClient SetMetadataOperationsClient { get; }The long-running operations client for SetMetadata.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetMinCpuPlatformOperationsClient
public override OperationsClient SetMinCpuPlatformOperationsClient { get; }The long-running operations client for SetMinCpuPlatform.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetNameOperationsClient
public override OperationsClient SetNameOperationsClient { get; }The long-running operations client for SetName.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetSchedulingOperationsClient
public override OperationsClient SetSchedulingOperationsClient { get; }The long-running operations client for SetScheduling.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetServiceAccountOperationsClient
public override OperationsClient SetServiceAccountOperationsClient { get; }The long-running operations client for SetServiceAccount.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetShieldedInstanceIntegrityPolicyOperationsClient
public override OperationsClient SetShieldedInstanceIntegrityPolicyOperationsClient { get; }The long-running operations client for SetShieldedInstanceIntegrityPolicy.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetTagsOperationsClient
public override OperationsClient SetTagsOperationsClient { get; }The long-running operations client for SetTags.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SimulateMaintenanceEventOperationsClient
public override OperationsClient SimulateMaintenanceEventOperationsClient { get; }The long-running operations client for SimulateMaintenanceEvent.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
StartOperationsClient
public override OperationsClient StartOperationsClient { get; }The long-running operations client for Start.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
StartWithEncryptionKeyOperationsClient
public override OperationsClient StartWithEncryptionKeyOperationsClient { get; }The long-running operations client for StartWithEncryptionKey.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
StopOperationsClient
public override OperationsClient StopOperationsClient { get; }The long-running operations client for Stop.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SuspendOperationsClient
public override OperationsClient SuspendOperationsClient { get; }The long-running operations client for Suspend.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateAccessConfigOperationsClient
public override OperationsClient UpdateAccessConfigOperationsClient { get; }The long-running operations client for UpdateAccessConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateDisplayDeviceOperationsClient
public override OperationsClient UpdateDisplayDeviceOperationsClient { get; }The long-running operations client for UpdateDisplayDevice.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateNetworkInterfaceOperationsClient
public override OperationsClient UpdateNetworkInterfaceOperationsClient { get; }The long-running operations client for UpdateNetworkInterface.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateOperationsClient
public override OperationsClient UpdateOperationsClient { get; }The long-running operations client for Update.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateShieldedInstanceConfigOperationsClient
public override OperationsClient UpdateShieldedInstanceConfigOperationsClient { get; }The long-running operations client for UpdateShieldedInstanceConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
AddAccessConfig(AddAccessConfigInstanceRequest, CallSettings)
public override Operation<Operation, Operation> AddAccessConfig(AddAccessConfigInstanceRequest request, CallSettings callSettings = null)Adds an access config to an instance's network interface.
| Parameters | |
|---|---|
| Name | Description |
request | AddAccessConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
AddAccessConfigAsync(AddAccessConfigInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> AddAccessConfigAsync(AddAccessConfigInstanceRequest request, CallSettings callSettings = null)Adds an access config to an instance's network interface.
| Parameters | |
|---|---|
| Name | Description |
request | AddAccessConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
AddResourcePolicies(AddResourcePoliciesInstanceRequest, CallSettings)
public override Operation<Operation, Operation> AddResourcePolicies(AddResourcePoliciesInstanceRequest request, CallSettings callSettings = null)Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.
| Parameters | |
|---|---|
| Name | Description |
request | AddResourcePoliciesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
AddResourcePoliciesAsync(AddResourcePoliciesInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> AddResourcePoliciesAsync(AddResourcePoliciesInstanceRequest request, CallSettings callSettings = null)Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.
| Parameters | |
|---|---|
| Name | Description |
request | AddResourcePoliciesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
AggregatedList(AggregatedListInstancesRequest, CallSettings)
public override PagedEnumerable<InstanceAggregatedList, KeyValuePair<string, InstancesScopedList>> AggregatedList(AggregatedListInstancesRequest request, CallSettings callSettings = null)Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableInstanceAggregatedListKeyValuePairstringInstancesScopedList | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
AggregatedListAsync(AggregatedListInstancesRequest, CallSettings)
public override PagedAsyncEnumerable<InstanceAggregatedList, KeyValuePair<string, InstancesScopedList>> AggregatedListAsync(AggregatedListInstancesRequest request, CallSettings callSettings = null)Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableInstanceAggregatedListKeyValuePairstringInstancesScopedList | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
AttachDisk(AttachDiskInstanceRequest, CallSettings)
public override Operation<Operation, Operation> AttachDisk(AttachDiskInstanceRequest request, CallSettings callSettings = null)Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.
| Parameters | |
|---|---|
| Name | Description |
request | AttachDiskInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
AttachDiskAsync(AttachDiskInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> AttachDiskAsync(AttachDiskInstanceRequest request, CallSettings callSettings = null)Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.
| Parameters | |
|---|---|
| Name | Description |
request | AttachDiskInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
BulkInsert(BulkInsertInstanceRequest, CallSettings)
public override Operation<Operation, Operation> BulkInsert(BulkInsertInstanceRequest request, CallSettings callSettings = null)Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.
| Parameters | |
|---|---|
| Name | Description |
request | BulkInsertInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
BulkInsertAsync(BulkInsertInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> BulkInsertAsync(BulkInsertInstanceRequest request, CallSettings callSettings = null)Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.
| Parameters | |
|---|---|
| Name | Description |
request | BulkInsertInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Delete(DeleteInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteInstanceRequest request, CallSettings callSettings = null)Deletes the specified Instance resource. For more information, see Deleting an instance.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
DeleteAccessConfig(DeleteAccessConfigInstanceRequest, CallSettings)
public override Operation<Operation, Operation> DeleteAccessConfig(DeleteAccessConfigInstanceRequest request, CallSettings callSettings = null)Deletes an access config from an instance's network interface.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAccessConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
DeleteAccessConfigAsync(DeleteAccessConfigInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAccessConfigAsync(DeleteAccessConfigInstanceRequest request, CallSettings callSettings = null)Deletes an access config from an instance's network interface.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAccessConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
DeleteAsync(DeleteInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteInstanceRequest request, CallSettings callSettings = null)Deletes the specified Instance resource. For more information, see Deleting an instance.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
DetachDisk(DetachDiskInstanceRequest, CallSettings)
public override Operation<Operation, Operation> DetachDisk(DetachDiskInstanceRequest request, CallSettings callSettings = null)Detaches a disk from an instance.
| Parameters | |
|---|---|
| Name | Description |
request | DetachDiskInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
DetachDiskAsync(DetachDiskInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DetachDiskAsync(DetachDiskInstanceRequest request, CallSettings callSettings = null)Detaches a disk from an instance.
| Parameters | |
|---|---|
| Name | Description |
request | DetachDiskInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Get(GetInstanceRequest, CallSettings)
public override Instance Get(GetInstanceRequest request, CallSettings callSettings = null)Returns the specified Instance resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Instance | The RPC response. |
GetAsync(GetInstanceRequest, CallSettings)
public override Task<Instance> GetAsync(GetInstanceRequest request, CallSettings callSettings = null)Returns the specified Instance resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskInstance | A Task containing the RPC response. |
GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest, CallSettings)
public override InstancesGetEffectiveFirewallsResponse GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest request, CallSettings callSettings = null)Returns effective firewalls applied to an interface of the instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetEffectiveFirewallsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
InstancesGetEffectiveFirewallsResponse | The RPC response. |
GetEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest, CallSettings)
public override Task<InstancesGetEffectiveFirewallsResponse> GetEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest request, CallSettings callSettings = null)Returns effective firewalls applied to an interface of the instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetEffectiveFirewallsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskInstancesGetEffectiveFirewallsResponse | A Task containing the RPC response. |
GetGuestAttributes(GetGuestAttributesInstanceRequest, CallSettings)
public override GuestAttributes GetGuestAttributes(GetGuestAttributesInstanceRequest request, CallSettings callSettings = null)Returns the specified guest attributes entry.
| Parameters | |
|---|---|
| Name | Description |
request | GetGuestAttributesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GuestAttributes | The RPC response. |
GetGuestAttributesAsync(GetGuestAttributesInstanceRequest, CallSettings)
public override Task<GuestAttributes> GetGuestAttributesAsync(GetGuestAttributesInstanceRequest request, CallSettings callSettings = null)Returns the specified guest attributes entry.
| Parameters | |
|---|---|
| Name | Description |
request | GetGuestAttributesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGuestAttributes | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyInstanceRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyInstanceRequest request, CallSettings callSettings = null)Gets the access control policy for a resource. May be empty if no such policy or resource exists.
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyInstanceRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyInstanceRequest request, CallSettings callSettings = null)Gets the access control policy for a resource. May be empty if no such policy or resource exists.
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
GetScreenshot(GetScreenshotInstanceRequest, CallSettings)
public override Screenshot GetScreenshot(GetScreenshotInstanceRequest request, CallSettings callSettings = null)Returns the screenshot from the specified instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetScreenshotInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Screenshot | The RPC response. |
GetScreenshotAsync(GetScreenshotInstanceRequest, CallSettings)
public override Task<Screenshot> GetScreenshotAsync(GetScreenshotInstanceRequest request, CallSettings callSettings = null)Returns the screenshot from the specified instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetScreenshotInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskScreenshot | A Task containing the RPC response. |
GetSerialPortOutput(GetSerialPortOutputInstanceRequest, CallSettings)
public override SerialPortOutput GetSerialPortOutput(GetSerialPortOutputInstanceRequest request, CallSettings callSettings = null)Returns the last 1 MB of serial port output from the specified instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetSerialPortOutputInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SerialPortOutput | The RPC response. |
GetSerialPortOutputAsync(GetSerialPortOutputInstanceRequest, CallSettings)
public override Task<SerialPortOutput> GetSerialPortOutputAsync(GetSerialPortOutputInstanceRequest request, CallSettings callSettings = null)Returns the last 1 MB of serial port output from the specified instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetSerialPortOutputInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSerialPortOutput | A Task containing the RPC response. |
GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest, CallSettings)
public override ShieldedInstanceIdentity GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest request, CallSettings callSettings = null)Returns the Shielded Instance Identity of an instance
| Parameters | |
|---|---|
| Name | Description |
request | GetShieldedInstanceIdentityInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ShieldedInstanceIdentity | The RPC response. |
GetShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest, CallSettings)
public override Task<ShieldedInstanceIdentity> GetShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest request, CallSettings callSettings = null)Returns the Shielded Instance Identity of an instance
| Parameters | |
|---|---|
| Name | Description |
request | GetShieldedInstanceIdentityInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskShieldedInstanceIdentity | A Task containing the RPC response. |
Insert(InsertInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Insert(InsertInstanceRequest request, CallSettings callSettings = null)Creates an instance resource in the specified project using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | InsertInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
InsertAsync(InsertInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> InsertAsync(InsertInstanceRequest request, CallSettings callSettings = null)Creates an instance resource in the specified project using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | InsertInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
List(ListInstancesRequest, CallSettings)
public override PagedEnumerable<InstanceList, Instance> List(ListInstancesRequest request, CallSettings callSettings = null)Retrieves the list of instances contained within the specified zone.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableInstanceListInstance | A pageable sequence of Instance resources. |
ListAsync(ListInstancesRequest, CallSettings)
public override PagedAsyncEnumerable<InstanceList, Instance> ListAsync(ListInstancesRequest request, CallSettings callSettings = null)Retrieves the list of instances contained within the specified zone.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableInstanceListInstance | A pageable asynchronous sequence of Instance resources. |
ListReferrers(ListReferrersInstancesRequest, CallSettings)
public override PagedEnumerable<InstanceListReferrers, Reference> ListReferrers(ListReferrersInstancesRequest request, CallSettings callSettings = null)Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.
| Parameters | |
|---|---|
| Name | Description |
request | ListReferrersInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableInstanceListReferrersReference | A pageable sequence of Reference resources. |
ListReferrersAsync(ListReferrersInstancesRequest, CallSettings)
public override PagedAsyncEnumerable<InstanceListReferrers, Reference> ListReferrersAsync(ListReferrersInstancesRequest request, CallSettings callSettings = null)Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.
| Parameters | |
|---|---|
| Name | Description |
request | ListReferrersInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableInstanceListReferrersReference | A pageable asynchronous sequence of Reference resources. |
RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest, CallSettings)
public override Operation<Operation, Operation> RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest request, CallSettings callSettings = null)Removes resource policies from an instance.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveResourcePoliciesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
RemoveResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> RemoveResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest request, CallSettings callSettings = null)Removes resource policies from an instance.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveResourcePoliciesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Reset(ResetInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Reset(ResetInstanceRequest request, CallSettings callSettings = null)Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.
| Parameters | |
|---|---|
| Name | Description |
request | ResetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
ResetAsync(ResetInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> ResetAsync(ResetInstanceRequest request, CallSettings callSettings = null)Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.
| Parameters | |
|---|---|
| Name | Description |
request | ResetInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Resume(ResumeInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Resume(ResumeInstanceRequest request, CallSettings callSettings = null)Resumes an instance that was suspended using the instances().suspend method.
| Parameters | |
|---|---|
| Name | Description |
request | ResumeInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
ResumeAsync(ResumeInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> ResumeAsync(ResumeInstanceRequest request, CallSettings callSettings = null)Resumes an instance that was suspended using the instances().suspend method.
| Parameters | |
|---|---|
| Name | Description |
request | ResumeInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest, CallSettings)
public override SendDiagnosticInterruptInstanceResponse SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest request, CallSettings callSettings = null)Sends diagnostic interrupt to the instance.
| Parameters | |
|---|---|
| Name | Description |
request | SendDiagnosticInterruptInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SendDiagnosticInterruptInstanceResponse | The RPC response. |
SendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest, CallSettings)
public override Task<SendDiagnosticInterruptInstanceResponse> SendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest request, CallSettings callSettings = null)Sends diagnostic interrupt to the instance.
| Parameters | |
|---|---|
| Name | Description |
request | SendDiagnosticInterruptInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSendDiagnosticInterruptInstanceResponse | A Task containing the RPC response. |
SetDeletionProtection(SetDeletionProtectionInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetDeletionProtection(SetDeletionProtectionInstanceRequest request, CallSettings callSettings = null)Sets deletion protection on the instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetDeletionProtectionInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetDeletionProtectionAsync(SetDeletionProtectionInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetDeletionProtectionAsync(SetDeletionProtectionInstanceRequest request, CallSettings callSettings = null)Sets deletion protection on the instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetDeletionProtectionInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest request, CallSettings callSettings = null)Sets the auto-delete flag for a disk attached to an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetDiskAutoDeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest request, CallSettings callSettings = null)Sets the auto-delete flag for a disk attached to an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetDiskAutoDeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetIamPolicy(SetIamPolicyInstanceRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyInstanceRequest request, CallSettings callSettings = null)Sets the access control policy on the specified resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyInstanceRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyInstanceRequest request, CallSettings callSettings = null)Sets the access control policy on the specified resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
SetLabels(SetLabelsInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetLabels(SetLabelsInstanceRequest request, CallSettings callSettings = null)Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
request | SetLabelsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetLabelsAsync(SetLabelsInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsInstanceRequest request, CallSettings callSettings = null)Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
request | SetLabelsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetMachineResources(SetMachineResourcesInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetMachineResources(SetMachineResourcesInstanceRequest request, CallSettings callSettings = null)Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetMachineResourcesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetMachineResourcesAsync(SetMachineResourcesInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetMachineResourcesAsync(SetMachineResourcesInstanceRequest request, CallSettings callSettings = null)Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetMachineResourcesInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetMachineType(SetMachineTypeInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetMachineType(SetMachineTypeInstanceRequest request, CallSettings callSettings = null)Changes the machine type for a stopped instance to the machine type specified in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetMachineTypeInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetMachineTypeAsync(SetMachineTypeInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetMachineTypeAsync(SetMachineTypeInstanceRequest request, CallSettings callSettings = null)Changes the machine type for a stopped instance to the machine type specified in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetMachineTypeInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetMetadata(SetMetadataInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetMetadata(SetMetadataInstanceRequest request, CallSettings callSettings = null)Sets metadata for the specified instance to the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetMetadataInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetMetadataAsync(SetMetadataInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetMetadataAsync(SetMetadataInstanceRequest request, CallSettings callSettings = null)Sets metadata for the specified instance to the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetMetadataInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest request, CallSettings callSettings = null)Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.
| Parameters | |
|---|---|
| Name | Description |
request | SetMinCpuPlatformInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest request, CallSettings callSettings = null)Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.
| Parameters | |
|---|---|
| Name | Description |
request | SetMinCpuPlatformInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetName(SetNameInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetName(SetNameInstanceRequest request, CallSettings callSettings = null)Sets name of an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetNameInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetNameAsync(SetNameInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetNameAsync(SetNameInstanceRequest request, CallSettings callSettings = null)Sets name of an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetNameInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetScheduling(SetSchedulingInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetScheduling(SetSchedulingInstanceRequest request, CallSettings callSettings = null)Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetSchedulingInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetSchedulingAsync(SetSchedulingInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetSchedulingAsync(SetSchedulingInstanceRequest request, CallSettings callSettings = null)Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.
| Parameters | |
|---|---|
| Name | Description |
request | SetSchedulingInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetServiceAccount(SetServiceAccountInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetServiceAccount(SetServiceAccountInstanceRequest request, CallSettings callSettings = null)Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetServiceAccountInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetServiceAccountAsync(SetServiceAccountInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetServiceAccountAsync(SetServiceAccountInstanceRequest request, CallSettings callSettings = null)Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SetServiceAccountInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest request, CallSettings callSettings = null)Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | SetShieldedInstanceIntegrityPolicyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest request, CallSettings callSettings = null)Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | SetShieldedInstanceIntegrityPolicyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SetTags(SetTagsInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SetTags(SetTagsInstanceRequest request, CallSettings callSettings = null)Sets network tags for the specified instance to the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetTagsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SetTagsAsync(SetTagsInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SetTagsAsync(SetTagsInstanceRequest request, CallSettings callSettings = null)Sets network tags for the specified instance to the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | SetTagsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest, CallSettings)
public override Operation<Operation, Operation> SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest request, CallSettings callSettings = null)Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request | SimulateMaintenanceEventInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SimulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SimulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest request, CallSettings callSettings = null)Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request | SimulateMaintenanceEventInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Start(StartInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Start(StartInstanceRequest request, CallSettings callSettings = null)Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
| Parameters | |
|---|---|
| Name | Description |
request | StartInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
StartAsync(StartInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> StartAsync(StartInstanceRequest request, CallSettings callSettings = null)Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
| Parameters | |
|---|---|
| Name | Description |
request | StartInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest, CallSettings)
public override Operation<Operation, Operation> StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest request, CallSettings callSettings = null)Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
| Parameters | |
|---|---|
| Name | Description |
request | StartWithEncryptionKeyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
StartWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> StartWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest request, CallSettings callSettings = null)Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
| Parameters | |
|---|---|
| Name | Description |
request | StartWithEncryptionKeyInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Stop(StopInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Stop(StopInstanceRequest request, CallSettings callSettings = null)Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
| Parameters | |
|---|---|
| Name | Description |
request | StopInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
StopAsync(StopInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> StopAsync(StopInstanceRequest request, CallSettings callSettings = null)Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
| Parameters | |
|---|---|
| Name | Description |
request | StopInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Suspend(SuspendInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Suspend(SuspendInstanceRequest request, CallSettings callSettings = null)This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SuspendInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
SuspendAsync(SuspendInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> SuspendAsync(SuspendInstanceRequest request, CallSettings callSettings = null)This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.
| Parameters | |
|---|---|
| Name | Description |
request | SuspendInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsInstanceRequest, CallSettings)
public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsInstanceRequest request, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsInstanceRequest, CallSettings)
public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsInstanceRequest request, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse | A Task containing the RPC response. |
Update(UpdateInstanceRequest, CallSettings)
public override Operation<Operation, Operation> Update(UpdateInstanceRequest request, CallSettings callSettings = null)Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
UpdateAccessConfig(UpdateAccessConfigInstanceRequest, CallSettings)
public override Operation<Operation, Operation> UpdateAccessConfig(UpdateAccessConfigInstanceRequest request, CallSettings callSettings = null)Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAccessConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
UpdateAccessConfigAsync(UpdateAccessConfigInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateAccessConfigAsync(UpdateAccessConfigInstanceRequest request, CallSettings callSettings = null)Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAccessConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
UpdateAsync(UpdateInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateInstanceRequest request, CallSettings callSettings = null)Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest, CallSettings)
public override Operation<Operation, Operation> UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest request, CallSettings callSettings = null)Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDisplayDeviceInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
UpdateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest request, CallSettings callSettings = null)Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDisplayDeviceInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest, CallSettings)
public override Operation<Operation, Operation> UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest request, CallSettings callSettings = null)Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateNetworkInterfaceInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
UpdateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest request, CallSettings callSettings = null)Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateNetworkInterfaceInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest, CallSettings)
public override Operation<Operation, Operation> UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest request, CallSettings callSettings = null)Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateShieldedInstanceConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest request, CallSettings callSettings = null)Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateShieldedInstanceConfigInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |