Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. offazure
  5. getHyperVSite
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
pulumi/pulumi-azure-native

azure-native-v2.offazure.getHyperVSite

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
pulumi/pulumi-azure-native

Site REST Resource. Azure REST API version: 2020-07-07.

Using getHyperVSite

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 getHyperVSite(args: GetHyperVSiteArgs, opts?: InvokeOptions): Promise<GetHyperVSiteResult>
function getHyperVSiteOutput(args: GetHyperVSiteOutputArgs, opts?: InvokeOptions): Output<GetHyperVSiteResult>
Copy
def get_hyper_v_site(resource_group_name: Optional[str] = None,
                     site_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetHyperVSiteResult
def get_hyper_v_site_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     site_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetHyperVSiteResult]
Copy
func LookupHyperVSite(ctx *Context, args *LookupHyperVSiteArgs, opts ...InvokeOption) (*LookupHyperVSiteResult, error)
func LookupHyperVSiteOutput(ctx *Context, args *LookupHyperVSiteOutputArgs, opts ...InvokeOption) LookupHyperVSiteResultOutput
Copy

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

public static class GetHyperVSite 
{
    public static Task<GetHyperVSiteResult> InvokeAsync(GetHyperVSiteArgs args, InvokeOptions? opts = null)
    public static Output<GetHyperVSiteResult> Invoke(GetHyperVSiteInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHyperVSiteResult> getHyperVSite(GetHyperVSiteArgs args, InvokeOptions options)
public static Output<GetHyperVSiteResult> getHyperVSite(GetHyperVSiteArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:offazure:getHyperVSite
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SiteName
This property is required.
Changes to this property will trigger replacement.
string
Site name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SiteName
This property is required.
Changes to this property will trigger replacement.
string
Site name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
String
Site name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
string
Site name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
site_name
This property is required.
Changes to this property will trigger replacement.
str
Site name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
siteName
This property is required.
Changes to this property will trigger replacement.
String
Site name.

getHyperVSite Result

The following output properties are available:

Id string
Resource Id.
Properties Pulumi.AzureNative.OffAzure.Outputs.SitePropertiesResponse
Nested properties of Hyper-V site.
SystemData Pulumi.AzureNative.OffAzure.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Type of resource. Type = Microsoft.OffAzure/HyperVSites.
ETag string
eTag for concurrency control.
Location string
Azure location in which Sites is created.
Name string
Name of the Hyper-V site.
Tags Dictionary<string, string>
Id string
Resource Id.
Properties SitePropertiesResponse
Nested properties of Hyper-V site.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Type of resource. Type = Microsoft.OffAzure/HyperVSites.
ETag string
eTag for concurrency control.
Location string
Azure location in which Sites is created.
Name string
Name of the Hyper-V site.
Tags map[string]string
id String
Resource Id.
properties SitePropertiesResponse
Nested properties of Hyper-V site.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Type of resource. Type = Microsoft.OffAzure/HyperVSites.
eTag String
eTag for concurrency control.
location String
Azure location in which Sites is created.
name String
Name of the Hyper-V site.
tags Map<String,String>
id string
Resource Id.
properties SitePropertiesResponse
Nested properties of Hyper-V site.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Type of resource. Type = Microsoft.OffAzure/HyperVSites.
eTag string
eTag for concurrency control.
location string
Azure location in which Sites is created.
name string
Name of the Hyper-V site.
tags {[key: string]: string}
id str
Resource Id.
properties SitePropertiesResponse
Nested properties of Hyper-V site.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Type of resource. Type = Microsoft.OffAzure/HyperVSites.
e_tag str
eTag for concurrency control.
location str
Azure location in which Sites is created.
name str
Name of the Hyper-V site.
tags Mapping[str, str]
id String
Resource Id.
properties Property Map
Nested properties of Hyper-V site.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Type of resource. Type = Microsoft.OffAzure/HyperVSites.
eTag String
eTag for concurrency control.
location String
Azure location in which Sites is created.
name String
Name of the Hyper-V site.
tags Map<String>

Supporting Types

SiteAgentPropertiesResponse

Id This property is required. string
Gets the ID of the agent.
LastHeartBeatUtc This property is required. string
Gets the last heartbeat time of the agent in UTC.
Version This property is required. string
Gets the version of the agent.
KeyVaultId string
Gets or sets the key vault ARM Id.
KeyVaultUri string
Gets or sets the key vault URI.
Id This property is required. string
Gets the ID of the agent.
LastHeartBeatUtc This property is required. string
Gets the last heartbeat time of the agent in UTC.
Version This property is required. string
Gets the version of the agent.
KeyVaultId string
Gets or sets the key vault ARM Id.
KeyVaultUri string
Gets or sets the key vault URI.
id This property is required. String
Gets the ID of the agent.
lastHeartBeatUtc This property is required. String
Gets the last heartbeat time of the agent in UTC.
version This property is required. String
Gets the version of the agent.
keyVaultId String
Gets or sets the key vault ARM Id.
keyVaultUri String
Gets or sets the key vault URI.
id This property is required. string
Gets the ID of the agent.
lastHeartBeatUtc This property is required. string
Gets the last heartbeat time of the agent in UTC.
version This property is required. string
Gets the version of the agent.
keyVaultId string
Gets or sets the key vault ARM Id.
keyVaultUri string
Gets or sets the key vault URI.
id This property is required. str
Gets the ID of the agent.
last_heart_beat_utc This property is required. str
Gets the last heartbeat time of the agent in UTC.
version This property is required. str
Gets the version of the agent.
key_vault_id str
Gets or sets the key vault ARM Id.
key_vault_uri str
Gets or sets the key vault URI.
id This property is required. String
Gets the ID of the agent.
lastHeartBeatUtc This property is required. String
Gets the last heartbeat time of the agent in UTC.
version This property is required. String
Gets the version of the agent.
keyVaultId String
Gets or sets the key vault ARM Id.
keyVaultUri String
Gets or sets the key vault URI.

SitePropertiesResponse

ServiceEndpoint This property is required. string
Service endpoint.
AgentDetails Pulumi.AzureNative.OffAzure.Inputs.SiteAgentPropertiesResponse
On-premises agent details.
ApplianceName string
Appliance Name.
DiscoverySolutionId string
ARM ID of migration hub solution for SDS.
ServicePrincipalIdentityDetails Pulumi.AzureNative.OffAzure.Inputs.SiteSpnPropertiesResponse
Service principal identity details used by agent for communication to the service.
ServiceEndpoint This property is required. string
Service endpoint.
AgentDetails SiteAgentPropertiesResponse
On-premises agent details.
ApplianceName string
Appliance Name.
DiscoverySolutionId string
ARM ID of migration hub solution for SDS.
ServicePrincipalIdentityDetails SiteSpnPropertiesResponse
Service principal identity details used by agent for communication to the service.
serviceEndpoint This property is required. String
Service endpoint.
agentDetails SiteAgentPropertiesResponse
On-premises agent details.
applianceName String
Appliance Name.
discoverySolutionId String
ARM ID of migration hub solution for SDS.
servicePrincipalIdentityDetails SiteSpnPropertiesResponse
Service principal identity details used by agent for communication to the service.
serviceEndpoint This property is required. string
Service endpoint.
agentDetails SiteAgentPropertiesResponse
On-premises agent details.
applianceName string
Appliance Name.
discoverySolutionId string
ARM ID of migration hub solution for SDS.
servicePrincipalIdentityDetails SiteSpnPropertiesResponse
Service principal identity details used by agent for communication to the service.
service_endpoint This property is required. str
Service endpoint.
agent_details SiteAgentPropertiesResponse
On-premises agent details.
appliance_name str
Appliance Name.
discovery_solution_id str
ARM ID of migration hub solution for SDS.
service_principal_identity_details SiteSpnPropertiesResponse
Service principal identity details used by agent for communication to the service.
serviceEndpoint This property is required. String
Service endpoint.
agentDetails Property Map
On-premises agent details.
applianceName String
Appliance Name.
discoverySolutionId String
ARM ID of migration hub solution for SDS.
servicePrincipalIdentityDetails Property Map
Service principal identity details used by agent for communication to the service.

SiteSpnPropertiesResponse

AadAuthority string
Gets or sets the AAD Authority URL which was used to request the token for the service principal.
ApplicationId string
Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
Audience string
Gets or sets the intended audience for the service principal.
ObjectId string

Gets or sets the object Id of the service principal with which the on-premise

       management/data plane components would communicate with our Azure

services.

RawCertData string
Gets or sets the raw certificate data for building certificate expiry flows.
TenantId string
Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
AadAuthority string
Gets or sets the AAD Authority URL which was used to request the token for the service principal.
ApplicationId string
Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
Audience string
Gets or sets the intended audience for the service principal.
ObjectId string

Gets or sets the object Id of the service principal with which the on-premise

       management/data plane components would communicate with our Azure

services.

RawCertData string
Gets or sets the raw certificate data for building certificate expiry flows.
TenantId string
Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
aadAuthority String
Gets or sets the AAD Authority URL which was used to request the token for the service principal.
applicationId String
Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience String
Gets or sets the intended audience for the service principal.
objectId String

Gets or sets the object Id of the service principal with which the on-premise

       management/data plane components would communicate with our Azure

services.

rawCertData String
Gets or sets the raw certificate data for building certificate expiry flows.
tenantId String
Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
aadAuthority string
Gets or sets the AAD Authority URL which was used to request the token for the service principal.
applicationId string
Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience string
Gets or sets the intended audience for the service principal.
objectId string

Gets or sets the object Id of the service principal with which the on-premise

       management/data plane components would communicate with our Azure

services.

rawCertData string
Gets or sets the raw certificate data for building certificate expiry flows.
tenantId string
Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
aad_authority str
Gets or sets the AAD Authority URL which was used to request the token for the service principal.
application_id str
Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience str
Gets or sets the intended audience for the service principal.
object_id str

Gets or sets the object Id of the service principal with which the on-premise

       management/data plane components would communicate with our Azure

services.

raw_cert_data str
Gets or sets the raw certificate data for building certificate expiry flows.
tenant_id str
Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
aadAuthority String
Gets or sets the AAD Authority URL which was used to request the token for the service principal.
applicationId String
Gets or sets the application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.
audience String
Gets or sets the intended audience for the service principal.
objectId String

Gets or sets the object Id of the service principal with which the on-premise

       management/data plane components would communicate with our Azure

services.

rawCertData String
Gets or sets the raw certificate data for building certificate expiry flows.
tenantId String
Gets or sets the tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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
pulumi/pulumi-azure-native