operationalinsights

package
v63.2.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package operationalinsights implements the Azure ARM Operationalinsights service API version 2015-03-20.

Operational Insights Client

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Operationalinsights
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AvailableServiceTier 

type AvailableServiceTier struct {
	// ServiceTier - READ-ONLY; The name of the Service Tier. Possible values include: 'Free', 'Standard', 'Premium', 'PerNode', 'PerGB2018', 'Standalone', 'CapacityReservation'
	ServiceTier SkuNameEnum `json:"ServiceTier,omitempty"`
	// Enabled - READ-ONLY; True if the Service Tier is enabled for the workspace.
	Enabled *bool `json:"Enabled,omitempty"`
	// MinimumRetention - READ-ONLY; The minimum retention for the Service Tier, in days.
	MinimumRetention *int64 `json:"MinimumRetention,omitempty"`
	// MaximumRetention - READ-ONLY; The maximum retention for the Service Tier, in days.
	MaximumRetention *int64 `json:"MaximumRetention,omitempty"`
	// DefaultRetention - READ-ONLY; The default retention for the Service Tier, in days.
	DefaultRetention *int64 `json:"DefaultRetention,omitempty"`
	// CapacityReservationLevel - READ-ONLY; The capacity reservation level in GB per day. Returned for the Capacity Reservation Service Tier.
	CapacityReservationLevel *int64 `json:"CapacityReservationLevel,omitempty"`
	// LastSkuUpdate - READ-ONLY; Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier.
	LastSkuUpdate *date.Time `json:"LastSkuUpdate,omitempty"`
}

AvailableServiceTier service Tier details.

func (AvailableServiceTier) MarshalJSON 

func (astVar AvailableServiceTier) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AvailableServiceTier.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
	PurgeID        string
}

BaseClient is the base client for Operationalinsights.

func New 

func New(subscriptionID string, purgeID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string, purgeID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CoreSummary 

type CoreSummary struct {
	// Status - The status of a core summary.
	Status *string `json:"status,omitempty"`
	// NumberOfDocuments - The number of documents of a core summary.
	NumberOfDocuments *int64 `json:"numberOfDocuments,omitempty"`
}

CoreSummary the core summary of a search.

type LinkTarget 

type LinkTarget struct {
	// CustomerID - The GUID that uniquely identifies the workspace.
	CustomerID *string `json:"customerId,omitempty"`
	// DisplayName - The display name of the workspace.
	DisplayName *string `json:"accountName,omitempty"`
	// WorkspaceName - The DNS valid workspace name.
	WorkspaceName *string `json:"workspaceName,omitempty"`
	// Location - The location of the workspace.
	Location *string `json:"location,omitempty"`
}

LinkTarget metadata for a workspace that isn't linked to an Azure subscription.

type ListAvailableServiceTier 

type ListAvailableServiceTier struct {
	autorest.Response `json:"-"`
	Value             *[]AvailableServiceTier `json:"value,omitempty"`
}

ListAvailableServiceTier ...

type ListLinkTarget 

type ListLinkTarget struct {
	autorest.Response `json:"-"`
	Value             *[]LinkTarget `json:"value,omitempty"`
}

ListLinkTarget ...

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation supported operation of OperationalInsights resource provider.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: OperationalInsights.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay display metadata associated with the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of operations supported by the OperationalInsights resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult result of the request to list OperationalInsights operations.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the operational Insights Client

func NewOperationsClient 

func NewOperationsClient(subscriptionID string, purgeID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string, purgeID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)

List lists all of the available OperationalInsights Rest API operations.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

ProxyResource common properties of proxy resource.

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type PurgeState 

type PurgeState string

PurgeState enumerates the values for purge state. 

const (
	// Completed ...
	Completed PurgeState = "completed"
	// Pending ...
	Pending PurgeState = "pending"
)

func PossiblePurgeStateValues 

func PossiblePurgeStateValues() []PurgeState

PossiblePurgeStateValues returns an array of possible values for the PurgeState const type.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

Resource the resource definition.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type SavedSearch 

type SavedSearch struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The id of the saved search.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the saved search.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the saved search.
	Type *string `json:"type,omitempty"`
	// ETag - The ETag of the saved search.
	ETag *string `json:"eTag,omitempty"`
	// SavedSearchProperties - The properties of the saved search.
	*SavedSearchProperties `json:"properties,omitempty"`
}

