ServiceFabricSchedulesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:service_fabric_schedules> attribute.
Constructor
ServiceFabricSchedulesOperations(*args, **kwargs)
Methods
| begin_execute |
Execute a schedule. This operation can take a while to complete. |
| create_or_update |
Create or replace an existing schedule. |
| delete |
Delete schedule. |
| get |
Get schedule. |
| list |
List schedules in a given service fabric. |
| update |
Allows modifying tags of schedules. All other properties will be ignored. |
begin_execute
Execute a schedule. This operation can take a while to complete.
begin_execute(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, **kwargs: Any) -> LROPoller[None]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
user_name
Required
|
The name of the user profile. Required. |
|
service_fabric_name
Required
|
The name of the service fabric. Required. |
|
name
Required
|
The name of the schedule. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update
Create or replace an existing schedule.
create_or_update(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, schedule: _models.Schedule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Schedule
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
user_name
Required
|
The name of the user profile. Required. |
|
service_fabric_name
Required
|
The name of the service fabric. Required. |
|
name
Required
|
The name of the schedule. Required. |
|
schedule
Required
|
A schedule. Is either a Schedule type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Schedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Delete schedule.
delete(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, **kwargs: Any) -> None
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
user_name
Required
|
The name of the user profile. Required. |
|
service_fabric_name
Required
|
The name of the service fabric. Required. |
|
name
Required
|
The name of the schedule. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get schedule.
get(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, expand: str | None = None, **kwargs: Any) -> Schedule
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
user_name
Required
|
The name of the user profile. Required. |
|
service_fabric_name
Required
|
The name of the service fabric. Required. |
|
name
Required
|
The name of the schedule. Required. |
|
expand
|
Specify the $expand query. Example: 'properties($select=status)'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
Schedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List schedules in a given service fabric.
list(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[Schedule]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
user_name
Required
|
The name of the user profile. Required. |
|
service_fabric_name
Required
|
The name of the service fabric. Required. |
|
expand
|
Specify the $expand query. Example: 'properties($select=status)'. Default value is None. Default value: None
|
|
filter
|
The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None. Default value: None
|
|
top
|
The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None. Default value: None
|
|
orderby
|
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Schedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Allows modifying tags of schedules. All other properties will be ignored.
update(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> Schedule
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
user_name
Required
|
The name of the user profile. Required. |
|
service_fabric_name
Required
|
The name of the service fabric. Required. |
|
name
Required
|
The name of the schedule. Required. |
|
tags
|
The tags of the resource. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
Schedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>