AzuremonitorlogsClient

Attributes

QuerySchemaInput module-attribute

QuerySchemaInput = str

Classes

QueryDataInput dataclass

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

Run query and list results

Attributes

query instance-attribute

query: str

Specify the query you would like to run.

timerangetype instance-attribute

timerangetype: str

Select Time Range type.

timerange instance-attribute

timerange: Dict[str, Any]

Time Range

Table dataclass

Table(*, value: Optional[List[Row | Mapping[str, Any]]] = None, error: Optional[PartialQueryError | Mapping[str, Any]] = None)

Response for Run query and list results

VisualizeQueryInput dataclass

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

Run query and visualize results

Attributes

query instance-attribute

query: str

Specify the query you would like to run.

timerangetype instance-attribute

timerangetype: str

Select Time Range type.

timerange instance-attribute

timerange: Dict[str, Any]

Time Range

VisualizeResults dataclass

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

Response for Run query and visualize results

SubscriptionListResult dataclass

SubscriptionListResult(*, value: Optional[List[Subscription | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute

value: Optional[List[Subscription | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The subscriptions .

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

ResourceGroupListResult dataclass

ResourceGroupListResult(*, value: Optional[List[ResourceGroup | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List resource groups

Attributes

value class-attribute instance-attribute

value: Optional[List[ResourceGroup | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resource groups.

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

ResourceItemListResult dataclass

ResourceItemListResult(*, value: Optional[List[ResourceItem | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List resources

Attributes

value class-attribute instance-attribute

value: Optional[List[ResourceItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resource items.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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

subscription_id class-attribute instance-attribute

subscription_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

authorization_source class-attribute instance-attribute

authorization_source: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The ID of the resource.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the resource .

TimeRangeTypesListResult dataclass

TimeRangeTypesListResult(*, value: Optional[List[TimeRangeItem | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Definition: TimeRangeTypesListResult

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeRangeItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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

next_link class-attribute instance-attribute

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

The URL to get the next set of results.

TimeRangeListResult dataclass

TimeRangeListResult(*, value: Optional[List[TimeRangeItem | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Definition: TimeRangeListResult

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeRangeItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of time range.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The ID of the item.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the item.

AzuremonitorlogsClient

AzuremonitorlogsClient(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 azuremonitorlogs connector.

Initialize a AzuremonitorlogsClient.

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:

query_data async

query_data(input: QueryDataInput | Mapping[str, Any], subscriptions: str, resourcegroups: str, resourcetype: str, resourcename: 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

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.

Swagger operation ID: QueryDataV2.

Parameters:

Name	Type	Description	Default
input	QueryDataInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscriptions	str	Select subscription.	required
resourcegroups	str	Select resource group.	required
resourcetype	str	Select Resource Type.	required
resourcename	str	Select Resource.	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.

visualize_query async

visualize_query(input: VisualizeQueryInput | Mapping[str, Any], subscriptions: str, resourcegroups: str, resourcetype: str, resourcename: str, vis_type: 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

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.

Swagger operation ID: VisualizeQueryV2.

Parameters:

Name	Type	Description	Default
input	VisualizeQueryInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscriptions	str	Select subscription.	required
resourcegroups	str	Select resource group.	required
resourcetype	str	Select Resource Type.	required
resourcename	str	Select Resource.	required
vis_type	str	Specify the resulting chart type.	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_subscriptions

list_subscriptions(*, 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 subscriptions

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListSubscriptions.

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 async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_resource_groups

list_resource_groups(subscriptions: 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 resource groups

Lists all the resource groups within the subscription.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListResourceGroups.

Parameters:

Name	Type	Description	Default
subscriptions	str	Select subscription.	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 async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_resources

list_resources(subscriptions: str, resourcegroups: str, resourcetype: 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 resources

Lists all the resource groups within the resource group.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListResources.

Parameters:

Name	Type	Description	Default
subscriptions	str	Select subscription.	required
resourcegroups	str	Select resource group.	required
resourcetype	str	Select Resource Type.	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 async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

query_schema async

query_schema(input: QuerySchemaInput, subscriptions: str, resourcegroups: str, resourcetype: str, resourcename: 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 query schema

Gets the schema for a specific query.

Swagger operation ID: QuerySchemaV2.

Parameters:

Name	Type	Description	Default
input	QuerySchemaInput	The request body.	required
subscriptions	str	Select subscription.	required
resourcegroups	str	Select resource group.	required
resourcetype	str	Select Resource Type.	required
resourcename	str	Select Resource.	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.

get_time_range_selection_control async

get_time_range_selection_control(timerangetype: 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

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

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

Swagger operation ID: getTimeRangeSelectionControl.

Parameters:

Name	Type	Description	Default
timerangetype	str	The Time Range type that the control represents.	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.