1. Packages
  2. Azure Native
  3. API Docs
  4. offazure
  5. getMasterSitesController
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.offazure.getMasterSitesController

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

Get a MasterSite

Uses Azure REST API version 2023-10-01-preview.

Other available API versions: 2023-06-06, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native offazure [ApiVersion]. See the version guide for details.

Using getMasterSitesController

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 getMasterSitesController(args: GetMasterSitesControllerArgs, opts?: InvokeOptions): Promise<GetMasterSitesControllerResult>
function getMasterSitesControllerOutput(args: GetMasterSitesControllerOutputArgs, opts?: InvokeOptions): Output<GetMasterSitesControllerResult>
Copy
def get_master_sites_controller(resource_group_name: Optional[str] = None,
                                site_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetMasterSitesControllerResult
def get_master_sites_controller_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                site_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetMasterSitesControllerResult]
Copy
func LookupMasterSitesController(ctx *Context, args *LookupMasterSitesControllerArgs, opts ...InvokeOption) (*LookupMasterSitesControllerResult, error)
func LookupMasterSitesControllerOutput(ctx *Context, args *LookupMasterSitesControllerOutputArgs, opts ...InvokeOption) LookupMasterSitesControllerResultOutput
Copy

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

public static class GetMasterSitesController 
{
    public static Task<GetMasterSitesControllerResult> InvokeAsync(GetMasterSitesControllerArgs args, InvokeOptions? opts = null)
    public static Output<GetMasterSitesControllerResult> Invoke(GetMasterSitesControllerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMasterSitesControllerResult> getMasterSitesController(GetMasterSitesControllerArgs args, InvokeOptions options)
public static Output<GetMasterSitesControllerResult> getMasterSitesController(GetMasterSitesControllerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:offazure:getMasterSitesController
  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

getMasterSitesController Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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
Name string
The name of the resource
NestedSites List<string>
Gets the nested sites under Master Site.
PrivateEndpointConnections List<Pulumi.AzureNative.OffAzure.Outputs.PrivateEndpointConnectionResponse>
Gets the private endpoint connections.
ProvisioningState string
provisioning state enum
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"
AllowMultipleSites bool
Gets or sets a value indicating whether multiple sites per site type are allowed.
CustomerStorageAccountArmId string
Gets or sets a value for customer storage account ARM id.
PublicNetworkAccess string
Gets or sets the state of public network access.
Sites List<string>
Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
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
Name string
The name of the resource
NestedSites []string
Gets the nested sites under Master Site.
PrivateEndpointConnections []PrivateEndpointConnectionResponse
Gets the private endpoint connections.
ProvisioningState string
provisioning state enum
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"
AllowMultipleSites bool
Gets or sets a value indicating whether multiple sites per site type are allowed.
CustomerStorageAccountArmId string
Gets or sets a value for customer storage account ARM id.
PublicNetworkAccess string
Gets or sets the state of public network access.
Sites []string
Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
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
name String
The name of the resource
nestedSites List<String>
Gets the nested sites under Master Site.
privateEndpointConnections List<PrivateEndpointConnectionResponse>
Gets the private endpoint connections.
provisioningState String
provisioning state enum
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"
allowMultipleSites Boolean
Gets or sets a value indicating whether multiple sites per site type are allowed.
customerStorageAccountArmId String
Gets or sets a value for customer storage account ARM id.
publicNetworkAccess String
Gets or sets the state of public network access.
sites List<String>
Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
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
name string
The name of the resource
nestedSites string[]
Gets the nested sites under Master Site.
privateEndpointConnections PrivateEndpointConnectionResponse[]
Gets the private endpoint connections.
provisioningState string
provisioning state enum
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"
allowMultipleSites boolean
Gets or sets a value indicating whether multiple sites per site type are allowed.
customerStorageAccountArmId string
Gets or sets a value for customer storage account ARM id.
publicNetworkAccess string
Gets or sets the state of public network access.
sites string[]
Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
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
name str
The name of the resource
nested_sites Sequence[str]
Gets the nested sites under Master Site.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
Gets the private endpoint connections.
provisioning_state str
provisioning state enum
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"
allow_multiple_sites bool
Gets or sets a value indicating whether multiple sites per site type are allowed.
customer_storage_account_arm_id str
Gets or sets a value for customer storage account ARM id.
public_network_access str
Gets or sets the state of public network access.
sites Sequence[str]
Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
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
name String
The name of the resource
nestedSites List<String>
Gets the nested sites under Master Site.
privateEndpointConnections List<Property Map>
Gets the private endpoint connections.
provisioningState String
provisioning state enum
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"
allowMultipleSites Boolean
Gets or sets a value indicating whether multiple sites per site type are allowed.
customerStorageAccountArmId String
Gets or sets a value for customer storage account ARM id.
publicNetworkAccess String
Gets or sets the state of public network access.
sites List<String>
Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name.
tags Map<String>
Resource tags.

Supporting Types

PrivateEndpointConnectionResponse

GroupIds This property is required. List<string>
array of group ids
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateEndpoint This property is required. Pulumi.AzureNative.OffAzure.Inputs.ResourceIdResponse
private endpoints
ProvisioningState This property is required. string
provisioning state enum
SystemData This property is required. Pulumi.AzureNative.OffAzure.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateLinkServiceConnectionState Pulumi.AzureNative.OffAzure.Inputs.PrivateLinkServiceConnectionStateResponse
private endpoints connection state
GroupIds This property is required. []string
array of group ids
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateEndpoint This property is required. ResourceIdResponse
private endpoints
ProvisioningState This property is required. string
provisioning state enum
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
private endpoints connection state
groupIds This property is required. List<String>
array of group ids
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateEndpoint This property is required. ResourceIdResponse
private endpoints
provisioningState This property is required. String
provisioning state enum
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
private endpoints connection state
groupIds This property is required. string[]
array of group ids
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
privateEndpoint This property is required. ResourceIdResponse
private endpoints
provisioningState This property is required. string
provisioning state enum
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
private endpoints connection state
group_ids This property is required. Sequence[str]
array of group ids
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
private_endpoint This property is required. ResourceIdResponse
private endpoints
provisioning_state This property is required. str
provisioning state enum
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
private endpoints connection state
groupIds This property is required. List<String>
array of group ids
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateEndpoint This property is required. Property Map
private endpoints
provisioningState This property is required. String
provisioning state enum
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateLinkServiceConnectionState Property Map
private endpoints connection state

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
actions required
Description string
description string
Status string
state status
ActionsRequired string
actions required
Description string
description string
Status string
state status
actionsRequired String
actions required
description String
description string
status String
state status
actionsRequired string
actions required
description string
description string
status string
state status
actions_required str
actions required
description str
description string
status str
state status
actionsRequired String
actions required
description String
description string
status String
state status

ResourceIdResponse

Id This property is required. string
id name
Id This property is required. string
id name
id This property is required. String
id name
id This property is required. string
id name
id This property is required. str
id name
id This property is required. String
id name

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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi