azure.mgmt.automation.models module

class azure.mgmt.automation.models.Activity(*, id: Optional[str] = None, definition: Optional[str] = None, parameter_sets: Optional[List[_models.ActivityParameterSet]] = None, output_types: Optional[List[_models.ActivityOutputType]] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the activity.

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

Variables

  • id (str) – Gets or sets the id of the resource.

  • name (str) – Gets the name of the activity.

  • definition (str) – Gets or sets the user name of the activity.

  • parameter_sets (list[ActivityParameterSet]) – Gets or sets the parameter sets of the activity.

  • output_types (list[ActivityOutputType]) – Gets or sets the output types of the activity.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • id (str) – Gets or sets the id of the resource.

  • definition (str) – Gets or sets the user name of the activity.

  • parameter_sets (list[ActivityParameterSet]) – Gets or sets the parameter sets of the activity.

  • output_types (list[ActivityOutputType]) – Gets or sets the output types of the activity.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.ActivityListResult(*, value: Optional[List[_models.Activity]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list activity operation.

Variables

  • value (list[Activity]) – Gets or sets a list of activities.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Activity]) – Gets or sets a list of activities.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.ActivityOutputType(*, name: Optional[str] = None, type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the activity output type.

Variables

  • name (str) – Gets or sets the name of the activity output type.

  • type (str) – Gets or sets the type of the activity output type.

Keyword Arguments

  • name (str) – Gets or sets the name of the activity output type.

  • type (str) – Gets or sets the type of the activity output type.

class azure.mgmt.automation.models.ActivityParameter(*, name: Optional[str] = None, type: Optional[str] = None, is_mandatory: Optional[bool] = None, is_dynamic: Optional[bool] = None, position: Optional[int] = None, value_from_pipeline: Optional[bool] = None, value_from_pipeline_by_property_name: Optional[bool] = None, value_from_remaining_arguments: Optional[bool] = None, description: Optional[str] = None, validation_set: Optional[List[_models.ActivityParameterValidationSet]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the activity parameter.

Variables

  • name (str) – Gets or sets the name of the activity parameter.

  • type (str) – Gets or sets the type of the activity parameter.

  • is_mandatory (bool) – Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.

  • is_dynamic (bool) – Gets or sets a Boolean value that indicates true if the parameter is dynamic.

  • position (int) – Gets or sets the position of the activity parameter.

  • value_from_pipeline (bool) – Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.

  • value_from_pipeline_by_property_name (bool) – Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.

  • value_from_remaining_arguments (bool) – Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

  • description (str) – Gets or sets the description of the activity parameter.

  • validation_set (list[ActivityParameterValidationSet]) – Gets or sets the validation set of activity parameter.

Keyword Arguments

  • name (str) – Gets or sets the name of the activity parameter.

  • type (str) – Gets or sets the type of the activity parameter.

  • is_mandatory (bool) – Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.

  • is_dynamic (bool) – Gets or sets a Boolean value that indicates true if the parameter is dynamic.

  • position (int) – Gets or sets the position of the activity parameter.

  • value_from_pipeline (bool) – Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.

  • value_from_pipeline_by_property_name (bool) – Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.

  • value_from_remaining_arguments (bool) – Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

  • description (str) – Gets or sets the description of the activity parameter.

  • validation_set (list[ActivityParameterValidationSet]) – Gets or sets the validation set of activity parameter.

class azure.mgmt.automation.models.ActivityParameterSet(*, name: Optional[str] = None, parameters: Optional[List[_models.ActivityParameter]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the activity parameter set.

Variables

  • name (str) – Gets or sets the name of the activity parameter set.

  • parameters (list[ActivityParameter]) – Gets or sets the parameters of the activity parameter set.

Keyword Arguments

  • name (str) – Gets or sets the name of the activity parameter set.

  • parameters (list[ActivityParameter]) – Gets or sets the parameters of the activity parameter set.

class azure.mgmt.automation.models.ActivityParameterValidationSet(*, member_value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the activity parameter validation set.

Variables

member_value (str) – Gets or sets the name of the activity parameter validation set member.

Keyword Arguments

member_value (str) – Gets or sets the name of the activity parameter validation set member.

class azure.mgmt.automation.models.AdvancedSchedule(*, week_days: Optional[List[str]] = None, month_days: Optional[List[int]] = None, monthly_occurrences: Optional[List[_models.AdvancedScheduleMonthlyOccurrence]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The properties of the create Advanced Schedule.

Variables

  • week_days (list[str]) – Days of the week that the job should execute on.

  • month_days (list[int]) – Days of the month that the job should execute on. Must be between 1 and 31.

  • monthly_occurrences (list[AdvancedScheduleMonthlyOccurrence]) – Occurrences of days within a month.

Keyword Arguments

  • week_days (list[str]) – Days of the week that the job should execute on.

  • month_days (list[int]) – Days of the month that the job should execute on. Must be between 1 and 31.

  • monthly_occurrences (list[AdvancedScheduleMonthlyOccurrence]) – Occurrences of days within a month.

class azure.mgmt.automation.models.AdvancedScheduleMonthlyOccurrence(*, occurrence: Optional[int] = None, day: Optional[Union[str, _models.ScheduleDay]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The properties of the create advanced schedule monthly occurrence.

Variables

  • occurrence (int) – Occurrence of the week within the month. Must be between 1 and 5.

  • day (str or ScheduleDay) – Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

Keyword Arguments

  • occurrence (int) – Occurrence of the week within the month. Must be between 1 and 5.

  • day (str or ScheduleDay) – Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

class azure.mgmt.automation.models.AgentRegistration(*, dsc_meta_configuration: Optional[str] = None, endpoint: Optional[str] = None, keys: Optional[_models.AgentRegistrationKeys] = None, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the agent registration information type.

Variables

  • dsc_meta_configuration (str) – Gets or sets the dsc meta configuration.

  • endpoint (str) – Gets or sets the dsc server endpoint.

  • keys (AgentRegistrationKeys) – Gets or sets the agent registration keys.

  • id (str) – Gets or sets the id.

Keyword Arguments

  • dsc_meta_configuration (str) – Gets or sets the dsc meta configuration.

  • endpoint (str) – Gets or sets the dsc server endpoint.

  • keys (AgentRegistrationKeys) – Gets or sets the agent registration keys.

  • id (str) – Gets or sets the id.

class azure.mgmt.automation.models.AgentRegistrationKeyName(value)[source]

Bases: str, enum.Enum

Gets or sets the agent registration key name - primary or secondary.

PRIMARY = 'primary'
SECONDARY = 'secondary'
class azure.mgmt.automation.models.AgentRegistrationKeys(*, primary: Optional[str] = None, secondary: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the agent registration keys.

Variables

  • primary (str) – Gets or sets the primary key.

  • secondary (str) – Gets or sets the secondary key.

Keyword Arguments

  • primary (str) – Gets or sets the primary key.

  • secondary (str) – Gets or sets the secondary key.

class azure.mgmt.automation.models.AgentRegistrationRegenerateKeyParameter(*, key_name: Union[str, _models.AgentRegistrationKeyName], **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the regenerate keys operation.

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

Variables

key_name (str or AgentRegistrationKeyName) – Gets or sets the agent registration key name - primary or secondary. Required. Known values are: “primary” and “secondary”.

Keyword Arguments

key_name (str or AgentRegistrationKeyName) – Gets or sets the agent registration key name - primary or secondary. Required. Known values are: “primary” and “secondary”.

class azure.mgmt.automation.models.AutomationAccount(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, etag: Optional[str] = None, identity: Optional[_models.Identity] = None, sku: Optional[_models.Sku] = None, last_modified_by: Optional[str] = None, description: Optional[str] = None, encryption: Optional[_models.EncryptionProperties] = None, private_endpoint_connections: Optional[List[_models.PrivateEndpointConnection]] = None, public_network_access: Optional[bool] = None, disable_local_auth: Optional[bool] = None, automation_hybrid_service_url: Optional[str] = None, **kwargs)[source]

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

Definition of the automation account type.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • identity (Identity) – Identity for the resource.

  • system_data (SystemData) – Resource system metadata.

  • sku (Sku) – Gets or sets the SKU of account.

  • last_modified_by (str) – Gets or sets the last modified by.

  • state (str or AutomationAccountState) – Gets status of account. Known values are: “Ok”, “Unavailable”, and “Suspended”.

  • creation_time (datetime) – Gets the creation time.

  • last_modified_time (datetime) – Gets the last modified time.

  • description (str) – Gets or sets the description.

  • encryption (EncryptionProperties) – Encryption properties for the automation account.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – List of Automation operations supported by the Automation resource provider.

  • public_network_access (bool) – Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.

  • disable_local_auth (bool) – Indicates whether requests using non-AAD authentication are blocked.

  • automation_hybrid_service_url (str) – URL of automation hybrid service which is used for hybrid worker on-boarding.

Keyword Arguments

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • identity (Identity) – Identity for the resource.

  • sku (Sku) – Gets or sets the SKU of account.

  • last_modified_by (str) – Gets or sets the last modified by.

  • description (str) – Gets or sets the description.

  • encryption (EncryptionProperties) – Encryption properties for the automation account.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – List of Automation operations supported by the Automation resource provider.

  • public_network_access (bool) – Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.

  • disable_local_auth (bool) – Indicates whether requests using non-AAD authentication are blocked.

  • automation_hybrid_service_url (str) – URL of automation hybrid service which is used for hybrid worker on-boarding.

class azure.mgmt.automation.models.AutomationAccountCreateOrUpdateParameters(*, name: Optional[str] = None, location: Optional[str] = None, identity: Optional[_models.Identity] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, encryption: Optional[_models.EncryptionProperties] = None, public_network_access: Optional[bool] = None, disable_local_auth: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update automation account operation.

Variables

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • identity (Identity) – Sets the identity property for automation account.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • sku (Sku) – Gets or sets account SKU.

  • encryption (EncryptionProperties) – Set the encryption properties for the automation account.

  • public_network_access (bool) – Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.

  • disable_local_auth (bool) – Indicates whether requests using non-AAD authentication are blocked.

Keyword Arguments

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • identity (Identity) – Sets the identity property for automation account.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • sku (Sku) – Gets or sets account SKU.

  • encryption (EncryptionProperties) – Set the encryption properties for the automation account.

  • public_network_access (bool) – Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.

  • disable_local_auth (bool) – Indicates whether requests using non-AAD authentication are blocked.

class azure.mgmt.automation.models.AutomationAccountListResult(*, value: Optional[List[_models.AutomationAccount]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list account operation.

Variables
Keyword Arguments
class azure.mgmt.automation.models.AutomationAccountState(value)[source]

Bases: str, enum.Enum

Gets status of account.

OK = 'Ok'
SUSPENDED = 'Suspended'
UNAVAILABLE = 'Unavailable'
class azure.mgmt.automation.models.AutomationAccountUpdateParameters(*, name: Optional[str] = None, location: Optional[str] = None, identity: Optional[_models.Identity] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, encryption: Optional[_models.EncryptionProperties] = None, public_network_access: Optional[bool] = None, disable_local_auth: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update automation account operation.

Variables

  • name (str) – Gets or sets the name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • identity (Identity) – Sets the identity property for automation account.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • sku (Sku) – Gets or sets account SKU.

  • encryption (EncryptionProperties) – Set the encryption properties for the automation account.

  • public_network_access (bool) – Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.

  • disable_local_auth (bool) – Indicates whether requests using non-AAD authentication are blocked.

Keyword Arguments

  • name (str) – Gets or sets the name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • identity (Identity) – Sets the identity property for automation account.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • sku (Sku) – Gets or sets account SKU.

  • encryption (EncryptionProperties) – Set the encryption properties for the automation account.

  • public_network_access (bool) – Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.

  • disable_local_auth (bool) – Indicates whether requests using non-AAD authentication are blocked.

class azure.mgmt.automation.models.AutomationKeyName(value)[source]

Bases: str, enum.Enum

Automation key name.

PRIMARY = 'Primary'
SECONDARY = 'Secondary'
class azure.mgmt.automation.models.AutomationKeyPermissions(value)[source]

Bases: str, enum.Enum

Automation key permissions.

FULL = 'Full'
READ = 'Read'
class azure.mgmt.automation.models.AzureQueryProperties(*, scope: Optional[List[str]] = None, locations: Optional[List[str]] = None, tag_settings: Optional[_models.TagSettingsProperties] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Azure query for the update configuration.

Variables

  • scope (list[str]) – List of Subscription or Resource Group ARM Ids.

  • locations (list[str]) – List of locations to scope the query to.

  • tag_settings (TagSettingsProperties) – Tag settings for the VM.

Keyword Arguments

  • scope (list[str]) – List of Subscription or Resource Group ARM Ids.

  • locations (list[str]) – List of locations to scope the query to.

  • tag_settings (TagSettingsProperties) – Tag settings for the VM.

class azure.mgmt.automation.models.Certificate(*, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the certificate.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • thumbprint (str) – Gets the thumbprint of the certificate.

  • expiry_time (datetime) – Gets the expiry time of the certificate.

  • is_exportable (bool) – Gets the is exportable flag of the certificate.

  • creation_time (datetime) – Gets the creation time.

  • last_modified_time (datetime) – Gets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

description (str) – Gets or sets the description.

class azure.mgmt.automation.models.CertificateCreateOrUpdateParameters(*, name: str, base64_value: str, description: Optional[str] = None, thumbprint: Optional[str] = None, is_exportable: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update or replace certificate operation.

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

Variables

  • name (str) – Gets or sets the name of the certificate. Required.

  • base64_value (str) – Gets or sets the base64 encoded value of the certificate. Required.

  • description (str) – Gets or sets the description of the certificate.

  • thumbprint (str) – Gets or sets the thumbprint of the certificate.

  • is_exportable (bool) – Gets or sets the is exportable flag of the certificate.

Keyword Arguments

  • name (str) – Gets or sets the name of the certificate. Required.

  • base64_value (str) – Gets or sets the base64 encoded value of the certificate. Required.

  • description (str) – Gets or sets the description of the certificate.

  • thumbprint (str) – Gets or sets the thumbprint of the certificate.

  • is_exportable (bool) – Gets or sets the is exportable flag of the certificate.

class azure.mgmt.automation.models.CertificateListResult(*, value: Optional[List[_models.Certificate]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list certificate operation.

Variables

  • value (list[Certificate]) – Gets or sets a list of certificates.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Certificate]) – Gets or sets a list of certificates.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.CertificateUpdateParameters(*, name: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update certificate operation.

Variables

  • name (str) – Gets or sets the name of the certificate.

  • description (str) – Gets or sets the description of the certificate.

Keyword Arguments

  • name (str) – Gets or sets the name of the certificate.

  • description (str) – Gets or sets the description of the certificate.

class azure.mgmt.automation.models.Connection(*, connection_type: Optional[_models.ConnectionTypeAssociationProperty] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the connection.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • connection_type (ConnectionTypeAssociationProperty) – Gets or sets the connectionType of the connection.

  • field_definition_values (dict[str, str]) – Gets the field definition values of the connection.

  • creation_time (datetime) – Gets the creation time.

  • last_modified_time (datetime) – Gets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments
class azure.mgmt.automation.models.ConnectionCreateOrUpdateParameters(*, name: str, connection_type: _models.ConnectionTypeAssociationProperty, description: Optional[str] = None, field_definition_values: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update connection operation.

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

Variables

  • name (str) – Gets or sets the name of the connection. Required.

  • description (str) – Gets or sets the description of the connection.

  • connection_type (ConnectionTypeAssociationProperty) – Gets or sets the connectionType of the connection. Required.

  • field_definition_values (dict[str, str]) – Gets or sets the field definition properties of the connection.

Keyword Arguments

  • name (str) – Gets or sets the name of the connection. Required.

  • description (str) – Gets or sets the description of the connection.

  • connection_type (ConnectionTypeAssociationProperty) – Gets or sets the connectionType of the connection. Required.

  • field_definition_values (dict[str, str]) – Gets or sets the field definition properties of the connection.

class azure.mgmt.automation.models.ConnectionListResult(*, value: Optional[List[_models.Connection]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list connection operation.

Variables

  • value (list[Connection]) – Gets or sets a list of connection.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Connection]) – Gets or sets a list of connection.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.ConnectionType(*, is_global: Optional[bool] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the connection type.

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

Variables

  • id (str) – Gets the id of the resource.

  • name (str) – Gets the name of the connection type.

  • type (str) – Resource type.

  • is_global (bool) – Gets or sets a Boolean value to indicate if the connection type is global.

  • field_definitions (dict[str, FieldDefinition]) – Gets the field definitions of the connection type.

  • creation_time (datetime) – Gets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • is_global (bool) – Gets or sets a Boolean value to indicate if the connection type is global.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.ConnectionTypeAssociationProperty(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The connection type property associated with the entity.

Variables

name (str) – Gets or sets the name of the connection type.

Keyword Arguments

name (str) – Gets or sets the name of the connection type.

class azure.mgmt.automation.models.ConnectionTypeCreateOrUpdateParameters(*, name: str, field_definitions: Dict[str, _models.FieldDefinition], is_global: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update connection type operation.

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

Variables

  • name (str) – Gets or sets the name of the connection type. Required.

  • is_global (bool) – Gets or sets a Boolean value to indicate if the connection type is global.

  • field_definitions (dict[str, FieldDefinition]) – Gets or sets the field definitions of the connection type. Required.

Keyword Arguments

  • name (str) – Gets or sets the name of the connection type. Required.

  • is_global (bool) – Gets or sets a Boolean value to indicate if the connection type is global.

  • field_definitions (dict[str, FieldDefinition]) – Gets or sets the field definitions of the connection type. Required.

class azure.mgmt.automation.models.ConnectionTypeListResult(*, value: Optional[List[_models.ConnectionType]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list connection type operation.

Variables

  • value (list[ConnectionType]) – Gets or sets a list of connection types.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[ConnectionType]) – Gets or sets a list of connection types.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.ConnectionUpdateParameters(*, name: Optional[str] = None, description: Optional[str] = None, field_definition_values: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update connection operation.

Variables

  • name (str) – Gets or sets the name of the connection.

  • description (str) – Gets or sets the description of the connection.

  • field_definition_values (dict[str, str]) – Gets or sets the field definition values of the connection.

Keyword Arguments

  • name (str) – Gets or sets the name of the connection.

  • description (str) – Gets or sets the description of the connection.

  • field_definition_values (dict[str, str]) – Gets or sets the field definition values of the connection.

class azure.mgmt.automation.models.ContentHash(*, algorithm: str, value: str, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the runbook property type.

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

Variables

  • algorithm (str) – Gets or sets the content hash algorithm used to hash the content. Required.

  • value (str) – Gets or sets expected hash value of the content. Required.

Keyword Arguments

  • algorithm (str) – Gets or sets the content hash algorithm used to hash the content. Required.

  • value (str) – Gets or sets expected hash value of the content. Required.

Bases: azure.mgmt.automation._serialization.Model

Definition of the content link.

Variables

  • uri (str) – Gets or sets the uri of the runbook content.

  • content_hash (ContentHash) – Gets or sets the hash.

  • version (str) – Gets or sets the version of the content.

Keyword Arguments

  • uri (str) – Gets or sets the uri of the runbook content.

  • content_hash (ContentHash) – Gets or sets the hash.

  • version (str) – Gets or sets the version of the content.

class azure.mgmt.automation.models.ContentSource(*, hash: Optional[_models.ContentHash] = None, type: Optional[Union[str, _models.ContentSourceType]] = None, value: Optional[str] = None, version: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the content source.

Variables

  • hash (ContentHash) – Gets or sets the hash.

  • type (str or ContentSourceType) – Gets or sets the content source type. Known values are: “embeddedContent” and “uri”.

  • value (str) – Gets or sets the value of the content. This is based on the content source type.

  • version (str) – Gets or sets the version of the content.

Keyword Arguments

  • hash (ContentHash) – Gets or sets the hash.

  • type (str or ContentSourceType) – Gets or sets the content source type. Known values are: “embeddedContent” and “uri”.

  • value (str) – Gets or sets the value of the content. This is based on the content source type.

  • version (str) – Gets or sets the version of the content.

class azure.mgmt.automation.models.ContentSourceType(value)[source]

Bases: str, enum.Enum

Gets or sets the content source type.

EMBEDDED_CONTENT = 'embeddedContent'
URI = 'uri'
class azure.mgmt.automation.models.CountType(value)[source]

Bases: str, enum.Enum

CountType.

NODECONFIGURATION = 'nodeconfiguration'
STATUS = 'status'
class azure.mgmt.automation.models.CreatedByType(value)[source]

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.automation.models.Credential(*, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the credential.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • user_name (str) – Gets the user name of the credential.

  • creation_time (datetime) – Gets the creation time.

  • last_modified_time (datetime) – Gets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

description (str) – Gets or sets the description.

class azure.mgmt.automation.models.CredentialCreateOrUpdateParameters(*, name: str, user_name: str, password: str, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update credential operation.

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

Variables

  • name (str) – Gets or sets the name of the credential. Required.

  • user_name (str) – Gets or sets the user name of the credential. Required.

  • password (str) – Gets or sets the password of the credential. Required.

  • description (str) – Gets or sets the description of the credential.

Keyword Arguments

  • name (str) – Gets or sets the name of the credential. Required.

  • user_name (str) – Gets or sets the user name of the credential. Required.

  • password (str) – Gets or sets the password of the credential. Required.

  • description (str) – Gets or sets the description of the credential.

class azure.mgmt.automation.models.CredentialListResult(*, value: Optional[List[_models.Credential]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list credential operation.

Variables

  • value (list[Credential]) – Gets or sets a list of credentials.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Credential]) – Gets or sets a list of credentials.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.CredentialUpdateParameters(*, name: Optional[str] = None, user_name: Optional[str] = None, password: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the Update credential operation.

Variables

  • name (str) – Gets or sets the name of the credential.

  • user_name (str) – Gets or sets the user name of the credential.

  • password (str) – Gets or sets the password of the credential.

  • description (str) – Gets or sets the description of the credential.

Keyword Arguments

  • name (str) – Gets or sets the name of the credential.

  • user_name (str) – Gets or sets the user name of the credential.

  • password (str) – Gets or sets the password of the credential.

  • description (str) – Gets or sets the description of the credential.

class azure.mgmt.automation.models.DeletedAutomationAccount(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, location: Optional[str] = None, automation_account_resource_id: Optional[str] = None, automation_account_id: Optional[str] = None, location_properties_location: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the deleted automation account type.

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

Variables

  • id (str) – The resource id.

  • name (str) – Gets or sets name of the resource.

  • type (str) – The resource type.

  • location (str) – Gets or sets the location of the resource.

  • automation_account_resource_id (str) – Gets or sets the Automation Account Resource Id.

  • automation_account_id (str) – Gets or sets the Automation Account Id.

  • location_properties_location (str) – Gets or sets the location of the resource.

  • deletion_time (datetime) – Gets the deletion time.

Keyword Arguments

  • id (str) – The resource id.

  • name (str) – Gets or sets name of the resource.

  • type (str) – The resource type.

  • location (str) – Gets or sets the location of the resource.

  • automation_account_resource_id (str) – Gets or sets the Automation Account Resource Id.

  • automation_account_id (str) – Gets or sets the Automation Account Id.

  • location_properties_location (str) – Gets or sets the location of the resource.

class azure.mgmt.automation.models.DeletedAutomationAccountListResult(*, value: Optional[List[_models.DeletedAutomationAccount]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list deleted automation account.

Variables

value (list[DeletedAutomationAccount]) – Gets or sets the list of deleted automation accounts.

Keyword Arguments

value (list[DeletedAutomationAccount]) – Gets or sets the list of deleted automation accounts.

class azure.mgmt.automation.models.Dimension(*, name: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Dimension of the metric.

Variables

  • name (str) – The name of the dimension.

  • display_name (str) – The display name of the dimension.

Keyword Arguments

  • name (str) – The name of the dimension.

  • display_name (str) – The display name of the dimension.

class azure.mgmt.automation.models.DscCompilationJob(*, configuration: Optional[_models.DscConfigurationAssociationProperty] = None, provisioning_state: Optional[Union[str, _models.JobProvisioningState]] = None, run_on: Optional[str] = None, status: Optional[Union[str, _models.JobStatus]] = None, status_details: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the Dsc Compilation job.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration.

  • started_by (str) – Gets the compilation job started by.

  • job_id (str) – Gets the id of the job.

  • creation_time (datetime) – Gets the creation time of the job.

  • provisioning_state (str or JobProvisioningState) – The current provisioning state of the job. Known values are: “Failed”, “Succeeded”, “Suspended”, and “Processing”.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

  • status (str or JobStatus) – Gets or sets the status of the job. Known values are: “New”, “Activating”, “Running”, “Completed”, “Failed”, “Stopped”, “Blocked”, “Suspended”, “Disconnected”, “Suspending”, “Stopping”, “Resuming”, and “Removing”.

  • status_details (str) – Gets or sets the status details of the job.

  • start_time (datetime) – Gets the start time of the job.

  • end_time (datetime) – Gets the end time of the job.

  • exception (str) – Gets the exception of the job.

  • last_modified_time (datetime) – Gets the last modified time of the job.

  • last_status_modified_time (datetime) – Gets the last status modified time of the job.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

Keyword Arguments

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration.

  • provisioning_state (str or JobProvisioningState) – The current provisioning state of the job. Known values are: “Failed”, “Succeeded”, “Suspended”, and “Processing”.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

  • status (str or JobStatus) – Gets or sets the status of the job. Known values are: “New”, “Activating”, “Running”, “Completed”, “Failed”, “Stopped”, “Blocked”, “Suspended”, “Disconnected”, “Suspending”, “Stopping”, “Resuming”, and “Removing”.

  • status_details (str) – Gets or sets the status details of the job.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

class azure.mgmt.automation.models.DscCompilationJobCreateParameters(*, configuration: _models.DscConfigurationAssociationProperty, name: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, parameters: Optional[Dict[str, str]] = None, increment_node_configuration_build: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create compilation job operation.

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

Variables

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration. Required.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • increment_node_configuration_build (bool) – If a new build version of NodeConfiguration is required.

Keyword Arguments

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration. Required.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • increment_node_configuration_build (bool) – If a new build version of NodeConfiguration is required.

class azure.mgmt.automation.models.DscCompilationJobListResult(*, value: Optional[List[_models.DscCompilationJob]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list job operation.

Variables

  • value (list[DscCompilationJob]) – Gets or sets a list of Dsc Compilation jobs.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[DscCompilationJob]) – Gets or sets a list of Dsc Compilation jobs.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.DscConfiguration(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, etag: Optional[str] = None, provisioning_state: Optional[Literal[Succeeded]] = None, job_count: Optional[int] = None, parameters: Optional[Dict[str, _models.DscConfigurationParameter]] = None, source: Optional[_models.ContentSource] = None, state: Optional[Union[str, _models.DscConfigurationState]] = None, log_verbose: Optional[bool] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, node_configuration_count: Optional[int] = None, description: Optional[str] = None, **kwargs)[source]

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

Definition of the configuration type.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • provisioning_state (str) – Gets or sets the provisioning state of the configuration. Default value is “Succeeded”.

  • job_count (int) – Gets or sets the job count of the configuration.

  • parameters (dict[str, DscConfigurationParameter]) – Gets or sets the configuration parameters.

  • source (ContentSource) – Gets or sets the source.

  • state (str or DscConfigurationState) – Gets or sets the state of the configuration. Known values are: “New”, “Edit”, and “Published”.

  • log_verbose (bool) – Gets or sets verbose log option.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • node_configuration_count (int) – Gets the number of compiled node configurations.

  • description (str) – Gets or sets the description.

Keyword Arguments

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • provisioning_state (str) – Gets or sets the provisioning state of the configuration. Default value is “Succeeded”.

  • job_count (int) – Gets or sets the job count of the configuration.

  • parameters (dict[str, DscConfigurationParameter]) – Gets or sets the configuration parameters.

  • source (ContentSource) – Gets or sets the source.

  • state (str or DscConfigurationState) – Gets or sets the state of the configuration. Known values are: “New”, “Edit”, and “Published”.

  • log_verbose (bool) – Gets or sets verbose log option.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • node_configuration_count (int) – Gets the number of compiled node configurations.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.DscConfigurationAssociationProperty(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The Dsc configuration property associated with the entity.

Variables

name (str) – Gets or sets the name of the Dsc configuration.

Keyword Arguments

name (str) – Gets or sets the name of the Dsc configuration.

class azure.mgmt.automation.models.DscConfigurationCreateOrUpdateParameters(*, source: _models.ContentSource, name: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, log_verbose: Optional[bool] = None, log_progress: Optional[bool] = None, parameters: Optional[Dict[str, _models.DscConfigurationParameter]] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update configuration operation.

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

Variables

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • source (ContentSource) – Gets or sets the source. Required.

  • parameters (dict[str, DscConfigurationParameter]) – Gets or sets the configuration parameters.

  • description (str) – Gets or sets the description of the configuration.

Keyword Arguments

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • source (ContentSource) – Gets or sets the source. Required.

  • parameters (dict[str, DscConfigurationParameter]) – Gets or sets the configuration parameters.

  • description (str) – Gets or sets the description of the configuration.

class azure.mgmt.automation.models.DscConfigurationListResult(*, value: Optional[List[_models.DscConfiguration]] = None, next_link: Optional[str] = None, total_count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list configuration operation.

Variables

  • value (list[DscConfiguration]) – Gets or sets a list of configurations.

  • next_link (str) – Gets or sets the next link.

  • total_count (int) – Gets the total number of configurations matching filter criteria.

Keyword Arguments

  • value (list[DscConfiguration]) – Gets or sets a list of configurations.

  • next_link (str) – Gets or sets the next link.

  • total_count (int) – Gets the total number of configurations matching filter criteria.

class azure.mgmt.automation.models.DscConfigurationParameter(*, type: Optional[str] = None, is_mandatory: Optional[bool] = None, position: Optional[int] = None, default_value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the configuration parameter type.

Variables

  • type (str) – Gets or sets the type of the parameter.

  • is_mandatory (bool) – Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

  • position (int) – Get or sets the position of the parameter.

  • default_value (str) – Gets or sets the default value of parameter.

Keyword Arguments

  • type (str) – Gets or sets the type of the parameter.

  • is_mandatory (bool) – Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

  • position (int) – Get or sets the position of the parameter.

  • default_value (str) – Gets or sets the default value of parameter.

class azure.mgmt.automation.models.DscConfigurationState(value)[source]

Bases: str, enum.Enum

Gets or sets the state of the configuration.

EDIT = 'Edit'
NEW = 'New'
PUBLISHED = 'Published'
class azure.mgmt.automation.models.DscConfigurationUpdateParameters(*, name: Optional[str] = None, tags: Optional[Dict[str, str]] = None, log_verbose: Optional[bool] = None, log_progress: Optional[bool] = None, source: Optional[_models.ContentSource] = None, parameters: Optional[Dict[str, _models.DscConfigurationParameter]] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update configuration operation.

Variables

  • name (str) – Gets or sets name of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • source (ContentSource) – Gets or sets the source.

  • parameters (dict[str, DscConfigurationParameter]) – Gets or sets the configuration parameters.

  • description (str) – Gets or sets the description of the configuration.

Keyword Arguments

  • name (str) – Gets or sets name of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • source (ContentSource) – Gets or sets the source.

  • parameters (dict[str, DscConfigurationParameter]) – Gets or sets the configuration parameters.

  • description (str) – Gets or sets the description of the configuration.

class azure.mgmt.automation.models.DscMetaConfiguration(*, configuration_mode_frequency_mins: Optional[int] = None, reboot_node_if_needed: Optional[bool] = None, configuration_mode: Optional[str] = None, action_after_reboot: Optional[str] = None, certificate_id: Optional[str] = None, refresh_frequency_mins: Optional[int] = None, allow_module_overwrite: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the DSC Meta Configuration.

Variables

  • configuration_mode_frequency_mins (int) – Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration.

  • reboot_node_if_needed (bool) – Gets or sets the RebootNodeIfNeeded value of the meta configuration.

  • configuration_mode (str) – Gets or sets the ConfigurationMode value of the meta configuration.

  • action_after_reboot (str) – Gets or sets the ActionAfterReboot value of the meta configuration.

  • certificate_id (str) – Gets or sets the CertificateId value of the meta configuration.

  • refresh_frequency_mins (int) – Gets or sets the RefreshFrequencyMins value of the meta configuration.

  • allow_module_overwrite (bool) – Gets or sets the AllowModuleOverwrite value of the meta configuration.

Keyword Arguments

  • configuration_mode_frequency_mins (int) – Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration.

  • reboot_node_if_needed (bool) – Gets or sets the RebootNodeIfNeeded value of the meta configuration.

  • configuration_mode (str) – Gets or sets the ConfigurationMode value of the meta configuration.

  • action_after_reboot (str) – Gets or sets the ActionAfterReboot value of the meta configuration.

  • certificate_id (str) – Gets or sets the CertificateId value of the meta configuration.

  • refresh_frequency_mins (int) – Gets or sets the RefreshFrequencyMins value of the meta configuration.

  • allow_module_overwrite (bool) – Gets or sets the AllowModuleOverwrite value of the meta configuration.

class azure.mgmt.automation.models.DscNode(*, last_seen: Optional[datetime.datetime] = None, registration_time: Optional[datetime.datetime] = None, ip: Optional[str] = None, account_id: Optional[str] = None, status: Optional[str] = None, node_id: Optional[str] = None, etag: Optional[str] = None, total_count: Optional[int] = None, extension_handler: Optional[List[_models.DscNodeExtensionHandlerAssociationProperty]] = None, name_properties_node_configuration_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of a DscNode.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • last_seen (datetime) – Gets or sets the last seen time of the node.

  • registration_time (datetime) – Gets or sets the registration time of the node.

  • ip (str) – Gets or sets the ip of the node.

  • account_id (str) – Gets or sets the account id of the node.

  • status (str) – Gets or sets the status of the node.

  • node_id (str) – Gets or sets the node id.

  • etag (str) – Gets or sets the etag of the resource.

  • total_count (int) – Gets the total number of records matching filter criteria.

  • extension_handler (list[DscNodeExtensionHandlerAssociationProperty]) – Gets or sets the list of extensionHandler properties for a Node.

  • name_properties_node_configuration_name (str) – Gets or sets the name of the dsc node configuration.

Keyword Arguments

  • last_seen (datetime) – Gets or sets the last seen time of the node.

  • registration_time (datetime) – Gets or sets the registration time of the node.

  • ip (str) – Gets or sets the ip of the node.

  • account_id (str) – Gets or sets the account id of the node.

  • status (str) – Gets or sets the status of the node.

  • node_id (str) – Gets or sets the node id.

  • etag (str) – Gets or sets the etag of the resource.

  • total_count (int) – Gets the total number of records matching filter criteria.

  • extension_handler (list[DscNodeExtensionHandlerAssociationProperty]) – Gets or sets the list of extensionHandler properties for a Node.

  • name_properties_node_configuration_name (str) – Gets or sets the name of the dsc node configuration.

class azure.mgmt.automation.models.DscNodeConfiguration(*, last_modified_time: Optional[datetime.datetime] = None, creation_time: Optional[datetime.datetime] = None, configuration: Optional[_models.DscConfigurationAssociationProperty] = None, source: Optional[str] = None, node_count: Optional[int] = None, increment_node_configuration_build: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the dsc node configuration.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • creation_time (datetime) – Gets or sets creation time.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration of the node.

  • source (str) – Source of node configuration.

  • node_count (int) – Number of nodes with this node configuration assigned.

  • increment_node_configuration_build (bool) – If a new build version of NodeConfiguration is required.

Keyword Arguments

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • creation_time (datetime) – Gets or sets creation time.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration of the node.

  • source (str) – Source of node configuration.

  • node_count (int) – Number of nodes with this node configuration assigned.

  • increment_node_configuration_build (bool) – If a new build version of NodeConfiguration is required.

class azure.mgmt.automation.models.DscNodeConfigurationCreateOrUpdateParameters(*, name: Optional[str] = None, tags: Optional[Dict[str, str]] = None, source: Optional[_models.ContentSource] = None, configuration: Optional[_models.DscConfigurationAssociationProperty] = None, increment_node_configuration_build: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update node configuration operation.

Variables

  • name (str) – Name of the node configuration.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • source (ContentSource) – Gets or sets the source.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration of the node.

  • increment_node_configuration_build (bool) – If a new build version of NodeConfiguration is required.

Keyword Arguments

  • name (str) – Name of the node configuration.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • source (ContentSource) – Gets or sets the source.

  • configuration (DscConfigurationAssociationProperty) – Gets or sets the configuration of the node.

  • increment_node_configuration_build (bool) – If a new build version of NodeConfiguration is required.

class azure.mgmt.automation.models.DscNodeConfigurationListResult(*, value: Optional[List[_models.DscNodeConfiguration]] = None, next_link: Optional[str] = None, total_count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list job operation.

Variables

  • value (list[DscNodeConfiguration]) – Gets or sets a list of Dsc node configurations.

  • next_link (str) – Gets or sets the next link.

  • total_count (int) – Gets or sets the total rows in query.

Keyword Arguments

  • value (list[DscNodeConfiguration]) – Gets or sets a list of Dsc node configurations.

  • next_link (str) – Gets or sets the next link.

  • total_count (int) – Gets or sets the total rows in query.

class azure.mgmt.automation.models.DscNodeExtensionHandlerAssociationProperty(*, name: Optional[str] = None, version: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The dsc extensionHandler property associated with the node.

Variables

  • name (str) – Gets or sets the name of the extension handler.

  • version (str) – Gets or sets the version of the extension handler.

Keyword Arguments

  • name (str) – Gets or sets the name of the extension handler.

  • version (str) – Gets or sets the version of the extension handler.

class azure.mgmt.automation.models.DscNodeListResult(*, value: Optional[List[_models.DscNode]] = None, next_link: Optional[str] = None, total_count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list dsc nodes operation.

Variables

  • value (list[DscNode]) – Gets or sets a list of dsc nodes.

  • next_link (str) – Gets or sets the next link.

  • total_count (int) – Gets the total number of nodes matching filter criteria.

Keyword Arguments

  • value (list[DscNode]) – Gets or sets a list of dsc nodes.

  • next_link (str) – Gets or sets the next link.

  • total_count (int) – Gets the total number of nodes matching filter criteria.

class azure.mgmt.automation.models.DscNodeReport(*, end_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, start_time: Optional[datetime.datetime] = None, type: Optional[str] = None, report_id: Optional[str] = None, status: Optional[str] = None, refresh_mode: Optional[str] = None, reboot_requested: Optional[str] = None, report_format_version: Optional[str] = None, configuration_version: Optional[str] = None, id: Optional[str] = None, errors: Optional[List[_models.DscReportError]] = None, resources: Optional[List[_models.DscReportResource]] = None, meta_configuration: Optional[_models.DscMetaConfiguration] = None, host_name: Optional[str] = None, i_pv4_addresses: Optional[List[str]] = None, i_pv6_addresses: Optional[List[str]] = None, number_of_resources: Optional[int] = None, raw_errors: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the dsc node report type.

Variables

  • end_time (datetime) – Gets or sets the end time of the node report.

  • last_modified_time (datetime) – Gets or sets the lastModifiedTime of the node report.

  • start_time (datetime) – Gets or sets the start time of the node report.

  • type (str) – Gets or sets the type of the node report.

  • report_id (str) – Gets or sets the id of the node report.

  • status (str) – Gets or sets the status of the node report.

  • refresh_mode (str) – Gets or sets the refreshMode of the node report.

  • reboot_requested (str) – Gets or sets the rebootRequested of the node report.

  • report_format_version (str) – Gets or sets the reportFormatVersion of the node report.

  • configuration_version (str) – Gets or sets the configurationVersion of the node report.

  • id (str) – Gets or sets the id.

  • errors (list[DscReportError]) – Gets or sets the errors for the node report.

  • resources (list[DscReportResource]) – Gets or sets the resource for the node report.

  • meta_configuration (DscMetaConfiguration) – Gets or sets the metaConfiguration of the node at the time of the report.

  • host_name (str) – Gets or sets the hostname of the node that sent the report.

  • i_pv4_addresses (list[str]) – Gets or sets the IPv4 address of the node that sent the report.

  • i_pv6_addresses (list[str]) – Gets or sets the IPv6 address of the node that sent the report.

  • number_of_resources (int) – Gets or sets the number of resource in the node report.

  • raw_errors (str) – Gets or sets the unparsed errors for the node report.

Keyword Arguments

  • end_time (datetime) – Gets or sets the end time of the node report.

  • last_modified_time (datetime) – Gets or sets the lastModifiedTime of the node report.

  • start_time (datetime) – Gets or sets the start time of the node report.

  • type (str) – Gets or sets the type of the node report.

  • report_id (str) – Gets or sets the id of the node report.

  • status (str) – Gets or sets the status of the node report.

  • refresh_mode (str) – Gets or sets the refreshMode of the node report.

  • reboot_requested (str) – Gets or sets the rebootRequested of the node report.

  • report_format_version (str) – Gets or sets the reportFormatVersion of the node report.

  • configuration_version (str) – Gets or sets the configurationVersion of the node report.

  • id (str) – Gets or sets the id.

  • errors (list[DscReportError]) – Gets or sets the errors for the node report.

  • resources (list[DscReportResource]) – Gets or sets the resource for the node report.

  • meta_configuration (DscMetaConfiguration) – Gets or sets the metaConfiguration of the node at the time of the report.

  • host_name (str) – Gets or sets the hostname of the node that sent the report.

  • i_pv4_addresses (list[str]) – Gets or sets the IPv4 address of the node that sent the report.

  • i_pv6_addresses (list[str]) – Gets or sets the IPv6 address of the node that sent the report.

  • number_of_resources (int) – Gets or sets the number of resource in the node report.

  • raw_errors (str) – Gets or sets the unparsed errors for the node report.

class azure.mgmt.automation.models.DscNodeReportListResult(*, value: Optional[List[_models.DscNodeReport]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list dsc nodes operation.

Variables

  • value (list[DscNodeReport]) – Gets or sets a list of dsc node reports.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[DscNodeReport]) – Gets or sets a list of dsc node reports.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.DscNodeUpdateParameters(*, node_id: Optional[str] = None, properties: Optional[_models.DscNodeUpdateParametersProperties] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update dsc node operation.

Variables
Keyword Arguments
class azure.mgmt.automation.models.DscNodeUpdateParametersProperties(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

DscNodeUpdateParametersProperties.

Variables

name (str) – Gets or sets the name of the dsc node configuration.

Keyword Arguments

name (str) – Gets or sets the name of the dsc node configuration.

class azure.mgmt.automation.models.DscReportError(*, error_source: Optional[str] = None, resource_id: Optional[str] = None, error_code: Optional[str] = None, error_message: Optional[str] = None, locale: Optional[str] = None, error_details: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the dsc node report error type.

Variables

  • error_source (str) – Gets or sets the source of the error.

  • resource_id (str) – Gets or sets the resource ID which generated the error.

  • error_code (str) – Gets or sets the error code.

  • error_message (str) – Gets or sets the error message.

  • locale (str) – Gets or sets the locale of the error.

  • error_details (str) – Gets or sets the error details.

Keyword Arguments

  • error_source (str) – Gets or sets the source of the error.

  • resource_id (str) – Gets or sets the resource ID which generated the error.

  • error_code (str) – Gets or sets the error code.

  • error_message (str) – Gets or sets the error message.

  • locale (str) – Gets or sets the locale of the error.

  • error_details (str) – Gets or sets the error details.

class azure.mgmt.automation.models.DscReportResource(*, resource_id: Optional[str] = None, source_info: Optional[str] = None, depends_on: Optional[List[_models.DscReportResourceNavigation]] = None, module_name: Optional[str] = None, module_version: Optional[str] = None, resource_name: Optional[str] = None, error: Optional[str] = None, status: Optional[str] = None, duration_in_seconds: Optional[float] = None, start_date: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the DSC Report Resource.

Variables

  • resource_id (str) – Gets or sets the ID of the resource.

  • source_info (str) – Gets or sets the source info of the resource.

  • depends_on (list[DscReportResourceNavigation]) – Gets or sets the Resource Navigation values for resources the resource depends on.

  • module_name (str) – Gets or sets the module name of the resource.

  • module_version (str) – Gets or sets the module version of the resource.

  • resource_name (str) – Gets or sets the name of the resource.

  • error (str) – Gets or sets the error of the resource.

  • status (str) – Gets or sets the status of the resource.

  • duration_in_seconds (float) – Gets or sets the duration in seconds for the resource.

  • start_date (datetime) – Gets or sets the start date of the resource.

Keyword Arguments

  • resource_id (str) – Gets or sets the ID of the resource.

  • source_info (str) – Gets or sets the source info of the resource.

  • depends_on (list[DscReportResourceNavigation]) – Gets or sets the Resource Navigation values for resources the resource depends on.

  • module_name (str) – Gets or sets the module name of the resource.

  • module_version (str) – Gets or sets the module version of the resource.

  • resource_name (str) – Gets or sets the name of the resource.

  • error (str) – Gets or sets the error of the resource.

  • status (str) – Gets or sets the status of the resource.

  • duration_in_seconds (float) – Gets or sets the duration in seconds for the resource.

  • start_date (datetime) – Gets or sets the start date of the resource.

class azure.mgmt.automation.models.DscReportResourceNavigation(*, resource_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Navigation for DSC Report Resource.

Variables

resource_id (str) – Gets or sets the ID of the resource to navigate to.

Keyword Arguments

resource_id (str) – Gets or sets the ID of the resource to navigate to.

class azure.mgmt.automation.models.EncryptionKeySourceType(value)[source]

Bases: str, enum.Enum

Encryption Key Source.

MICROSOFT_AUTOMATION = 'Microsoft.Automation'
MICROSOFT_KEYVAULT = 'Microsoft.Keyvault'
class azure.mgmt.automation.models.EncryptionProperties(*, key_vault_properties: Optional[_models.KeyVaultProperties] = None, key_source: Optional[Union[str, _models.EncryptionKeySourceType]] = None, identity: Optional[_models.EncryptionPropertiesIdentity] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The encryption settings for automation account.

Variables
Keyword Arguments
class azure.mgmt.automation.models.EncryptionPropertiesIdentity(*, user_assigned_identity: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

User identity used for CMK.

Variables

user_assigned_identity (JSON) – The user identity used for CMK. It will be an ARM resource id in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Keyword Arguments

user_assigned_identity (JSON) – The user identity used for CMK. It will be an ARM resource id in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

class azure.mgmt.automation.models.ErrorResponse(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Error response of an operation failure.

Variables

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

Keyword Arguments

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

class azure.mgmt.automation.models.FieldDefinition(*, type: str, is_encrypted: Optional[bool] = None, is_optional: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the connection fields.

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

Variables

  • is_encrypted (bool) – Gets or sets the isEncrypted flag of the connection field definition.

  • is_optional (bool) – Gets or sets the isOptional flag of the connection field definition.

  • type (str) – Gets or sets the type of the connection field definition. Required.

Keyword Arguments

  • is_encrypted (bool) – Gets or sets the isEncrypted flag of the connection field definition.

  • is_optional (bool) – Gets or sets the isOptional flag of the connection field definition.

  • type (str) – Gets or sets the type of the connection field definition. Required.

class azure.mgmt.automation.models.GraphRunbookType(value)[source]

Bases: str, enum.Enum

Runbook Type.

GRAPH_POWER_SHELL = 'GraphPowerShell'
GRAPH_POWER_SHELL_WORKFLOW = 'GraphPowerShellWorkflow'
class azure.mgmt.automation.models.GraphicalRunbookContent(*, raw_content: Optional[_models.RawGraphicalRunbookContent] = None, graph_runbook_json: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Graphical Runbook Content.

Variables
Keyword Arguments
class azure.mgmt.automation.models.GroupTypeEnum(value)[source]

Bases: str, enum.Enum

Type of the HybridWorkerGroup.

SYSTEM = 'System'
USER = 'User'
class azure.mgmt.automation.models.HttpStatusCode(value)[source]

Bases: str, enum.Enum

HttpStatusCode.

ACCEPTED = 'Accepted'
AMBIGUOUS = 'Ambiguous'
BAD_GATEWAY = 'BadGateway'
BAD_REQUEST = 'BadRequest'
CONFLICT = 'Conflict'
CONTINUE = 'Continue'
CREATED = 'Created'
EXPECTATION_FAILED = 'ExpectationFailed'
FORBIDDEN = 'Forbidden'
FOUND = 'Found'
GATEWAY_TIMEOUT = 'GatewayTimeout'
GONE = 'Gone'
HTTP_VERSION_NOT_SUPPORTED = 'HttpVersionNotSupported'
INTERNAL_SERVER_ERROR = 'InternalServerError'
LENGTH_REQUIRED = 'LengthRequired'
METHOD_NOT_ALLOWED = 'MethodNotAllowed'
MOVED = 'Moved'
MOVED_PERMANENTLY = 'MovedPermanently'
MULTIPLE_CHOICES = 'MultipleChoices'
NON_AUTHORITATIVE_INFORMATION = 'NonAuthoritativeInformation'
NOT_ACCEPTABLE = 'NotAcceptable'
NOT_FOUND = 'NotFound'
NOT_IMPLEMENTED = 'NotImplemented'
NOT_MODIFIED = 'NotModified'
NO_CONTENT = 'NoContent'
OK = 'OK'
PARTIAL_CONTENT = 'PartialContent'
PAYMENT_REQUIRED = 'PaymentRequired'
PRECONDITION_FAILED = 'PreconditionFailed'
PROXY_AUTHENTICATION_REQUIRED = 'ProxyAuthenticationRequired'
REDIRECT = 'Redirect'
REDIRECT_KEEP_VERB = 'RedirectKeepVerb'
REDIRECT_METHOD = 'RedirectMethod'
REQUESTED_RANGE_NOT_SATISFIABLE = 'RequestedRangeNotSatisfiable'
REQUEST_ENTITY_TOO_LARGE = 'RequestEntityTooLarge'
REQUEST_TIMEOUT = 'RequestTimeout'
REQUEST_URI_TOO_LONG = 'RequestUriTooLong'
RESET_CONTENT = 'ResetContent'
SEE_OTHER = 'SeeOther'
SERVICE_UNAVAILABLE = 'ServiceUnavailable'
SWITCHING_PROTOCOLS = 'SwitchingProtocols'
TEMPORARY_REDIRECT = 'TemporaryRedirect'
UNAUTHORIZED = 'Unauthorized'
UNSUPPORTED_MEDIA_TYPE = 'UnsupportedMediaType'
UNUSED = 'Unused'
UPGRADE_REQUIRED = 'UpgradeRequired'
USE_PROXY = 'UseProxy'
class azure.mgmt.automation.models.HybridRunbookWorker(*, ip: Optional[str] = None, registered_date_time: Optional[datetime.datetime] = None, last_seen_date_time: Optional[datetime.datetime] = None, vm_resource_id: Optional[str] = None, worker_type: Optional[Union[str, _models.WorkerType]] = None, worker_name: Optional[str] = None, **kwargs)[source]

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

Definition of hybrid runbook worker.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • system_data (SystemData) – Resource system metadata.

  • ip (str) – Gets or sets the assigned machine IP address.

  • registered_date_time (datetime) – Gets or sets the registration time of the worker machine.

  • last_seen_date_time (datetime) – Last Heartbeat from the Worker.

  • vm_resource_id (str) – Azure Resource Manager Id for a virtual machine.

  • worker_type (str or WorkerType) – Type of the HybridWorker. Known values are: “HybridV1” and “HybridV2”.

  • worker_name (str) – Name of the HybridWorker.

Keyword Arguments

  • ip (str) – Gets or sets the assigned machine IP address.

  • registered_date_time (datetime) – Gets or sets the registration time of the worker machine.

  • last_seen_date_time (datetime) – Last Heartbeat from the Worker.

  • vm_resource_id (str) – Azure Resource Manager Id for a virtual machine.

  • worker_type (str or WorkerType) – Type of the HybridWorker. Known values are: “HybridV1” and “HybridV2”.

  • worker_name (str) – Name of the HybridWorker.

class azure.mgmt.automation.models.HybridRunbookWorkerCreateParameters(*, name: Optional[str] = None, vm_resource_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create hybrid runbook worker operation.

Variables

  • name (str) – Gets or sets the name of the resource.

  • vm_resource_id (str) – Azure Resource Manager Id for a virtual machine.

Keyword Arguments

  • name (str) – Gets or sets the name of the resource.

  • vm_resource_id (str) – Azure Resource Manager Id for a virtual machine.

class azure.mgmt.automation.models.HybridRunbookWorkerGroup(*, group_type: Optional[Union[str, _models.GroupTypeEnum]] = None, credential: Optional[_models.RunAsCredentialAssociationProperty] = None, **kwargs)[source]

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

Definition of hybrid runbook worker group.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • system_data (SystemData) – Resource system metadata.

  • group_type (str or GroupTypeEnum) – Type of the HybridWorkerGroup. Known values are: “User” and “System”.

  • credential (RunAsCredentialAssociationProperty) – Sets the credential of a worker group.

Keyword Arguments
class azure.mgmt.automation.models.HybridRunbookWorkerGroupCreateOrUpdateParameters(*, name: Optional[str] = None, credential: Optional[_models.RunAsCredentialAssociationProperty] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create hybrid runbook worker group operation.

Variables
Keyword Arguments
class azure.mgmt.automation.models.HybridRunbookWorkerGroupsListResult(*, value: Optional[List[_models.HybridRunbookWorkerGroup]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list hybrid runbook worker groups.

Variables
Keyword Arguments
class azure.mgmt.automation.models.HybridRunbookWorkerMoveParameters(*, hybrid_runbook_worker_group_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Parameters supplied to move hybrid worker operation.

Variables

hybrid_runbook_worker_group_name (str) – Gets or sets the target hybrid runbook worker group.

Keyword Arguments

hybrid_runbook_worker_group_name (str) – Gets or sets the target hybrid runbook worker group.

class azure.mgmt.automation.models.HybridRunbookWorkersListResult(*, value: Optional[List[_models.HybridRunbookWorker]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list hybrid runbook workers.

Variables

  • value (list[HybridRunbookWorker]) – Gets or sets a list of hybrid runbook workers.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[HybridRunbookWorker]) – Gets or sets a list of hybrid runbook workers.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.Identity(*, type: Optional[Union[str, _models.ResourceIdentityType]] = None, user_assigned_identities: Optional[Dict[str, _models.UserAssignedIdentitiesProperties]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Identity for the resource.

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

Variables

  • principal_id (str) – The principal ID of resource identity.

  • tenant_id (str) – The tenant ID of resource.

  • type (str or ResourceIdentityType) – The identity type. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

  • user_assigned_identities (dict[str, UserAssignedIdentitiesProperties]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Keyword Arguments

  • type (str or ResourceIdentityType) – The identity type. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.

  • user_assigned_identities (dict[str, UserAssignedIdentitiesProperties]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

class azure.mgmt.automation.models.Job(*, runbook: Optional[_models.RunbookAssociationProperty] = None, started_by: Optional[str] = None, run_on: Optional[str] = None, job_id: Optional[str] = None, creation_time: Optional[datetime.datetime] = None, status: Optional[Union[str, _models.JobStatus]] = None, status_details: Optional[str] = None, start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, exception: Optional[str] = None, last_modified_time: Optional[datetime.datetime] = None, last_status_modified_time: Optional[datetime.datetime] = None, parameters: Optional[Dict[str, str]] = None, provisioning_state: Optional[Union[str, _models.JobProvisioningState]] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the job.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • started_by (str) – Gets or sets the job started by.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

  • job_id (str) – Gets or sets the id of the job.

  • creation_time (datetime) – Gets or sets the creation time of the job.

  • status (str or JobStatus) – Gets or sets the status of the job. Known values are: “New”, “Activating”, “Running”, “Completed”, “Failed”, “Stopped”, “Blocked”, “Suspended”, “Disconnected”, “Suspending”, “Stopping”, “Resuming”, and “Removing”.

  • status_details (str) – Gets or sets the status details of the job.

  • start_time (datetime) – Gets or sets the start time of the job.

  • end_time (datetime) – Gets or sets the end time of the job.

  • exception (str) – Gets or sets the exception of the job.

  • last_modified_time (datetime) – Gets or sets the last modified time of the job.

  • last_status_modified_time (datetime) – Gets or sets the last status modified time of the job.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • provisioning_state (str or JobProvisioningState) – The current provisioning state of the job. Known values are: “Failed”, “Succeeded”, “Suspended”, and “Processing”.

Keyword Arguments

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • started_by (str) – Gets or sets the job started by.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

  • job_id (str) – Gets or sets the id of the job.

  • creation_time (datetime) – Gets or sets the creation time of the job.

  • status (str or JobStatus) – Gets or sets the status of the job. Known values are: “New”, “Activating”, “Running”, “Completed”, “Failed”, “Stopped”, “Blocked”, “Suspended”, “Disconnected”, “Suspending”, “Stopping”, “Resuming”, and “Removing”.

  • status_details (str) – Gets or sets the status details of the job.

  • start_time (datetime) – Gets or sets the start time of the job.

  • end_time (datetime) – Gets or sets the end time of the job.

  • exception (str) – Gets or sets the exception of the job.

  • last_modified_time (datetime) – Gets or sets the last modified time of the job.

  • last_status_modified_time (datetime) – Gets or sets the last status modified time of the job.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • provisioning_state (str or JobProvisioningState) – The current provisioning state of the job. Known values are: “Failed”, “Succeeded”, “Suspended”, and “Processing”.

class azure.mgmt.automation.models.JobCollectionItem(*, run_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Job collection item properties.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • runbook (RunbookAssociationProperty) – The runbook association.

  • job_id (str) – The id of the job.

  • creation_time (datetime) – The creation time of the job.

  • status (str or JobStatus) – The status of the job. Known values are: “New”, “Activating”, “Running”, “Completed”, “Failed”, “Stopped”, “Blocked”, “Suspended”, “Disconnected”, “Suspending”, “Stopping”, “Resuming”, and “Removing”.

  • start_time (datetime) – The start time of the job.

  • end_time (datetime) – The end time of the job.

  • last_modified_time (datetime) – The last modified time of the job.

  • provisioning_state (str) – The provisioning state of a resource.

  • run_on (str) – Specifies the runOn group name where the job was executed.

Keyword Arguments

run_on (str) – Specifies the runOn group name where the job was executed.

class azure.mgmt.automation.models.JobCreateParameters(*, runbook: Optional[_models.RunbookAssociationProperty] = None, parameters: Optional[Dict[str, str]] = None, run_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create job operation.

Variables

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

Keyword Arguments

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

class azure.mgmt.automation.models.JobListResultV2(*, value: Optional[List[_models.JobCollectionItem]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list job operation.

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

Variables
Keyword Arguments

value (list[JobCollectionItem]) – List of jobs.

class azure.mgmt.automation.models.JobNavigation(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration machine run job navigation properties.

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

Variables

id (str) – Id of the job associated with the software update configuration run.

class azure.mgmt.automation.models.JobProvisioningState(value)[source]

Bases: str, enum.Enum

The provisioning state of the resource.

FAILED = 'Failed'
PROCESSING = 'Processing'
SUCCEEDED = 'Succeeded'
SUSPENDED = 'Suspended'
class azure.mgmt.automation.models.JobSchedule(*, job_schedule_id: Optional[str] = None, schedule: Optional[_models.ScheduleAssociationProperty] = None, runbook: Optional[_models.RunbookAssociationProperty] = None, run_on: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the job schedule.

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

Variables

  • id (str) – Gets the id of the resource.

  • name (str) – Gets the name of the variable.

  • type (str) – Resource type.

  • job_schedule_id (str) – Gets or sets the id of job schedule.

  • schedule (ScheduleAssociationProperty) – Gets or sets the schedule.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • run_on (str) – Gets or sets the hybrid worker group that the scheduled job should run on.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job schedule.

Keyword Arguments

  • job_schedule_id (str) – Gets or sets the id of job schedule.

  • schedule (ScheduleAssociationProperty) – Gets or sets the schedule.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • run_on (str) – Gets or sets the hybrid worker group that the scheduled job should run on.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job schedule.

class azure.mgmt.automation.models.JobScheduleCreateParameters(*, schedule: _models.ScheduleAssociationProperty, runbook: _models.RunbookAssociationProperty, run_on: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create job schedule operation.

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

Variables
Keyword Arguments
class azure.mgmt.automation.models.JobScheduleListResult(*, value: Optional[List[_models.JobSchedule]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list job schedule operation.

Variables

  • value (list[JobSchedule]) – Gets or sets a list of job schedules.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[JobSchedule]) – Gets or sets a list of job schedules.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.JobStatus(value)[source]

Bases: str, enum.Enum

Gets or sets the status of the job.

ACTIVATING = 'Activating'
BLOCKED = 'Blocked'
COMPLETED = 'Completed'
DISCONNECTED = 'Disconnected'
FAILED = 'Failed'
NEW = 'New'
REMOVING = 'Removing'
RESUMING = 'Resuming'
RUNNING = 'Running'
STOPPED = 'Stopped'
STOPPING = 'Stopping'
SUSPENDED = 'Suspended'
SUSPENDING = 'Suspending'
class azure.mgmt.automation.models.JobStream(*, id: Optional[str] = None, job_stream_id: Optional[str] = None, time: Optional[datetime.datetime] = None, stream_type: Optional[Union[str, _models.JobStreamType]] = None, stream_text: Optional[str] = None, summary: Optional[str] = None, value: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the job stream.

Variables

  • id (str) – Gets or sets the id of the resource.

  • job_stream_id (str) – Gets or sets the id of the job stream.

  • time (datetime) – Gets or sets the creation time of the job.

  • stream_type (str or JobStreamType) – Gets or sets the stream type. Known values are: “Progress”, “Output”, “Warning”, “Error”, “Debug”, “Verbose”, and “Any”.

  • stream_text (str) – Gets or sets the stream text.

  • summary (str) – Gets or sets the summary.

  • value (dict[str, JSON]) – Gets or sets the values of the job stream.

Keyword Arguments

  • id (str) – Gets or sets the id of the resource.

  • job_stream_id (str) – Gets or sets the id of the job stream.

  • time (datetime) – Gets or sets the creation time of the job.

  • stream_type (str or JobStreamType) – Gets or sets the stream type. Known values are: “Progress”, “Output”, “Warning”, “Error”, “Debug”, “Verbose”, and “Any”.

  • stream_text (str) – Gets or sets the stream text.

  • summary (str) – Gets or sets the summary.

  • value (dict[str, JSON]) – Gets or sets the values of the job stream.

class azure.mgmt.automation.models.JobStreamListResult(*, value: Optional[List[_models.JobStream]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list job stream operation.

Variables

  • value (list[JobStream]) – A list of job streams.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[JobStream]) – A list of job streams.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.JobStreamType(value)[source]

Bases: str, enum.Enum

Gets or sets the stream type.

ANY = 'Any'
DEBUG = 'Debug'
ERROR = 'Error'
OUTPUT = 'Output'
PROGRESS = 'Progress'
VERBOSE = 'Verbose'
WARNING = 'Warning'
class azure.mgmt.automation.models.Key(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Automation key which is used to register a DSC Node.

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

Variables

  • key_name (str or AutomationKeyName) – Automation key name. Known values are: “Primary” and “Secondary”.

  • permissions (str or AutomationKeyPermissions) – Automation key permissions. Known values are: “Read” and “Full”.

  • value (str) – Value of the Automation Key used for registration.

class azure.mgmt.automation.models.KeyListResult(*, keys: Optional[List[_models.Key]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

KeyListResult.

Variables

keys (list[Key]) – Lists the automation keys.

Keyword Arguments

keys (list[Key]) – Lists the automation keys.

class azure.mgmt.automation.models.KeyVaultProperties(*, keyvault_uri: Optional[str] = None, key_name: Optional[str] = None, key_version: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Settings concerning key vault encryption for a configuration store.

Variables

  • keyvault_uri (str) – The URI of the key vault key used to encrypt data.

  • key_name (str) – The name of key used to encrypt data.

  • key_version (str) – The key version of the key used to encrypt data.

Keyword Arguments

  • keyvault_uri (str) – The URI of the key vault key used to encrypt data.

  • key_name (str) – The name of key used to encrypt data.

  • key_version (str) – The key version of the key used to encrypt data.

class azure.mgmt.automation.models.LinkedWorkspace(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the linked workspace.

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

Variables

id (str) – Gets the id of the linked workspace.

class azure.mgmt.automation.models.LinuxProperties(*, included_package_classifications: Optional[Union[str, _models.LinuxUpdateClasses]] = None, excluded_package_name_masks: Optional[List[str]] = None, included_package_name_masks: Optional[List[str]] = None, reboot_setting: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Linux specific update configuration.

Variables

  • included_package_classifications (str or LinuxUpdateClasses) – Update classifications included in the software update configuration. Known values are: “Unclassified”, “Critical”, “Security”, and “Other”.

  • excluded_package_name_masks (list[str]) – packages excluded from the software update configuration.

  • included_package_name_masks (list[str]) – packages included from the software update configuration.

  • reboot_setting (str) – Reboot setting for the software update configuration.

Keyword Arguments

  • included_package_classifications (str or LinuxUpdateClasses) – Update classifications included in the software update configuration. Known values are: “Unclassified”, “Critical”, “Security”, and “Other”.

  • excluded_package_name_masks (list[str]) – packages excluded from the software update configuration.

  • included_package_name_masks (list[str]) – packages included from the software update configuration.

  • reboot_setting (str) – Reboot setting for the software update configuration.

class azure.mgmt.automation.models.LinuxUpdateClasses(value)[source]

Bases: str, enum.Enum

Update classifications included in the software update configuration.

CRITICAL = 'Critical'
OTHER = 'Other'
SECURITY = 'Security'
UNCLASSIFIED = 'Unclassified'
class azure.mgmt.automation.models.LogSpecification(*, name: Optional[str] = None, display_name: Optional[str] = None, blob_duration: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Description of logging specification.

Variables

  • name (str) – The name of the specification.

  • display_name (str) – The display name of the specification.

  • blob_duration (str) – Duration of the blob.

Keyword Arguments

  • name (str) – The name of the specification.

  • display_name (str) – The display name of the specification.

  • blob_duration (str) – Duration of the blob.

class azure.mgmt.automation.models.MetricSpecification(*, name: Optional[str] = None, display_name: Optional[str] = None, display_description: Optional[str] = None, unit: Optional[str] = None, aggregation_type: Optional[str] = None, dimensions: Optional[List[_models.Dimension]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Description of metrics specification.

Variables

  • name (str) – The name of the metric.

  • display_name (str) – The display name of the metric.

  • display_description (str) – The description of the metric.

  • unit (str) – Units the metric to be displayed in.

  • aggregation_type (str) – The aggregation type.

  • dimensions (list[Dimension]) – List of dimensions.

Keyword Arguments

  • name (str) – The name of the metric.

  • display_name (str) – The display name of the metric.

  • display_description (str) – The description of the metric.

  • unit (str) – Units the metric to be displayed in.

  • aggregation_type (str) – The aggregation type.

  • dimensions (list[Dimension]) – List of dimensions.

class azure.mgmt.automation.models.Module(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, etag: Optional[str] = None, is_global: Optional[bool] = None, version: Optional[str] = None, size_in_bytes: Optional[int] = None, activity_count: Optional[int] = None, provisioning_state: Optional[Union[str, _models.ModuleProvisioningState]] = None, content_link: Optional[_models.ContentLink] = None, error: Optional[_models.ModuleErrorInfo] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, is_composite: Optional[bool] = None, **kwargs)[source]

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

Definition of the module type.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • is_global (bool) – Gets or sets the isGlobal flag of the module.

  • version (str) – Gets or sets the version of the module.

  • size_in_bytes (int) – Gets or sets the size in bytes of the module.

  • activity_count (int) – Gets or sets the activity count of the module.

  • provisioning_state (str or ModuleProvisioningState) – Gets or sets the provisioning state of the module. Known values are: “Created”, “Creating”, “StartingImportModuleRunbook”, “RunningImportModuleRunbook”, “ContentRetrieved”, “ContentDownloaded”, “ContentValidated”, “ConnectionTypeImported”, “ContentStored”, “ModuleDataStored”, “ActivitiesStored”, “ModuleImportRunbookComplete”, “Succeeded”, “Failed”, “Cancelled”, and “Updating”.

  • content_link (ContentLink) – Gets or sets the contentLink of the module.

  • error (ModuleErrorInfo) – Gets or sets the error info of the module.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

  • is_composite (bool) – Gets or sets type of module, if its composite or not.

Keyword Arguments

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • is_global (bool) – Gets or sets the isGlobal flag of the module.

  • version (str) – Gets or sets the version of the module.

  • size_in_bytes (int) – Gets or sets the size in bytes of the module.

  • activity_count (int) – Gets or sets the activity count of the module.

  • provisioning_state (str or ModuleProvisioningState) – Gets or sets the provisioning state of the module. Known values are: “Created”, “Creating”, “StartingImportModuleRunbook”, “RunningImportModuleRunbook”, “ContentRetrieved”, “ContentDownloaded”, “ContentValidated”, “ConnectionTypeImported”, “ContentStored”, “ModuleDataStored”, “ActivitiesStored”, “ModuleImportRunbookComplete”, “Succeeded”, “Failed”, “Cancelled”, and “Updating”.

  • content_link (ContentLink) – Gets or sets the contentLink of the module.

  • error (ModuleErrorInfo) – Gets or sets the error info of the module.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

  • is_composite (bool) – Gets or sets type of module, if its composite or not.

class azure.mgmt.automation.models.ModuleCreateOrUpdateParameters(*, content_link: _models.ContentLink, name: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update module operation.

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

Variables

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • content_link (ContentLink) – Gets or sets the module content link. Required.

Keyword Arguments

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • content_link (ContentLink) – Gets or sets the module content link. Required.

class azure.mgmt.automation.models.ModuleErrorInfo(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the module error info type.

Variables

  • code (str) – Gets or sets the error code.

  • message (str) – Gets or sets the error message.

Keyword Arguments

  • code (str) – Gets or sets the error code.

  • message (str) – Gets or sets the error message.

class azure.mgmt.automation.models.ModuleListResult(*, value: Optional[List[_models.Module]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list module operation.

Variables

  • value (list[Module]) – Gets or sets a list of modules.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Module]) – Gets or sets a list of modules.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.ModuleProvisioningState(value)[source]

Bases: str, enum.Enum

Gets or sets the provisioning state of the module.

ACTIVITIES_STORED = 'ActivitiesStored'
CANCELLED = 'Cancelled'
CONNECTION_TYPE_IMPORTED = 'ConnectionTypeImported'
CONTENT_DOWNLOADED = 'ContentDownloaded'
CONTENT_RETRIEVED = 'ContentRetrieved'
CONTENT_STORED = 'ContentStored'
CONTENT_VALIDATED = 'ContentValidated'
CREATED = 'Created'
CREATING = 'Creating'
FAILED = 'Failed'
MODULE_DATA_STORED = 'ModuleDataStored'
MODULE_IMPORT_RUNBOOK_COMPLETE = 'ModuleImportRunbookComplete'
RUNNING_IMPORT_MODULE_RUNBOOK = 'RunningImportModuleRunbook'
STARTING_IMPORT_MODULE_RUNBOOK = 'StartingImportModuleRunbook'
SUCCEEDED = 'Succeeded'
UPDATING = 'Updating'
class azure.mgmt.automation.models.ModuleUpdateParameters(*, name: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, content_link: Optional[_models.ContentLink] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update module operation.

Variables

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • content_link (ContentLink) – Gets or sets the module content link.

Keyword Arguments

  • name (str) – Gets or sets name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • content_link (ContentLink) – Gets or sets the module content link.

class azure.mgmt.automation.models.NodeCount(*, name: Optional[str] = None, properties: Optional[_models.NodeCountProperties] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Number of nodes based on the Filter.

Variables
Keyword Arguments
class azure.mgmt.automation.models.NodeCountProperties(*, count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

NodeCountProperties.

Variables

count (int) – Gets the count for the name.

Keyword Arguments

count (int) – Gets the count for the name.

class azure.mgmt.automation.models.NodeCounts(*, value: Optional[List[_models.NodeCount]] = None, total_count: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Gets the count of nodes by count type.

Variables

  • value (list[NodeCount]) – Gets an array of counts.

  • total_count (int) – Gets the total number of records matching countType criteria.

Keyword Arguments

  • value (list[NodeCount]) – Gets an array of counts.

  • total_count (int) – Gets the total number of records matching countType criteria.

class azure.mgmt.automation.models.NonAzureQueryProperties(*, function_alias: Optional[str] = None, workspace_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Non Azure query for the update configuration.

Variables

  • function_alias (str) – Log Analytics Saved Search name.

  • workspace_id (str) – Workspace Id for Log Analytics in which the saved Search is resided.

Keyword Arguments

  • function_alias (str) – Log Analytics Saved Search name.

  • workspace_id (str) – Workspace Id for Log Analytics in which the saved Search is resided.

class azure.mgmt.automation.models.OperatingSystemType(value)[source]

Bases: str, enum.Enum

Target operating system for the software update configuration.

LINUX = 'Linux'
WINDOWS = 'Windows'
class azure.mgmt.automation.models.Operation(*, name: Optional[str] = None, display: Optional[_models.OperationDisplay] = None, origin: Optional[str] = None, service_specification: Optional[_models.OperationPropertiesFormatServiceSpecification] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Automation REST API operation.

Variables
Keyword Arguments
class azure.mgmt.automation.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Provider, Resource and Operation values.

Variables

  • provider (str) – Service provider: Microsoft.Automation.

  • resource (str) – Resource on which the operation is performed: Runbooks, Jobs etc.

  • operation (str) – Operation type: Read, write, delete, etc.

  • description (str) – Description of the operation.

Keyword Arguments

  • provider (str) – Service provider: Microsoft.Automation.

  • resource (str) – Resource on which the operation is performed: Runbooks, Jobs etc.

  • operation (str) – Operation type: Read, write, delete, etc.

  • description (str) – Description of the operation.

class azure.mgmt.automation.models.OperationListResult(*, value: Optional[List[_models.Operation]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list of Automation operations.

Variables

value (list[Operation]) – List of Automation operations supported by the Automation resource provider.

Keyword Arguments

value (list[Operation]) – List of Automation operations supported by the Automation resource provider.

class azure.mgmt.automation.models.OperationPropertiesFormatServiceSpecification(*, metric_specifications: Optional[List[_models.MetricSpecification]] = None, log_specifications: Optional[List[_models.LogSpecification]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Specification of the service.

Variables
Keyword Arguments
class azure.mgmt.automation.models.PrivateEndpointConnection(*, private_endpoint: Optional[_models.PrivateEndpointProperty] = None, group_ids: Optional[List[str]] = None, private_link_service_connection_state: Optional[_models.PrivateLinkServiceConnectionStateProperty] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

A private endpoint connection.

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

Variables
Keyword Arguments
class azure.mgmt.automation.models.PrivateEndpointConnectionListResult(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

A list of private endpoint connections.

Variables

value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

Keyword Arguments

value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

class azure.mgmt.automation.models.PrivateEndpointProperty(*, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Private endpoint which the connection belongs to.

Variables

id (str) – Resource id of the private endpoint.

Keyword Arguments

id (str) – Resource id of the private endpoint.

class azure.mgmt.automation.models.PrivateLinkResource(**kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

A private link 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • group_id (str) – The private link resource group id.

  • required_members (list[str]) – The private link resource required member names.

class azure.mgmt.automation.models.PrivateLinkResourceListResult(*, value: Optional[List[_models.PrivateLinkResource]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

A list of private link resources.

Variables

value (list[PrivateLinkResource]) – Array of private link resources.

Keyword Arguments

value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.automation.models.PrivateLinkServiceConnectionStateProperty(*, status: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Connection State of the Private Endpoint Connection.

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

Variables

  • status (str) – The private link service connection status.

  • description (str) – The private link service connection description.

  • actions_required (str) – Any action that is required beyond basic workflow (approve/ reject/ disconnect).

Keyword Arguments

  • status (str) – The private link service connection status.

  • description (str) – The private link service connection description.

class azure.mgmt.automation.models.ProvisioningState(value)[source]

Bases: str, enum.Enum

The provisioning state of the job.

COMPLETED = 'Completed'
FAILED = 'Failed'
RUNNING = 'Running'
class azure.mgmt.automation.models.ProxyResource(**kwargs)[source]

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

ARM proxy 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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

class azure.mgmt.automation.models.PythonPackageCreateParameters(*, content_link: _models.ContentLink, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update module operation.

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

Variables

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • content_link (ContentLink) – Gets or sets the module content link. Required.

Keyword Arguments

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • content_link (ContentLink) – Gets or sets the module content link. Required.

class azure.mgmt.automation.models.PythonPackageUpdateParameters(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update module operation.

Variables

tags (dict[str, str]) – Gets or sets the tags attached to the resource.

Keyword Arguments

tags (dict[str, str]) – Gets or sets the tags attached to the resource.

class azure.mgmt.automation.models.RawGraphicalRunbookContent(*, schema_version: Optional[str] = None, runbook_definition: Optional[str] = None, runbook_type: Optional[Union[str, _models.GraphRunbookType]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Raw Graphical Runbook content.

Variables

  • schema_version (str) – Schema version of the serializer.

  • runbook_definition (str) – Serialized Graphical runbook.

  • runbook_type (str or GraphRunbookType) – Runbook Type. Known values are: “GraphPowerShell” and “GraphPowerShellWorkflow”.

Keyword Arguments

  • schema_version (str) – Schema version of the serializer.

  • runbook_definition (str) – Serialized Graphical runbook.

  • runbook_type (str or GraphRunbookType) – Runbook Type. Known values are: “GraphPowerShell” and “GraphPowerShellWorkflow”.

class azure.mgmt.automation.models.Resource(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The core properties of ARM resources.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

class azure.mgmt.automation.models.ResourceIdentityType(value)[source]

Bases: str, enum.Enum

The identity type.

NONE = 'None'
SYSTEM_ASSIGNED = 'SystemAssigned'
SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'
USER_ASSIGNED = 'UserAssigned'
class azure.mgmt.automation.models.RunAsCredentialAssociationProperty(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of RunAs credential to use for hybrid worker.

Variables

name (str) – Gets or sets the name of the credential.

Keyword Arguments

name (str) – Gets or sets the name of the credential.

class azure.mgmt.automation.models.Runbook(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, etag: Optional[str] = None, runbook_type: Optional[Union[str, _models.RunbookTypeEnum]] = None, publish_content_link: Optional[_models.ContentLink] = None, state: Optional[Union[str, _models.RunbookState]] = None, log_verbose: Optional[bool] = None, log_progress: Optional[bool] = None, log_activity_trace: Optional[int] = None, job_count: Optional[int] = None, parameters: Optional[Dict[str, _models.RunbookParameter]] = None, output_types: Optional[List[str]] = None, draft: Optional[_models.RunbookDraft] = None, provisioning_state: Optional[Literal[Succeeded]] = None, last_modified_by: Optional[str] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, **kwargs)[source]

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

Definition of the runbook type.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • runbook_type (str or RunbookTypeEnum) – Gets or sets the type of the runbook. Known values are: “Script”, “Graph”, “PowerShellWorkflow”, “PowerShell”, “GraphPowerShellWorkflow”, “GraphPowerShell”, “Python2”, and “Python3”.

  • publish_content_link (ContentLink) – Gets or sets the published runbook content link.

  • state (str or RunbookState) – Gets or sets the state of the runbook. Known values are: “New”, “Edit”, and “Published”.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • log_activity_trace (int) – Gets or sets the option to log activity trace of the runbook.

  • job_count (int) – Gets or sets the job count of the runbook.

  • parameters (dict[str, RunbookParameter]) – Gets or sets the runbook parameters.

  • output_types (list[str]) – Gets or sets the runbook output types.

  • draft (RunbookDraft) – Gets or sets the draft runbook properties.

  • provisioning_state (str) – Gets or sets the provisioning state of the runbook. Default value is “Succeeded”.

  • last_modified_by (str) – Gets or sets the last modified by.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

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

  • location (str) – The Azure Region where the resource lives.

  • etag (str) – Gets or sets the etag of the resource.

  • runbook_type (str or RunbookTypeEnum) – Gets or sets the type of the runbook. Known values are: “Script”, “Graph”, “PowerShellWorkflow”, “PowerShell”, “GraphPowerShellWorkflow”, “GraphPowerShell”, “Python2”, and “Python3”.

  • publish_content_link (ContentLink) – Gets or sets the published runbook content link.

  • state (str or RunbookState) – Gets or sets the state of the runbook. Known values are: “New”, “Edit”, and “Published”.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • log_activity_trace (int) – Gets or sets the option to log activity trace of the runbook.

  • job_count (int) – Gets or sets the job count of the runbook.

  • parameters (dict[str, RunbookParameter]) – Gets or sets the runbook parameters.

  • output_types (list[str]) – Gets or sets the runbook output types.

  • draft (RunbookDraft) – Gets or sets the draft runbook properties.

  • provisioning_state (str) – Gets or sets the provisioning state of the runbook. Default value is “Succeeded”.

  • last_modified_by (str) – Gets or sets the last modified by.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.RunbookAssociationProperty(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The runbook property associated with the entity.

Variables

name (str) – Gets or sets the name of the runbook.

Keyword Arguments

name (str) – Gets or sets the name of the runbook.

class azure.mgmt.automation.models.RunbookCreateOrUpdateDraftParameters(*, runbook_content: str, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update runbook operation.

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

Variables

runbook_content (str) – Content of the Runbook. Required.

Keyword Arguments

runbook_content (str) – Content of the Runbook. Required.

class azure.mgmt.automation.models.RunbookCreateOrUpdateDraftProperties(*, runbook_type: Union[str, _models.RunbookTypeEnum], draft: _models.RunbookDraft, log_verbose: Optional[bool] = None, log_progress: Optional[bool] = None, description: Optional[str] = None, log_activity_trace: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update draft runbook properties.

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

Variables

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • runbook_type (str or RunbookTypeEnum) – Gets or sets the type of the runbook. Required. Known values are: “Script”, “Graph”, “PowerShellWorkflow”, “PowerShell”, “GraphPowerShellWorkflow”, “GraphPowerShell”, “Python2”, and “Python3”.

  • draft (RunbookDraft) – Gets or sets the draft runbook properties. Required.

  • description (str) – Gets or sets the description of the runbook.

  • log_activity_trace (int) – Gets or sets the activity-level tracing options of the runbook.

Keyword Arguments

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • runbook_type (str or RunbookTypeEnum) – Gets or sets the type of the runbook. Required. Known values are: “Script”, “Graph”, “PowerShellWorkflow”, “PowerShell”, “GraphPowerShellWorkflow”, “GraphPowerShell”, “Python2”, and “Python3”.

  • draft (RunbookDraft) – Gets or sets the draft runbook properties. Required.

  • description (str) – Gets or sets the description of the runbook.

  • log_activity_trace (int) – Gets or sets the activity-level tracing options of the runbook.

class azure.mgmt.automation.models.RunbookCreateOrUpdateParameters(*, runbook_type: Union[str, _models.RunbookTypeEnum], name: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, log_verbose: Optional[bool] = None, log_progress: Optional[bool] = None, draft: Optional[_models.RunbookDraft] = None, publish_content_link: Optional[_models.ContentLink] = None, description: Optional[str] = None, log_activity_trace: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update runbook operation.

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

Variables

  • name (str) – Gets or sets the name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • runbook_type (str or RunbookTypeEnum) – Gets or sets the type of the runbook. Required. Known values are: “Script”, “Graph”, “PowerShellWorkflow”, “PowerShell”, “GraphPowerShellWorkflow”, “GraphPowerShell”, “Python2”, and “Python3”.

  • draft (RunbookDraft) – Gets or sets the draft runbook properties.

  • publish_content_link (ContentLink) – Gets or sets the published runbook content link.

  • description (str) – Gets or sets the description of the runbook.

  • log_activity_trace (int) – Gets or sets the activity-level tracing options of the runbook.

Keyword Arguments

  • name (str) – Gets or sets the name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • runbook_type (str or RunbookTypeEnum) – Gets or sets the type of the runbook. Required. Known values are: “Script”, “Graph”, “PowerShellWorkflow”, “PowerShell”, “GraphPowerShellWorkflow”, “GraphPowerShell”, “Python2”, and “Python3”.

  • draft (RunbookDraft) – Gets or sets the draft runbook properties.

  • publish_content_link (ContentLink) – Gets or sets the published runbook content link.

  • description (str) – Gets or sets the description of the runbook.

  • log_activity_trace (int) – Gets or sets the activity-level tracing options of the runbook.

class azure.mgmt.automation.models.RunbookDraft(*, in_edit: Optional[bool] = None, draft_content_link: Optional[_models.ContentLink] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, parameters: Optional[Dict[str, _models.RunbookParameter]] = None, output_types: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

RunbookDraft.

Variables

  • in_edit (bool) – Gets or sets whether runbook is in edit mode.

  • draft_content_link (ContentLink) – Gets or sets the draft runbook content link.

  • creation_time (datetime) – Gets or sets the creation time of the runbook draft.

  • last_modified_time (datetime) – Gets or sets the last modified time of the runbook draft.

  • parameters (dict[str, RunbookParameter]) – Gets or sets the runbook draft parameters.

  • output_types (list[str]) – Gets or sets the runbook output types.

Keyword Arguments

  • in_edit (bool) – Gets or sets whether runbook is in edit mode.

  • draft_content_link (ContentLink) – Gets or sets the draft runbook content link.

  • creation_time (datetime) – Gets or sets the creation time of the runbook draft.

  • last_modified_time (datetime) – Gets or sets the last modified time of the runbook draft.

  • parameters (dict[str, RunbookParameter]) – Gets or sets the runbook draft parameters.

  • output_types (list[str]) – Gets or sets the runbook output types.

class azure.mgmt.automation.models.RunbookDraftUndoEditResult(*, status_code: Optional[Union[str, _models.HttpStatusCode]] = None, request_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the undo edit runbook operation.

Variables

  • status_code (str or HttpStatusCode) – Known values are: “Continue”, “SwitchingProtocols”, “OK”, “Created”, “Accepted”, “NonAuthoritativeInformation”, “NoContent”, “ResetContent”, “PartialContent”, “MultipleChoices”, “Ambiguous”, “MovedPermanently”, “Moved”, “Found”, “Redirect”, “SeeOther”, “RedirectMethod”, “NotModified”, “UseProxy”, “Unused”, “TemporaryRedirect”, “RedirectKeepVerb”, “BadRequest”, “Unauthorized”, “PaymentRequired”, “Forbidden”, “NotFound”, “MethodNotAllowed”, “NotAcceptable”, “ProxyAuthenticationRequired”, “RequestTimeout”, “Conflict”, “Gone”, “LengthRequired”, “PreconditionFailed”, “RequestEntityTooLarge”, “RequestUriTooLong”, “UnsupportedMediaType”, “RequestedRangeNotSatisfiable”, “ExpectationFailed”, “UpgradeRequired”, “InternalServerError”, “NotImplemented”, “BadGateway”, “ServiceUnavailable”, “GatewayTimeout”, and “HttpVersionNotSupported”.

  • request_id (str) –

Keyword Arguments

  • status_code (str or HttpStatusCode) – Known values are: “Continue”, “SwitchingProtocols”, “OK”, “Created”, “Accepted”, “NonAuthoritativeInformation”, “NoContent”, “ResetContent”, “PartialContent”, “MultipleChoices”, “Ambiguous”, “MovedPermanently”, “Moved”, “Found”, “Redirect”, “SeeOther”, “RedirectMethod”, “NotModified”, “UseProxy”, “Unused”, “TemporaryRedirect”, “RedirectKeepVerb”, “BadRequest”, “Unauthorized”, “PaymentRequired”, “Forbidden”, “NotFound”, “MethodNotAllowed”, “NotAcceptable”, “ProxyAuthenticationRequired”, “RequestTimeout”, “Conflict”, “Gone”, “LengthRequired”, “PreconditionFailed”, “RequestEntityTooLarge”, “RequestUriTooLong”, “UnsupportedMediaType”, “RequestedRangeNotSatisfiable”, “ExpectationFailed”, “UpgradeRequired”, “InternalServerError”, “NotImplemented”, “BadGateway”, “ServiceUnavailable”, “GatewayTimeout”, and “HttpVersionNotSupported”.

  • request_id (str) –

class azure.mgmt.automation.models.RunbookListResult(*, value: Optional[List[_models.Runbook]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list runbook operation.

Variables

  • value (list[Runbook]) – Gets or sets a list of runbooks.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Runbook]) – Gets or sets a list of runbooks.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.RunbookParameter(*, type: Optional[str] = None, is_mandatory: Optional[bool] = None, position: Optional[int] = None, default_value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the runbook parameter type.

Variables

  • type (str) – Gets or sets the type of the parameter.

  • is_mandatory (bool) – Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

  • position (int) – Get or sets the position of the parameter.

  • default_value (str) – Gets or sets the default value of parameter.

Keyword Arguments

  • type (str) – Gets or sets the type of the parameter.

  • is_mandatory (bool) – Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

  • position (int) – Get or sets the position of the parameter.

  • default_value (str) – Gets or sets the default value of parameter.

class azure.mgmt.automation.models.RunbookState(value)[source]

Bases: str, enum.Enum

Gets or sets the state of the runbook.

EDIT = 'Edit'
NEW = 'New'
PUBLISHED = 'Published'
class azure.mgmt.automation.models.RunbookTypeEnum(value)[source]

Bases: str, enum.Enum

Gets or sets the type of the runbook.

GRAPH = 'Graph'
GRAPH_POWER_SHELL = 'GraphPowerShell'
GRAPH_POWER_SHELL_WORKFLOW = 'GraphPowerShellWorkflow'
POWER_SHELL = 'PowerShell'
POWER_SHELL_WORKFLOW = 'PowerShellWorkflow'
PYTHON2 = 'Python2'
PYTHON3 = 'Python3'
SCRIPT = 'Script'
class azure.mgmt.automation.models.RunbookUpdateParameters(*, name: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, description: Optional[str] = None, log_verbose: Optional[bool] = None, log_progress: Optional[bool] = None, log_activity_trace: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update runbook operation.

Variables

  • name (str) – Gets or sets the name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • description (str) – Gets or sets the description of the runbook.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • log_activity_trace (int) – Gets or sets the activity-level tracing options of the runbook.

Keyword Arguments

  • name (str) – Gets or sets the name of the resource.

  • location (str) – Gets or sets the location of the resource.

  • tags (dict[str, str]) – Gets or sets the tags attached to the resource.

  • description (str) – Gets or sets the description of the runbook.

  • log_verbose (bool) – Gets or sets verbose log option.

  • log_progress (bool) – Gets or sets progress log option.

  • log_activity_trace (int) – Gets or sets the activity-level tracing options of the runbook.

class azure.mgmt.automation.models.SUCScheduleProperties(*, start_time: Optional[datetime.datetime] = None, expiry_time: Optional[datetime.datetime] = None, expiry_time_offset_minutes: Optional[float] = None, is_enabled: bool = False, next_run: Optional[datetime.datetime] = None, next_run_offset_minutes: Optional[float] = None, interval: Optional[int] = None, frequency: Optional[Union[str, _models.ScheduleFrequency]] = None, time_zone: Optional[str] = None, advanced_schedule: Optional[_models.AdvancedSchedule] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of schedule parameters.

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

Variables

  • start_time (datetime) – Gets or sets the start time of the schedule.

  • start_time_offset_minutes (float) – Gets the start time’s offset in minutes.

  • expiry_time (datetime) – Gets or sets the end time of the schedule.

  • expiry_time_offset_minutes (float) – Gets or sets the expiry time’s offset in minutes.

  • is_enabled (bool) – Gets or sets a value indicating whether this schedule is enabled.

  • next_run (datetime) – Gets or sets the next run time of the schedule.

  • next_run_offset_minutes (float) – Gets or sets the next run time’s offset in minutes.

  • interval (int) – Gets or sets the interval of the schedule.

  • frequency (str or ScheduleFrequency) – Gets or sets the frequency of the schedule. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • time_zone (str) – Gets or sets the time zone of the schedule.

  • advanced_schedule (AdvancedSchedule) – Gets or sets the advanced schedule.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • start_time (datetime) – Gets or sets the start time of the schedule.

  • expiry_time (datetime) – Gets or sets the end time of the schedule.

  • expiry_time_offset_minutes (float) – Gets or sets the expiry time’s offset in minutes.

  • is_enabled (bool) – Gets or sets a value indicating whether this schedule is enabled.

  • next_run (datetime) – Gets or sets the next run time of the schedule.

  • next_run_offset_minutes (float) – Gets or sets the next run time’s offset in minutes.

  • interval (int) – Gets or sets the interval of the schedule.

  • frequency (str or ScheduleFrequency) – Gets or sets the frequency of the schedule. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • time_zone (str) – Gets or sets the time zone of the schedule.

  • advanced_schedule (AdvancedSchedule) – Gets or sets the advanced schedule.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.Schedule(*, start_time: Optional[datetime.datetime] = None, expiry_time: Optional[datetime.datetime] = None, expiry_time_offset_minutes: Optional[float] = None, is_enabled: bool = False, next_run: Optional[datetime.datetime] = None, next_run_offset_minutes: Optional[float] = None, interval: Optional[Any] = None, frequency: Optional[Union[str, _models.ScheduleFrequency]] = None, time_zone: Optional[str] = None, advanced_schedule: Optional[_models.AdvancedSchedule] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the schedule.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • start_time (datetime) – Gets or sets the start time of the schedule.

  • start_time_offset_minutes (float) – Gets the start time’s offset in minutes.

  • expiry_time (datetime) – Gets or sets the end time of the schedule.

  • expiry_time_offset_minutes (float) – Gets or sets the expiry time’s offset in minutes.

  • is_enabled (bool) – Gets or sets a value indicating whether this schedule is enabled.

  • next_run (datetime) – Gets or sets the next run time of the schedule.

  • next_run_offset_minutes (float) – Gets or sets the next run time’s offset in minutes.

  • interval (any) – Gets or sets the interval of the schedule.

  • frequency (str or ScheduleFrequency) – Gets or sets the frequency of the schedule. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • time_zone (str) – Gets or sets the time zone of the schedule.

  • advanced_schedule (AdvancedSchedule) – Gets or sets the advanced schedule.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • start_time (datetime) – Gets or sets the start time of the schedule.

  • expiry_time (datetime) – Gets or sets the end time of the schedule.

  • expiry_time_offset_minutes (float) – Gets or sets the expiry time’s offset in minutes.

  • is_enabled (bool) – Gets or sets a value indicating whether this schedule is enabled.

  • next_run (datetime) – Gets or sets the next run time of the schedule.

  • next_run_offset_minutes (float) – Gets or sets the next run time’s offset in minutes.

  • interval (any) – Gets or sets the interval of the schedule.

  • frequency (str or ScheduleFrequency) – Gets or sets the frequency of the schedule. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • time_zone (str) – Gets or sets the time zone of the schedule.

  • advanced_schedule (AdvancedSchedule) – Gets or sets the advanced schedule.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.ScheduleAssociationProperty(*, name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The schedule property associated with the entity.

Variables

name (str) – Gets or sets the name of the Schedule.

Keyword Arguments

name (str) – Gets or sets the name of the Schedule.

class azure.mgmt.automation.models.ScheduleCreateOrUpdateParameters(*, name: str, start_time: datetime.datetime, frequency: Union[str, _models.ScheduleFrequency], description: Optional[str] = None, expiry_time: Optional[datetime.datetime] = None, interval: Optional[Any] = None, time_zone: Optional[str] = None, advanced_schedule: Optional[_models.AdvancedSchedule] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update schedule operation.

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

Variables

  • name (str) – Gets or sets the name of the Schedule. Required.

  • description (str) – Gets or sets the description of the schedule.

  • start_time (datetime) – Gets or sets the start time of the schedule. Required.

  • expiry_time (datetime) – Gets or sets the end time of the schedule.

  • interval (any) – Gets or sets the interval of the schedule.

  • frequency (str or ScheduleFrequency) – Gets or sets the frequency of the schedule. Required. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • time_zone (str) – Gets or sets the time zone of the schedule.

  • advanced_schedule (AdvancedSchedule) – Gets or sets the AdvancedSchedule.

Keyword Arguments

  • name (str) – Gets or sets the name of the Schedule. Required.

  • description (str) – Gets or sets the description of the schedule.

  • start_time (datetime) – Gets or sets the start time of the schedule. Required.

  • expiry_time (datetime) – Gets or sets the end time of the schedule.

  • interval (any) – Gets or sets the interval of the schedule.

  • frequency (str or ScheduleFrequency) – Gets or sets the frequency of the schedule. Required. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • time_zone (str) – Gets or sets the time zone of the schedule.

  • advanced_schedule (AdvancedSchedule) – Gets or sets the AdvancedSchedule.

class azure.mgmt.automation.models.ScheduleDay(value)[source]

Bases: str, enum.Enum

Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.automation.models.ScheduleFrequency(value)[source]

Bases: str, enum.Enum

Gets or sets the frequency of the schedule.

DAY = 'Day'
HOUR = 'Hour'
MINUTE = 'Minute'

The minimum allowed interval for Minute schedules is 15 minutes.

MONTH = 'Month'
ONE_TIME = 'OneTime'
WEEK = 'Week'
class azure.mgmt.automation.models.ScheduleListResult(*, value: Optional[List[_models.Schedule]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list schedule operation.

Variables

  • value (list[Schedule]) – Gets or sets a list of schedules.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Schedule]) – Gets or sets a list of schedules.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.ScheduleUpdateParameters(*, name: Optional[str] = None, description: Optional[str] = None, is_enabled: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update schedule operation.

Variables

  • name (str) – Gets or sets the name of the Schedule.

  • description (str) – Gets or sets the description of the schedule.

  • is_enabled (bool) – Gets or sets a value indicating whether this schedule is enabled.

Keyword Arguments

  • name (str) – Gets or sets the name of the Schedule.

  • description (str) – Gets or sets the description of the schedule.

  • is_enabled (bool) – Gets or sets a value indicating whether this schedule is enabled.

class azure.mgmt.automation.models.Sku(*, name: Union[str, _models.SkuNameEnum], family: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The account SKU.

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

Variables

  • name (str or SkuNameEnum) – Gets or sets the SKU name of the account. Required. Known values are: “Free” and “Basic”.

  • family (str) – Gets or sets the SKU family.

  • capacity (int) – Gets or sets the SKU capacity.

Keyword Arguments

  • name (str or SkuNameEnum) – Gets or sets the SKU name of the account. Required. Known values are: “Free” and “Basic”.

  • family (str) – Gets or sets the SKU family.

  • capacity (int) – Gets or sets the SKU capacity.

class azure.mgmt.automation.models.SkuNameEnum(value)[source]

Bases: str, enum.Enum

Gets or sets the SKU name of the account.

BASIC = 'Basic'
FREE = 'Free'
class azure.mgmt.automation.models.SoftwareUpdateConfiguration(*, update_configuration: _models.UpdateConfiguration, schedule_info: _models.SUCScheduleProperties, error: Optional[_models.ErrorResponse] = None, tasks: Optional[_models.SoftwareUpdateConfigurationTasks] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration properties.

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

  • name (str) – Resource name.

  • id (str) – Resource Id.

  • type (str) – Resource type.

  • update_configuration (UpdateConfiguration) – update specific properties for the Software update configuration. Required.

  • schedule_info (SUCScheduleProperties) – Schedule information for the Software update configuration. Required.

  • provisioning_state (str) – Provisioning state for the software update configuration, which only appears in the response.

  • error (ErrorResponse) – Details of provisioning error.

  • creation_time (datetime) – Creation time of the resource, which only appears in the response.

  • created_by (str) – CreatedBy property, which only appears in the response.

  • last_modified_time (datetime) – Last time resource was modified, which only appears in the response.

  • last_modified_by (str) – LastModifiedBy property, which only appears in the response.

  • tasks (SoftwareUpdateConfigurationTasks) – Tasks information for the Software update configuration.

Keyword Arguments
class azure.mgmt.automation.models.SoftwareUpdateConfigurationCollectionItem(*, update_configuration: Optional[_models.UpdateConfiguration] = None, tasks: Optional[_models.SoftwareUpdateConfigurationTasks] = None, frequency: Optional[Union[str, _models.ScheduleFrequency]] = None, start_time: Optional[datetime.datetime] = None, next_run: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration collection item properties.

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

Variables

  • name (str) – Name of the software update configuration.

  • id (str) – Resource Id of the software update configuration.

  • update_configuration (UpdateConfiguration) – Update specific properties of the software update configuration.

  • tasks (SoftwareUpdateConfigurationTasks) – Pre and Post Tasks defined.

  • frequency (str or ScheduleFrequency) – execution frequency of the schedule associated with the software update configuration. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • start_time (datetime) – the start time of the update.

  • creation_time (datetime) – Creation time of the software update configuration, which only appears in the response.

  • last_modified_time (datetime) – Last time software update configuration was modified, which only appears in the response.

  • provisioning_state (str) – Provisioning state for the software update configuration, which only appears in the response.

  • next_run (datetime) – ext run time of the update.

Keyword Arguments

  • update_configuration (UpdateConfiguration) – Update specific properties of the software update configuration.

  • tasks (SoftwareUpdateConfigurationTasks) – Pre and Post Tasks defined.

  • frequency (str or ScheduleFrequency) – execution frequency of the schedule associated with the software update configuration. Known values are: “OneTime”, “Day”, “Hour”, “Week”, “Month”, and “Minute”.

  • start_time (datetime) – the start time of the update.

  • next_run (datetime) – ext run time of the update.

class azure.mgmt.automation.models.SoftwareUpdateConfigurationListResult(*, value: Optional[List[_models.SoftwareUpdateConfigurationCollectionItem]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

result of listing all software update configuration.

Variables

value (list[SoftwareUpdateConfigurationCollectionItem]) – outer object returned when listing all software update configurations.

Keyword Arguments

value (list[SoftwareUpdateConfigurationCollectionItem]) – outer object returned when listing all software update configurations.

class azure.mgmt.automation.models.SoftwareUpdateConfigurationMachineRun(*, software_update_configuration: Optional[_models.UpdateConfigurationNavigation] = None, job: Optional[_models.JobNavigation] = None, error: Optional[_models.ErrorResponse] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration machine run model.

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

Variables

  • name (str) – Name of the software update configuration machine run.

  • id (str) – Resource Id of the software update configuration machine run.

  • target_computer (str) – name of the updated computer.

  • target_computer_type (str) – type of the updated computer.

  • software_update_configuration (UpdateConfigurationNavigation) – software update configuration triggered this run.

  • status (str) – Status of the software update configuration machine run.

  • os_type (str) – Operating system target of the software update configuration triggered this run.

  • correlation_id (str) – correlation id of the software update configuration machine run.

  • source_computer_id (str) – source computer id of the software update configuration machine run.

  • start_time (datetime) – Start time of the software update configuration machine run.

  • end_time (datetime) – End time of the software update configuration machine run.

  • configured_duration (str) – configured duration for the software update configuration run.

  • job (JobNavigation) – Job associated with the software update configuration machine run.

  • creation_time (datetime) – Creation time of the resource, which only appears in the response.

  • created_by (str) – createdBy property, which only appears in the response.

  • last_modified_time (datetime) – Last time resource was modified, which only appears in the response.

  • last_modified_by (str) – lastModifiedBy property, which only appears in the response.

  • error (ErrorResponse) – Details of provisioning error.

Keyword Arguments
class azure.mgmt.automation.models.SoftwareUpdateConfigurationMachineRunListResult(*, value: Optional[List[_models.SoftwareUpdateConfigurationMachineRun]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

result of listing all software update configuration machine runs.

Variables
Keyword Arguments
class azure.mgmt.automation.models.SoftwareUpdateConfigurationRun(*, software_update_configuration: Optional[_models.UpdateConfigurationNavigation] = None, tasks: Optional[_models.SoftwareUpdateConfigurationRunTasks] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration Run properties.

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

Variables

  • name (str) – Name of the software update configuration run.

  • id (str) – Resource Id of the software update configuration run.

  • software_update_configuration (UpdateConfigurationNavigation) – software update configuration triggered this run.

  • status (str) – Status of the software update configuration run.

  • configured_duration (str) – Configured duration for the software update configuration run.

  • os_type (str) – Operating system target of the software update configuration triggered this run.

  • start_time (datetime) – Start time of the software update configuration run.

  • end_time (datetime) – End time of the software update configuration run.

  • computer_count (int) – Number of computers in the software update configuration run.

  • failed_count (int) – Number of computers with failed status.

  • creation_time (datetime) – Creation time of the resource, which only appears in the response.

  • created_by (str) – CreatedBy property, which only appears in the response.

  • last_modified_time (datetime) – Last time resource was modified, which only appears in the response.

  • last_modified_by (str) – LastModifiedBy property, which only appears in the response.

  • tasks (SoftwareUpdateConfigurationRunTasks) – Software update configuration tasks triggered in this run.

Keyword Arguments
class azure.mgmt.automation.models.SoftwareUpdateConfigurationRunListResult(*, value: Optional[List[_models.SoftwareUpdateConfigurationRun]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

result of listing all software update configuration runs.

Variables
Keyword Arguments
class azure.mgmt.automation.models.SoftwareUpdateConfigurationRunTaskProperties(*, status: Optional[str] = None, source: Optional[str] = None, job_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Task properties of the software update configuration.

Variables

  • status (str) – The status of the task.

  • source (str) – The name of the source of the task.

  • job_id (str) – The job id of the task.

Keyword Arguments

  • status (str) – The status of the task.

  • source (str) – The name of the source of the task.

  • job_id (str) – The job id of the task.

class azure.mgmt.automation.models.SoftwareUpdateConfigurationRunTasks(*, pre_task: Optional[_models.SoftwareUpdateConfigurationRunTaskProperties] = None, post_task: Optional[_models.SoftwareUpdateConfigurationRunTaskProperties] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration run tasks model.

Variables
Keyword Arguments
class azure.mgmt.automation.models.SoftwareUpdateConfigurationTasks(*, pre_task: Optional[_models.TaskProperties] = None, post_task: Optional[_models.TaskProperties] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Task properties of the software update configuration.

Variables
Keyword Arguments
class azure.mgmt.automation.models.SourceControl(*, repo_url: Optional[str] = None, branch: Optional[str] = None, folder_path: Optional[str] = None, auto_sync: Optional[bool] = None, publish_runbook: Optional[bool] = None, source_type: Optional[Union[str, _models.SourceType]] = None, description: Optional[str] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the source control.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • repo_url (str) – The repo url of the source control.

  • branch (str) – The repo branch of the source control. Include branch as empty string for VsoTfvc.

  • folder_path (str) – The folder path of the source control.

  • auto_sync (bool) – The auto sync of the source control. Default is false.

  • publish_runbook (bool) – The auto publish of the source control. Default is true.

  • source_type (str or SourceType) – The source type. Must be one of VsoGit, VsoTfvc, GitHub. Known values are: “VsoGit”, “VsoTfvc”, and “GitHub”.

  • description (str) – The description.

  • creation_time (datetime) – The creation time.

  • last_modified_time (datetime) – The last modified time.

Keyword Arguments

  • repo_url (str) – The repo url of the source control.

  • branch (str) – The repo branch of the source control. Include branch as empty string for VsoTfvc.

  • folder_path (str) – The folder path of the source control.

  • auto_sync (bool) – The auto sync of the source control. Default is false.

  • publish_runbook (bool) – The auto publish of the source control. Default is true.

  • source_type (str or SourceType) – The source type. Must be one of VsoGit, VsoTfvc, GitHub. Known values are: “VsoGit”, “VsoTfvc”, and “GitHub”.

  • description (str) – The description.

  • creation_time (datetime) – The creation time.

  • last_modified_time (datetime) – The last modified time.

class azure.mgmt.automation.models.SourceControlCreateOrUpdateParameters(*, repo_url: Optional[str] = None, branch: Optional[str] = None, folder_path: Optional[str] = None, auto_sync: Optional[bool] = None, publish_runbook: Optional[bool] = None, source_type: Optional[Union[str, _models.SourceType]] = None, security_token: Optional[_models.SourceControlSecurityTokenProperties] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update source control operation.

Variables

  • repo_url (str) – The repo url of the source control.

  • branch (str) – The repo branch of the source control. Include branch as empty string for VsoTfvc.

  • folder_path (str) – The folder path of the source control. Path must be relative.

  • auto_sync (bool) – The auto async of the source control. Default is false.

  • publish_runbook (bool) – The auto publish of the source control. Default is true.

  • source_type (str or SourceType) – The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive. Known values are: “VsoGit”, “VsoTfvc”, and “GitHub”.

  • security_token (SourceControlSecurityTokenProperties) – The authorization token for the repo of the source control.

  • description (str) – The user description of the source control.

Keyword Arguments

  • repo_url (str) – The repo url of the source control.

  • branch (str) – The repo branch of the source control. Include branch as empty string for VsoTfvc.

  • folder_path (str) – The folder path of the source control. Path must be relative.

  • auto_sync (bool) – The auto async of the source control. Default is false.

  • publish_runbook (bool) – The auto publish of the source control. Default is true.

  • source_type (str or SourceType) – The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive. Known values are: “VsoGit”, “VsoTfvc”, and “GitHub”.

  • security_token (SourceControlSecurityTokenProperties) – The authorization token for the repo of the source control.

  • description (str) – The user description of the source control.

class azure.mgmt.automation.models.SourceControlListResult(*, value: Optional[List[_models.SourceControl]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list source controls operation.

Variables
Keyword Arguments
class azure.mgmt.automation.models.SourceControlSecurityTokenProperties(*, access_token: Optional[str] = None, refresh_token: Optional[str] = None, token_type: Optional[Union[str, _models.TokenType]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

SourceControlSecurityTokenProperties.

Variables

  • access_token (str) – The access token.

  • refresh_token (str) – The refresh token.

  • token_type (str or TokenType) – The token type. Must be either PersonalAccessToken or Oauth. Known values are: “PersonalAccessToken” and “Oauth”.

Keyword Arguments

  • access_token (str) – The access token.

  • refresh_token (str) – The refresh token.

  • token_type (str or TokenType) – The token type. Must be either PersonalAccessToken or Oauth. Known values are: “PersonalAccessToken” and “Oauth”.

class azure.mgmt.automation.models.SourceControlSyncJob(*, source_control_sync_job_id: Optional[str] = None, provisioning_state: Optional[Union[str, _models.ProvisioningState]] = None, sync_type: Optional[Union[str, _models.SyncType]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the source control sync job.

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

Variables

  • name (str) – Resource name.

  • type (str) – Resource type.

  • id (str) – Resource id.

  • source_control_sync_job_id (str) – The source control sync job id.

  • creation_time (datetime) – The creation time of the job.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the job. Known values are: “Completed”, “Failed”, and “Running”.

  • start_time (datetime) – The start time of the job.

  • end_time (datetime) – The end time of the job.

  • sync_type (str or SyncType) – The sync type. Known values are: “PartialSync” and “FullSync”.

Keyword Arguments

  • source_control_sync_job_id (str) – The source control sync job id.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the job. Known values are: “Completed”, “Failed”, and “Running”.

  • sync_type (str or SyncType) – The sync type. Known values are: “PartialSync” and “FullSync”.

class azure.mgmt.automation.models.SourceControlSyncJobById(*, id: Optional[str] = None, source_control_sync_job_id: Optional[str] = None, provisioning_state: Optional[Union[str, _models.ProvisioningState]] = None, sync_type: Optional[Union[str, _models.SyncType]] = None, exception: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the source control sync job.

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

Variables

  • id (str) – The id of the job.

  • source_control_sync_job_id (str) – The source control sync job id.

  • creation_time (datetime) – The creation time of the job.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the job. Known values are: “Completed”, “Failed”, and “Running”.

  • start_time (datetime) – The start time of the job.

  • end_time (datetime) – The end time of the job.

  • sync_type (str or SyncType) – The sync type. Known values are: “PartialSync” and “FullSync”.

  • exception (str) – The exceptions that occurred while running the sync job.

Keyword Arguments

  • id (str) – The id of the job.

  • source_control_sync_job_id (str) – The source control sync job id.

  • provisioning_state (str or ProvisioningState) – The provisioning state of the job. Known values are: “Completed”, “Failed”, and “Running”.

  • sync_type (str or SyncType) – The sync type. Known values are: “PartialSync” and “FullSync”.

  • exception (str) – The exceptions that occurred while running the sync job.

class azure.mgmt.automation.models.SourceControlSyncJobCreateParameters(*, commit_id: str, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create source control sync job operation.

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

Variables

commit_id (str) – The commit id of the source control sync job. If not syncing to a commitId, enter an empty string. Required.

Keyword Arguments

commit_id (str) – The commit id of the source control sync job. If not syncing to a commitId, enter an empty string. Required.

class azure.mgmt.automation.models.SourceControlSyncJobListResult(*, value: Optional[List[_models.SourceControlSyncJob]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list source control sync jobs operation.

Variables
Keyword Arguments
class azure.mgmt.automation.models.SourceControlSyncJobStream(*, source_control_sync_job_stream_id: Optional[str] = None, summary: Optional[str] = None, stream_type: Optional[Union[str, _models.StreamType]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the source control sync job stream.

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

Variables

  • id (str) – Resource id.

  • source_control_sync_job_stream_id (str) – The sync job stream id.

  • summary (str) – The summary of the sync job stream.

  • time (datetime) – The time of the sync job stream.

  • stream_type (str or StreamType) – The type of the sync job stream. Known values are: “Error” and “Output”.

Keyword Arguments

  • source_control_sync_job_stream_id (str) – The sync job stream id.

  • summary (str) – The summary of the sync job stream.

  • stream_type (str or StreamType) – The type of the sync job stream. Known values are: “Error” and “Output”.

class azure.mgmt.automation.models.SourceControlSyncJobStreamById(*, source_control_sync_job_stream_id: Optional[str] = None, summary: Optional[str] = None, stream_type: Optional[Union[str, _models.StreamType]] = None, stream_text: Optional[str] = None, value: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the source control sync job stream by id.

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

Variables

  • id (str) – Resource id.

  • source_control_sync_job_stream_id (str) – The sync job stream id.

  • summary (str) – The summary of the sync job stream.

  • time (datetime) – The time of the sync job stream.

  • stream_type (str or StreamType) – The type of the sync job stream. Known values are: “Error” and “Output”.

  • stream_text (str) – The text of the sync job stream.

  • value (dict[str, JSON]) – The values of the job stream.

Keyword Arguments

  • source_control_sync_job_stream_id (str) – The sync job stream id.

  • summary (str) – The summary of the sync job stream.

  • stream_type (str or StreamType) – The type of the sync job stream. Known values are: “Error” and “Output”.

  • stream_text (str) – The text of the sync job stream.

  • value (dict[str, JSON]) – The values of the job stream.

class azure.mgmt.automation.models.SourceControlSyncJobStreamsListBySyncJob(*, value: Optional[List[_models.SourceControlSyncJobStream]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list source control sync job streams operation.

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

Variables
Keyword Arguments

value (list[SourceControlSyncJobStream]) – The list of source control sync job streams.

class azure.mgmt.automation.models.SourceControlUpdateParameters(*, branch: Optional[str] = None, folder_path: Optional[str] = None, auto_sync: Optional[bool] = None, publish_runbook: Optional[bool] = None, security_token: Optional[_models.SourceControlSecurityTokenProperties] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update source control operation.

Variables

  • branch (str) – The repo branch of the source control.

  • folder_path (str) – The folder path of the source control. Path must be relative.

  • auto_sync (bool) – The auto sync of the source control. Default is false.

  • publish_runbook (bool) – The auto publish of the source control. Default is true.

  • security_token (SourceControlSecurityTokenProperties) – The authorization token for the repo of the source control.

  • description (str) – The user description of the source control.

Keyword Arguments

  • branch (str) – The repo branch of the source control.

  • folder_path (str) – The folder path of the source control. Path must be relative.

  • auto_sync (bool) – The auto sync of the source control. Default is false.

  • publish_runbook (bool) – The auto publish of the source control. Default is true.

  • security_token (SourceControlSecurityTokenProperties) – The authorization token for the repo of the source control.

  • description (str) – The user description of the source control.

class azure.mgmt.automation.models.SourceType(value)[source]

Bases: str, enum.Enum

The source type. Must be one of VsoGit, VsoTfvc, GitHub.

GIT_HUB = 'GitHub'
VSO_GIT = 'VsoGit'
VSO_TFVC = 'VsoTfvc'
class azure.mgmt.automation.models.Statistics(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the statistic.

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

Variables

  • counter_property (str) – Gets the property value of the statistic.

  • counter_value (int) – Gets the value of the statistic.

  • start_time (datetime) – Gets the startTime of the statistic.

  • end_time (datetime) – Gets the endTime of the statistic.

  • id (str) – Gets the id.

class azure.mgmt.automation.models.StatisticsListResult(*, value: Optional[List[_models.Statistics]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list statistics operation.

Variables

value (list[Statistics]) – Gets or sets a list of statistics.

Keyword Arguments

value (list[Statistics]) – Gets or sets a list of statistics.

class azure.mgmt.automation.models.StreamType(value)[source]

Bases: str, enum.Enum

The type of the sync job stream.

ERROR = 'Error'
OUTPUT = 'Output'
class azure.mgmt.automation.models.SyncType(value)[source]

Bases: str, enum.Enum

The sync type.

FULL_SYNC = 'FullSync'
PARTIAL_SYNC = 'PartialSync'
class azure.mgmt.automation.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.automation.models.TagOperators(value)[source]

Bases: str, enum.Enum

Filter VMs by Any or All specified tags.

ALL = 'All'
ANY = 'Any'
class azure.mgmt.automation.models.TagSettingsProperties(*, tags: Optional[Dict[str, List[str]]] = None, filter_operator: Optional[Union[str, _models.TagOperators]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Tag filter information for the VM.

Variables

  • tags (dict[str, list[str]]) – Dictionary of tags with its list of values.

  • filter_operator (str or TagOperators) – Filter VMs by Any or All specified tags. Known values are: “All” and “Any”.

Keyword Arguments

  • tags (dict[str, list[str]]) – Dictionary of tags with its list of values.

  • filter_operator (str or TagOperators) – Filter VMs by Any or All specified tags. Known values are: “All” and “Any”.

class azure.mgmt.automation.models.TargetProperties(*, azure_queries: Optional[List[_models.AzureQueryProperties]] = None, non_azure_queries: Optional[List[_models.NonAzureQueryProperties]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Group specific to the update configuration.

Variables
Keyword Arguments
class azure.mgmt.automation.models.TaskProperties(*, parameters: Optional[Dict[str, str]] = None, source: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Task properties of the software update configuration.

Variables

  • parameters (dict[str, str]) – Gets or sets the parameters of the task.

  • source (str) – Gets or sets the name of the runbook.

Keyword Arguments

  • parameters (dict[str, str]) – Gets or sets the parameters of the task.

  • source (str) – Gets or sets the name of the runbook.

class azure.mgmt.automation.models.TestJob(*, creation_time: Optional[datetime.datetime] = None, status: Optional[str] = None, status_details: Optional[str] = None, run_on: Optional[str] = None, start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, exception: Optional[str] = None, last_modified_time: Optional[datetime.datetime] = None, last_status_modified_time: Optional[datetime.datetime] = None, parameters: Optional[Dict[str, str]] = None, log_activity_trace: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of the test job.

Variables

  • creation_time (datetime) – Gets or sets the creation time of the test job.

  • status (str) – Gets or sets the status of the test job.

  • status_details (str) – Gets or sets the status details of the test job.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

  • start_time (datetime) – Gets or sets the start time of the test job.

  • end_time (datetime) – Gets or sets the end time of the test job.

  • exception (str) – Gets or sets the exception of the test job.

  • last_modified_time (datetime) – Gets or sets the last modified time of the test job.

  • last_status_modified_time (datetime) – Gets or sets the last status modified time of the test job.

  • parameters (dict[str, str]) – Gets or sets the parameters of the test job.

  • log_activity_trace (int) – The activity-level tracing options of the runbook.

Keyword Arguments

  • creation_time (datetime) – Gets or sets the creation time of the test job.

  • status (str) – Gets or sets the status of the test job.

  • status_details (str) – Gets or sets the status details of the test job.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

  • start_time (datetime) – Gets or sets the start time of the test job.

  • end_time (datetime) – Gets or sets the end time of the test job.

  • exception (str) – Gets or sets the exception of the test job.

  • last_modified_time (datetime) – Gets or sets the last modified time of the test job.

  • last_status_modified_time (datetime) – Gets or sets the last status modified time of the test job.

  • parameters (dict[str, str]) – Gets or sets the parameters of the test job.

  • log_activity_trace (int) – The activity-level tracing options of the runbook.

class azure.mgmt.automation.models.TestJobCreateParameters(*, parameters: Optional[Dict[str, str]] = None, run_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create test job operation.

Variables

  • parameters (dict[str, str]) – Gets or sets the parameters of the test job.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

Keyword Arguments

  • parameters (dict[str, str]) – Gets or sets the parameters of the test job.

  • run_on (str) – Gets or sets the runOn which specifies the group name where the job is to be executed.

class azure.mgmt.automation.models.TokenType(value)[source]

Bases: str, enum.Enum

The token type. Must be either PersonalAccessToken or Oauth.

OAUTH = 'Oauth'
PERSONAL_ACCESS_TOKEN = 'PersonalAccessToken'
class azure.mgmt.automation.models.TrackedResource(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.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.

Variables

  • id (str) – Fully qualified resource Id for the resource.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

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

  • location (str) – The Azure Region where the resource lives.

Keyword Arguments

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

  • location (str) – The Azure Region where the resource lives.

class azure.mgmt.automation.models.TypeField(*, name: Optional[str] = None, type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Information about a field of a type.

Variables

  • name (str) – Gets or sets the name of the field.

  • type (str) – Gets or sets the type of the field.

Keyword Arguments

  • name (str) – Gets or sets the name of the field.

  • type (str) – Gets or sets the type of the field.

class azure.mgmt.automation.models.TypeFieldListResult(*, value: Optional[List[_models.TypeField]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list fields operation.

Variables

value (list[TypeField]) – Gets or sets a list of fields.

Keyword Arguments

value (list[TypeField]) – Gets or sets a list of fields.

class azure.mgmt.automation.models.UpdateConfiguration(*, operating_system: Union[str, _models.OperatingSystemType], windows: Optional[_models.WindowsProperties] = None, linux: Optional[_models.LinuxProperties] = None, duration: Optional[datetime.timedelta] = None, azure_virtual_machines: Optional[List[str]] = None, non_azure_computer_names: Optional[List[str]] = None, targets: Optional[_models.TargetProperties] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Update specific properties of the software update configuration.

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

Variables

  • operating_system (str or OperatingSystemType) – operating system of target machines. Required. Known values are: “Windows” and “Linux”.

  • windows (WindowsProperties) – Windows specific update configuration.

  • linux (LinuxProperties) – Linux specific update configuration.

  • duration (timedelta) – Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601.

  • azure_virtual_machines (list[str]) – List of azure resource Ids for azure virtual machines targeted by the software update configuration.

  • non_azure_computer_names (list[str]) – List of names of non-azure machines targeted by the software update configuration.

  • targets (TargetProperties) – Group targets for the software update configuration.

Keyword Arguments

  • operating_system (str or OperatingSystemType) – operating system of target machines. Required. Known values are: “Windows” and “Linux”.

  • windows (WindowsProperties) – Windows specific update configuration.

  • linux (LinuxProperties) – Linux specific update configuration.

  • duration (timedelta) – Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601.

  • azure_virtual_machines (list[str]) – List of azure resource Ids for azure virtual machines targeted by the software update configuration.

  • non_azure_computer_names (list[str]) – List of names of non-azure machines targeted by the software update configuration.

  • targets (TargetProperties) – Group targets for the software update configuration.

class azure.mgmt.automation.models.UpdateConfigurationNavigation(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Software update configuration Run Navigation model.

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

Variables

name (str) – Name of the software update configuration triggered the software update configuration run.

class azure.mgmt.automation.models.Usage(*, id: Optional[str] = None, name: Optional[_models.UsageCounterName] = None, unit: Optional[str] = None, current_value: Optional[float] = None, limit: Optional[int] = None, throttle_status: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of Usage.

Variables

  • id (str) – Gets or sets the id of the resource.

  • name (UsageCounterName) – Gets or sets the usage counter name.

  • unit (str) – Gets or sets the usage unit name.

  • current_value (float) – Gets or sets the current usage value.

  • limit (int) – Gets or sets max limit. -1 for unlimited.

  • throttle_status (str) – Gets or sets the throttle status.

Keyword Arguments

  • id (str) – Gets or sets the id of the resource.

  • name (UsageCounterName) – Gets or sets the usage counter name.

  • unit (str) – Gets or sets the usage unit name.

  • current_value (float) – Gets or sets the current usage value.

  • limit (int) – Gets or sets max limit. -1 for unlimited.

  • throttle_status (str) – Gets or sets the throttle status.

class azure.mgmt.automation.models.UsageCounterName(*, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Definition of usage counter name.

Variables

  • value (str) – Gets or sets the usage counter name.

  • localized_value (str) – Gets or sets the localized usage counter name.

Keyword Arguments

  • value (str) – Gets or sets the usage counter name.

  • localized_value (str) – Gets or sets the localized usage counter name.

class azure.mgmt.automation.models.UsageListResult(*, value: Optional[List[_models.Usage]] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the get usage operation.

Variables

value (list[Usage]) – Gets or sets usage.

Keyword Arguments

value (list[Usage]) – Gets or sets usage.

class azure.mgmt.automation.models.UserAssignedIdentitiesProperties(**kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

UserAssignedIdentitiesProperties.

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

Variables

  • principal_id (str) – The principal id of user assigned identity.

  • client_id (str) – The client id of user assigned identity.

class azure.mgmt.automation.models.Variable(*, value: Optional[str] = None, is_encrypted: Optional[bool] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the variable.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • value (str) – Gets or sets the value of the variable.

  • is_encrypted (bool) – Gets or sets the encrypted flag of the variable.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • value (str) – Gets or sets the value of the variable.

  • is_encrypted (bool) – Gets or sets the encrypted flag of the variable.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.VariableCreateOrUpdateParameters(*, name: str, value: Optional[str] = None, description: Optional[str] = None, is_encrypted: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update variable operation.

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

Variables

  • name (str) – Gets or sets the name of the variable. Required.

  • value (str) – Gets or sets the value of the variable.

  • description (str) – Gets or sets the description of the variable.

  • is_encrypted (bool) – Gets or sets the encrypted flag of the variable.

Keyword Arguments

  • name (str) – Gets or sets the name of the variable. Required.

  • value (str) – Gets or sets the value of the variable.

  • description (str) – Gets or sets the description of the variable.

  • is_encrypted (bool) – Gets or sets the encrypted flag of the variable.

class azure.mgmt.automation.models.VariableListResult(*, value: Optional[List[_models.Variable]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list variables operation.

Variables

  • value (list[Variable]) – Gets or sets a list of variables.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Variable]) – Gets or sets a list of variables.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.VariableUpdateParameters(*, name: Optional[str] = None, value: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update variable operation.

Variables

  • name (str) – Gets or sets the name of the variable.

  • value (str) – Gets or sets the value of the variable.

  • description (str) – Gets or sets the description of the variable.

Keyword Arguments

  • name (str) – Gets or sets the name of the variable.

  • value (str) – Gets or sets the value of the variable.

  • description (str) – Gets or sets the description of the variable.

class azure.mgmt.automation.models.Watcher(*, etag: Optional[str] = None, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, execution_frequency_in_seconds: Optional[int] = None, script_name: Optional[str] = None, script_parameters: Optional[Dict[str, str]] = None, script_run_on: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

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

Definition of the watcher type.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • etag (str) – Gets or sets the etag of the resource.

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

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

  • execution_frequency_in_seconds (int) – Gets or sets the frequency at which the watcher is invoked.

  • script_name (str) – Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.

  • script_parameters (dict[str, str]) – Gets or sets the parameters of the script.

  • script_run_on (str) – Gets or sets the name of the hybrid worker group the watcher will run on.

  • status (str) – Gets the current status of the watcher.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • last_modified_by (str) – Details of the user who last modified the watcher.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • etag (str) – Gets or sets the etag of the resource.

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

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

  • execution_frequency_in_seconds (int) – Gets or sets the frequency at which the watcher is invoked.

  • script_name (str) – Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.

  • script_parameters (dict[str, str]) – Gets or sets the parameters of the script.

  • script_run_on (str) – Gets or sets the name of the hybrid worker group the watcher will run on.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.WatcherListResult(*, value: Optional[List[_models.Watcher]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list watcher operation.

Variables

  • value (list[Watcher]) – Gets or sets a list of watchers.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Watcher]) – Gets or sets a list of watchers.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.WatcherUpdateParameters(*, name: Optional[str] = None, execution_frequency_in_seconds: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

WatcherUpdateParameters.

Variables

  • name (str) – Gets or sets the name of the resource.

  • execution_frequency_in_seconds (int) – Gets or sets the frequency at which the watcher is invoked.

Keyword Arguments

  • name (str) – Gets or sets the name of the resource.

  • execution_frequency_in_seconds (int) – Gets or sets the frequency at which the watcher is invoked.

class azure.mgmt.automation.models.Webhook(*, is_enabled: bool = False, uri: Optional[str] = None, expiry_time: Optional[datetime.datetime] = None, last_invoked_time: Optional[datetime.datetime] = None, parameters: Optional[Dict[str, str]] = None, runbook: Optional[_models.RunbookAssociationProperty] = None, run_on: Optional[str] = None, creation_time: Optional[datetime.datetime] = None, last_modified_time: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation.models._models_py3.ProxyResource

Definition of the webhook type.

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.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • is_enabled (bool) – Gets or sets the value of the enabled flag of the webhook.

  • uri (str) – Gets or sets the webhook uri.

  • expiry_time (datetime) – Gets or sets the expiry time.

  • last_invoked_time (datetime) – Gets or sets the last invoked time.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook the webhook is associated with.

  • run_on (str) – Gets or sets the name of the hybrid worker group the webhook job will run on.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • last_modified_by (str) – Details of the user who last modified the Webhook.

  • description (str) – Gets or sets the description.

Keyword Arguments

  • is_enabled (bool) – Gets or sets the value of the enabled flag of the webhook.

  • uri (str) – Gets or sets the webhook uri.

  • expiry_time (datetime) – Gets or sets the expiry time.

  • last_invoked_time (datetime) – Gets or sets the last invoked time.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook the webhook is associated with.

  • run_on (str) – Gets or sets the name of the hybrid worker group the webhook job will run on.

  • creation_time (datetime) – Gets or sets the creation time.

  • last_modified_time (datetime) – Gets or sets the last modified time.

  • last_modified_by (str) – Details of the user who last modified the Webhook.

  • description (str) – Gets or sets the description.

class azure.mgmt.automation.models.WebhookCreateOrUpdateParameters(*, name: str, is_enabled: Optional[bool] = None, uri: Optional[str] = None, expiry_time: Optional[datetime.datetime] = None, parameters: Optional[Dict[str, str]] = None, runbook: Optional[_models.RunbookAssociationProperty] = None, run_on: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the create or update webhook operation.

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

Variables

  • name (str) – Gets or sets the name of the webhook. Required.

  • is_enabled (bool) – Gets or sets the value of the enabled flag of webhook.

  • uri (str) – Gets or sets the uri.

  • expiry_time (datetime) – Gets or sets the expiry time.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • run_on (str) – Gets or sets the name of the hybrid worker group the webhook job will run on.

Keyword Arguments

  • name (str) – Gets or sets the name of the webhook. Required.

  • is_enabled (bool) – Gets or sets the value of the enabled flag of webhook.

  • uri (str) – Gets or sets the uri.

  • expiry_time (datetime) – Gets or sets the expiry time.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • runbook (RunbookAssociationProperty) – Gets or sets the runbook.

  • run_on (str) – Gets or sets the name of the hybrid worker group the webhook job will run on.

class azure.mgmt.automation.models.WebhookListResult(*, value: Optional[List[_models.Webhook]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The response model for the list webhook operation.

Variables

  • value (list[Webhook]) – Gets or sets a list of webhooks.

  • next_link (str) – Gets or sets the next link.

Keyword Arguments

  • value (list[Webhook]) – Gets or sets a list of webhooks.

  • next_link (str) – Gets or sets the next link.

class azure.mgmt.automation.models.WebhookUpdateParameters(*, name: Optional[str] = None, is_enabled: Optional[bool] = None, run_on: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

The parameters supplied to the update webhook operation.

Variables

  • name (str) – Gets or sets the name of the webhook.

  • is_enabled (bool) – Gets or sets the value of the enabled flag of webhook.

  • run_on (str) – Gets or sets the name of the hybrid worker group the webhook job will run on.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • description (str) – Gets or sets the description of the webhook.

Keyword Arguments

  • name (str) – Gets or sets the name of the webhook.

  • is_enabled (bool) – Gets or sets the value of the enabled flag of webhook.

  • run_on (str) – Gets or sets the name of the hybrid worker group the webhook job will run on.

  • parameters (dict[str, str]) – Gets or sets the parameters of the job.

  • description (str) – Gets or sets the description of the webhook.

class azure.mgmt.automation.models.WindowsProperties(*, included_update_classifications: Optional[Union[str, _models.WindowsUpdateClasses]] = None, excluded_kb_numbers: Optional[List[str]] = None, included_kb_numbers: Optional[List[str]] = None, reboot_setting: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.automation._serialization.Model

Windows specific update configuration.

Variables

  • included_update_classifications (str or WindowsUpdateClasses) – Update classification included in the software update configuration. A comma separated string with required values. Known values are: “Unclassified”, “Critical”, “Security”, “UpdateRollup”, “FeaturePack”, “ServicePack”, “Definition”, “Tools”, and “Updates”.

  • excluded_kb_numbers (list[str]) – KB numbers excluded from the software update configuration.

  • included_kb_numbers (list[str]) – KB numbers included from the software update configuration.

  • reboot_setting (str) – Reboot setting for the software update configuration.

Keyword Arguments

  • included_update_classifications (str or WindowsUpdateClasses) – Update classification included in the software update configuration. A comma separated string with required values. Known values are: “Unclassified”, “Critical”, “Security”, “UpdateRollup”, “FeaturePack”, “ServicePack”, “Definition”, “Tools”, and “Updates”.

  • excluded_kb_numbers (list[str]) – KB numbers excluded from the software update configuration.

  • included_kb_numbers (list[str]) – KB numbers included from the software update configuration.

  • reboot_setting (str) – Reboot setting for the software update configuration.

class azure.mgmt.automation.models.WindowsUpdateClasses(value)[source]

Bases: str, enum.Enum

Update classification included in the software update configuration. A comma separated string with required values.

CRITICAL = 'Critical'
DEFINITION = 'Definition'
FEATURE_PACK = 'FeaturePack'
SECURITY = 'Security'
SERVICE_PACK = 'ServicePack'
TOOLS = 'Tools'
UNCLASSIFIED = 'Unclassified'
UPDATES = 'Updates'
UPDATE_ROLLUP = 'UpdateRollup'
class azure.mgmt.automation.models.WorkerType(value)[source]

Bases: str, enum.Enum

Type of the HybridWorker.

HYBRID_V1 = 'HybridV1'
HYBRID_V2 = 'HybridV2'