License Profiles - List

Service:: Hybrid Compute

API Version:: 2025-01-13

The operation to get all license profiles of a non-Azure machine

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles?api-version=2025-01-13

URI Parameters

Name	In	Required	Type	Description
machineName	path	True	string minLength: 1 maxLength: 54 pattern: ^[a-zA-Z0-9-_\.]{1,54}$	The name of the machine.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	LicenseProfilesListResult	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List all License Profiles

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/licenseProfiles?api-version=2025-01-13

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default",
      "name": "default",
      "type": "Microsoft.HybridCompute/machines/licenseProfiles",
      "location": "eastus2euap",
      "tags": null,
      "properties": {
        "softwareAssurance": {
          "softwareAssuranceCustomer": true
        },
        "esuProfile": {
          "assignedLicense": "{LicenseResourceId}",
          "esuEligibility": "Eligible",
          "serverType": "Standard",
          "esuKeyState": "Inactive",
          "esuKeys": [
            {
              "sku": "skuNumber1",
              "licenseStatus": 1
            },
            {
              "sku": "skuNumber2",
              "licenseStatus": 1
            }
          ]
        },
        "productProfile": {
          "subscriptionStatus": "Enabled",
          "productType": "WindowsServer",
          "enrollmentDate": "2023-10-05T20:36:49.745Z",
          "billingStartDate": "2023-10-05T20:36:49.745Z",
          "disenrollmentDate": "2023-11-05T20:36:49.745Z",
          "billingEndDate": "2023-11-05T20:36:49.745Z",
          "productFeatures": [
            {
              "name": "Hotpatch",
              "subscriptionStatus": "Enabled",
              "enrollmentDate": "2023-10-05T20:36:49.745Z",
              "billingStartDate": "2023-10-05T20:36:49.745Z",
              "disenrollmentDate": "2023-11-05T20:36:49.745Z",
              "billingEndDate": "2023-11-05T20:36:49.745Z"
            }
          ]
        }
      }
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
EsuEligibility	The ESU eligibility.
EsuKey	ESU key
EsuKeyState	The ESU key state.
EsuServerType	The server types for Esu.
LicenseProfile	Describes a license profile in a hybrid machine.
LicenseProfileProductType	The product type of the license.
LicenseProfilesListResult	The List hybrid machine license profile operation response.
LicenseProfileSubscriptionStatus	Subscription status of the OS or Product feature.
ProductFeature	Product Feature
ProvisioningState	The provisioning state, which only appears in the response.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

EsuEligibility

Enumeration

The ESU eligibility.

Value	Description
Eligible
Ineligible
Unknown

EsuKey

Object

ESU key

Name	Type	Description
licenseStatus	integer (int32)	The current status of the license profile key. Represented by the same integer value that is presented on the machine itself when querying the license key status.
sku	string	SKU number.

EsuKeyState

Enumeration

The ESU key state.

Value	Description
Inactive
Active

EsuServerType

Enumeration

The server types for Esu.

Value	Description
Standard
Datacenter

LicenseProfile

Object

Describes a license profile in a hybrid machine.

Name	Type	Description
assignedLicenseImmutableId	string	The guid id of the license.
esuKeys	EsuKey[]	The list of ESU keys.
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
properties.esuProfile.assignedLicense	string	The resource id of the license.
properties.esuProfile.esuEligibility	EsuEligibility	Indicates the eligibility state of Esu.
properties.esuProfile.esuKeyState	EsuKeyState	Indicates whether there is an ESU Key currently active for the machine.
properties.esuProfile.serverType	EsuServerType	The type of the Esu servers.
properties.productProfile.billingEndDate	string (date-time)	The timestamp in UTC when the billing ends.
properties.productProfile.billingStartDate	string (date-time)	The timestamp in UTC when the billing starts.
properties.productProfile.disenrollmentDate	string (date-time)	The timestamp in UTC when the user disenrolled the feature.
properties.productProfile.enrollmentDate	string (date-time)	The timestamp in UTC when the user enrolls the feature.
properties.productProfile.error	ErrorDetail	The errors that were encountered during the feature enrollment or disenrollment.
properties.productProfile.productFeatures	ProductFeature[]	The list of product features.
properties.productProfile.productType	LicenseProfileProductType	Indicates the product type of the license.
properties.productProfile.subscriptionStatus	LicenseProfileSubscriptionStatus	Indicates the subscription status of the product.
properties.provisioningState	ProvisioningState	The provisioning state, which only appears in the response.
properties.softwareAssurance.softwareAssuranceCustomer	boolean	Specifies if this machine is licensed as part of a Software Assurance agreement.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

LicenseProfileProductType

Enumeration

The product type of the license.

Value	Description
WindowsServer
WindowsIoTEnterprise