Skip to content

AzuremonitorlogsClient

Attributes

QuerySchemaInput module-attribute

QuerySchemaInput = str

Classes

QueryDataInput dataclass

QueryDataInput(query: Optional[str] = None, timerangetype: Optional[str] = None, timerange: Optional[Dict[str, Any]] = None)

Run query and list results

Attributes

query class-attribute instance-attribute
query: Optional[str] = None

Specify the query you would like to run.

timerangetype class-attribute instance-attribute
timerangetype: Optional[str] = None

Select Time Range type.

timerange class-attribute instance-attribute
timerange: Optional[Dict[str, Any]] = None

Time Range

Table dataclass

Table(value: Optional[List[Row]] = None, error: Optional[PartialQueryError] = None)

Response for Run query and list results

VisualizeQueryInput dataclass

VisualizeQueryInput(query: Optional[str] = None, timerangetype: Optional[str] = None, timerange: Optional[Dict[str, Any]] = None)

Run query and visualize results

Attributes

query class-attribute instance-attribute
query: Optional[str] = None

Specify the query you would like to run.

timerangetype class-attribute instance-attribute
timerangetype: Optional[str] = None

Select Time Range type.

timerange class-attribute instance-attribute
timerange: Optional[Dict[str, Any]] = None

Time Range

VisualizeResults dataclass

VisualizeResults(body: Optional[str] = None, attachment_content: Optional[str] = None, attachment_name: Optional[str] = None, error: Optional[PartialQueryError] = None)

Response for Run query and visualize results

SubscriptionListResult dataclass

SubscriptionListResult(value: Optional[List[Subscription]] = None, next_link: Optional[str] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute
value: Optional[List[Subscription]] = None

The subscriptions .

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ResourceGroupListResult dataclass

ResourceGroupListResult(value: Optional[List[ResourceGroup]] = None, next_link: Optional[str] = None)

Response for List resource groups

Attributes

value class-attribute instance-attribute
value: Optional[List[ResourceGroup]] = None

The list of resource groups.

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ResourceItemListResult dataclass

ResourceItemListResult(value: Optional[List[ResourceItem]] = None, next_link: Optional[str] = None)

Response for List resources

Attributes

value class-attribute instance-attribute
value: Optional[List[ResourceItem]] = None

The list of resource items.

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Response for Get query schema

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Row dataclass

Row(additional_properties: Dict[str, Any] = dict())

Definition: Row

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PartialQueryError dataclass

PartialQueryError(code: Optional[str] = None)

Definition: PartialQueryError

Subscription dataclass

Subscription(id: Optional[str] = None, subscription_id: Optional[str] = None, authorization_source: Optional[str] = None)

Definition: Subscription

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.

subscription_id class-attribute instance-attribute
subscription_id: Optional[str] = field(default=None, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

authorization_source class-attribute instance-attribute
authorization_source: Optional[str] = field(default=None, metadata={'wire_name': 'authorizationSource'})

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

ResourceGroup dataclass

ResourceGroup(id: Optional[str] = None, name: Optional[str] = None)

Definition: ResourceGroup

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).

name class-attribute instance-attribute
name: Optional[str] = None

The Name of the resource group.

ResourceItem dataclass

ResourceItem(id: Optional[str] = None, name: Optional[str] = None)

Definition: ResourceItem

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The ID of the resource.

name class-attribute instance-attribute
name: Optional[str] = None

The Name of the resource .

TimeRangeTypesListResult dataclass

TimeRangeTypesListResult(value: Optional[List[TimeRangeItem]] = None, next_link: Optional[str] = None)

Definition: TimeRangeTypesListResult

Attributes

value class-attribute instance-attribute
value: Optional[List[TimeRangeItem]] = None

The list of time range types (Relative\Absolute\SetInQuery).

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

TimeRangeListResult dataclass

TimeRangeListResult(value: Optional[List[TimeRangeItem]] = None, next_link: Optional[str] = None)

Definition: TimeRangeListResult

Attributes

value class-attribute instance-attribute
value: Optional[List[TimeRangeItem]] = None

The list of time range.

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

TimeRangeItem dataclass

TimeRangeItem(id: Optional[int] = None, name: Optional[str] = None)

Definition: TimeRangeItem

Attributes

id class-attribute instance-attribute
id: Optional[int] = None

The ID of the item.

name class-attribute instance-attribute
name: Optional[str] = None

The Name of the item.

AzuremonitorlogsClient

AzuremonitorlogsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for azuremonitorlogs connector.

Initialize a AzuremonitorlogsClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

None
options Optional[ConnectorClientOptions]

Optional connector client options.

None

Methods:

query_data_async async
query_data_async(input: QueryDataInput, subscriptions: str, resourcegroups: str, resourcetype: str, resourcename: str) -> dict[str, Any] | None

Run query and list results

Returns each row as its own object. Use this action when you want to work with each row separately in the rest of the workflow.

visualize_query_async async
visualize_query_async(input: VisualizeQueryInput, subscriptions: str, resourcegroups: str, resourcetype: str, resourcename: str, vis_type: str) -> dict[str, Any] | None

Run query and visualize results

Returns all rows in the result set as a single formatted object. Use this action when you want to use the result set together in the rest of the workflow.

list_subscriptions_async async
list_subscriptions_async() -> dict[str, Any] | None

List subscriptions

Gets a list of all the subscriptions to which the principal has access.

list_resource_groups_async async
list_resource_groups_async(subscriptions: str) -> dict[str, Any] | None

List resource groups

Lists all the resource groups within the subscription.

list_resources_async async
list_resources_async(subscriptions: str, resourcegroups: str, resourcetype: str) -> dict[str, Any] | None

List resources

Lists all the resource groups within the resource group.

query_schema_async async
query_schema_async(input: QuerySchemaInput, subscriptions: str, resourcegroups: str, resourcetype: str, resourcename: str) -> dict[str, Any] | None

Get query schema

Gets the schema for a specific query.

get_time_range_selection_control_async async
get_time_range_selection_control_async(timerangetype: str) -> dict[str, Any] | None

Returns the control schema according to to the given time range type

Returns the Relative\Absolute\Set in query time range control.