SavedSearch value object for saved search results.

func (SavedSearch) MarshalJSON 

func (ss SavedSearch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SavedSearch.

func (*SavedSearch) UnmarshalJSON 

func (ss *SavedSearch) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SavedSearch struct.

type SavedSearchProperties 

type SavedSearchProperties struct {
	// Category - The category of the saved search. This helps the user to find a saved search faster.
	Category *string `json:"category,omitempty"`
	// DisplayName - Saved search display name.
	DisplayName *string `json:"displayName,omitempty"`
	// Query - The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference.
	Query *string `json:"query,omitempty"`
	// Version - The version number of the query language. The current version is 2 and is the default.
	Version *int64 `json:"version,omitempty"`
	// Tags - The tags attached to the saved search.
	Tags *[]Tag `json:"tags,omitempty"`
}

SavedSearchProperties value object for saved search results.

type SavedSearchesClient 

type SavedSearchesClient struct {
	BaseClient
}

SavedSearchesClient is the operational Insights Client

func NewSavedSearchesClient 

func NewSavedSearchesClient(subscriptionID string, purgeID string) SavedSearchesClient

NewSavedSearchesClient creates an instance of the SavedSearchesClient client.

func NewSavedSearchesClientWithBaseURI 

func NewSavedSearchesClientWithBaseURI(baseURI string, subscriptionID string, purgeID string) SavedSearchesClient

NewSavedSearchesClientWithBaseURI creates an instance of the SavedSearchesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SavedSearchesClient) CreateOrUpdate 

func (client SavedSearchesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, savedSearchID string, parameters SavedSearch) (result SavedSearch, err error)

CreateOrUpdate creates or updates a saved search for a given workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. savedSearchID - the id of the saved search. parameters - the parameters required to save a search.

func (SavedSearchesClient) CreateOrUpdatePreparer 

func (client SavedSearchesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, savedSearchID string, parameters SavedSearch) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (SavedSearchesClient) CreateOrUpdateResponder 

