1. Packages
  2. Azure Native v2
  3. API Docs
  4. offazure
  5. getSitesController
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.offazure.getSitesController

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 VmwareSite Azure REST API version: 2023-06-06.

Other available API versions: 2023-10-01-preview, 2024-05-01-preview.

Using getSitesController

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 getSitesController(args: GetSitesControllerArgs, opts?: InvokeOptions): Promise<GetSitesControllerResult>
function getSitesControllerOutput(args: GetSitesControllerOutputArgs, opts?: InvokeOptions): Output<GetSitesControllerResult>
Copy
def get_sites_controller(resource_group_name: Optional[str] = None,
                         site_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSitesControllerResult
def get_sites_controller_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                         site_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSitesControllerResult]
Copy
func LookupSitesController(ctx *Context, args *LookupSitesControllerArgs, opts ...InvokeOption) (*LookupSitesControllerResult, error)
func LookupSitesControllerOutput(ctx *Context, args *LookupSitesControllerOutputArgs, opts ...InvokeOption) LookupSitesControllerResultOutput
Copy

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

public static class GetSitesController 
{
    public static Task<GetSitesControllerResult> InvokeAsync(GetSitesControllerArgs args, InvokeOptions? opts = null)
    public static Output<GetSitesControllerResult> Invoke(GetSitesControllerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSitesControllerResult> getSitesController(GetSitesControllerArgs args, InvokeOptions options)
public static Output<GetSitesControllerResult> getSitesController(GetSitesControllerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:offazure:getSitesController
  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

getSitesController Result

The following output properties are available:

ETag string
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
MasterSiteId string
Gets the Master Site this site is linked to.
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
ServiceEndpoint string
Gets the service endpoint.
SystemData Pulumi.AzureNative.OffAzure.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AgentDetails Pulumi.AzureNative.OffAzure.Outputs.SiteAgentPropertiesResponse
Gets or sets the on-premises agent details.
ApplianceName string
Gets or sets the Appliance Name.
DiscoverySolutionId string
Gets or sets the ARM ID of migration hub solution for SDS.
ServicePrincipalIdentityDetails Pulumi.AzureNative.OffAzure.Outputs.SiteSpnPropertiesResponse
Gets or sets the service principal identity details used by agent for communication to the service.
Tags Dictionary<string, string>
Resource tags.
ETag string
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
MasterSiteId string
Gets the Master Site this site is linked to.
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
ServiceEndpoint string
Gets the service endpoint.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AgentDetails SiteAgentPropertiesResponse
Gets or sets the on-premises agent details.
ApplianceName string
Gets or sets the Appliance Name.
DiscoverySolutionId string
Gets or sets the ARM ID of migration hub solution for SDS.
ServicePrincipalIdentityDetails SiteSpnPropertiesResponse
Gets or sets the service principal identity details used by agent for communication to the service.
Tags map[string]string
Resource tags.
eTag String
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
masterSiteId String
Gets the Master Site this site is linked to.
name String
The name of the resource
provisioningState String
The status of the last operation.
serviceEndpoint String
Gets the service endpoint.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agentDetails SiteAgentPropertiesResponse
Gets or sets the on-premises agent details.
applianceName String
Gets or sets the Appliance Name.
discoverySolutionId String
Gets or sets the ARM ID of migration hub solution for SDS.
servicePrincipalIdentityDetails SiteSpnPropertiesResponse
Gets or sets the service principal identity details used by agent for communication to the service.
tags Map<String,String>
Resource tags.
eTag string
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
masterSiteId string
Gets the Master Site this site is linked to.
name string
The name of the resource
provisioningState string
The status of the last operation.
serviceEndpoint string
Gets the service endpoint.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agentDetails SiteAgentPropertiesResponse
Gets or sets the on-premises agent details.
applianceName string
Gets or sets the Appliance Name.
discoverySolutionId string
Gets or sets the ARM ID of migration hub solution for SDS.
servicePrincipalIdentityDetails SiteSpnPropertiesResponse
Gets or sets the service principal identity details used by agent for communication to the service.
tags {[key: string]: string}
Resource tags.
e_tag str
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
master_site_id str
Gets the Master Site this site is linked to.
name str
The name of the resource
provisioning_state str
The status of the last operation.
service_endpoint str
Gets the service endpoint.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agent_details SiteAgentPropertiesResponse
Gets or sets the on-premises agent details.
appliance_name str
Gets or sets the Appliance Name.
discovery_solution_id str
Gets or sets the ARM ID of migration hub solution for SDS.
service_principal_identity_details SiteSpnPropertiesResponse
Gets or sets the service principal identity details used by agent for communication to the service.
tags Mapping[str, str]
Resource tags.
eTag String
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
masterSiteId String
Gets the Master Site this site is linked to.
name String
The name of the resource
provisioningState String
The status of the last operation.
serviceEndpoint String
Gets the service endpoint.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agentDetails Property Map
Gets or sets the on-premises agent details.
applianceName String
Gets or sets the Appliance Name.
discoverySolutionId String
Gets or sets the ARM ID of migration hub solution for SDS.
servicePrincipalIdentityDetails Property Map
Gets or sets the service principal identity details used by agent for communication to the service.
tags Map<String>
Resource tags.

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.

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