azure.mgmt.hybridcompute.models module

exception azure.mgmt.hybridcompute.models.ErrorResponseException(deserialize, response, *args)

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters

• deserialize – A deserializer

• response – Server response to be deserialized.

class azure.mgmt.hybridcompute.models.AzureEntityResource(**kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.Resource

The resource model definition for a Azure Resource Manager resource with an etag.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name (str) – The name of the resource

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

• etag (str) – Resource Etag.

class azure.mgmt.hybridcompute.models.ErrorDetail(*, code: str, message: str, target: str = None, details=None, **kwargs)

Bases: msrest.serialization.Model

Error details.

All required parameters must be populated in order to send to Azure.

Parameters

• code (str) – Required. The error’s code.

• message (str) – Required. A human readable error message.

• target (str) – Indicates which property in the request is responsible for the error.

• details (list[ErrorDetail]) – Additional error details.

class azure.mgmt.hybridcompute.models.ErrorResponse(*, error, **kwargs)

Bases: msrest.serialization.Model

Error response.

Contains details when the response code indicates an error.

All required parameters must be populated in order to send to Azure.

Parameters

error (ErrorDetail) – Required. The error details.

class azure.mgmt.hybridcompute.models.Identity(*, type: str = None, **kwargs)

Bases: msrest.serialization.Model

Managed Identity.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

type (str) – The identity type.

Variables

• principal_id (str) – The identity’s principal id.

• tenant_id (str) – The identity’s tenant id.

class azure.mgmt.hybridcompute.models.LocationData(*, name: str, city: str = None, district: str = None, country_or_region: str = None, **kwargs)

Bases: msrest.serialization.Model

Metadata pertaining to the geographic location of the resource.

All required parameters must be populated in order to send to Azure.

Parameters

• name (str) – Required. A canonical name for the geographic or physical location.

• city (str) – The city or locality where the resource is located.

• district (str) – The district, state, or province where the resource is located.

• country_or_region (str) – The country or region where the resource is located

class azure.mgmt.hybridcompute.models.Machine(*, location: str, tags=None, location_data=None, os_profile=None, vm_id: str = None, client_public_key: str = None, identity=None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.TrackedResource

Describes a hybrid machine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name (str) – The name of the resource

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

• provisioning_state (str) – The provisioning state, which only appears in the response.

• status (str or StatusTypes) – The status of the hybrid machine agent. Possible values include: ‘Connected’, ‘Disconnected’, ‘Error’

• last_status_change (datetime) – The time of the last status change.

• error_details (list[ErrorDetail]) – Details about the error state.

• agent_version (str) – The hybrid machine agent full version.

• display_name (str) – Specifies the hybrid machine display name.

• machine_fqdn (str) – Specifies the hybrid machine FQDN.

• os_name (str) – The Operating System running on the hybrid machine.

• os_version (str) – The version of Operating System running on the hybrid machine.

• vm_uuid (str) – Specifies the Arc Machine’s unique SMBIOS ID

• extensions (list[MachineExtensionInstanceView]) – Machine Extensions information

• os_sku (str) – Specifies the Operating System product SKU.

• domain_name (str) – Specifies the Windows domain name.

• ad_fqdn (str) – Specifies the AD fully qualified display name.

• dns_fqdn (str) – Specifies the DNS fully qualified display name.

Parameters

• tags (dict[str, str]) – Resource tags.

• location (str) – Required. The geo-location where the resource lives

• location_data (LocationData) –

• os_profile (MachinePropertiesOsProfile) – Specifies the operating system settings for the hybrid machine.

• vm_id (str) – Specifies the hybrid machine unique ID.

• client_public_key (str) – Public Key that the client provides to be used during initial resource onboarding

• identity (MachineIdentity) –

class azure.mgmt.hybridcompute.models.MachineExtension(*, location: str, tags=None, force_update_tag: str = None, publisher: str = None, machine_extension_type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, instance_view=None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.TrackedResource

Describes a Machine Extension.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name (str) – The name of the resource

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

• provisioning_state (str) – The provisioning state, which only appears in the response.

Parameters

• tags (dict[str, str]) – Resource tags.

• location (str) – Required. The geo-location where the resource lives

• force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.

• publisher (str) – The name of the extension handler publisher.

• machine_extension_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

• type_handler_version (str) – Specifies the version of the script handler.

• auto_upgrade_minor_version (bool) – Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

• settings (object) – Json formatted public settings for the extension.

• protected_settings (object) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

• instance_view (MachineExtensionPropertiesInstanceView) – The machine extension instance view.

class azure.mgmt.hybridcompute.models.MachineExtensionInstanceView(*, status=None, **kwargs)

Bases: msrest.serialization.Model

Describes the Machine Extension Instance View.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• name (str) – The machine extension name.

• type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

• type_handler_version (str) – Specifies the version of the script handler.

Parameters

status (MachineExtensionInstanceViewStatus) – Instance view status.

class azure.mgmt.hybridcompute.models.MachineExtensionInstanceViewStatus(**kwargs)

Bases: msrest.serialization.Model

Instance view status.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• code (str) – The status code.

• level (str or StatusLevelTypes) – The level code. Possible values include: ‘Info’, ‘Warning’, ‘Error’

• display_status (str) – The short localizable label for the status.

• message (str) – The detailed status message, including for alerts and error messages.

• time (datetime) – The time of the status.

class azure.mgmt.hybridcompute.models.MachineExtensionPropertiesInstanceView(*, status=None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.MachineExtensionInstanceView

The machine extension instance view.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• name (str) – The machine extension name.

• type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

• type_handler_version (str) – Specifies the version of the script handler.

Parameters

status (MachineExtensionInstanceViewStatus) – Instance view status.

class azure.mgmt.hybridcompute.models.MachineExtensionPropertiesModel(*, force_update_tag: str = None, publisher: str = None, type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, instance_view=None, **kwargs)

Bases: msrest.serialization.Model

Describes the properties of a Machine Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

• force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.

• publisher (str) – The name of the extension handler publisher.

• type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

• type_handler_version (str) – Specifies the version of the script handler.

• auto_upgrade_minor_version (bool) – Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

• settings (object) – Json formatted public settings for the extension.

• protected_settings (object) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

• instance_view (MachineExtensionPropertiesInstanceView) – The machine extension instance view.

Variables

provisioning_state (str) – The provisioning state, which only appears in the response.

class azure.mgmt.hybridcompute.models.MachineExtensionUpdate(*, tags=None, force_update_tag: str = None, publisher: str = None, type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.UpdateResource

Describes a Machine Extension Update.

Parameters

• tags (dict[str, str]) – Resource tags

• force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.

• publisher (str) – The name of the extension handler publisher.

• type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

• type_handler_version (str) – Specifies the version of the script handler.

• auto_upgrade_minor_version (bool) – Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

• settings (object) – Json formatted public settings for the extension.

• protected_settings (object) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

class azure.mgmt.hybridcompute.models.MachineExtensionUpdatePropertiesModel(*, force_update_tag: str = None, publisher: str = None, type: str = None, type_handler_version: str = None, auto_upgrade_minor_version: bool = None, settings=None, protected_settings=None, **kwargs)

Bases: msrest.serialization.Model

Describes the properties of a Machine Extension.

Parameters

• force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.

• publisher (str) – The name of the extension handler publisher.

• type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.

• type_handler_version (str) – Specifies the version of the script handler.

• auto_upgrade_minor_version (bool) – Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

• settings (object) – Json formatted public settings for the extension.

• protected_settings (object) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

class azure.mgmt.hybridcompute.models.MachineIdentity(*, type: str = None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.Identity

MachineIdentity.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

type (str) – The identity type.

Variables

• principal_id (str) – The identity’s principal id.

• tenant_id (str) – The identity’s tenant id.

class azure.mgmt.hybridcompute.models.MachineProperties(*, location_data=None, os_profile=None, vm_id: str = None, client_public_key: str = None, **kwargs)

Bases: msrest.serialization.Model

Describes the properties of a hybrid machine.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

• location_data (LocationData) –

• os_profile (MachinePropertiesOsProfile) – Specifies the operating system settings for the hybrid machine.

• vm_id (str) – Specifies the hybrid machine unique ID.

• client_public_key (str) – Public Key that the client provides to be used during initial resource onboarding

Variables

• provisioning_state (str) – The provisioning state, which only appears in the response.

• status (str or StatusTypes) – The status of the hybrid machine agent. Possible values include: ‘Connected’, ‘Disconnected’, ‘Error’

• last_status_change (datetime) – The time of the last status change.

• error_details (list[ErrorDetail]) – Details about the error state.

• agent_version (str) – The hybrid machine agent full version.

• display_name (str) – Specifies the hybrid machine display name.

• machine_fqdn (str) – Specifies the hybrid machine FQDN.

• os_name (str) – The Operating System running on the hybrid machine.

• os_version (str) – The version of Operating System running on the hybrid machine.

• vm_uuid (str) – Specifies the Arc Machine’s unique SMBIOS ID

• extensions (list[MachineExtensionInstanceView]) – Machine Extensions information

• os_sku (str) – Specifies the Operating System product SKU.

• domain_name (str) – Specifies the Windows domain name.

• ad_fqdn (str) – Specifies the AD fully qualified display name.

• dns_fqdn (str) – Specifies the DNS fully qualified display name.

class azure.mgmt.hybridcompute.models.MachinePropertiesOsProfile(**kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.OSProfile

Specifies the operating system settings for the hybrid machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

computer_name (str) – Specifies the host OS name of the hybrid machine.

class azure.mgmt.hybridcompute.models.MachineUpdate(*, tags=None, type: str = None, location_data=None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.UpdateResource

Describes a hybrid machine Update.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

• tags (dict[str, str]) – Resource tags

• type (str) – The identity type.

• location_data (LocationData) –

Variables

• principal_id (str) – The identity’s principal id.

• tenant_id (str) – The identity’s tenant id.

class azure.mgmt.hybridcompute.models.MachineUpdateProperties(*, location_data=None, **kwargs)

Bases: msrest.serialization.Model

Describes the ARM updatable properties of a hybrid machine.

Parameters

location_data (LocationData) –

class azure.mgmt.hybridcompute.models.OperationValue(**kwargs)

Bases: msrest.serialization.Model

Describes the properties of a Compute Operation value.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• origin (str) – The origin of the compute operation.

• name (str) – The name of the compute operation.

• operation (str) – The display name of the compute operation.

• resource (str) – The display name of the resource the operation applies to.

• description (str) – The description of the operation.

• provider (str) – The resource provider for the operation.

class azure.mgmt.hybridcompute.models.OperationValueDisplayModel(**kwargs)

Bases: msrest.serialization.Model

Describes the properties of a Hybrid Compute Operation Value Display.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• operation (str) – The display name of the compute operation.

• resource (str) – The display name of the resource the operation applies to.

• description (str) – The description of the operation.

• provider (str) – The resource provider for the operation.

class azure.mgmt.hybridcompute.models.OSProfile(**kwargs)

Bases: msrest.serialization.Model

Specifies the operating system settings for the hybrid machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

computer_name (str) – Specifies the host OS name of the hybrid machine.

class azure.mgmt.hybridcompute.models.ProxyResource(**kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.Resource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name (str) – The name of the resource

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.hybridcompute.models.Resource(**kwargs)

Bases: msrest.serialization.Model

Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name (str) – The name of the resource

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.hybridcompute.models.TrackedResource(*, location: str, tags=None, **kwargs)

Bases: azure.mgmt.hybridcompute.models._models_py3.Resource

The resource model definition for a ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

• id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name (str) – The name of the resource

• type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

• tags (dict[str, str]) – Resource tags.

• location (str) – Required. The geo-location where the resource lives

class azure.mgmt.hybridcompute.models.UpdateResource(*, tags=None, **kwargs)

Bases: msrest.serialization.Model

The Update Resource model definition.

Parameters

tags (dict[str, str]) – Resource tags

class azure.mgmt.hybridcompute.models.MachinePaged(*args, **kwargs)

Bases: msrest.paging.Paged

A paging container for iterating over a list of Machine object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.hybridcompute.models.MachineExtensionPaged(*args, **kwargs)

Bases: msrest.paging.Paged

A paging container for iterating over a list of MachineExtension object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.hybridcompute.models.OperationValuePaged(*args, **kwargs)

Bases: msrest.paging.Paged

A paging container for iterating over a list of OperationValue object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.hybridcompute.models.StatusTypes

Bases: str, enum.Enum

An enumeration.

connected = 'Connected'

disconnected = 'Disconnected'

error = 'Error'

class azure.mgmt.hybridcompute.models.StatusLevelTypes

Bases: str, enum.Enum

An enumeration.

error = 'Error'

info = 'Info'

warning = 'Warning'

class azure.mgmt.hybridcompute.models.InstanceViewTypes

Bases: str, enum.Enum

An enumeration.

instance_view = 'instanceView'