PlannerClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnCompleteTask_V3': {'operation_id': 'OnCompleteTask_V3', 'path': '/{connectionId}/v2/v1.0/planner/oncompletetask_trigger/plans/{id}/tasks', 'method': 'get', 'required_parameters': ['groupId', 'id'], 'callback_payload_type': 'ListTasksResponse'}, 'OnNewTask_V3': {'operation_id': 'OnNewTask_V3', 'path': '/{connectionId}/v2/v1.0/planner/onnewtask_trigger/plans/{id}/tasks', 'method': 'get', 'required_parameters': ['groupId', 'id'], 'callback_payload_type': 'ListTasksResponse'}, 'OnTaskAssignedToMe_V2': {'operation_id': 'OnTaskAssignedToMe_V2', 'path': '/{connectionId}/v1.0/me/planner/ontaskassignedtome_trigger/tasks', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'ListTasksResponse'}}
Classes
dataclass
dataclass
GetTaskResponseV2(*, created_by: Optional[Dict[str, Any]] = None, plan_id: Optional[str] = None, bucket_id: Optional[str] = None, title: Optional[str] = None, percent_complete: Optional[int] = None, start_date_time: Optional[str] = None, created_date_time: Optional[str] = None, due_date_time: Optional[str] = None, has_description: Optional[bool] = None, completed_date_time: Optional[str] = None, reference_count: Optional[int] = None, id: Optional[str] = None, applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = None, assignments: Optional[List[Dict[str, Any]]] = None)
Response for Remove assignees from a task
Attributes
class-attribute
instance-attribute
plan_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'planId'})
The id of the plan this task belongs to.
class-attribute
instance-attribute
bucket_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bucketId'})
The id of the bucket this task belongs to.
class-attribute
instance-attribute
The title of the task.
class-attribute
instance-attribute
percent_complete: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'percentComplete'})
The completion percentage of the task.
class-attribute
instance-attribute
start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})
The start datetime of the task.
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})
The datetime the task was created.
class-attribute
instance-attribute
due_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})
The datetime the task is due.
class-attribute
instance-attribute
has_description: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasDescription'})
Set to true if the task has a description.
class-attribute
instance-attribute
completed_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completedDateTime'})
The datetime the task was completed.
dataclass
dataclass
Response for List plans for a group
dataclass
dataclass
Create a bucket
Attributes
class-attribute
instance-attribute
The group to retrieve the plan.
dataclass
CreateBucketResponse(*, name: Optional[str] = None, plan_id: Optional[str] = None, order_hint: Optional[str] = None, id: Optional[str] = None)
Response for Create a bucket
Attributes
class-attribute
instance-attribute
Name of the bucket
class-attribute
instance-attribute
plan_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'planId'})
Plan ID to which the bucket belongs
dataclass
GetTaskResponseV3(*, created_by: Optional[Dict[str, Any]] = None, plan_id: Optional[str] = None, bucket_id: Optional[str] = None, title: Optional[str] = None, percent_complete: Optional[int] = None, start_date_time: Optional[str] = None, created_date_time: Optional[str] = None, due_date_time: Optional[str] = None, has_description: Optional[bool] = None, completed_date_time: Optional[str] = None, reference_count: Optional[int] = None, id: Optional[str] = None, applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = None, priority: Optional[int] = None, assignments: Optional[List[Dict[str, Any]]] = None)
Response for Create a task
Attributes
class-attribute
instance-attribute
plan_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'planId'})
The id of the plan this task belongs to.
class-attribute
instance-attribute
bucket_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bucketId'})
The id of the bucket this task belongs to.
class-attribute
instance-attribute
The title of the task.
class-attribute
instance-attribute
percent_complete: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'percentComplete'})
The completion percentage of the task.
class-attribute
instance-attribute
start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})
The start datetime of the task.
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})
The datetime the task was created.
class-attribute
instance-attribute
due_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})
The datetime the task is due.
class-attribute
instance-attribute
has_description: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasDescription'})
Set to true if the task has a description.
class-attribute
instance-attribute
completed_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completedDateTime'})
The datetime the task was completed.
class-attribute
instance-attribute
reference_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'referenceCount'})
The number of external references that exist on the task.
class-attribute
instance-attribute
The id of the task.
class-attribute
instance-attribute
Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2 and 3 and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low".
dataclass
GetTaskDetailsResponse(*, description: Optional[str] = None, id: Optional[str] = None, references: Optional[List[Dict[str, Any]]] = None, checklist: Optional[List[Dict[str, Any]]] = None)
Response for Get task details
Attributes
class-attribute
instance-attribute
The description of the task.
class-attribute
instance-attribute
The id of the task.
class-attribute
instance-attribute
The collection of references on the task
dataclass
Response for List buckets
dataclass
dataclass
dataclass
UpdateTaskDetailsRequest(*, description: Optional[str] = None, references: Optional[List[Dict[str, Any]]] = None, checklist: Optional[List[Dict[str, Any]]] = None)
Definition: UpdateTaskDetails_Request
Attributes
class-attribute
instance-attribute
The description of the task.
class-attribute
instance-attribute
The collection of references on the task
dataclass
UpdateTaskRequest(*, title: Optional[str] = None, due_date_time: Optional[str] = None, start_date_time: Optional[str] = None, percent_complete: Optional[int] = None, bucket_id: Optional[str] = None, applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = None)
Definition: UpdateTask_Request
Attributes
class-attribute
instance-attribute
The title of the plan (maximum of 255 chars).
class-attribute
instance-attribute
due_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})
The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').
class-attribute
instance-attribute
start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})
The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').
dataclass
CreateTaskRequest(group_id: str, plan_id: str, title: str, *, bucket_id: Optional[str] = None, start_date_time: Optional[str] = None, due_date_time: Optional[str] = None, assignments: Optional[str] = None, applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = None, priority: Optional[int] = None)
Definition: CreateTask_Request
Attributes
class-attribute
instance-attribute
The group to retrieve the plan.
class-attribute
instance-attribute
The plan for the new task.
class-attribute
instance-attribute
bucket_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bucketId'})
The bucket to place this task in.
class-attribute
instance-attribute
start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})
The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').
class-attribute
instance-attribute
due_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})
The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').
class-attribute
instance-attribute
Semi-colon separated ids or email addresses of users to assign this task to.
class-attribute
instance-attribute
Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2 and 3 and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Currently, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low".
dataclass
AppliedCategories(*, category1: Optional[bool] = None, category2: Optional[bool] = None, category3: Optional[bool] = None, category4: Optional[bool] = None, category5: Optional[bool] = None, category6: Optional[bool] = None, category7: Optional[bool] = None, category8: Optional[bool] = None, category9: Optional[bool] = None, category10: Optional[bool] = None, category11: Optional[bool] = None, category12: Optional[bool] = None, category13: Optional[bool] = None, category14: Optional[bool] = None, category15: Optional[bool] = None, category16: Optional[bool] = None, category17: Optional[bool] = None, category18: Optional[bool] = None, category19: Optional[bool] = None, category20: Optional[bool] = None, category21: Optional[bool] = None, category22: Optional[bool] = None, category23: Optional[bool] = None, category24: Optional[bool] = None, category25: Optional[bool] = None)
Definition: AppliedCategories
Attributes
class-attribute
instance-attribute
True if the task has the Pink category.
class-attribute
instance-attribute
True if the task has the Red category.
class-attribute
instance-attribute
True if the task has the Yellow category.
class-attribute
instance-attribute
True if the task has the Green category.
class-attribute
instance-attribute
True if the task has the Blue category.
class-attribute
instance-attribute
True if the task has the Purple category.
class-attribute
instance-attribute
True if the task has the Bronze category.
class-attribute
instance-attribute
True if the task has the Lime category.
class-attribute
instance-attribute
True if the task has the Aqua category.
class-attribute
instance-attribute
True if the task has the Gray category.
class-attribute
instance-attribute
True if the task has the Silver category.
class-attribute
instance-attribute
True if the task has the Brown category.
class-attribute
instance-attribute
True if the task has the Cranberry category.
class-attribute
instance-attribute
True if the task has the Orange category.
class-attribute
instance-attribute
True if the task has the Peach category.
class-attribute
instance-attribute
True if the task has the Marigold category.
class-attribute
instance-attribute
True if the task has the Light green category.
class-attribute
instance-attribute
True if the task has the Dark green category.
class-attribute
instance-attribute
True if the task has the Teal category.
class-attribute
instance-attribute
True if the task has the Light blue category.
class-attribute
instance-attribute
True if the task has the Dark blue category.
class-attribute
instance-attribute
True if the task has the Lavender category.
class-attribute
instance-attribute
True if the task has the Plum category.
class-attribute
instance-attribute
True if the task has the Light gray category.
dataclass
GetTaskResponse(*, created_by: Optional[Dict[str, Any]] = None, plan_id: Optional[str] = None, bucket_id: Optional[str] = None, title: Optional[str] = None, percent_complete: Optional[int] = None, start_date_time: Optional[str] = None, created_date_time: Optional[str] = None, due_date_time: Optional[str] = None, has_description: Optional[bool] = None, completed_date_time: Optional[str] = None, reference_count: Optional[int] = None, id: Optional[str] = None)
Definition: GetTask_Response
Attributes
class-attribute
instance-attribute
plan_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'planId'})
The id of the plan this task belongs to.
class-attribute
instance-attribute
bucket_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bucketId'})
The id of the bucket this task belongs to.
class-attribute
instance-attribute
The title of the task.
class-attribute
instance-attribute
percent_complete: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'percentComplete'})
The completion percentage of the task.
class-attribute
instance-attribute
start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})
The start datetime of the task.
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})
The datetime the task was created.
class-attribute
instance-attribute
due_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})
The datetime the task is due.
class-attribute
instance-attribute
has_description: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasDescription'})
Set to true if the task has a description.
class-attribute
instance-attribute
completed_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completedDateTime'})
The datetime the task was completed.
dataclass
Definition: ErrorResponse
PlannerClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for planner connector.
Initialize a PlannerClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
delete_task(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete a task
Deletes an existing Planner task.
Swagger operation ID: DeleteTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of the task to delete. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
unassign_users(input: UnassignUsersInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Remove assignees from a task
Remove assignees from an existing Planner task.
Swagger operation ID: UnassignUsers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UnassignUsersInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
The unique identifier of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
assign_users(input: AssignUsersInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add assignees to a task
Add assignees to an existing Planner task.
Swagger operation ID: AssignUsers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
AssignUsersInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
The unique identifier of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_group_plans(group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List plans for a group
List plans owned by the group specified.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListGroupPlans.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_id
|
str
|
Id of the group. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_plan_details(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get plan details
Get plan details where the task belongs to
Swagger operation ID: GetPlanDetails.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique plan id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_bucket(input: CreateBucketInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a bucket
Create a bucket in Planner for the specified plan and group.
Swagger operation ID: CreateBucket_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateBucketInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_task(input: CreateTaskRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a task
Create a new task in Planner.
Swagger operation ID: CreateTask_V4.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateTaskRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_task(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a task
Get an existing Planner task.
Swagger operation ID: GetTask_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_task_details(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get task details
Get the task details for an existing task.
Swagger operation ID: GetTaskDetails_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_buckets(id: str, group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List buckets
List the buckets in a plan.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListBuckets_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of the plan. |
required |
group_id
|
str
|
The group to retrieve the plan. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_my_tasks(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List my tasks
List the tasks assigned to me.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListMyTasks_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_tasks(id: str, group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List tasks
List the tasks in a plan.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListTasks_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
The unique identifier of the plan. |
required |
group_id
|
str
|
The group to retrieve the plan. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_task(input: UpdateTaskRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a task
Update an existing Planner task.
Swagger operation ID: UpdateTask_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateTaskRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
The unique identifier of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_task_details(input: UpdateTaskDetailsRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update task details
Update the task details for an existing task.
Swagger operation ID: UpdateTaskDetails_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateTaskDetailsRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
str
|
The unique identifier of the task to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_groups(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List groups that I am member of
Get groups that the user is a direct member of.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListGroups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |