QueriesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
LogAnalyticsManagementClient's
<xref:queries> attribute.
Constructor
QueriesOperations(*args, **kwargs)
Methods
| delete |
Deletes a specific Query defined within an Log Analytics QueryPack. |
| get |
Gets a specific Log Analytics Query defined within a Log Analytics QueryPack. |
| list |
Gets a list of Queries defined within a Log Analytics QueryPack. |
| put |
Adds or Updates a specific Query within a Log Analytics QueryPack. |
| search |
Search a list of Queries defined within a Log Analytics QueryPack according to given search properties. |
| update |
Adds or Updates a specific Query within a Log Analytics QueryPack. |
delete
Deletes a specific Query defined within an Log Analytics QueryPack.
async delete(resource_group_name: str, query_pack_name: str, id: str, **kwargs: Any) -> None
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
query_pack_name
Required
|
The name of the Log Analytics QueryPack resource. Required. |
|
id
Required
|
The id of a specific query defined in the Log Analytics QueryPack. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.
async get(resource_group_name: str, query_pack_name: str, id: str, **kwargs: Any) -> LogAnalyticsQueryPackQuery
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
query_pack_name
Required
|
The name of the Log Analytics QueryPack resource. Required. |
|
id
Required
|
The id of a specific query defined in the Log Analytics QueryPack. Required. |
Returns
| Type | Description |
|---|---|
|
LogAnalyticsQueryPackQuery or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Gets a list of Queries defined within a Log Analytics QueryPack.
list(resource_group_name: str, query_pack_name: str, top: int | None = None, include_body: bool | None = None, skip_token: str | None = None, **kwargs: Any) -> AsyncIterable[LogAnalyticsQueryPackQuery]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
query_pack_name
Required
|
The name of the Log Analytics QueryPack resource. Required. |
|
top
|
Maximum items returned in page. Default value is None. Default value: None
|
|
include_body
|
Flag indicating whether or not to return the body of each applicable query. If false, only return the query information. Default value is None. Default value: None
|
|
skip_token
|
Base64 encoded token used to fetch the next page of items. Default is null. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either LogAnalyticsQueryPackQuery or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
put
Adds or Updates a specific Query within a Log Analytics QueryPack.
async put(resource_group_name: str, query_pack_name: str, id: str, query_payload: _models.LogAnalyticsQueryPackQuery, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LogAnalyticsQueryPackQuery
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
query_pack_name
Required
|
The name of the Log Analytics QueryPack resource. Required. |
|
id
Required
|
The id of a specific query defined in the Log Analytics QueryPack. Required. |
|
query_payload
Required
|
Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack. Is either a LogAnalyticsQueryPackQuery type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
LogAnalyticsQueryPackQuery or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
search
Search a list of Queries defined within a Log Analytics QueryPack according to given search properties.
search(resource_group_name: str, query_pack_name: str, query_search_properties: _models.LogAnalyticsQueryPackQuerySearchProperties, top: int | None = None, include_body: bool | None = None, skip_token: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncIterable['_models.LogAnalyticsQueryPackQuery']
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
query_pack_name
Required
|
The name of the Log Analytics QueryPack resource. Required. |
|
query_search_properties
Required
|
Properties by which to search queries in the given Log Analytics QueryPack. Is either a LogAnalyticsQueryPackQuerySearchProperties type or a IO[bytes] type. Required. |
|
top
|
Maximum items returned in page. Default value is None. Default value: None
|
|
include_body
|
Flag indicating whether or not to return the body of each applicable query. If false, only return the query information. Default value is None. Default value: None
|
|
skip_token
|
Base64 encoded token used to fetch the next page of items. Default is null. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either LogAnalyticsQueryPackQuery or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Adds or Updates a specific Query within a Log Analytics QueryPack.
async update(resource_group_name: str, query_pack_name: str, id: str, query_payload: _models.LogAnalyticsQueryPackQuery, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LogAnalyticsQueryPackQuery
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
query_pack_name
Required
|
The name of the Log Analytics QueryPack resource. Required. |
|
id
Required
|
The id of a specific query defined in the Log Analytics QueryPack. Required. |
|
query_payload
Required
|
Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack. Is either a LogAnalyticsQueryPackQuery type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
LogAnalyticsQueryPackQuery or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.loganalytics.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv186\\Lib\\site-packages\\azure\\mgmt\\loganalytics\\models\\__init__.py'>