HealthMonitorsOperations Class
HealthMonitorsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectHealthMonitorsOperations
Constructor
HealthMonitorsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| get |
Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration). Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration). |
| get_state_change |
Get the health state change of a monitor of a virtual machine at the provided timestamp. Optional parameter: $expand (retrieve the monitor's evidence and configuration). Get the health state change of a monitor of a virtual machine at the provided timestamp. Optional parameter: $expand (retrieve the monitor's evidence and configuration). |
| list |
Get the current health status of all monitors of a virtual machine. Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by monitor name). Get the current health status of all monitors of a virtual machine. Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by monitor name). |
| list_state_changes |
Get the health state changes of a monitor of a virtual machine within the provided time window (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by heartbeat condition). Get the health state changes of a monitor of a virtual machine within the provided time window (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by heartbeat condition). |
get
Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
Get the current health status of a monitor of a virtual machine. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
get(subscription_id: str, resource_group_name: str, provider_name: str, resource_collection_name: str, resource_name: str, monitor_id: str, expand: Optional[str] = None, **kwargs: Any) -> models.HealthMonitorParameters
- resource_collection_name
- str
The resource collection name (ex: virtualMachines for virtual machines).
- expand
- str
Optionally expand the monitor's evidence and/or configuration. Example: $expand=evidence,configuration.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
HealthMonitor, or the result of cls(response)
Return type
Exceptions
get_state_change
Get the health state change of a monitor of a virtual machine at the provided timestamp. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
Get the health state change of a monitor of a virtual machine at the provided timestamp. Optional parameter: $expand (retrieve the monitor's evidence and configuration).
get_state_change(subscription_id: str, resource_group_name: str, provider_name: str, resource_collection_name: str, resource_name: str, monitor_id: str, timestamp_unix: str, expand: Optional[str] = None, **kwargs: Any) -> models.HealthMonitorStateChangeParameters
- resource_collection_name
- str
The resource collection name (ex: virtualMachines for virtual machines).
- expand
- str
Optionally expand the monitor's evidence and/or configuration. Example: $expand=evidence,configuration.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
HealthMonitorStateChange, or the result of cls(response)
Return type
Exceptions
list
Get the current health status of all monitors of a virtual machine. Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by monitor name).
Get the current health status of all monitors of a virtual machine. Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by monitor name).
list(subscription_id: str, resource_group_name: str, provider_name: str, resource_collection_name: str, resource_name: str, filter: Optional[str] = None, expand: Optional[str] = None, **kwargs: Any) -> Iterable[models.HealthMonitorList]Parameters
- resource_collection_name
- str
The resource collection name (ex: virtualMachines for virtual machines).
- filter
- str
Optionally filter by monitor name. Example: $filter=monitorName eq 'logical- disks|C:>>|<<disk-free-space-mb.'.
- expand
- str
Optionally expand the monitor's evidence and/or configuration. Example: $expand=evidence,configuration.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either HealthMonitorList or the result of cls(response)
Return type
Exceptions
list_state_changes
Get the health state changes of a monitor of a virtual machine within the provided time window (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by heartbeat condition).
Get the health state changes of a monitor of a virtual machine within the provided time window (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor's evidence and configuration) and $filter (filter by heartbeat condition).
list_state_changes(subscription_id: str, resource_group_name: str, provider_name: str, resource_collection_name: str, resource_name: str, monitor_id: str, filter: Optional[str] = None, expand: Optional[str] = None, start_timestamp_utc: Optional[datetime.datetime] = None, end_timestamp_utc: Optional[datetime.datetime] = None, **kwargs: Any) -> Iterable[models.HealthMonitorStateChangeList]Parameters
- resource_collection_name
- str
The resource collection name (ex: virtualMachines for virtual machines).
- filter
- str
Optionally filter by heartbeat condition. Example: $filter=isHeartbeat eq false.
- expand
- str
Optionally expand the monitor's evidence and/or configuration. Example: $expand=evidence,configuration.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either HealthMonitorStateChangeList or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.workloadmonitor.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\workloadmonitor\\models\\__init__.py'>Feedback
Submit and view feedback for