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 sites 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.HybridNetwork/sites resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridNetwork/sites@2024-04-15' = {
location: 'string'
name: 'string'
properties: {
nfvis: [
{
name: 'string'
nfviType: 'string'
// For remaining properties, see NFVIs objects
}
]
}
tags: {
{customized property}: 'string'
}
}
NFVIs objects
Set the nfviType property to specify the type of object.
For AzureArcKubernetes, use:
{
customLocationReference: {
id: 'string'
}
nfviType: 'AzureArcKubernetes'
}
For AzureCore, use:
{
location: 'string'
nfviType: 'AzureCore'
}
For AzureOperatorNexus, use:
{
customLocationReference: {
id: 'string'
}
nfviType: 'AzureOperatorNexus'
}
Property Values
Microsoft.HybridNetwork/sites
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Site properties. | SitePropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AzureArcK8SClusterNfviDetails
| Name | Description | Value |
|---|---|---|
| customLocationReference | The reference to the custom location. | ReferencedResource |
| nfviType | The NFVI type. | 'AzureArcKubernetes' (required) |
AzureCoreNfviDetails
| Name | Description | Value |
|---|---|---|
| location | Location of the Azure core. | string |
| nfviType | The NFVI type. | 'AzureCore' (required) |
AzureOperatorNexusClusterNfviDetails
| Name | Description | Value |
|---|---|---|
| customLocationReference | The reference to the custom location. | ReferencedResource |
| nfviType | The NFVI type. | 'AzureOperatorNexus' (required) |
NFVIs
| Name | Description | Value |
|---|---|---|
| name | Name of the nfvi. | string |
| nfviType | Set to 'AzureArcKubernetes' for type AzureArcK8SClusterNfviDetails. Set to 'AzureCore' for type AzureCoreNfviDetails. Set to 'AzureOperatorNexus' for type AzureOperatorNexusClusterNfviDetails. | 'AzureArcKubernetes' 'AzureCore' 'AzureOperatorNexus' (required) |
ReferencedResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
SitePropertiesFormat
| Name | Description | Value |
|---|---|---|
| nfvis | List of NFVIs | NFVIs[] |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The sites 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.
Usage Examples
Resource format
To create a Microsoft.HybridNetwork/sites resource, add the following JSON to your template.
{
"type": "Microsoft.HybridNetwork/sites",
"apiVersion": "2024-04-15",
"name": "string",
"location": "string",
"properties": {
"nfvis": [ {
"name": "string",
"nfviType": "string"
// For remaining properties, see NFVIs objects
} ]
},
"tags": {
"{customized property}": "string"
}
}
NFVIs objects
Set the nfviType property to specify the type of object.
For AzureArcKubernetes, use:
{
"customLocationReference": {
"id": "string"
},
"nfviType": "AzureArcKubernetes"
}
For AzureCore, use:
{
"location": "string",
"nfviType": "AzureCore"
}
For AzureOperatorNexus, use:
{
"customLocationReference": {
"id": "string"
},
"nfviType": "AzureOperatorNexus"
}
Property Values
Microsoft.HybridNetwork/sites
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-04-15' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Site properties. | SitePropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HybridNetwork/sites' |
AzureArcK8SClusterNfviDetails
| Name | Description | Value |
|---|---|---|
| customLocationReference | The reference to the custom location. | ReferencedResource |
| nfviType | The NFVI type. | 'AzureArcKubernetes' (required) |
AzureCoreNfviDetails
| Name | Description | Value |
|---|---|---|
| location | Location of the Azure core. | string |
| nfviType | The NFVI type. | 'AzureCore' (required) |
AzureOperatorNexusClusterNfviDetails
| Name | Description | Value |
|---|---|---|
| customLocationReference | The reference to the custom location. | ReferencedResource |
| nfviType | The NFVI type. | 'AzureOperatorNexus' (required) |
NFVIs
| Name | Description | Value |
|---|---|---|
| name | Name of the nfvi. | string |
| nfviType | Set to 'AzureArcKubernetes' for type AzureArcK8SClusterNfviDetails. Set to 'AzureCore' for type AzureCoreNfviDetails. Set to 'AzureOperatorNexus' for type AzureOperatorNexusClusterNfviDetails. | 'AzureArcKubernetes' 'AzureCore' 'AzureOperatorNexus' (required) |
ReferencedResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
SitePropertiesFormat
| Name | Description | Value |
|---|---|---|
| nfvis | List of NFVIs | NFVIs[] |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The sites 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.HybridNetwork/sites resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridNetwork/sites@2024-04-15"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
nfvis = [
{
name = "string"
nfviType = "string"
// For remaining properties, see NFVIs objects
}
]
}
}
}
NFVIs objects
Set the nfviType property to specify the type of object.
For AzureArcKubernetes, use:
{
customLocationReference = {
id = "string"
}
nfviType = "AzureArcKubernetes"
}
For AzureCore, use:
{
location = "string"
nfviType = "AzureCore"
}
For AzureOperatorNexus, use:
{
customLocationReference = {
id = "string"
}
nfviType = "AzureOperatorNexus"
}
Property Values
Microsoft.HybridNetwork/sites
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Site properties. | SitePropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HybridNetwork/sites@2024-04-15" |
AzureArcK8SClusterNfviDetails
| Name | Description | Value |
|---|---|---|
| customLocationReference | The reference to the custom location. | ReferencedResource |
| nfviType | The NFVI type. | 'AzureArcKubernetes' (required) |
AzureCoreNfviDetails
| Name | Description | Value |
|---|---|---|
| location | Location of the Azure core. | string |
| nfviType | The NFVI type. | 'AzureCore' (required) |
AzureOperatorNexusClusterNfviDetails
| Name | Description | Value |
|---|---|---|
| customLocationReference | The reference to the custom location. | ReferencedResource |
| nfviType | The NFVI type. | 'AzureOperatorNexus' (required) |
NFVIs
| Name | Description | Value |
|---|---|---|
| name | Name of the nfvi. | string |
| nfviType | Set to 'AzureArcKubernetes' for type AzureArcK8SClusterNfviDetails. Set to 'AzureCore' for type AzureCoreNfviDetails. Set to 'AzureOperatorNexus' for type AzureOperatorNexusClusterNfviDetails. | 'AzureArcKubernetes' 'AzureCore' 'AzureOperatorNexus' (required) |
ReferencedResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
SitePropertiesFormat
| Name | Description | Value |
|---|---|---|
| nfvis | List of NFVIs | NFVIs[] |
TrackedResourceTags
| Name | Description | Value |
|---|