Azure Arc License [Microsoft.HybridCompute/licenses]

This module deploys an Azure Arc License for use with Azure Arc-enabled servers. This module should not be used for other Arc-enabled server scenarios, where the Arc License resource is created automatically by the onboarding process.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/arc-license/main.bicep.

• Using only defaults
• WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

module license './packages/arc-license/main.bicep' = {
  name: 'licenseDeployment'
  params: {
    name: 'hclmin001'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "value": "hclmin001"
    }
  }
}

using './packages/arc-license/main.bicep'

param name = 'hclmin001'

Example 2: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module license './packages/arc-license/main.bicep' = {
  name: 'licenseDeployment'
  params: {
    name: 'hclwaf001'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "value": "hclwaf001"
    }
  }
}

using './packages/arc-license/main.bicep'

param name = 'hclwaf001'

Parameters

Required parameters

Optional parameters

Parameter: name

The name of the Azure Arc License to be created.

• Required: Yes
• Type: string

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: licenseDetailEdition

Describes the edition of the license. Default is Standard.

• Required: No
• Type: string
• Default: 'Standard'
• Allowed:

  [
    'Datacenter'
    'Standard'
  ]
  

Parameter: licenseDetailProcessors

Describes the number of processors.

• Required: No
• Type: int
• Default: 8
• MinValue: 8

Parameter: licenseDetailState

Describes the license state. Default is Deactivated.

• Required: No
• Type: string
• Default: 'Deactivated'
• Allowed:

  [
    'Active'
    'Deactivated'
  ]
  

• MinValue: 8

Parameter: licenseDetailTarget

Describes the license target server. Default is Windows Server 2012 R2.

• Required: No
• Type: string
• Default: 'Windows Server 2012 R2'
• Allowed:

  [
    'Windows Server 2012'
    'Windows Server 2012 R2'
  ]
  

• MinValue: 8

Parameter: licenseDetailType

Provide the core type (vCore or pCore) needed for this ESU licens. Default is vCore.

• Required: No
• Type: string
• Default: 'vCore'
• Allowed:

  [
    'pCore'
    'vCore'
  ]
  

• MinValue: 8

Parameter: licenseType

The type of the license resource. The value is ESU.

• Required: No
• Type: string
• Default: 'ESU'
• Allowed:

  [
    'ESU'
  ]
  

• MinValue: 8

Parameter: licenseVolumeLicenseDetails

A list of volume license details.

• Required: No
• Type: array
• Default: []
• MinValue: 8

Required parameters

Parameter: licenseVolumeLicenseDetails.invoiceId

The invoice id for the volume license.

• Required: Yes
• Type: string
• MinValue: 8

Parameter: licenseVolumeLicenseDetails.programYear

Describes the program year the volume license is for.

• Required: Yes
• Type: string
• Allowed:

  [
    'Year 1'
    'Year 2'
    'Year 3'
  ]
  

• MinValue: 8

Parameter: location

The location of the Azure Arc License to be created.

• Required: No
• Type: string
• Default: [resourceGroup().location]
• MinValue: 8

Parameter: tags

Tags of the resource.

• Required: No
• Type: object
• MinValue: 8

Parameter: tenantId

The tenant ID of the license resource. Default is the tenant ID of the current subscription.

• Required: No
• Type: string
• Default: [tenant().tenantId]
• MinValue: 8

Outputs

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.