func (client SavedSearchesClient) CreateOrUpdateResponder(resp *http.Response) (result SavedSearch, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (SavedSearchesClient) CreateOrUpdateSender 

func (client SavedSearchesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (SavedSearchesClient) Delete 

func (client SavedSearchesClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, savedSearchID string) (result autorest.Response, err error)

Delete deletes the specified saved search in a given workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. savedSearchID - the id of the saved search.

func (SavedSearchesClient) DeletePreparer 

func (client SavedSearchesClient) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceName string, savedSearchID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SavedSearchesClient) DeleteResponder 

func (client SavedSearchesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (SavedSearchesClient) DeleteSender 

func (client SavedSearchesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (SavedSearchesClient) Get 

func (client SavedSearchesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, savedSearchID string) (result SavedSearch, err error)

Get gets the specified saved search for a given workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. savedSearchID - the id of the saved search.

func (SavedSearchesClient) GetPreparer 

func (client SavedSearchesClient) GetPreparer(ctx context.Context, resourceGroupName string, workspaceName string, savedSearchID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SavedSearchesClient) GetResponder 

func (client SavedSearchesClient) GetResponder(resp *http.Response) (result SavedSearch, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SavedSearchesClient) GetSender 

func (client SavedSearchesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SavedSearchesClient) ListByWorkspace 

func (client SavedSearchesClient) ListByWorkspace(ctx context.Context, resourceGroupName string, workspaceName string) (result SavedSearchesListResult, err error)

ListByWorkspace gets the saved searches for a given Log Analytics Workspace Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (SavedSearchesClient) ListByWorkspacePreparer 

func (client SavedSearchesClient) ListByWorkspacePreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

ListByWorkspacePreparer prepares the ListByWorkspace request.

func (SavedSearchesClient) ListByWorkspaceResponder 

func (client SavedSearchesClient) ListByWorkspaceResponder(resp *http.Response) (result SavedSearchesListResult, err error)

ListByWorkspaceResponder handles the response to the ListByWorkspace request. The method always closes the http.Response Body.

func (SavedSearchesClient) ListByWorkspaceSender 

func (client SavedSearchesClient) ListByWorkspaceSender(req *http.Request) (*http.Response, error)

ListByWorkspaceSender sends the ListByWorkspace request. The method will close the http.Response Body if it receives an error.

type SavedSearchesListResult 

type SavedSearchesListResult struct {
	autorest.Response `json:"-"`
	// Metadata - Unused legacy property, kept here for backward compatibility.
	Metadata *SearchMetadata `json:"__metadata,omitempty"`
	// Value - The array of result values.
	Value *[]SavedSearch `json:"value,omitempty"`
}

SavedSearchesListResult the saved search list operation response.

type SearchGetSchemaResponse 

type SearchGetSchemaResponse struct {
	autorest.Response `json:"-"`
	// Metadata - The metadata from search results.
	Metadata *SearchMetadata `json:"metadata,omitempty"`
	// Value - The array of result values.
	Value *[]SearchSchemaValue `json:"value,omitempty"`
}

SearchGetSchemaResponse the get schema operation response.

type SearchMetadata 

type SearchMetadata struct {
	// SearchID - The request id of the search.
	SearchID *string `json:"requestId,omitempty"`
	// ResultType - The search result type.
	ResultType *string `json:"resultType,omitempty"`
	// Total - The total number of search results.
	Total *int64 `json:"total,omitempty"`
	// Top - The number of top search results.
	Top *int64 `json:"top,omitempty"`
	// ID - The id of the search results request.
	ID *string `json:"id,omitempty"`
	// CoreSummaries - The core summaries.
	CoreSummaries *[]CoreSummary `json:"coreSummaries,omitempty"`
	// Status - The status of the search results.
	Status *string `json:"status,omitempty"`
	// StartTime - The start time for the search.
	StartTime *date.Time `json:"startTime,omitempty"`
	// LastUpdated - The time of last update.
	LastUpdated *date.Time `json:"lastUpdated,omitempty"`
	// ETag - The ETag of the search results.
	ETag *string `json:"eTag,omitempty"`
	// Sort - How the results are sorted.
	Sort *[]SearchSort `json:"sort,omitempty"`
	// RequestTime - The request time.
	RequestTime *int64 `json:"requestTime,omitempty"`
	// AggregatedValueField - The aggregated value field.
	AggregatedValueField *string `json:"aggregatedValueField,omitempty"`
	// AggregatedGroupingFields - The aggregated grouping fields.
	AggregatedGroupingFields *string `json:"aggregatedGroupingFields,omitempty"`
	// Sum - The sum of all aggregates returned in the result set.
	Sum *int64 `json:"sum,omitempty"`
	// Max - The max of all aggregates returned in the result set.
	Max *int64 `json:"max,omitempty"`
	// Schema - The schema.
	Schema *SearchMetadataSchema `json:"schema,omitempty"`
}

SearchMetadata metadata for search results.

type SearchMetadataSchema 

type SearchMetadataSchema struct {
	// Name - The name of the metadata schema.
	Name *string `json:"name,omitempty"`
	// Version - The version of the metadata schema.
	Version *int32 `json:"version,omitempty"`
}

SearchMetadataSchema schema metadata for search.

type SearchSchemaValue 

type SearchSchemaValue struct {
	// Name - The name of the schema.
	Name *string `json:"name,omitempty"`
	// DisplayName - The display name of the schema.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - The type.
	Type *string `json:"type,omitempty"`
	// Indexed - The boolean that indicates the field is searchable as free text.
	Indexed *bool `json:"indexed,omitempty"`
	// Stored - The boolean that indicates whether or not the field is stored.
	Stored *bool `json:"stored,omitempty"`
	// Facet - The boolean that indicates whether or not the field is a facet.
	Facet *bool `json:"facet,omitempty"`
	// OwnerType - The array of workflows containing the field.
	OwnerType *[]string `json:"ownerType,omitempty"`
}

SearchSchemaValue value object for schema results.

type SearchSort 

type SearchSort struct {
	// Name - The name of the field the search query is sorted on.
	Name *string `json:"name,omitempty"`
	// Order - The sort order of the search. Possible values include: 'Asc', 'Desc'
	Order SearchSortEnum `json:"order,omitempty"`
}

SearchSort the sort parameters for search.

type SearchSortEnum 

type SearchSortEnum string

SearchSortEnum enumerates the values for search sort enum. 

const (
	// Asc ...
	Asc SearchSortEnum = "asc"
	// Desc ...
	Desc SearchSortEnum = "desc"
)

func PossibleSearchSortEnumValues 

func PossibleSearchSortEnumValues() []SearchSortEnum

PossibleSearchSortEnumValues returns an array of possible values for the SearchSortEnum const type.

type SharedKeys 

type SharedKeys struct {
	autorest.Response `json:"-"`
	// PrimarySharedKey - The primary shared key of a workspace.
	PrimarySharedKey *string `json:"primarySharedKey,omitempty"`
	// SecondarySharedKey - The secondary shared key of a workspace.
	SecondarySharedKey *string `json:"secondarySharedKey,omitempty"`
}

SharedKeys the shared keys for a workspace.

type SkuNameEnum 

type SkuNameEnum string

SkuNameEnum enumerates the values for sku name enum. 

const (
	// CapacityReservation ...
	CapacityReservation SkuNameEnum = "CapacityReservation"
	// Free ...
	Free SkuNameEnum = "Free"
	// PerGB2018 ...
	PerGB2018 SkuNameEnum = "PerGB2018"
	// PerNode ...
	PerNode SkuNameEnum = "PerNode"
	// Premium ...
	Premium SkuNameEnum = "Premium"
	// Standalone ...
	Standalone SkuNameEnum = "Standalone"
	// Standard ...
	Standard SkuNameEnum = "Standard"
)

func PossibleSkuNameEnumValues 

func PossibleSkuNameEnumValues() []SkuNameEnum

PossibleSkuNameEnumValues returns an array of possible values for the SkuNameEnum const type.

type StorageAccount 

type StorageAccount struct {
	// ID - The Azure Resource Manager ID of the storage account resource.
	ID *string `json:"id,omitempty"`
	// Key - The storage account key.
	Key *string `json:"key,omitempty"`
}

StorageAccount describes a storage account connection.

type StorageInsight 

type StorageInsight struct {
	autorest.Response `json:"-"`
	// StorageInsightProperties - Storage insight properties.
	*StorageInsightProperties `json:"properties,omitempty"`
	// ETag - The ETag of the storage insight.
	ETag *string `json:"eTag,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

StorageInsight the top level storage insight resource container.

func (StorageInsight) MarshalJSON 

func (si StorageInsight) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageInsight.

func (*StorageInsight) UnmarshalJSON 

func (si *StorageInsight) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for StorageInsight struct.

type StorageInsightListResult 

type StorageInsightListResult struct {
	autorest.Response `json:"-"`
	// Value - A list of storage insight items.
	Value *[]StorageInsight `json:"value,omitempty"`
	// OdataNextLink - The link (url) to the next page of results.
	OdataNextLink *string `json:"@odata.nextLink,omitempty"`
}

StorageInsightListResult the list storage insights operation response.

func (StorageInsightListResult) IsEmpty 

func (silr StorageInsightListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type StorageInsightListResultIterator 

type StorageInsightListResultIterator struct {
	// contains filtered or unexported fields
}

StorageInsightListResultIterator provides access to a complete listing of StorageInsight values.

func NewStorageInsightListResultIterator 

func NewStorageInsightListResultIterator(page StorageInsightListResultPage) StorageInsightListResultIterator

Creates a new instance of the StorageInsightListResultIterator type.

func (*StorageInsightListResultIterator) Next 

func (iter *StorageInsightListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*StorageInsightListResultIterator) NextWithContext 

func (iter *StorageInsightListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (StorageInsightListResultIterator) NotDone 

func (iter StorageInsightListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (StorageInsightListResultIterator) Response 

func (iter StorageInsightListResultIterator) Response() StorageInsightListResult

Response returns the raw server response from the last page request.

func (StorageInsightListResultIterator) Value 

func (iter StorageInsightListResultIterator) Value() StorageInsight

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type StorageInsightListResultPage 

type StorageInsightListResultPage struct {
	// contains filtered or unexported fields
}

StorageInsightListResultPage contains a page of StorageInsight values.

func NewStorageInsightListResultPage 

func NewStorageInsightListResultPage(cur StorageInsightListResult, getNextPage func(context.Context, StorageInsightListResult) (StorageInsightListResult, error)) StorageInsightListResultPage

Creates a new instance of the StorageInsightListResultPage type.

func (*StorageInsightListResultPage) Next 

func (page *StorageInsightListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*StorageInsightListResultPage) NextWithContext 

func (page *StorageInsightListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (StorageInsightListResultPage) NotDone 

func (page StorageInsightListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (StorageInsightListResultPage) Response 

func (page StorageInsightListResultPage) Response() StorageInsightListResult

Response returns the raw server response from the last page request.

func (StorageInsightListResultPage) Values 

func (page StorageInsightListResultPage) Values() []StorageInsight

Values returns the slice of values for the current page or nil if there are no values.

type StorageInsightProperties 

type StorageInsightProperties struct {
	// Containers - The names of the blob containers that the workspace should read
	Containers *[]string `json:"containers,omitempty"`
	// Tables - The names of the Azure tables that the workspace should read
	Tables *[]string `json:"tables,omitempty"`
	// StorageAccount - The storage account connection details
	StorageAccount *StorageAccount `json:"storageAccount,omitempty"`
	// Status - READ-ONLY; The status of the storage insight
	Status *StorageInsightStatus `json:"status,omitempty"`
}

StorageInsightProperties storage insight properties.

func (StorageInsightProperties) MarshalJSON 

func (sip StorageInsightProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageInsightProperties.

type StorageInsightState 

type StorageInsightState string

StorageInsightState enumerates the values for storage insight state. 

const (
	// ERROR ...
	ERROR StorageInsightState = "ERROR"
	// OK ...
	OK StorageInsightState = "OK"
)

func PossibleStorageInsightStateValues 

func PossibleStorageInsightStateValues() []StorageInsightState

PossibleStorageInsightStateValues returns an array of possible values for the StorageInsightState const type.

type StorageInsightStatus 

type StorageInsightStatus struct {
	// State - The state of the storage insight connection to the workspace. Possible values include: 'OK', 'ERROR'
	State StorageInsightState `json:"state,omitempty"`
	// Description - Description of the state of the storage insight.
	Description *string `json:"description,omitempty"`
}

StorageInsightStatus the status of the storage insight.

type StorageInsightsClient 

type StorageInsightsClient struct {
	BaseClient
}

StorageInsightsClient is the operational Insights Client

func NewStorageInsightsClient 

func NewStorageInsightsClient(subscriptionID string, purgeID string) StorageInsightsClient

NewStorageInsightsClient creates an instance of the StorageInsightsClient client.

func NewStorageInsightsClientWithBaseURI 

func NewStorageInsightsClientWithBaseURI(baseURI string, subscriptionID string, purgeID string) StorageInsightsClient

NewStorageInsightsClientWithBaseURI creates an instance of the StorageInsightsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (StorageInsightsClient) CreateOrUpdate 

func (client StorageInsightsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, storageInsightName string, parameters StorageInsight) (result StorageInsight, err error)

CreateOrUpdate create or update a storage insight. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. storageInsightName - name of the storageInsightsConfigs resource parameters - the parameters required to create or update a storage insight.

func (StorageInsightsClient) CreateOrUpdatePreparer 

func (client StorageInsightsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, storageInsightName string, parameters StorageInsight) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StorageInsightsClient) CreateOrUpdateResponder 

func (client StorageInsightsClient) CreateOrUpdateResponder(resp *http.Response) (result StorageInsight, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (StorageInsightsClient) CreateOrUpdateSender 

func (client StorageInsightsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (StorageInsightsClient) Delete 

func (client StorageInsightsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, storageInsightName string) (result autorest.Response, err error)

Delete deletes a storageInsightsConfigs resource Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. storageInsightName - name of the storageInsightsConfigs resource

func (StorageInsightsClient) DeletePreparer 

func (client StorageInsightsClient) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceName string, storageInsightName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (StorageInsightsClient) DeleteResponder 

func (client StorageInsightsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (StorageInsightsClient) DeleteSender 

func (client StorageInsightsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (StorageInsightsClient) Get 

func (client StorageInsightsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, storageInsightName string) (result StorageInsight, err error)

Get gets a storage insight instance. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. storageInsightName - name of the storageInsightsConfigs resource

func (StorageInsightsClient) GetPreparer 

func (client StorageInsightsClient) GetPreparer(ctx context.Context, resourceGroupName string, workspaceName string, storageInsightName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (StorageInsightsClient) GetResponder 

func (client StorageInsightsClient) GetResponder(resp *http.Response) (result StorageInsight, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (StorageInsightsClient) GetSender 

func (client StorageInsightsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (StorageInsightsClient) ListByWorkspace 

func (client StorageInsightsClient) ListByWorkspace(ctx context.Context, resourceGroupName string, workspaceName string) (result StorageInsightListResultPage, err error)

ListByWorkspace lists the storage insight instances within a workspace Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (StorageInsightsClient) ListByWorkspaceComplete 

func (client StorageInsightsClient) ListByWorkspaceComplete(ctx context.Context, resourceGroupName string, workspaceName string) (result StorageInsightListResultIterator, err error)

ListByWorkspaceComplete enumerates all values, automatically crossing page boundaries as required.

func (StorageInsightsClient) ListByWorkspacePreparer 

func (client StorageInsightsClient) ListByWorkspacePreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

ListByWorkspacePreparer prepares the ListByWorkspace request.

func (StorageInsightsClient) ListByWorkspaceResponder 

func (client StorageInsightsClient) ListByWorkspaceResponder(resp *http.Response) (result StorageInsightListResult, err error)

ListByWorkspaceResponder handles the response to the ListByWorkspace request. The method always closes the http.Response Body.

func (StorageInsightsClient) ListByWorkspaceSender 

func (client StorageInsightsClient) ListByWorkspaceSender(req *http.Request) (*http.Response, error)

ListByWorkspaceSender sends the ListByWorkspace request. The method will close the http.Response Body if it receives an error.

type Tag 

type Tag struct {
	// Name - The tag name.
	Name *string `json:"name,omitempty"`
	// Value - The tag value.
	Value *string `json:"value,omitempty"`
}

Tag a tag of a saved search.

type WorkspacePurgeBody 

type WorkspacePurgeBody struct {
	// Table - Table from which to purge data.
	Table *string `json:"table,omitempty"`
	// Filters - The set of columns and filters (queries) to run over them to purge the resulting data.
	Filters *[]WorkspacePurgeBodyFilters `json:"filters,omitempty"`
}

WorkspacePurgeBody describes the body of a purge request for an App Insights Workspace

type WorkspacePurgeBodyFilters 

type WorkspacePurgeBodyFilters struct {
	// Column - The column of the table over which the given query should run
	Column *string `json:"column,omitempty"`
	// Operator - A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query.
	Operator *string `json:"operator,omitempty"`
	// Value - the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values.
	Value interface{} `json:"value,omitempty"`
	// Key - When filtering over custom dimensions, this key will be used as the name of the custom dimension.
	Key *string `json:"key,omitempty"`
}

WorkspacePurgeBodyFilters user-defined filters to return data which will be purged from the table.

type WorkspacePurgeResponse 

type WorkspacePurgeResponse struct {
	autorest.Response `json:"-"`
	// OperationID - Id to use when querying for status for a particular purge operation.
	OperationID *string `json:"operationId,omitempty"`
}

WorkspacePurgeResponse response containing operationId for a specific purge action.

type WorkspacePurgeStatusResponse 

type WorkspacePurgeStatusResponse struct {
	autorest.Response `json:"-"`
	// Status - Status of the operation represented by the requested Id. Possible values include: 'Pending', 'Completed'
	Status PurgeState `json:"status,omitempty"`
}

WorkspacePurgeStatusResponse response containing status for a specific purge operation.

type WorkspacesClient 

type WorkspacesClient struct {
	BaseClient
}

WorkspacesClient is the operational Insights Client

func NewWorkspacesClient 

func NewWorkspacesClient(subscriptionID string, purgeID string) WorkspacesClient

NewWorkspacesClient creates an instance of the WorkspacesClient client.

func NewWorkspacesClientWithBaseURI 

func NewWorkspacesClientWithBaseURI(baseURI string, subscriptionID string, purgeID string) WorkspacesClient

NewWorkspacesClientWithBaseURI creates an instance of the WorkspacesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (WorkspacesClient) AvailableServiceTiers 

func (client WorkspacesClient) AvailableServiceTiers(ctx context.Context, resourceGroupName string, workspaceName string) (result ListAvailableServiceTier, err error)

AvailableServiceTiers gets the available service tiers for the workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (WorkspacesClient) AvailableServiceTiersPreparer 

func (client WorkspacesClient) AvailableServiceTiersPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

AvailableServiceTiersPreparer prepares the AvailableServiceTiers request.

func (WorkspacesClient) AvailableServiceTiersResponder 

func (client WorkspacesClient) AvailableServiceTiersResponder(resp *http.Response) (result ListAvailableServiceTier, err error)

AvailableServiceTiersResponder handles the response to the AvailableServiceTiers request. The method always closes the http.Response Body.

func (WorkspacesClient) AvailableServiceTiersSender 

func (client WorkspacesClient) AvailableServiceTiersSender(req *http.Request) (*http.Response, error)

AvailableServiceTiersSender sends the AvailableServiceTiers request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) DeleteGateways 

func (client WorkspacesClient) DeleteGateways(ctx context.Context, resourceGroupName string, workspaceName string, gatewayID string) (result autorest.Response, err error)

DeleteGateways delete a Log Analytics gateway. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. gatewayID - the Log Analytics gateway Id.

func (WorkspacesClient) DeleteGatewaysPreparer 

func (client WorkspacesClient) DeleteGatewaysPreparer(ctx context.Context, resourceGroupName string, workspaceName string, gatewayID string) (*http.Request, error)

DeleteGatewaysPreparer prepares the DeleteGateways request.

func (WorkspacesClient) DeleteGatewaysResponder 

func (client WorkspacesClient) DeleteGatewaysResponder(resp *http.Response) (result autorest.Response, err error)

DeleteGatewaysResponder handles the response to the DeleteGateways request. The method always closes the http.Response Body.

func (WorkspacesClient) DeleteGatewaysSender 

func (client WorkspacesClient) DeleteGatewaysSender(req *http.Request) (*http.Response, error)

DeleteGatewaysSender sends the DeleteGateways request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) GetPurgeStatus 

func (client WorkspacesClient) GetPurgeStatus(ctx context.Context, resourceGroupName string, workspaceName string) (result WorkspacePurgeStatusResponse, err error)

GetPurgeStatus gets status of an ongoing purge operation. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (WorkspacesClient) GetPurgeStatusPreparer 

func (client WorkspacesClient) GetPurgeStatusPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

GetPurgeStatusPreparer prepares the GetPurgeStatus request.

func (WorkspacesClient) GetPurgeStatusResponder 

func (client WorkspacesClient) GetPurgeStatusResponder(resp *http.Response) (result WorkspacePurgeStatusResponse, err error)

GetPurgeStatusResponder handles the response to the GetPurgeStatus request. The method always closes the http.Response Body.

func (WorkspacesClient) GetPurgeStatusSender 

func (client WorkspacesClient) GetPurgeStatusSender(req *http.Request) (*http.Response, error)

GetPurgeStatusSender sends the GetPurgeStatus request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) GetSchema 

func (client WorkspacesClient) GetSchema(ctx context.Context, resourceGroupName string, workspaceName string) (result SearchGetSchemaResponse, err error)

GetSchema gets the schema for a given workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (WorkspacesClient) GetSchemaPreparer 

func (client WorkspacesClient) GetSchemaPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

GetSchemaPreparer prepares the GetSchema request.

func (WorkspacesClient) GetSchemaResponder 

func (client WorkspacesClient) GetSchemaResponder(resp *http.Response) (result SearchGetSchemaResponse, err error)

GetSchemaResponder handles the response to the GetSchema request. The method always closes the http.Response Body.

func (WorkspacesClient) GetSchemaSender 

func (client WorkspacesClient) GetSchemaSender(req *http.Request) (*http.Response, error)

GetSchemaSender sends the GetSchema request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) ListKeys 

func (client WorkspacesClient) ListKeys(ctx context.Context, resourceGroupName string, workspaceName string) (result SharedKeys, err error)

ListKeys gets the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (WorkspacesClient) ListKeysPreparer 

func (client WorkspacesClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (WorkspacesClient) ListKeysResponder 

func (client WorkspacesClient) ListKeysResponder(resp *http.Response) (result SharedKeys, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (WorkspacesClient) ListKeysSender 

func (client WorkspacesClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) ListLinkTargets 

func (client WorkspacesClient) ListLinkTargets(ctx context.Context) (result ListLinkTarget, err error)

ListLinkTargets get a list of workspaces which the current user has administrator privileges and are not associated with an Azure Subscription. The subscriptionId parameter in the Url is ignored.

func (WorkspacesClient) ListLinkTargetsPreparer 

func (client WorkspacesClient) ListLinkTargetsPreparer(ctx context.Context) (*http.Request, error)

ListLinkTargetsPreparer prepares the ListLinkTargets request.

func (WorkspacesClient) ListLinkTargetsResponder 

func (client WorkspacesClient) ListLinkTargetsResponder(resp *http.Response) (result ListLinkTarget, err error)

ListLinkTargetsResponder handles the response to the ListLinkTargets request. The method always closes the http.Response Body.

func (WorkspacesClient) ListLinkTargetsSender 

func (client WorkspacesClient) ListLinkTargetsSender(req *http.Request) (*http.Response, error)

ListLinkTargetsSender sends the ListLinkTargets request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) Purge 

func (client WorkspacesClient) Purge(ctx context.Context, resourceGroupName string, workspaceName string, body WorkspacePurgeBody) (result WorkspacePurgeResponse, err error)

Purge 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: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name. body - describes the body of a request to purge data in a single table of an Log Analytics Workspace

func (WorkspacesClient) PurgePreparer 

func (client WorkspacesClient) PurgePreparer(ctx context.Context, resourceGroupName string, workspaceName string, body WorkspacePurgeBody) (*http.Request, error)

PurgePreparer prepares the Purge request.

func (WorkspacesClient) PurgeResponder 

func (client WorkspacesClient) PurgeResponder(resp *http.Response) (result WorkspacePurgeResponse, err error)

PurgeResponder handles the response to the Purge request. The method always closes the http.Response Body.

func (WorkspacesClient) PurgeSender 

func (client WorkspacesClient) PurgeSender(req *http.Request) (*http.Response, error)

PurgeSender sends the Purge request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) RegenerateSharedKeys 

func (client WorkspacesClient) RegenerateSharedKeys(ctx context.Context, resourceGroupName string, workspaceName string) (result SharedKeys, err error)

RegenerateSharedKeys regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace. Parameters: resourceGroupName - the Resource Group name. workspaceName - the Log Analytics Workspace name.

func (WorkspacesClient) RegenerateSharedKeysPreparer 

func (client WorkspacesClient) RegenerateSharedKeysPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

RegenerateSharedKeysPreparer prepares the RegenerateSharedKeys request.

func (WorkspacesClient) RegenerateSharedKeysResponder 

func (client WorkspacesClient) RegenerateSharedKeysResponder(resp *http.Response) (result SharedKeys, err error)

RegenerateSharedKeysResponder handles the response to the RegenerateSharedKeys request. The method always closes the http.Response Body.

func (WorkspacesClient) RegenerateSharedKeysSender 

func (client WorkspacesClient) RegenerateSharedKeysSender(req *http.Request) (*http.Response, error)

RegenerateSharedKeysSender sends the RegenerateSharedKeys request. The method will close the http.Response Body if it receives an error.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.