license_profiles

Creates, updates, deletes, gets or lists a license_profiles resource.

Overview

Name	license_profiles
Type	Resource
Id	azure.hybrid_compute.license_profiles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
esuProfile	object	Hybrid Compute ESU Profile properties.
location	string	The geo-location where the resource lives. Required.
productProfile	object	Hybrid Compute Product Profile properties.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Accepted", "Canceled", and "Deleted". (Creating, Updating, Deleting, Succeeded, Failed, Accepted, Canceled, Deleted)
softwareAssurance	object	:vartype software_assurance: ~azure.mgmt.hybridcompute.models.LicenseProfilePropertiesSoftwareAssurance
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, machine_name, subscription_id		Retrieves information about the view of a license profile.
create_or_update	insert	resource_group_name, machine_name, subscription_id, location		The operation to create or update a license profile.
update	update	resource_group_name, machine_name, subscription_id		The operation to update a license profile.
create_or_update	replace	resource_group_name, machine_name, subscription_id, location		The operation to create or update a license profile.
delete	delete	resource_group_name, machine_name, subscription_id		The operation to delete a license profile.
list_raw	exec	resource_group_name, machine_name, subscription_id		The operation to get all license profiles of a non-Azure machine.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
machine_name	string	The name of the hybrid machine. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves information about the view of a license profile.

SELECT
id,
name,
esuProfile,
location,
productProfile,
provisioningState,
softwareAssurance,
systemData,
tags,
type
FROM azure.hybrid_compute.license_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND machine_name = '{{ machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a license profile.

INSERT INTO azure.hybrid_compute.license_profiles (
tags,
location,
properties,
resource_group_name,
machine_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ machine_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: license_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the license_profiles resource.
  - name: machine_name
    value: "{{ machine_name }}"
    description: Required parameter for the license_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the license_profiles resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describe the properties of a license profile.
    value:
      softwareAssurance:
        softwareAssuranceCustomer: {{ softwareAssuranceCustomer }}
      esuProfile:
        assignedLicenseImmutableId: "{{ assignedLicenseImmutableId }}"
        esuKeys:
          - sku: "{{ sku }}"
            licenseStatus: {{ licenseStatus }}
        serverType: "{{ serverType }}"
        esuEligibility: "{{ esuEligibility }}"
        esuKeyState: "{{ esuKeyState }}"
        assignedLicense: "{{ assignedLicense }}"
      productProfile:
        subscriptionStatus: "{{ subscriptionStatus }}"
        productType: "{{ productType }}"
        enrollmentDate: "{{ enrollmentDate }}"
        billingStartDate: "{{ billingStartDate }}"
        disenrollmentDate: "{{ disenrollmentDate }}"
        billingEndDate: "{{ billingEndDate }}"
        error:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"
              additionalInfo: "{{ additionalInfo }}"
          additionalInfo:
            - type: "{{ type }}"
              info: "{{ info }}"
        productFeatures:
          - name: "{{ name }}"
            subscriptionStatus: "{{ subscriptionStatus }}"
            enrollmentDate: "{{ enrollmentDate }}"
            billingStartDate: "{{ billingStartDate }}"
            disenrollmentDate: "{{ disenrollmentDate }}"
            billingEndDate: "{{ billingEndDate }}"
            error:
              code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details:
                - code: "{{ code }}"
                  message: "{{ message }}"
                  target: "{{ target }}"
                  details: "{{ details }}"
                  additionalInfo: "{{ additionalInfo }}"
              additionalInfo:
                - type: "{{ type }}"
                  info: "{{ info }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

The operation to update a license profile.

UPDATE azure.hybrid_compute.license_profiles
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

The operation to create or update a license profile.

REPLACE azure.hybrid_compute.license_profiles
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a license profile.

DELETE FROM azure.hybrid_compute.license_profiles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_raw

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

EXEC azure.hybrid_compute.license_profiles.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@machine_name='{{ machine_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;