Google Cloud Native v0.28.0, Feb 2 23

google-native.vmmigration/v1.getUtilizationReport

Gets a single Utilization Report.

Using getUtilizationReport

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUtilizationReport(args: GetUtilizationReportArgs, opts?: InvokeOptions): Promise<GetUtilizationReportResult>
function getUtilizationReportOutput(args: GetUtilizationReportOutputArgs, opts?: InvokeOptions): Output<GetUtilizationReportResult>

def get_utilization_report(location: Optional[str] = None,
                           project: Optional[str] = None,
                           source_id: Optional[str] = None,
                           utilization_report_id: Optional[str] = None,
                           view: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetUtilizationReportResult
def get_utilization_report_output(location: Optional[pulumi.Input[str]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           source_id: Optional[pulumi.Input[str]] = None,
                           utilization_report_id: Optional[pulumi.Input[str]] = None,
                           view: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetUtilizationReportResult]

func LookupUtilizationReport(ctx *Context, args *LookupUtilizationReportArgs, opts ...InvokeOption) (*LookupUtilizationReportResult, error)
func LookupUtilizationReportOutput(ctx *Context, args *LookupUtilizationReportOutputArgs, opts ...InvokeOption) LookupUtilizationReportResultOutput

> Note: This function is named LookupUtilizationReport in the Go SDK.

public static class GetUtilizationReport 
{
    public static Task<GetUtilizationReportResult> InvokeAsync(GetUtilizationReportArgs args, InvokeOptions? opts = null)
    public static Output<GetUtilizationReportResult> Invoke(GetUtilizationReportInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUtilizationReportResult> getUtilizationReport(GetUtilizationReportArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:vmmigration/v1:getUtilizationReport
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string
SourceId string
UtilizationReportId string
Project string
View string

Location string
SourceId string
UtilizationReportId string
Project string
View string

location String
sourceId String
utilizationReportId String
project String
view String

location string
sourceId string
utilizationReportId string
project string
view string

location str
source_id str
utilization_report_id str
project str
view str

location String
sourceId String
utilizationReportId String
project String
view String

getUtilizationReport Result

The following output properties are available:

CreateTime string: The time the report was created (this refers to the time of the request, not the time the report creation completed).
DisplayName string: The report display name, as assigned by the user.
Error Pulumi.GoogleNative.VMMigration.V1.Outputs.StatusResponse: Provides details on the state of the report in case of an error.
FrameEndTime string: The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
Name string: The report unique name.
State string: Current state of the report.
StateTime string: The time the state was last set.
TimeFrame string: Time frame of the report.
VmCount int: Total number of VMs included in the report.
Vms List<Pulumi.GoogleNative.VMMigration.V1.Outputs.VmUtilizationInfoResponse>: List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

CreateTime string: The time the report was created (this refers to the time of the request, not the time the report creation completed).
DisplayName string: The report display name, as assigned by the user.
Error StatusResponse: Provides details on the state of the report in case of an error.
FrameEndTime string: The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
Name string: The report unique name.
State string: Current state of the report.
StateTime string: The time the state was last set.
TimeFrame string: Time frame of the report.
VmCount int: Total number of VMs included in the report.
Vms []VmUtilizationInfoResponse: List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

createTime String: The time the report was created (this refers to the time of the request, not the time the report creation completed).
displayName String: The report display name, as assigned by the user.
error StatusResponse: Provides details on the state of the report in case of an error.
frameEndTime String: The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
name String: The report unique name.
state String: Current state of the report.
stateTime String: The time the state was last set.
timeFrame String: Time frame of the report.
vmCount Integer: Total number of VMs included in the report.
vms List<VmUtilizationInfoResponse>: List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

createTime string: The time the report was created (this refers to the time of the request, not the time the report creation completed).
displayName string: The report display name, as assigned by the user.
error StatusResponse: Provides details on the state of the report in case of an error.
frameEndTime string: The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
name string: The report unique name.
state string: Current state of the report.
stateTime string: The time the state was last set.
timeFrame string: Time frame of the report.
vmCount number: Total number of VMs included in the report.
vms VmUtilizationInfoResponse[]: List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

create_time str: The time the report was created (this refers to the time of the request, not the time the report creation completed).
display_name str: The report display name, as assigned by the user.
error StatusResponse: Provides details on the state of the report in case of an error.
frame_end_time str: The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
name str: The report unique name.
state str: Current state of the report.
state_time str: The time the state was last set.
time_frame str: Time frame of the report.
vm_count int: Total number of VMs included in the report.
vms Sequence[VmUtilizationInfoResponse]: List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

createTime String: The time the report was created (this refers to the time of the request, not the time the report creation completed).
displayName String: The report display name, as assigned by the user.
error Property Map: Provides details on the state of the report in case of an error.
frameEndTime String: The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.
name String: The report unique name.
state String: Current state of the report.
stateTime String: The time the state was last set.
timeFrame String: Time frame of the report.
vmCount Number: Total number of VMs included in the report.
vms List<Property Map>: List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

Supporting Types

StatusResponse

Code int: The status code, which should be an enum value of google.rpc.Code.
Details List<ImmutableDictionary<string, string>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Code int: The status code, which should be an enum value of google.rpc.Code.
Details []map[string]string: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Integer: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String,String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code number: The status code, which should be an enum value of google.rpc.Code.
details {[key: string]: string}[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code int: The status code, which should be an enum value of google.rpc.Code.
details Sequence[Mapping[str, str]]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message str: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Number: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

VmUtilizationInfoResponse

Utilization Pulumi.GoogleNative.VMMigration.V1.Inputs.VmUtilizationMetricsResponse: Utilization metrics for this VM.
VmId string: The VM's ID in the source.
VmwareVmDetails Pulumi.GoogleNative.VMMigration.V1.Inputs.VmwareVmDetailsResponse: The description of the VM in a Source of type Vmware.

Utilization VmUtilizationMetricsResponse: Utilization metrics for this VM.
VmId string: The VM's ID in the source.
VmwareVmDetails VmwareVmDetailsResponse: The description of the VM in a Source of type Vmware.

utilization VmUtilizationMetricsResponse: Utilization metrics for this VM.
vmId String: The VM's ID in the source.
vmwareVmDetails VmwareVmDetailsResponse: The description of the VM in a Source of type Vmware.

utilization VmUtilizationMetricsResponse: Utilization metrics for this VM.
vmId string: The VM's ID in the source.
vmwareVmDetails VmwareVmDetailsResponse: The description of the VM in a Source of type Vmware.

utilization VmUtilizationMetricsResponse: Utilization metrics for this VM.
vm_id str: The VM's ID in the source.
vmware_vm_details VmwareVmDetailsResponse: The description of the VM in a Source of type Vmware.

utilization Property Map: Utilization metrics for this VM.
vmId String: The VM's ID in the source.
vmwareVmDetails Property Map: The description of the VM in a Source of type Vmware.

VmUtilizationMetricsResponse

CpuAveragePercent int: Average CPU usage, percent.
CpuMaxPercent int: Max CPU usage, percent.
DiskIoRateAverageKbps string: Average disk IO rate, in kilobytes per second.
DiskIoRateMaxKbps string: Max disk IO rate, in kilobytes per second.
MemoryAveragePercent int: Average memory usage, percent.
MemoryMaxPercent int: Max memory usage, percent.
NetworkThroughputAverageKbps string: Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
NetworkThroughputMaxKbps string: Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

CpuAveragePercent int: Average CPU usage, percent.
CpuMaxPercent int: Max CPU usage, percent.
DiskIoRateAverageKbps string: Average disk IO rate, in kilobytes per second.
DiskIoRateMaxKbps string: Max disk IO rate, in kilobytes per second.
MemoryAveragePercent int: Average memory usage, percent.
MemoryMaxPercent int: Max memory usage, percent.
NetworkThroughputAverageKbps string: Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
NetworkThroughputMaxKbps string: Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

cpuAveragePercent Integer: Average CPU usage, percent.
cpuMaxPercent Integer: Max CPU usage, percent.
diskIoRateAverageKbps String: Average disk IO rate, in kilobytes per second.
diskIoRateMaxKbps String: Max disk IO rate, in kilobytes per second.
memoryAveragePercent Integer: Average memory usage, percent.
memoryMaxPercent Integer: Max memory usage, percent.
networkThroughputAverageKbps String: Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
networkThroughputMaxKbps String: Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

cpuAveragePercent number: Average CPU usage, percent.
cpuMaxPercent number: Max CPU usage, percent.
diskIoRateAverageKbps string: Average disk IO rate, in kilobytes per second.
diskIoRateMaxKbps string: Max disk IO rate, in kilobytes per second.
memoryAveragePercent number: Average memory usage, percent.
memoryMaxPercent number: Max memory usage, percent.
networkThroughputAverageKbps string: Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
networkThroughputMaxKbps string: Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

cpu_average_percent int: Average CPU usage, percent.
cpu_max_percent int: Max CPU usage, percent.
disk_io_rate_average_kbps str: Average disk IO rate, in kilobytes per second.
disk_io_rate_max_kbps str: Max disk IO rate, in kilobytes per second.
memory_average_percent int: Average memory usage, percent.
memory_max_percent int: Max memory usage, percent.
network_throughput_average_kbps str: Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
network_throughput_max_kbps str: Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

cpuAveragePercent Number: Average CPU usage, percent.
cpuMaxPercent Number: Max CPU usage, percent.
diskIoRateAverageKbps String: Average disk IO rate, in kilobytes per second.
diskIoRateMaxKbps String: Max disk IO rate, in kilobytes per second.
memoryAveragePercent Number: Average memory usage, percent.
memoryMaxPercent Number: Max memory usage, percent.
networkThroughputAverageKbps String: Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.
networkThroughputMaxKbps String: Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

VmwareVmDetailsResponse

BootOption string: The VM Boot Option.
CommittedStorageMb string: The total size of the storage allocated to the VM in MB.
CpuCount int: The number of cpus in the VM.
DatacenterDescription string: The descriptive name of the vCenter's datacenter this VM is contained in.
DatacenterId string: The id of the vCenter's datacenter this VM is contained in.
DiskCount int: The number of disks the VM has.
DisplayName string: The display name of the VM. Note that this is not necessarily unique.
GuestDescription string: The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
MemoryMb int: The size of the memory of the VM in MB.
PowerState string: The power state of the VM at the moment list was taken.
Uuid string: The unique identifier of the VM in vCenter.
VmId string: The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

BootOption string: The VM Boot Option.
CommittedStorageMb string: The total size of the storage allocated to the VM in MB.
CpuCount int: The number of cpus in the VM.
DatacenterDescription string: The descriptive name of the vCenter's datacenter this VM is contained in.
DatacenterId string: The id of the vCenter's datacenter this VM is contained in.
DiskCount int: The number of disks the VM has.
DisplayName string: The display name of the VM. Note that this is not necessarily unique.
GuestDescription string: The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
MemoryMb int: The size of the memory of the VM in MB.
PowerState string: The power state of the VM at the moment list was taken.
Uuid string: The unique identifier of the VM in vCenter.
VmId string: The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

bootOption String: The VM Boot Option.
committedStorageMb String: The total size of the storage allocated to the VM in MB.
cpuCount Integer: The number of cpus in the VM.
datacenterDescription String: The descriptive name of the vCenter's datacenter this VM is contained in.
datacenterId String: The id of the vCenter's datacenter this VM is contained in.
diskCount Integer: The number of disks the VM has.
displayName String: The display name of the VM. Note that this is not necessarily unique.
guestDescription String: The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
memoryMb Integer: The size of the memory of the VM in MB.
powerState String: The power state of the VM at the moment list was taken.
uuid String: The unique identifier of the VM in vCenter.
vmId String: The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

bootOption string: The VM Boot Option.
committedStorageMb string: The total size of the storage allocated to the VM in MB.
cpuCount number: The number of cpus in the VM.
datacenterDescription string: The descriptive name of the vCenter's datacenter this VM is contained in.
datacenterId string: The id of the vCenter's datacenter this VM is contained in.
diskCount number: The number of disks the VM has.
displayName string: The display name of the VM. Note that this is not necessarily unique.
guestDescription string: The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
memoryMb number: The size of the memory of the VM in MB.
powerState string: The power state of the VM at the moment list was taken.
uuid string: The unique identifier of the VM in vCenter.
vmId string: The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

boot_option str: The VM Boot Option.
committed_storage_mb str: The total size of the storage allocated to the VM in MB.
cpu_count int: The number of cpus in the VM.
datacenter_description str: The descriptive name of the vCenter's datacenter this VM is contained in.
datacenter_id str: The id of the vCenter's datacenter this VM is contained in.
disk_count int: The number of disks the VM has.
display_name str: The display name of the VM. Note that this is not necessarily unique.
guest_description str: The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
memory_mb int: The size of the memory of the VM in MB.
power_state str: The power state of the VM at the moment list was taken.
uuid str: The unique identifier of the VM in vCenter.
vm_id str: The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

bootOption String: The VM Boot Option.
committedStorageMb String: The total size of the storage allocated to the VM in MB.
cpuCount Number: The number of cpus in the VM.
datacenterDescription String: The descriptive name of the vCenter's datacenter this VM is contained in.
datacenterId String: The id of the vCenter's datacenter this VM is contained in.
diskCount Number: The number of disks the VM has.
displayName String: The display name of the VM. Note that this is not necessarily unique.
guestDescription String: The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
memoryMb Number: The size of the memory of the VM in MB.
powerState String: The power state of the VM at the moment list was taken.
uuid String: The unique identifier of the VM in vCenter.
vmId String: The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0