Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The masterSites resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.OffAzure/masterSites resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.OffAzure/masterSites@2024-05-01-preview' = {
location: 'string'
name: 'string'
properties: {
allowMultipleSites: bool
customerStorageAccountArmId: 'string'
publicNetworkAccess: 'string'
sites: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.OffAzure/masterSites
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | MasterSiteProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
MasterSiteProperties
| Name | Description | Value |
|---|---|---|
| allowMultipleSites | Gets or sets a value indicating whether multiple sites per site type are allowed. |
bool |
| customerStorageAccountArmId | Gets or sets a value for customer storage account ARM id. | string |
| publicNetworkAccess | Gets or sets the state of public network access. | 'Disabled' 'Enabled' 'NotSpecified' |
| sites | Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. |
string[] |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The masterSites resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.OffAzure/masterSites resource, add the following JSON to your template.
{
"type": "Microsoft.OffAzure/masterSites",
"apiVersion": "2024-05-01-preview",
"name": "string",
"location": "string",
"properties": {
"allowMultipleSites": "bool",
"customerStorageAccountArmId": "string",
"publicNetworkAccess": "string",
"sites": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.OffAzure/masterSites
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | MasterSiteProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.OffAzure/masterSites' |
MasterSiteProperties
| Name | Description | Value |
|---|---|---|
| allowMultipleSites | Gets or sets a value indicating whether multiple sites per site type are allowed. |
bool |
| customerStorageAccountArmId | Gets or sets a value for customer storage account ARM id. | string |
| publicNetworkAccess | Gets or sets the state of public network access. | 'Disabled' 'Enabled' 'NotSpecified' |
| sites | Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. |
string[] |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The masterSites resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.OffAzure/masterSites resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.OffAzure/masterSites@2024-05-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
allowMultipleSites = bool
customerStorageAccountArmId = "string"
publicNetworkAccess = "string"
sites = [
"string"
]
}
}
}
Property Values
Microsoft.OffAzure/masterSites
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | MasterSiteProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.OffAzure/masterSites@2024-05-01-preview" |
MasterSiteProperties
| Name | Description | Value |
|---|---|---|
| allowMultipleSites | Gets or sets a value indicating whether multiple sites per site type are allowed. |
bool |
| customerStorageAccountArmId | Gets or sets a value for customer storage account ARM id. | string |
| publicNetworkAccess | Gets or sets the state of public network access. | 'Disabled' 'Enabled' 'NotSpecified' |
| sites | Gets or sets the sites that are a part of Master Site. The key should contain the Site ARM name. |
string[] |
TrackedResourceTags
| Name | Description | Value |
|---|