azure.mgmt.servermanager.models module¶
-
exception
azure.mgmt.servermanager.models.
ErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘Error’.
Parameters: - deserialize – A deserializer
- response – Server response to be deserialized.
-
class
azure.mgmt.servermanager.models.
Resource
(*, tags=None, etag: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource Manager Resource Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.servermanager.models.
EncryptionJwkResource
(*, kty: str = None, alg: str = None, e: str = None, n: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The public key of the gateway.
Parameters:
-
class
azure.mgmt.servermanager.models.
GatewayStatus
(*, available_memory_mbyte: float = None, gateway_cpu_utilization_percent: float = None, total_cpu_utilization_percent: float = None, gateway_version: str = None, friendly_os_name: str = None, installed_date=None, logical_processor_count: int = None, name: str = None, gateway_id: str = None, gateway_working_set_mbyte: float = None, status_updated=None, group_policy_error: str = None, allow_gateway_group_policy_status: bool = None, require_mfa_group_policy_status: bool = None, encryption_certificate_thumbprint: str = None, secondary_encryption_certificate_thumbprint: str = None, encryption_jwk=None, secondary_encryption_jwk=None, active_message_count: int = None, latest_published_msi_version: str = None, published_time_utc=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Expanded gateway status information.
Parameters: - available_memory_mbyte (float) – The available memory on the gateway host machine in megabytes.
- gateway_cpu_utilization_percent (float) – The CPU utilization of the gateway process (numeric value between 0 and 100).
- total_cpu_utilization_percent (float) – CPU Utilization of the whole system.
- gateway_version (str) – The version of the gateway that is installed on the system.
- friendly_os_name (str) – The Plaintext description of the OS on the gateway.
- installed_date (datetime) – The date the gateway was installed.
- logical_processor_count (int) – Number of logical processors in the gateway system.
- name (str) – The computer name of the gateway system.
- gateway_id (str) – The gateway resource ID.
- gateway_working_set_mbyte (float) – The working set size of the gateway process in megabytes.
- status_updated (datetime) – UTC date and time when gateway status was last updated.
- group_policy_error (str) – The group policy error.
- allow_gateway_group_policy_status (bool) – Status of the allowGatewayGroupPolicy setting.
- require_mfa_group_policy_status (bool) – Status of the requireMfaGroupPolicy setting.
- encryption_certificate_thumbprint (str) – Thumbprint of the encryption certificate.
- secondary_encryption_certificate_thumbprint (str) – Secondary thumbprint of the encryption certificate.
- encryption_jwk (EncryptionJwkResource) – The encryption certificate key.
- secondary_encryption_jwk (EncryptionJwkResource) – The secondary encryption certificate key.
- active_message_count (int) – Active message count.
- latest_published_msi_version (str) – Latest published version of the gateway install MSI.
- published_time_utc (datetime) – Gateway install MSI published time.
-
class
azure.mgmt.servermanager.models.
GatewayResource
(*, tags=None, etag: str = None, created=None, updated=None, upgrade_mode=None, desired_version: str = None, instances=None, active_message_count: int = None, latest_published_msi_version: str = None, published_time_utc=None, **kwargs)[source]¶ Bases:
azure.mgmt.servermanager.models.resource_py3.Resource
Data model for an arm gateway resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - tags (dict[str, str]) – Resource Manager Resource Tags.
- etag (str) –
- created (datetime) – UTC date and time when gateway was first added to management service.
- updated (datetime) – UTC date and time when node was last updated.
- upgrade_mode (str or UpgradeMode) – The upgradeMode property gives the flexibility to gateway to auto upgrade itself. If properties value not specified, then we assume upgradeMode = Automatic. Possible values include: ‘Manual’, ‘Automatic’
- desired_version (str) – Latest available MSI version.
- instances (list[GatewayStatus]) – Names of the nodes in the gateway.
- active_message_count (int) – Number of active messages.
- latest_published_msi_version (str) – Last published MSI version.
- published_time_utc (datetime) – The date/time of the last published gateway.
-
class
azure.mgmt.servermanager.models.
GatewayProfile
(*, data_plane_service_base_address: str = None, gateway_id: str = None, environment: str = None, upgrade_manifest_url: str = None, messaging_namespace: str = None, messaging_account: str = None, messaging_key: str = None, request_queue: str = None, response_topic: str = None, status_blob_signature: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
JSON properties that the gateway service uses know how to communicate with the resource.
Parameters: - data_plane_service_base_address (str) – The Dataplane connection URL.
- gateway_id (str) – The ID of the gateway.
- environment (str) – The environment for the gateway (DEV, DogFood, or Production).
- upgrade_manifest_url (str) – Gateway upgrade manifest URL.
- messaging_namespace (str) – Messaging namespace.
- messaging_account (str) – Messaging Account.
- messaging_key (str) – Messaging Key.
- request_queue (str) – Request queue name.
- response_topic (str) – Response topic name.
- status_blob_signature (str) – The gateway status blob SAS URL.
-
class
azure.mgmt.servermanager.models.
GatewayParameters
(*, location: str = None, tags=None, upgrade_mode=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Collection of parameters for operations on a gateway resource.
Parameters: - location (str) – Location of the resource.
- tags (object) – Resource tags.
- upgrade_mode (str or UpgradeMode) – The upgradeMode property gives the flexibility to gateway to auto upgrade itself. If properties value not specified, then we assume upgradeMode = Automatic. Possible values include: ‘Manual’, ‘Automatic’
-
class
azure.mgmt.servermanager.models.
NodeResource
(*, tags=None, etag: str = None, gateway_id: str = None, connection_name: str = None, created=None, updated=None, **kwargs)[source]¶ Bases:
azure.mgmt.servermanager.models.resource_py3.Resource
A Node Resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - tags (dict[str, str]) – Resource Manager Resource Tags.
- etag (str) –
- gateway_id (str) – ID of the gateway.
- connection_name (str) – myhost.domain.com
- created (datetime) – UTC date and time when node was first added to management service.
- updated (datetime) – UTC date and time when node was last updated.
-
class
azure.mgmt.servermanager.models.
NodeParameters
(*, location: str = None, tags=None, gateway_id: str = None, connection_name: str = None, user_name: str = None, password: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameter collection for operations on arm node resource.
Parameters:
-
class
azure.mgmt.servermanager.models.
SessionResource
(*, tags=None, etag: str = None, user_name: str = None, created=None, updated=None, **kwargs)[source]¶ Bases:
azure.mgmt.servermanager.models.resource_py3.Resource
The session object.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.servermanager.models.
SessionParameters
(*, user_name: str = None, password: str = None, retention_period=None, credential_data_format=None, encryption_certificate_thumbprint: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameter collection for creation and other operations on sessions.
Parameters: - user_name (str) – Encrypted User name to be used to connect to node.
- password (str) – Encrypted Password associated with user name.
- retention_period (str or RetentionPeriod) – Session retention period. Possible values include: ‘Session’, ‘Persistent’
- credential_data_format (str or CredentialDataFormat) – Credential data format. Possible values include: ‘RsaEncrypted’
- encryption_certificate_thumbprint (str) – Encryption certificate thumbprint.
-
class
azure.mgmt.servermanager.models.
Version
(*, major: int = None, minor: int = None, build: int = None, revision: int = None, major_revision: int = None, minor_revision: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A multipart-numeric version number.
Parameters: - major (int) – The leftmost number of the version.
- minor (int) – The second leftmost number of the version.
- build (int) – The third number of the version.
- revision (int) – The fourth number of the version.
- major_revision (int) – The MSW of the fourth part.
- minor_revision (int) – The LSW of the fourth part.
-
class
azure.mgmt.servermanager.models.
PowerShellSessionResource
(*, tags=None, etag: str = None, session_id: str = None, state: str = None, runspace_availability: str = None, disconnected_on=None, expires_on=None, version=None, power_shell_session_resource_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.servermanager.models.resource_py3.Resource
A PowerShell session resource (practically equivalent to a runspace instance).
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - tags (dict[str, str]) – Resource Manager Resource Tags.
- etag (str) –
- session_id (str) – The PowerShell Session ID.
- state (str) – The runspace state.
- runspace_availability (str) – The availability of the runspace.
- disconnected_on (datetime) – Timestamp of last time the service disconnected from the runspace.
- expires_on (datetime) – Timestamp when the runspace expires.
- version (Version) –
- power_shell_session_resource_name (str) – Name of the runspace.
-
class
azure.mgmt.servermanager.models.
PromptFieldDescription
(*, name: str = None, label: str = None, help_message: str = None, prompt_field_type_is_list: bool = None, prompt_field_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Field description for the implementation of PSHostUserInterface.Prompt.
Parameters: - name (str) – The name of the prompt.
- label (str) – The label text of the prompt.
- help_message (str) – The help message of the prompt.
- prompt_field_type_is_list (bool) – When set to ‘true’ the prompt field type is a list of values.
- prompt_field_type (str or PromptFieldType) – Possible values include: ‘String’, ‘SecureString’, ‘Credential’
-
class
azure.mgmt.servermanager.models.
PowerShellCommandResult
(*, message_type: int = None, foreground_color: str = None, background_color: str = None, value: str = None, prompt: str = None, exit_code: int = None, id: int = None, caption: str = None, message: str = None, descriptions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Results from invoking a PowerShell command.
Parameters: - message_type (int) – The type of message.
- foreground_color (str) – The HTML color string representing the foreground color.
- background_color (str) – The HTML color string representing the background color.
- value (str) – Actual result text from the PowerShell Command.
- prompt (str) – The interactive prompt message.
- exit_code (int) – The exit code from a executable that was called from PowerShell.
- id (int) – ID of the prompt message.
- caption (str) – Text that precedes the prompt.
- message (str) – Text of the prompt.
- descriptions (list[PromptFieldDescription]) – Collection of PromptFieldDescription objects that contains the user input.
-
class
azure.mgmt.servermanager.models.
PowerShellCommandResults
(*, results=None, pssession: str = None, command: str = None, completed: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A collection of results from a PowerShell command.
Parameters: - results (list[PowerShellCommandResult]) –
- pssession (str) –
- command (str) –
- completed (bool) –
-
class
azure.mgmt.servermanager.models.
PowerShellCommandStatus
(*, tags=None, etag: str = None, results=None, pssession: str = None, command: str = None, completed: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.servermanager.models.resource_py3.Resource
Result status from invoking a PowerShell command.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.servermanager.models.
PowerShellSessionResources
(*, value=None, next_link: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A collection of PowerShell session resources.
Parameters: - value (list[PowerShellSessionResource]) – Collection of PowerShell session resources.
- next_link (str) – The URL to the next set of resources.
-
class
azure.mgmt.servermanager.models.
PowerShellCommandParameters
(*, command: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The parameters to a PowerShell script execution command.
Parameters: command (str) – Script to execute.
-
class
azure.mgmt.servermanager.models.
PromptMessageResponse
(*, response=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The response to a prompt message.
Parameters: response (list[str]) – The list of responses a cmdlet expects.
-
class
azure.mgmt.servermanager.models.
PowerShellTabCompletionParameters
(*, command: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Collection of parameters for PowerShell tab completion.
Parameters: command (str) – Command to get tab completion for.
-
class
azure.mgmt.servermanager.models.
PowerShellTabCompletionResults
(*, results=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An array of strings representing the different values that can be selected through.
Parameters: results (list[str]) –
-
class
azure.mgmt.servermanager.models.
Error
(*, code: int = None, message: str = None, fields: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error message.
Parameters:
-
class
azure.mgmt.servermanager.models.
GatewayResourcePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GatewayResource
object
-
class
azure.mgmt.servermanager.models.
NodeResourcePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
NodeResource
object
-
class
azure.mgmt.servermanager.models.
UpgradeMode
[source]¶ -
An enumeration.
-
automatic
= 'Automatic'¶
-
manual
= 'Manual'¶
-
-
class
azure.mgmt.servermanager.models.
RetentionPeriod
[source]¶ -
An enumeration.
-
persistent
= 'Persistent'¶
-
session
= 'Session'¶
-
-
class
azure.mgmt.servermanager.models.
CredentialDataFormat
[source]¶ -
An enumeration.
-
rsa_encrypted
= 'RsaEncrypted'¶
-
-
class
azure.mgmt.servermanager.models.
PromptFieldType
[source]¶ -
An enumeration.
-
credential
= 'Credential'¶
-
secure_string
= 'SecureString'¶
-
string
= 'String'¶
-