azure.mgmt.loganalytics.operations module¶
-
class
azure.mgmt.loganalytics.operations.
AvailableServiceTiersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AvailableServiceTiersOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → List[azure.mgmt.loganalytics.models._models_py3.AvailableServiceTier][source]¶ Gets the available service tiers for the workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
list of AvailableServiceTier, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
ClustersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ClustersOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update
(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.Cluster, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.Cluster][source]¶ Create or update a Log Analytics cluster.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a cluster instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.ClusterPatch, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.Cluster][source]¶ Updates a Log Analytics cluster.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
cluster_name (str) – Name of the Log Analytics Cluster.
parameters (ClusterPatch) – The parameters required to patch a Log Analytics cluster.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Cluster[source]¶ Gets a Log Analytics cluster instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Cluster, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.ClusterListResult][source]¶ Gets the Log Analytics clusters in a subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ClusterListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.ClusterListResult][source]¶ Gets Log Analytics clusters in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ClusterListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
DataExportsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DataExportsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name: str, workspace_name: str, data_export_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.DataExport, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.DataExport[source]¶ Create or update a data export.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
data_export_name (str) – The data export rule name.
parameters (DataExport) – The parameters required to create or update a data export.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DataExport, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, workspace_name: str, data_export_name: str, **kwargs: Any) → None[source]¶ Deletes the specified data export in a given workspace..
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, data_export_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.DataExport[source]¶ Gets a data export instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DataExport, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.DataExportListResult][source]¶ Lists the data export instances within a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either DataExportListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
DataSourcesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DataSourcesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name: str, workspace_name: str, data_source_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.DataSource, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.DataSource[source]¶ Create or update a data source.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
data_source_name (str) – The name of the datasource resource.
parameters (DataSource) – The parameters required to create or update a datasource.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DataSource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, workspace_name: str, data_source_name: str, **kwargs: Any) → None[source]¶ Deletes a data source instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, data_source_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.DataSource[source]¶ Gets a datasource instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DataSource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, filter: str, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.DataSourceListResult][source]¶ Gets the first page of data source instances in a workspace with the link to the next page.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either DataSourceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
DeletedWorkspacesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeletedWorkspacesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list
(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.WorkspaceListResult][source]¶ Gets recently deleted workspaces in a subscription, available for recovery.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.WorkspaceListResult][source]¶ Gets recently deleted workspaces in a resource group, available for recovery.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
GatewaysOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
GatewaysOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
delete
(resource_group_name: str, workspace_name: str, gateway_id: str, **kwargs: Any) → None[source]¶ Delete a Log Analytics gateway.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
IntelligencePacksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IntelligencePacksOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
disable
(resource_group_name: str, workspace_name: str, intelligence_pack_name: str, **kwargs: Any) → None[source]¶ Disables an intelligence pack for a given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
enable
(resource_group_name: str, workspace_name: str, intelligence_pack_name: str, **kwargs: Any) → None[source]¶ Enables an intelligence pack for a given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, workspace_name: str, **kwargs: Any) → List[azure.mgmt.loganalytics.models._models_py3.IntelligencePack][source]¶ Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
list of IntelligencePack, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
LinkedServicesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LinkedServicesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update
(resource_group_name: str, workspace_name: str, linked_service_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.LinkedService, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.LinkedService][source]¶ Create or update a linked service.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
linked_service_name (str) – Name of the linkedServices resource.
parameters (LinkedService) – The parameters required to create or update a linked service.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either LinkedService or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, workspace_name: str, linked_service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.LinkedService][source]¶ Deletes a linked service instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either LinkedService or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, linked_service_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LinkedService[source]¶ Gets a linked service instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LinkedService, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LinkedServiceListResult][source]¶ Gets the linked services instances in a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LinkedServiceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
LinkedStorageAccountsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LinkedStorageAccountsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name: str, workspace_name: str, data_source_type: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceType], parameters: azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsResource, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsResource[source]¶ Create or Update a link relation between current workspace and a group of storage accounts of a specific data source type.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
data_source_type (str or DataSourceType) – Linked storage accounts type.
parameters (LinkedStorageAccountsResource) – The parameters required to create or update linked storage accounts.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LinkedStorageAccountsResource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, workspace_name: str, data_source_type: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceType], **kwargs: Any) → None[source]¶ Deletes all linked storage accounts of a specific data source type associated with the specified workspace.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
data_source_type (str or DataSourceType) – Linked storage accounts type.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, data_source_type: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceType], **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsResource[source]¶ Gets all linked storage account of a specific data source type associated with the specified workspace.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
data_source_type (str or DataSourceType) – Linked storage accounts type.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LinkedStorageAccountsResource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsListResult][source]¶ Gets all linked storage accounts associated with the specified workspace, storage accounts will be sorted by their data source type.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LinkedStorageAccountsListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
ManagementGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ManagementGroupsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.WorkspaceListManagementGroupsResult][source]¶ Gets a list of management groups connected to a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceListManagementGroupsResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
OperationStatusesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
OperationStatusesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
get
(location: str, async_operation_id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.OperationStatus[source]¶ Get the status of a long running azure asynchronous operation.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
OperationStatus, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list
(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.OperationListResult][source]¶ Lists all of the available OperationalInsights Rest API operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
QueriesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
QueriesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
delete
(resource_group_name: str, query_pack_name: str, id: str, **kwargs: Any) → None[source]¶ Deletes a specific Query defined within an Log Analytics QueryPack.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, query_pack_name: str, id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery[source]¶ Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LogAnalyticsQueryPackQuery, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, query_pack_name: str, top: Optional[int] = None, include_body: Optional[bool] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQueryListResult][source]¶ Gets a list of Queries defined within a Log Analytics QueryPack.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_pack_name (str) – The name of the Log Analytics QueryPack resource.
top (long) – Maximum items returned in page.
include_body (bool) – Flag indicating whether or not to return the body of each applicable query. If false, only return the query information.
skip_token (str) – Base64 encoded token used to fetch the next page of items. Default is null.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LogAnalyticsQueryPackQueryListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
put
(resource_group_name: str, query_pack_name: str, id: str, query_payload: azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery[source]¶ Adds or Updates a specific Query within a Log Analytics QueryPack.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_pack_name (str) – The name of the Log Analytics QueryPack resource.
id (str) – The id of a specific query defined in the Log Analytics QueryPack.
query_payload (LogAnalyticsQueryPackQuery) – Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LogAnalyticsQueryPackQuery, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
search
(resource_group_name: str, query_pack_name: str, query_search_properties: azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuerySearchProperties, top: Optional[int] = None, include_body: Optional[bool] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQueryListResult][source]¶ Search a list of Queries defined within a Log Analytics QueryPack according to given search properties.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_pack_name (str) – The name of the Log Analytics QueryPack resource.
query_search_properties (LogAnalyticsQueryPackQuerySearchProperties) – Properties by which to search queries in the given Log Analytics QueryPack.
top (long) – Maximum items returned in page.
include_body (bool) – Flag indicating whether or not to return the body of each applicable query. If false, only return the query information.
skip_token (str) – Base64 encoded token used to fetch the next page of items. Default is null.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LogAnalyticsQueryPackQueryListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, query_pack_name: str, id: str, query_payload: azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery[source]¶ Adds or Updates a specific Query within a Log Analytics QueryPack.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_pack_name (str) – The name of the Log Analytics QueryPack resource.
id (str) – The id of a specific query defined in the Log Analytics QueryPack.
query_payload (LogAnalyticsQueryPackQuery) – Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LogAnalyticsQueryPackQuery, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
QueryPacksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
QueryPacksOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name: str, query_pack_name: str, log_analytics_query_pack_payload: azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack[source]¶ Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_pack_name (str) – The name of the Log Analytics QueryPack resource.
log_analytics_query_pack_payload (LogAnalyticsQueryPack) – Properties that need to be specified to create or update a Log Analytics QueryPack.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LogAnalyticsQueryPack, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, query_pack_name: str, **kwargs: Any) → None[source]¶ Deletes a Log Analytics QueryPack.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, query_pack_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack[source]¶ Returns a Log Analytics QueryPack.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LogAnalyticsQueryPack, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackListResult][source]¶ Gets a list of all Log Analytics QueryPacks within a subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LogAnalyticsQueryPackListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackListResult][source]¶ Gets a list of Log Analytics QueryPacks within a resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LogAnalyticsQueryPackListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Updates an existing QueryPack’s tags. To update other fields use the CreateOrUpdate method.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
query_pack_name (str) – The name of the Log Analytics QueryPack resource.
query_pack_tags (TagsResource) – Updated tag information to set into the QueryPack instance.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
LogAnalyticsQueryPack, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
SavedSearchesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SavedSearchesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name: str, workspace_name: str, saved_search_id: str, parameters: azure.mgmt.loganalytics.models._models_py3.SavedSearch, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SavedSearch[source]¶ Creates or updates a saved search for a given workspace.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
saved_search_id (str) – The id of the saved search.
parameters (SavedSearch) – The parameters required to save a search.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SavedSearch, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, workspace_name: str, saved_search_id: str, **kwargs: Any) → None[source]¶ Deletes the specified saved search in a given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, saved_search_id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SavedSearch[source]¶ Gets the specified saved search for a given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SavedSearch, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SavedSearchesListResult[source]¶ Gets the saved searches for a given Log Analytics Workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SavedSearchesListResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
SchemaOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SchemaOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
get
(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SearchGetSchemaResponse[source]¶ Gets the schema for a given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SearchGetSchemaResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
Bases:
object
SharedKeysOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
Gets the shared keys for a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SharedKeys, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SharedKeys, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
class
azure.mgmt.loganalytics.operations.
StorageInsightConfigsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
StorageInsightConfigsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name: str, workspace_name: str, storage_insight_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.StorageInsight, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.StorageInsight[source]¶ Create or update a storage insight.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
storage_insight_name (str) – Name of the storageInsightsConfigs resource.
parameters (StorageInsight) – The parameters required to create or update a storage insight.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
StorageInsight, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, workspace_name: str, storage_insight_name: str, **kwargs: Any) → None[source]¶ Deletes a storageInsightsConfigs resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, storage_insight_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.StorageInsight[source]¶ Gets a storage insight instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
StorageInsight, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.StorageInsightListResult][source]¶ Lists the storage insight instances within a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either StorageInsightListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
TablesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TablesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update
(resource_group_name: str, workspace_name: str, table_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.Table, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.Table][source]¶ Update or Create a Log Analytics workspace table.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Table or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Delete a Log Analytics workspace table.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, workspace_name: str, table_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.Table, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.Table][source]¶ Update a Log Analytics workspace table.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Table or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Table[source]¶ Gets a Log Analytics workspace table.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Table, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.TablesListResult][source]¶ Gets all the tables for the specified Log Analytics workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either TablesListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
migrate
(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → None[source]¶ Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
UsagesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
UsagesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list
(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.WorkspaceListUsagesResult][source]¶ Gets a list of usage metrics for a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceListUsagesResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
WorkspacePurgeOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
WorkspacePurgeOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
get_purge_status
(resource_group_name: str, workspace_name: str, purge_id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeStatusResponse[source]¶ Gets status of an ongoing purge operation.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
WorkspacePurgeStatusResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
purge
(resource_group_name: str, workspace_name: str, body: azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeBody, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeResponse[source]¶ Purges data in an Log Analytics workspace by a set of user-defined filters.
In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
body (WorkspacePurgeBody) – Describes the body of a request to purge data in a single table of an Log Analytics Workspace.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
WorkspacePurgeResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶
-
class
azure.mgmt.loganalytics.operations.
WorkspacesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
WorkspacesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update
(resource_group_name: str, workspace_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.Workspace, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.Workspace][source]¶ Create or update a workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either Workspace or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, workspace_name: str, force: Optional[bool] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Workspace[source]¶ Gets a workspace instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Workspace, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.WorkspaceListResult][source]¶ Gets the workspaces in a subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.WorkspaceListResult][source]¶ Gets workspaces in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, workspace_name: str, parameters: azure.mgmt.loganalytics.models._models_py3.WorkspacePatch, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Workspace[source]¶ Updates a workspace.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive.
workspace_name (str) – The name of the workspace.
parameters (WorkspacePatch) – The parameters required to patch a workspace.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Workspace, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