1. Packages
  2. Azure Native v2
  3. API Docs
  4. migrate
  5. getHyperVCollector
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.migrate.getHyperVCollector

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Get a Hyper-V collector. Azure REST API version: 2019-10-01.

Using getHyperVCollector

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 getHyperVCollector(args: GetHyperVCollectorArgs, opts?: InvokeOptions): Promise<GetHyperVCollectorResult>
function getHyperVCollectorOutput(args: GetHyperVCollectorOutputArgs, opts?: InvokeOptions): Output<GetHyperVCollectorResult>
Copy
def get_hyper_v_collector(hyper_v_collector_name: Optional[str] = None,
                          project_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHyperVCollectorResult
def get_hyper_v_collector_output(hyper_v_collector_name: Optional[pulumi.Input[str]] = None,
                          project_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHyperVCollectorResult]
Copy
func LookupHyperVCollector(ctx *Context, args *LookupHyperVCollectorArgs, opts ...InvokeOption) (*LookupHyperVCollectorResult, error)
func LookupHyperVCollectorOutput(ctx *Context, args *LookupHyperVCollectorOutputArgs, opts ...InvokeOption) LookupHyperVCollectorResultOutput
Copy

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

public static class GetHyperVCollector 
{
    public static Task<GetHyperVCollectorResult> InvokeAsync(GetHyperVCollectorArgs args, InvokeOptions? opts = null)
    public static Output<GetHyperVCollectorResult> Invoke(GetHyperVCollectorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHyperVCollectorResult> getHyperVCollector(GetHyperVCollectorArgs args, InvokeOptions options)
public static Output<GetHyperVCollectorResult> getHyperVCollector(GetHyperVCollectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:migrate:getHyperVCollector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HyperVCollectorName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a Hyper-V collector within a project.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
HyperVCollectorName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a Hyper-V collector within a project.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
hyperVCollectorName
This property is required.
Changes to this property will trigger replacement.
String
Unique name of a Hyper-V collector within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Resource Group that project is part of.
hyperVCollectorName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a Hyper-V collector within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
hyper_v_collector_name
This property is required.
Changes to this property will trigger replacement.
str
Unique name of a Hyper-V collector within a project.
project_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Migrate project.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Resource Group that project is part of.
hyperVCollectorName
This property is required.
Changes to this property will trigger replacement.
String
Unique name of a Hyper-V collector within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Resource Group that project is part of.

getHyperVCollector Result

The following output properties are available:

id String
name String
properties Property Map
type String
eTag String

Supporting Types

CollectorAgentPropertiesResponse

Id This property is required. string
LastHeartbeatUtc This property is required. string
Version This property is required. string
SpnDetails Pulumi.AzureNative.Migrate.Inputs.CollectorBodyAgentSpnPropertiesResponse
Id This property is required. string
LastHeartbeatUtc This property is required. string
Version This property is required. string
SpnDetails CollectorBodyAgentSpnPropertiesResponse
id This property is required. String
lastHeartbeatUtc This property is required. String
version This property is required. String
spnDetails CollectorBodyAgentSpnPropertiesResponse
id This property is required. string
lastHeartbeatUtc This property is required. string
version This property is required. string
spnDetails CollectorBodyAgentSpnPropertiesResponse
id This property is required. str
last_heartbeat_utc This property is required. str
version This property is required. str
spn_details CollectorBodyAgentSpnPropertiesResponse
id This property is required. String
lastHeartbeatUtc This property is required. String
version This property is required. String
spnDetails Property Map

CollectorBodyAgentSpnPropertiesResponse

ApplicationId string
Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
Audience string
Intended audience for the service principal.
Authority string
AAD Authority URL which was used to request the token for the service principal.
ObjectId string
Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
TenantId string
Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
ApplicationId string
Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
Audience string
Intended audience for the service principal.
Authority string
AAD Authority URL which was used to request the token for the service principal.
ObjectId string
Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
TenantId string
Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
applicationId String
Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience String
Intended audience for the service principal.
authority String
AAD Authority URL which was used to request the token for the service principal.
objectId String
Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
tenantId String
Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
applicationId string
Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience string
Intended audience for the service principal.
authority string
AAD Authority URL which was used to request the token for the service principal.
objectId string
Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
tenantId string
Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
application_id str
Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience str
Intended audience for the service principal.
authority str
AAD Authority URL which was used to request the token for the service principal.
object_id str
Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
tenant_id str
Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
applicationId String
Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience String
Intended audience for the service principal.
authority String
AAD Authority URL which was used to request the token for the service principal.
objectId String
Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.
tenantId String
Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.

CollectorPropertiesResponse

CreatedTimestamp This property is required. string
Time when this collector was created. Date-Time represented in ISO-8601 format.
UpdatedTimestamp This property is required. string
Time when this collector was updated. Date-Time represented in ISO-8601 format.
AgentProperties Pulumi.AzureNative.Migrate.Inputs.CollectorAgentPropertiesResponse
DiscoverySiteId string
The ARM id of the discovery service site.
CreatedTimestamp This property is required. string
Time when this collector was created. Date-Time represented in ISO-8601 format.
UpdatedTimestamp This property is required. string
Time when this collector was updated. Date-Time represented in ISO-8601 format.
AgentProperties CollectorAgentPropertiesResponse
DiscoverySiteId string
The ARM id of the discovery service site.
createdTimestamp This property is required. String
Time when this collector was created. Date-Time represented in ISO-8601 format.
updatedTimestamp This property is required. String
Time when this collector was updated. Date-Time represented in ISO-8601 format.
agentProperties CollectorAgentPropertiesResponse
discoverySiteId String
The ARM id of the discovery service site.
createdTimestamp This property is required. string
Time when this collector was created. Date-Time represented in ISO-8601 format.
updatedTimestamp This property is required. string
Time when this collector was updated. Date-Time represented in ISO-8601 format.
agentProperties CollectorAgentPropertiesResponse
discoverySiteId string
The ARM id of the discovery service site.
created_timestamp This property is required. str
Time when this collector was created. Date-Time represented in ISO-8601 format.
updated_timestamp This property is required. str
Time when this collector was updated. Date-Time represented in ISO-8601 format.
agent_properties CollectorAgentPropertiesResponse
discovery_site_id str
The ARM id of the discovery service site.
createdTimestamp This property is required. String
Time when this collector was created. Date-Time represented in ISO-8601 format.
updatedTimestamp This property is required. String
Time when this collector was updated. Date-Time represented in ISO-8601 format.
agentProperties Property Map
discoverySiteId String
The ARM id of the discovery service site.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi