armtimeseriesinsights

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2022 License: MIT Imports: 16 Imported by: 1

README

Azure Time Series Insights Module for Go

PkgGoDev

The armtimeseriesinsights module provides operations for working with Azure Time Series Insights.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Time Series Insights module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Time Series Insights. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Time Series Insights modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armtimeseriesinsights.NewEventSourcesClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions{
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armtimeseriesinsights.NewEventSourcesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Time Series Insights label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPoliciesClient 

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

AccessPoliciesClient contains the methods for the AccessPolicies group. Don't use this type directly, use NewAccessPoliciesClient() instead.

func NewAccessPoliciesClient 

func NewAccessPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccessPoliciesClient, error)

NewAccessPoliciesClient creates a new instance of AccessPoliciesClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessPoliciesClient) CreateOrUpdate 

func (client *AccessPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, accessPolicyName string, parameters AccessPolicyCreateOrUpdateParameters, options *AccessPoliciesClientCreateOrUpdateOptions) (AccessPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update an access policy in the specified environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. accessPolicyName - Name of the access policy. parameters - Parameters for creating an access policy. options - AccessPoliciesClientCreateOrUpdateOptions contains the optional parameters for the AccessPoliciesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesCreate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewAccessPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg1",
		"env1",
		"ap1",
		armtimeseriesinsights.AccessPolicyCreateOrUpdateParameters{
			Properties: &armtimeseriesinsights.AccessPolicyResourceProperties{
				Description:       to.Ptr("some description"),
				PrincipalObjectID: to.Ptr("aGuid"),
				Roles: []*armtimeseriesinsights.AccessPolicyRole{
					to.Ptr(armtimeseriesinsights.AccessPolicyRoleReader)},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AccessPoliciesClient) Delete 

func (client *AccessPoliciesClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, accessPolicyName string, options *AccessPoliciesClientDeleteOptions) (AccessPoliciesClientDeleteResponse, error)

Delete - Deletes the access policy with the specified name in the specified subscription, resource group, and environment If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. accessPolicyName - The name of the Time Series Insights access policy associated with the specified environment. options - AccessPoliciesClientDeleteOptions contains the optional parameters for the AccessPoliciesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewAccessPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg1",
		"env1",
		"ap1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*AccessPoliciesClient) Get 

func (client *AccessPoliciesClient) Get(ctx context.Context, resourceGroupName string, environmentName string, accessPolicyName string, options *AccessPoliciesClientGetOptions) (AccessPoliciesClientGetResponse, error)

Get - Gets the access policy with the specified name in the specified environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. accessPolicyName - The name of the Time Series Insights access policy associated with the specified environment. options - AccessPoliciesClientGetOptions contains the optional parameters for the AccessPoliciesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewAccessPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"env1",
		"ap1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AccessPoliciesClient) ListByEnvironment 

func (client *AccessPoliciesClient) ListByEnvironment(ctx context.Context, resourceGroupName string, environmentName string, options *AccessPoliciesClientListByEnvironmentOptions) (AccessPoliciesClientListByEnvironmentResponse, error)

ListByEnvironment - Lists all the available access policies associated with the environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. options - AccessPoliciesClientListByEnvironmentOptions contains the optional parameters for the AccessPoliciesClient.ListByEnvironment method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewAccessPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByEnvironment(ctx,
		"rg1",
		"env1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AccessPoliciesClient) Update 

func (client *AccessPoliciesClient) Update(ctx context.Context, resourceGroupName string, environmentName string, accessPolicyName string, accessPolicyUpdateParameters AccessPolicyUpdateParameters, options *AccessPoliciesClientUpdateOptions) (AccessPoliciesClientUpdateResponse, error)

Update - Updates the access policy with the specified name in the specified subscription, resource group, and environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. accessPolicyName - The name of the Time Series Insights access policy associated with the specified environment. accessPolicyUpdateParameters - Request object that contains the updated information for the access policy. options - AccessPoliciesClientUpdateOptions contains the optional parameters for the AccessPoliciesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesPatchRoles.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewAccessPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg1",
		"env1",
		"ap1",
		armtimeseriesinsights.AccessPolicyUpdateParameters{
			Properties: &armtimeseriesinsights.AccessPolicyMutableProperties{
				Roles: []*armtimeseriesinsights.AccessPolicyRole{
					to.Ptr(armtimeseriesinsights.AccessPolicyRoleReader),
					to.Ptr(armtimeseriesinsights.AccessPolicyRoleContributor)},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type AccessPoliciesClientCreateOrUpdateOptions 

type AccessPoliciesClientCreateOrUpdateOptions struct {
}

AccessPoliciesClientCreateOrUpdateOptions contains the optional parameters for the AccessPoliciesClient.CreateOrUpdate method.

type AccessPoliciesClientCreateOrUpdateResponse 

type AccessPoliciesClientCreateOrUpdateResponse struct {
	AccessPolicyResource
}

AccessPoliciesClientCreateOrUpdateResponse contains the response from method AccessPoliciesClient.CreateOrUpdate.

type AccessPoliciesClientDeleteOptions 

type AccessPoliciesClientDeleteOptions struct {
}

AccessPoliciesClientDeleteOptions contains the optional parameters for the AccessPoliciesClient.Delete method.

type AccessPoliciesClientDeleteResponse 

type AccessPoliciesClientDeleteResponse struct {
}

AccessPoliciesClientDeleteResponse contains the response from method AccessPoliciesClient.Delete.

type AccessPoliciesClientGetOptions 

type AccessPoliciesClientGetOptions struct {
}

AccessPoliciesClientGetOptions contains the optional parameters for the AccessPoliciesClient.Get method.

type AccessPoliciesClientGetResponse 

type AccessPoliciesClientGetResponse struct {
	AccessPolicyResource
}

AccessPoliciesClientGetResponse contains the response from method AccessPoliciesClient.Get.

type AccessPoliciesClientListByEnvironmentOptions 

type AccessPoliciesClientListByEnvironmentOptions struct {
}

AccessPoliciesClientListByEnvironmentOptions contains the optional parameters for the AccessPoliciesClient.ListByEnvironment method.

type AccessPoliciesClientListByEnvironmentResponse 

type AccessPoliciesClientListByEnvironmentResponse struct {
	AccessPolicyListResponse
}

AccessPoliciesClientListByEnvironmentResponse contains the response from method AccessPoliciesClient.ListByEnvironment.

type AccessPoliciesClientUpdateOptions 

type AccessPoliciesClientUpdateOptions struct {
}

AccessPoliciesClientUpdateOptions contains the optional parameters for the AccessPoliciesClient.Update method.

type AccessPoliciesClientUpdateResponse 

type AccessPoliciesClientUpdateResponse struct {
	AccessPolicyResource
}

AccessPoliciesClientUpdateResponse contains the response from method AccessPoliciesClient.Update.

type AccessPolicyCreateOrUpdateParameters 

type AccessPolicyCreateOrUpdateParameters struct {
	// REQUIRED
	Properties *AccessPolicyResourceProperties `json:"properties,omitempty"`
}

type AccessPolicyListResponse 

type AccessPolicyListResponse struct {
	// Result of the List access policies operation.
	Value []*AccessPolicyResource `json:"value,omitempty"`
}

AccessPolicyListResponse - The response of the List access policies operation.

type AccessPolicyMutableProperties 

type AccessPolicyMutableProperties struct {
	// An description of the access policy.
	Description *string `json:"description,omitempty"`

	// The list of roles the principal is assigned on the environment.
	Roles []*AccessPolicyRole `json:"roles,omitempty"`
}

AccessPolicyMutableProperties - An object that represents a set of mutable access policy resource properties.

func (AccessPolicyMutableProperties) MarshalJSON 

func (a AccessPolicyMutableProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessPolicyMutableProperties.

type AccessPolicyResource 

type AccessPolicyResource struct {
	Properties *AccessPolicyResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

AccessPolicyResource - An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs.

type AccessPolicyResourceProperties 

type AccessPolicyResourceProperties struct {
	// An description of the access policy.
	Description *string `json:"description,omitempty"`

	// The objectId of the principal in Azure Active Directory.
	PrincipalObjectID *string `json:"principalObjectId,omitempty"`

	// The list of roles the principal is assigned on the environment.
	Roles []*AccessPolicyRole `json:"roles,omitempty"`
}

func (AccessPolicyResourceProperties) MarshalJSON 

func (a AccessPolicyResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessPolicyResourceProperties.

type AccessPolicyRole 

type AccessPolicyRole string

AccessPolicyRole - A role defining the data plane operations that a principal can perform on a Time Series Insights client. 

const (
	AccessPolicyRoleContributor AccessPolicyRole = "Contributor"
	AccessPolicyRoleReader      AccessPolicyRole = "Reader"
)

func PossibleAccessPolicyRoleValues 

func PossibleAccessPolicyRoleValues() []AccessPolicyRole

PossibleAccessPolicyRoleValues returns the possible values for the AccessPolicyRole const type.

type AccessPolicyUpdateParameters 

type AccessPolicyUpdateParameters struct {
	// An object that represents a set of mutable access policy resource properties.
	Properties *AccessPolicyMutableProperties `json:"properties,omitempty"`
}

func (AccessPolicyUpdateParameters) MarshalJSON 

func (a AccessPolicyUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessPolicyUpdateParameters.

type AzureEventSourceProperties 

type AzureEventSourceProperties struct {
	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureEventSourceProperties - Properties of an event source that reads events from an event broker in Azure.

func (AzureEventSourceProperties) MarshalJSON 

func (a AzureEventSourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureEventSourceProperties.

func (*AzureEventSourceProperties) UnmarshalJSON 

func (a *AzureEventSourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureEventSourceProperties.

type CloudError 

type CloudError struct {
	// Describes a particular API error with an error code and a message.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError - Contains information about an API error.

type CloudErrorBody 

type CloudErrorBody struct {
	// An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically
	// handle specific error cases.
	Code *string `json:"code,omitempty"`

	// Contains nested errors that are related to this error.
	Details []*CloudErrorBody `json:"details,omitempty"`

	// A message that describes the error in detail and provides debugging information.
	Message *string `json:"message,omitempty"`

	// The target of the particular error (for example, the name of the property in error).
	Target *string `json:"target,omitempty"`
}

CloudErrorBody - Describes a particular API error with an error code and a message.

type CreateOrUpdateTrackedResourceProperties 

type CreateOrUpdateTrackedResourceProperties struct {
	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

CreateOrUpdateTrackedResourceProperties - Properties required to create any resource tracked by Azure Resource Manager.

func (CreateOrUpdateTrackedResourceProperties) MarshalJSON 

func (c CreateOrUpdateTrackedResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CreateOrUpdateTrackedResourceProperties.

type DataStringComparisonBehavior 

type DataStringComparisonBehavior string

DataStringComparisonBehavior - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. 

const (
	DataStringComparisonBehaviorOrdinal           DataStringComparisonBehavior = "Ordinal"
	DataStringComparisonBehaviorOrdinalIgnoreCase DataStringComparisonBehavior = "OrdinalIgnoreCase"
)

func PossibleDataStringComparisonBehaviorValues 

func PossibleDataStringComparisonBehaviorValues() []DataStringComparisonBehavior

PossibleDataStringComparisonBehaviorValues returns the possible values for the DataStringComparisonBehavior const type.

type Dimension 

type Dimension struct {
	// Display name of dimension.
	DisplayName *string `json:"displayName,omitempty"`

	// Display name of dimension.
	Name *string `json:"name,omitempty"`
}

Dimension of blobs, possibly be blob type or access tier.

type EnvironmentCreateOrUpdateParameters 

type EnvironmentCreateOrUpdateParameters struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentKind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku
	// determines the capacity of the environment, the ingress rate, and the billing rate.
	SKU *SKU `json:"sku,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

EnvironmentCreateOrUpdateParameters - Parameters supplied to the CreateOrUpdate Environment operation.

func (*EnvironmentCreateOrUpdateParameters) GetEnvironmentCreateOrUpdateParameters 

func (e *EnvironmentCreateOrUpdateParameters) GetEnvironmentCreateOrUpdateParameters() *EnvironmentCreateOrUpdateParameters

GetEnvironmentCreateOrUpdateParameters implements the EnvironmentCreateOrUpdateParametersClassification interface for type EnvironmentCreateOrUpdateParameters.

func (EnvironmentCreateOrUpdateParameters) MarshalJSON 

func (e EnvironmentCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentCreateOrUpdateParameters.

type EnvironmentCreateOrUpdateParametersClassification 

type EnvironmentCreateOrUpdateParametersClassification interface {
	// GetEnvironmentCreateOrUpdateParameters returns the EnvironmentCreateOrUpdateParameters content of the underlying type.
	GetEnvironmentCreateOrUpdateParameters() *EnvironmentCreateOrUpdateParameters
}

EnvironmentCreateOrUpdateParametersClassification provides polymorphic access to related types. Call the interface's GetEnvironmentCreateOrUpdateParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EnvironmentCreateOrUpdateParameters, *Gen1EnvironmentCreateOrUpdateParameters, *Gen2EnvironmentCreateOrUpdateParameters

type EnvironmentKind 

type EnvironmentKind string

EnvironmentKind - The kind of the environment. 

const (
	EnvironmentKindGen1 EnvironmentKind = "Gen1"
	EnvironmentKindGen2 EnvironmentKind = "Gen2"
)

func PossibleEnvironmentKindValues 

func PossibleEnvironmentKindValues() []EnvironmentKind

PossibleEnvironmentKindValues returns the possible values for the EnvironmentKind const type.

type EnvironmentListResponse 

type EnvironmentListResponse struct {
	// Result of the List Environments operation.
	Value []EnvironmentResourceClassification `json:"value,omitempty"`
}

EnvironmentListResponse - The response of the List Environments operation.

func (*EnvironmentListResponse) UnmarshalJSON 

func (e *EnvironmentListResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentListResponse.

type EnvironmentResource 

type EnvironmentResource struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentResourceKind `json:"kind,omitempty"`

	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// REQUIRED; The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku
	// determines the capacity of the environment, the ingress rate, and the billing rate.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

EnvironmentResource - An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.

func (*EnvironmentResource) GetEnvironmentResource 

func (e *EnvironmentResource) GetEnvironmentResource() *EnvironmentResource

GetEnvironmentResource implements the EnvironmentResourceClassification interface for type EnvironmentResource.

type EnvironmentResourceClassification 

type EnvironmentResourceClassification interface {
	// GetEnvironmentResource returns the EnvironmentResource content of the underlying type.
	GetEnvironmentResource() *EnvironmentResource
}

EnvironmentResourceClassification provides polymorphic access to related types. Call the interface's GetEnvironmentResource() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EnvironmentResource, *Gen1EnvironmentResource, *Gen2EnvironmentResource

type EnvironmentResourceKind 

type EnvironmentResourceKind string

EnvironmentResourceKind - The kind of the environment. 

const (
	EnvironmentResourceKindGen1 EnvironmentResourceKind = "Gen1"
	EnvironmentResourceKindGen2 EnvironmentResourceKind = "Gen2"
)

func PossibleEnvironmentResourceKindValues 

func PossibleEnvironmentResourceKindValues() []EnvironmentResourceKind

PossibleEnvironmentResourceKindValues returns the possible values for the EnvironmentResourceKind const type.

type EnvironmentResourceProperties 

type EnvironmentResourceProperties struct {
	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; The fully qualified domain name used to access the environment data, e.g. to query the environment's events
	// or upload reference data for the environment.
	DataAccessFqdn *string `json:"dataAccessFqdn,omitempty" azure:"ro"`

	// READ-ONLY; An id used to access the environment data, e.g. to query the environment's events or upload reference data for
	// the environment.
	DataAccessID *string `json:"dataAccessId,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; An object that represents the status of the environment, and its internal state in the Time Series Insights
	// service.
	Status *EnvironmentStatus `json:"status,omitempty" azure:"ro"`
}

EnvironmentResourceProperties - Properties of the environment.

func (EnvironmentResourceProperties) MarshalJSON 

func (e EnvironmentResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentResourceProperties.

func (*EnvironmentResourceProperties) UnmarshalJSON 

func (e *EnvironmentResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResourceProperties.

type EnvironmentStateDetails 

type EnvironmentStateDetails struct {
	// Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically
	// handle specific cases.
	Code *string `json:"code,omitempty"`

	// A message that describes the state in detail.
	Message *string `json:"message,omitempty"`
}

EnvironmentStateDetails - An object that contains the details about an environment's state.

type EnvironmentStatus 

type EnvironmentStatus struct {
	// READ-ONLY; An object that represents the status of ingress on an environment.
	Ingress *IngressEnvironmentStatus `json:"ingress,omitempty" azure:"ro"`

	// READ-ONLY; An object that represents the status of warm storage on an environment.
	WarmStorage *WarmStorageEnvironmentStatus `json:"warmStorage,omitempty" azure:"ro"`
}

EnvironmentStatus - An object that represents the status of the environment, and its internal state in the Time Series Insights service.

type EnvironmentUpdateParameters 

type EnvironmentUpdateParameters struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentKind `json:"kind,omitempty"`

	// Key-value pairs of additional properties for the environment.
	Tags map[string]*string `json:"tags,omitempty"`
}

EnvironmentUpdateParameters - Parameters supplied to the Update Environment operation.

func (*EnvironmentUpdateParameters) GetEnvironmentUpdateParameters 

func (e *EnvironmentUpdateParameters) GetEnvironmentUpdateParameters() *EnvironmentUpdateParameters

GetEnvironmentUpdateParameters implements the EnvironmentUpdateParametersClassification interface for type EnvironmentUpdateParameters.

func (EnvironmentUpdateParameters) MarshalJSON 

func (e EnvironmentUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentUpdateParameters.

type EnvironmentUpdateParametersClassification 

type EnvironmentUpdateParametersClassification interface {
	// GetEnvironmentUpdateParameters returns the EnvironmentUpdateParameters content of the underlying type.
	GetEnvironmentUpdateParameters() *EnvironmentUpdateParameters
}

EnvironmentUpdateParametersClassification provides polymorphic access to related types. Call the interface's GetEnvironmentUpdateParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EnvironmentUpdateParameters, *Gen1EnvironmentUpdateParameters, *Gen2EnvironmentUpdateParameters

type EnvironmentsClient 

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

EnvironmentsClient contains the methods for the Environments group. Don't use this type directly, use NewEnvironmentsClient() instead.

func NewEnvironmentsClient 

func NewEnvironmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EnvironmentsClient, error)

NewEnvironmentsClient creates a new instance of EnvironmentsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EnvironmentsClient) BeginCreateOrUpdate 

func (client *EnvironmentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, parameters EnvironmentCreateOrUpdateParametersClassification, options *EnvironmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[EnvironmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update an environment in the specified subscription and resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - Name of the environment parameters - Parameters for creating an environment resource. options - EnvironmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsCreate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEnvironmentsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"env1",
		&armtimeseriesinsights.Gen1EnvironmentCreateOrUpdateParameters{
			Location: to.Ptr("West US"),
			Kind:     to.Ptr(armtimeseriesinsights.EnvironmentKindGen1),
			SKU: &armtimeseriesinsights.SKU{
				Name:     to.Ptr(armtimeseriesinsights.SKUNameS1),
				Capacity: to.Ptr[int32](1),
			},
			Properties: &armtimeseriesinsights.Gen1EnvironmentCreationProperties{
				DataRetentionTime: to.Ptr("P31D"),
				PartitionKeyProperties: []*armtimeseriesinsights.TimeSeriesIDProperty{
					{
						Name: to.Ptr("DeviceId1"),
						Type: to.Ptr(armtimeseriesinsights.PropertyTypeString),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EnvironmentsClient) BeginUpdate 

func (client *EnvironmentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, environmentName string, environmentUpdateParameters EnvironmentUpdateParametersClassification, options *EnvironmentsClientBeginUpdateOptions) (*runtime.Poller[EnvironmentsClientUpdateResponse], error)

BeginUpdate - Updates the environment with the specified name in the specified subscription and resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. environmentUpdateParameters - Request object that contains the updated information for the environment. options - EnvironmentsClientBeginUpdateOptions contains the optional parameters for the EnvironmentsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsPatchTags.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEnvironmentsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginUpdate(ctx,
		"rg1",
		"env1",
		&armtimeseriesinsights.EnvironmentUpdateParameters{
			Tags: map[string]*string{
				"someTag": to.Ptr("someTagValue"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EnvironmentsClient) Delete 

func (client *EnvironmentsClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, options *EnvironmentsClientDeleteOptions) (EnvironmentsClientDeleteResponse, error)

Delete - Deletes the environment with the specified name in the specified subscription and resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. options - EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEnvironmentsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg1",
		"env1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*EnvironmentsClient) Get 

func (client *EnvironmentsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, options *EnvironmentsClientGetOptions) (EnvironmentsClientGetResponse, error)

Get - Gets the environment with the specified name in the specified subscription and resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. options - EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEnvironmentsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"env1",
		&armtimeseriesinsights.EnvironmentsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EnvironmentsClient) ListByResourceGroup 

func (client *EnvironmentsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, options *EnvironmentsClientListByResourceGroupOptions) (EnvironmentsClientListByResourceGroupResponse, error)

ListByResourceGroup - Lists all the available environments associated with the subscription and within the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. options - EnvironmentsClientListByResourceGroupOptions contains the optional parameters for the EnvironmentsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEnvironmentsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByResourceGroup(ctx,
		"rg1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EnvironmentsClient) ListBySubscription 

func (client *EnvironmentsClient) ListBySubscription(ctx context.Context, options *EnvironmentsClientListBySubscriptionOptions) (EnvironmentsClientListBySubscriptionResponse, error)

ListBySubscription - Lists all the available environments within a subscription, irrespective of the resource groups. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 options - EnvironmentsClientListBySubscriptionOptions contains the optional parameters for the EnvironmentsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEnvironmentsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListBySubscription(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type EnvironmentsClientBeginCreateOrUpdateOptions 

type EnvironmentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

EnvironmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.BeginCreateOrUpdate method.

type EnvironmentsClientBeginUpdateOptions 

type EnvironmentsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

EnvironmentsClientBeginUpdateOptions contains the optional parameters for the EnvironmentsClient.BeginUpdate method.

type EnvironmentsClientCreateOrUpdateResponse 

type EnvironmentsClientCreateOrUpdateResponse struct {
	EnvironmentResourceClassification
}

EnvironmentsClientCreateOrUpdateResponse contains the response from method EnvironmentsClient.CreateOrUpdate.

func (*EnvironmentsClientCreateOrUpdateResponse) UnmarshalJSON 

func (e *EnvironmentsClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentsClientCreateOrUpdateResponse.

type EnvironmentsClientDeleteOptions 

type EnvironmentsClientDeleteOptions struct {
}

EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.

type EnvironmentsClientDeleteResponse 

type EnvironmentsClientDeleteResponse struct {
}

EnvironmentsClientDeleteResponse contains the response from method EnvironmentsClient.Delete.

type EnvironmentsClientGetOptions 

type EnvironmentsClientGetOptions struct {
	// Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights
	// service.
	Expand *string
}

EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.

type EnvironmentsClientGetResponse 

type EnvironmentsClientGetResponse struct {
	EnvironmentResourceClassification
}

EnvironmentsClientGetResponse contains the response from method EnvironmentsClient.Get.

func (*EnvironmentsClientGetResponse) UnmarshalJSON 

func (e *EnvironmentsClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentsClientGetResponse.

type EnvironmentsClientListByResourceGroupOptions 

type EnvironmentsClientListByResourceGroupOptions struct {
}

EnvironmentsClientListByResourceGroupOptions contains the optional parameters for the EnvironmentsClient.ListByResourceGroup method.

type EnvironmentsClientListByResourceGroupResponse 

type EnvironmentsClientListByResourceGroupResponse struct {
	EnvironmentListResponse
}

EnvironmentsClientListByResourceGroupResponse contains the response from method EnvironmentsClient.ListByResourceGroup.

type EnvironmentsClientListBySubscriptionOptions 

type EnvironmentsClientListBySubscriptionOptions struct {
}

EnvironmentsClientListBySubscriptionOptions contains the optional parameters for the EnvironmentsClient.ListBySubscription method.

type EnvironmentsClientListBySubscriptionResponse 

type EnvironmentsClientListBySubscriptionResponse struct {
	EnvironmentListResponse
}

EnvironmentsClientListBySubscriptionResponse contains the response from method EnvironmentsClient.ListBySubscription.

type EnvironmentsClientUpdateResponse 

type EnvironmentsClientUpdateResponse struct {
	EnvironmentResourceClassification
}

EnvironmentsClientUpdateResponse contains the response from method EnvironmentsClient.Update.

func (*EnvironmentsClientUpdateResponse) UnmarshalJSON 

func (e *EnvironmentsClientUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentsClientUpdateResponse.

type EventHubEventSourceCommonProperties 

type EventHubEventSourceCommonProperties struct {
	// REQUIRED; The name of the event hub's consumer group that holds the partitions from which events will be read.
	ConsumerGroupName *string `json:"consumerGroupName,omitempty"`

	// REQUIRED; The name of the event hub.
	EventHubName *string `json:"eventHubName,omitempty"`

	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// REQUIRED; The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access
	// policies for this key must grant 'Listen' permissions to the event hub.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; The name of the service bus that contains the event hub.
	ServiceBusNamespace *string `json:"serviceBusNamespace,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

EventHubEventSourceCommonProperties - Properties of the EventHub event source.

func (EventHubEventSourceCommonProperties) MarshalJSON 

func (e EventHubEventSourceCommonProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSourceCommonProperties.

func (*EventHubEventSourceCommonProperties) UnmarshalJSON 

func (e *EventHubEventSourceCommonProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSourceCommonProperties.

type EventHubEventSourceCreateOrUpdateParameters 

type EventHubEventSourceCreateOrUpdateParameters struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceKind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the EventHub event source that are required on create or update requests.
	Properties *EventHubEventSourceCreationProperties `json:"properties,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

EventHubEventSourceCreateOrUpdateParameters - Parameters supplied to the Create or Update Event Source operation for an EventHub event source.

func (*EventHubEventSourceCreateOrUpdateParameters) GetEventSourceCreateOrUpdateParameters 

func (e *EventHubEventSourceCreateOrUpdateParameters) GetEventSourceCreateOrUpdateParameters() *EventSourceCreateOrUpdateParameters

GetEventSourceCreateOrUpdateParameters implements the EventSourceCreateOrUpdateParametersClassification interface for type EventHubEventSourceCreateOrUpdateParameters.

func (EventHubEventSourceCreateOrUpdateParameters) MarshalJSON 

func (e EventHubEventSourceCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSourceCreateOrUpdateParameters.

func (*EventHubEventSourceCreateOrUpdateParameters) UnmarshalJSON 

func (e *EventHubEventSourceCreateOrUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSourceCreateOrUpdateParameters.

type EventHubEventSourceCreationProperties 

type EventHubEventSourceCreationProperties struct {
	// REQUIRED; The name of the event hub's consumer group that holds the partitions from which events will be read.
	ConsumerGroupName *string `json:"consumerGroupName,omitempty"`

	// REQUIRED; The name of the event hub.
	EventHubName *string `json:"eventHubName,omitempty"`

	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// REQUIRED; The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access
	// policies for this key must grant 'Listen' permissions to the event hub.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; The name of the service bus that contains the event hub.
	ServiceBusNamespace *string `json:"serviceBusNamespace,omitempty"`

	// REQUIRED; The value of the shared access key that grants the Time Series Insights service read access to the event hub.
	// This property is not shown in event source responses.
	SharedAccessKey *string `json:"sharedAccessKey,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

EventHubEventSourceCreationProperties - Properties of the EventHub event source that are required on create or update requests.

func (EventHubEventSourceCreationProperties) MarshalJSON 

func (e EventHubEventSourceCreationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSourceCreationProperties.

func (*EventHubEventSourceCreationProperties) UnmarshalJSON 

func (e *EventHubEventSourceCreationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSourceCreationProperties.

type EventHubEventSourceMutableProperties 

type EventHubEventSourceMutableProperties struct {
	// The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property
	// is not shown in event source responses.
	SharedAccessKey *string `json:"sharedAccessKey,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`
}

EventHubEventSourceMutableProperties - An object that represents a set of mutable EventHub event source resource properties.

type EventHubEventSourceResource 

type EventHubEventSourceResource struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceResourceKind `json:"kind,omitempty"`

	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the EventHub event source resource.
	Properties *EventHubEventSourceResourceProperties `json:"properties,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

EventHubEventSourceResource - An event source that receives its data from an Azure EventHub.

func (*EventHubEventSourceResource) GetEventSourceResource 

func (e *EventHubEventSourceResource) GetEventSourceResource() *EventSourceResource

GetEventSourceResource implements the EventSourceResourceClassification interface for type EventHubEventSourceResource.

func (*EventHubEventSourceResource) UnmarshalJSON 

func (e *EventHubEventSourceResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSourceResource.

type EventHubEventSourceResourceProperties 

type EventHubEventSourceResourceProperties struct {
	// REQUIRED; The name of the event hub's consumer group that holds the partitions from which events will be read.
	ConsumerGroupName *string `json:"consumerGroupName,omitempty"`

	// REQUIRED; The name of the event hub.
	EventHubName *string `json:"eventHubName,omitempty"`

	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// REQUIRED; The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access
	// policies for this key must grant 'Listen' permissions to the event hub.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; The name of the service bus that contains the event hub.
	ServiceBusNamespace *string `json:"serviceBusNamespace,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

EventHubEventSourceResourceProperties - Properties of the EventHub event source resource.

func (EventHubEventSourceResourceProperties) MarshalJSON 

func (e EventHubEventSourceResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSourceResourceProperties.

func (*EventHubEventSourceResourceProperties) UnmarshalJSON 

func (e *EventHubEventSourceResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSourceResourceProperties.

type EventHubEventSourceUpdateParameters 

type EventHubEventSourceUpdateParameters struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceKind `json:"kind,omitempty"`

	// Properties of the EventHub event source.
	Properties *EventHubEventSourceMutableProperties `json:"properties,omitempty"`

	// Key-value pairs of additional properties for the event source.
	Tags map[string]*string `json:"tags,omitempty"`
}

EventHubEventSourceUpdateParameters - Parameters supplied to the Update Event Source operation to update an EventHub event source.

func (*EventHubEventSourceUpdateParameters) GetEventSourceUpdateParameters 

func (e *EventHubEventSourceUpdateParameters) GetEventSourceUpdateParameters() *EventSourceUpdateParameters

GetEventSourceUpdateParameters implements the EventSourceUpdateParametersClassification interface for type EventHubEventSourceUpdateParameters.

func (EventHubEventSourceUpdateParameters) MarshalJSON 

func (e EventHubEventSourceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubEventSourceUpdateParameters.

func (*EventHubEventSourceUpdateParameters) UnmarshalJSON 

func (e *EventHubEventSourceUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubEventSourceUpdateParameters.

type EventSourceCommonProperties 

type EventSourceCommonProperties struct {
	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

EventSourceCommonProperties - Properties of the event source.

func (EventSourceCommonProperties) MarshalJSON 

func (e EventSourceCommonProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSourceCommonProperties.

func (*EventSourceCommonProperties) UnmarshalJSON 

func (e *EventSourceCommonProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSourceCommonProperties.

type EventSourceCreateOrUpdateParameters 

type EventSourceCreateOrUpdateParameters struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceKind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

EventSourceCreateOrUpdateParameters - Parameters supplied to the Create or Update Event Source operation.

func (*EventSourceCreateOrUpdateParameters) GetEventSourceCreateOrUpdateParameters 

func (e *EventSourceCreateOrUpdateParameters) GetEventSourceCreateOrUpdateParameters() *EventSourceCreateOrUpdateParameters

GetEventSourceCreateOrUpdateParameters implements the EventSourceCreateOrUpdateParametersClassification interface for type EventSourceCreateOrUpdateParameters.

func (EventSourceCreateOrUpdateParameters) MarshalJSON 

func (e EventSourceCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSourceCreateOrUpdateParameters.

type EventSourceCreateOrUpdateParametersClassification 

type EventSourceCreateOrUpdateParametersClassification interface {
	// GetEventSourceCreateOrUpdateParameters returns the EventSourceCreateOrUpdateParameters content of the underlying type.
	GetEventSourceCreateOrUpdateParameters() *EventSourceCreateOrUpdateParameters
}

EventSourceCreateOrUpdateParametersClassification provides polymorphic access to related types. Call the interface's GetEventSourceCreateOrUpdateParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EventHubEventSourceCreateOrUpdateParameters, *EventSourceCreateOrUpdateParameters, *IoTHubEventSourceCreateOrUpdateParameters

type EventSourceKind 

type EventSourceKind string

EventSourceKind - The kind of the event source. 

const (
	EventSourceKindMicrosoftEventHub EventSourceKind = "Microsoft.EventHub"
	EventSourceKindMicrosoftIoTHub   EventSourceKind = "Microsoft.IoTHub"
)

func PossibleEventSourceKindValues 

func PossibleEventSourceKindValues() []EventSourceKind

PossibleEventSourceKindValues returns the possible values for the EventSourceKind const type.

type EventSourceListResponse 

type EventSourceListResponse struct {
	// Result of the List EventSources operation.
	Value []EventSourceResourceClassification `json:"value,omitempty"`
}

EventSourceListResponse - The response of the List EventSources operation.

func (*EventSourceListResponse) UnmarshalJSON 

func (e *EventSourceListResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSourceListResponse.

type EventSourceMutableProperties 

type EventSourceMutableProperties struct {
	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`
}

EventSourceMutableProperties - An object that represents a set of mutable event source resource properties.

type EventSourceResource 

type EventSourceResource struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceResourceKind `json:"kind,omitempty"`

	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

EventSourceResource - An environment receives data from one or more event sources. Each event source has associated connection info that allows the Time Series Insights ingress pipeline to connect to and pull data from the event source

func (*EventSourceResource) GetEventSourceResource 

func (e *EventSourceResource) GetEventSourceResource() *EventSourceResource

GetEventSourceResource implements the EventSourceResourceClassification interface for type EventSourceResource.

type EventSourceResourceClassification 

type EventSourceResourceClassification interface {
	// GetEventSourceResource returns the EventSourceResource content of the underlying type.
	GetEventSourceResource() *EventSourceResource
}

EventSourceResourceClassification provides polymorphic access to related types. Call the interface's GetEventSourceResource() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EventHubEventSourceResource, *EventSourceResource, *IoTHubEventSourceResource

type EventSourceResourceKind 

type EventSourceResourceKind string

EventSourceResourceKind - The kind of the event source. 

const (
	EventSourceResourceKindMicrosoftEventHub EventSourceResourceKind = "Microsoft.EventHub"
	EventSourceResourceKindMicrosoftIoTHub   EventSourceResourceKind = "Microsoft.IoTHub"
)

func PossibleEventSourceResourceKindValues 

func PossibleEventSourceResourceKindValues() []EventSourceResourceKind

PossibleEventSourceResourceKindValues returns the possible values for the EventSourceResourceKind const type.

type EventSourceUpdateParameters 

type EventSourceUpdateParameters struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceKind `json:"kind,omitempty"`

	// Key-value pairs of additional properties for the event source.
	Tags map[string]*string `json:"tags,omitempty"`
}

EventSourceUpdateParameters - Parameters supplied to the Update Event Source operation.

func (*EventSourceUpdateParameters) GetEventSourceUpdateParameters 

func (e *EventSourceUpdateParameters) GetEventSourceUpdateParameters() *EventSourceUpdateParameters

GetEventSourceUpdateParameters implements the EventSourceUpdateParametersClassification interface for type EventSourceUpdateParameters.

func (EventSourceUpdateParameters) MarshalJSON 

func (e EventSourceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventSourceUpdateParameters.

type EventSourceUpdateParametersClassification 

type EventSourceUpdateParametersClassification interface {
	// GetEventSourceUpdateParameters returns the EventSourceUpdateParameters content of the underlying type.
	GetEventSourceUpdateParameters() *EventSourceUpdateParameters
}

EventSourceUpdateParametersClassification provides polymorphic access to related types. Call the interface's GetEventSourceUpdateParameters() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EventHubEventSourceUpdateParameters, *EventSourceUpdateParameters, *IoTHubEventSourceUpdateParameters

type EventSourcesClient 

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

EventSourcesClient contains the methods for the EventSources group. Don't use this type directly, use NewEventSourcesClient() instead.

func NewEventSourcesClient 

func NewEventSourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EventSourcesClient, error)

NewEventSourcesClient creates a new instance of EventSourcesClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EventSourcesClient) CreateOrUpdate 

func (client *EventSourcesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, eventSourceName string, parameters EventSourceCreateOrUpdateParametersClassification, options *EventSourcesClientCreateOrUpdateOptions) (EventSourcesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update an event source under the specified environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. eventSourceName - Name of the event source. parameters - Parameters for creating an event source resource. options - EventSourcesClientCreateOrUpdateOptions contains the optional parameters for the EventSourcesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEventSourcesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg1",
		"env1",
		"es1",
		&armtimeseriesinsights.EventHubEventSourceCreateOrUpdateParameters{
			Location: to.Ptr("West US"),
			Kind:     to.Ptr(armtimeseriesinsights.EventSourceKindMicrosoftEventHub),
			Properties: &armtimeseriesinsights.EventHubEventSourceCreationProperties{
				IngressStartAt: &armtimeseriesinsights.IngressStartAtProperties{
					Type: to.Ptr(armtimeseriesinsights.IngressStartAtTypeEarliestAvailable),
				},
				LocalTimestamp: &armtimeseriesinsights.LocalTimestamp{
					Format: to.Ptr(armtimeseriesinsights.LocalTimestampFormat("TimeSpan")),
					TimeZoneOffset: &armtimeseriesinsights.LocalTimestampTimeZoneOffset{
						PropertyName: to.Ptr("someEventPropertyName"),
					},
				},
				TimestampPropertyName: to.Ptr("someTimestampProperty"),
				EventSourceResourceID: to.Ptr("somePathInArm"),
				ConsumerGroupName:     to.Ptr("cgn"),
				EventHubName:          to.Ptr("ehn"),
				KeyName:               to.Ptr("managementKey"),
				ServiceBusNamespace:   to.Ptr("sbn"),
				SharedAccessKey:       to.Ptr("someSecretvalue"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EventSourcesClient) Delete 

func (client *EventSourcesClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, eventSourceName string, options *EventSourcesClientDeleteOptions) (EventSourcesClientDeleteResponse, error)

Delete - Deletes the event source with the specified name in the specified subscription, resource group, and environment If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. eventSourceName - The name of the Time Series Insights event source associated with the specified environment. options - EventSourcesClientDeleteOptions contains the optional parameters for the EventSourcesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEventSourcesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg1",
		"env1",
		"es1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*EventSourcesClient) Get 

func (client *EventSourcesClient) Get(ctx context.Context, resourceGroupName string, environmentName string, eventSourceName string, options *EventSourcesClientGetOptions) (EventSourcesClientGetResponse, error)

Get - Gets the event source with the specified name in the specified environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. eventSourceName - The name of the Time Series Insights event source associated with the specified environment. options - EventSourcesClientGetOptions contains the optional parameters for the EventSourcesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEventSourcesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"env1",
		"es1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EventSourcesClient) ListByEnvironment 

func (client *EventSourcesClient) ListByEnvironment(ctx context.Context, resourceGroupName string, environmentName string, options *EventSourcesClientListByEnvironmentOptions) (EventSourcesClientListByEnvironmentResponse, error)

ListByEnvironment - Lists all the available event sources associated with the subscription and within the specified resource group and environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. options - EventSourcesClientListByEnvironmentOptions contains the optional parameters for the EventSourcesClient.ListByEnvironment method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEventSourcesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByEnvironment(ctx,
		"rg1",
		"env1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*EventSourcesClient) Update 

func (client *EventSourcesClient) Update(ctx context.Context, resourceGroupName string, environmentName string, eventSourceName string, eventSourceUpdateParameters EventSourceUpdateParametersClassification, options *EventSourcesClientUpdateOptions) (EventSourcesClientUpdateResponse, error)

Update - Updates the event source with the specified name in the specified subscription, resource group, and environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. eventSourceName - The name of the Time Series Insights event source associated with the specified environment. eventSourceUpdateParameters - Request object that contains the updated information for the event source. options - EventSourcesClientUpdateOptions contains the optional parameters for the EventSourcesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewEventSourcesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg1",
		"env1",
		"es1",
		&armtimeseriesinsights.EventSourceUpdateParameters{
			Tags: map[string]*string{
				"someKey": to.Ptr("someValue"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type EventSourcesClientCreateOrUpdateOptions 

type EventSourcesClientCreateOrUpdateOptions struct {
}

EventSourcesClientCreateOrUpdateOptions contains the optional parameters for the EventSourcesClient.CreateOrUpdate method.

type EventSourcesClientCreateOrUpdateResponse 

type EventSourcesClientCreateOrUpdateResponse struct {
	EventSourceResourceClassification
}

EventSourcesClientCreateOrUpdateResponse contains the response from method EventSourcesClient.CreateOrUpdate.

func (*EventSourcesClientCreateOrUpdateResponse) UnmarshalJSON 

func (e *EventSourcesClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSourcesClientCreateOrUpdateResponse.

type EventSourcesClientDeleteOptions 

type EventSourcesClientDeleteOptions struct {
}

EventSourcesClientDeleteOptions contains the optional parameters for the EventSourcesClient.Delete method.

type EventSourcesClientDeleteResponse 

type EventSourcesClientDeleteResponse struct {
}

EventSourcesClientDeleteResponse contains the response from method EventSourcesClient.Delete.

type EventSourcesClientGetOptions 

type EventSourcesClientGetOptions struct {
}

EventSourcesClientGetOptions contains the optional parameters for the EventSourcesClient.Get method.

type EventSourcesClientGetResponse 

type EventSourcesClientGetResponse struct {
	EventSourceResourceClassification
}

EventSourcesClientGetResponse contains the response from method EventSourcesClient.Get.

func (*EventSourcesClientGetResponse) UnmarshalJSON 

func (e *EventSourcesClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSourcesClientGetResponse.

type EventSourcesClientListByEnvironmentOptions 

type EventSourcesClientListByEnvironmentOptions struct {
}

EventSourcesClientListByEnvironmentOptions contains the optional parameters for the EventSourcesClient.ListByEnvironment method.

type EventSourcesClientListByEnvironmentResponse 

type EventSourcesClientListByEnvironmentResponse struct {
	EventSourceListResponse
}

EventSourcesClientListByEnvironmentResponse contains the response from method EventSourcesClient.ListByEnvironment.

type EventSourcesClientUpdateOptions 

type EventSourcesClientUpdateOptions struct {
}

EventSourcesClientUpdateOptions contains the optional parameters for the EventSourcesClient.Update method.

type EventSourcesClientUpdateResponse 

type EventSourcesClientUpdateResponse struct {
	EventSourceResourceClassification
}

EventSourcesClientUpdateResponse contains the response from method EventSourcesClient.Update.

func (*EventSourcesClientUpdateResponse) UnmarshalJSON 

func (e *EventSourcesClientUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventSourcesClientUpdateResponse.

type Gen1EnvironmentCreateOrUpdateParameters 

type Gen1EnvironmentCreateOrUpdateParameters struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentKind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties used to create a Gen1 environment.
	Properties *Gen1EnvironmentCreationProperties `json:"properties,omitempty"`

	// REQUIRED; The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku
	// determines the capacity of the environment, the ingress rate, and the billing rate.
	SKU *SKU `json:"sku,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

Gen1EnvironmentCreateOrUpdateParameters - Parameters supplied to the Create or Update Environment operation for a Gen1 environment.

func (*Gen1EnvironmentCreateOrUpdateParameters) GetEnvironmentCreateOrUpdateParameters 

func (g *Gen1EnvironmentCreateOrUpdateParameters) GetEnvironmentCreateOrUpdateParameters() *EnvironmentCreateOrUpdateParameters

GetEnvironmentCreateOrUpdateParameters implements the EnvironmentCreateOrUpdateParametersClassification interface for type Gen1EnvironmentCreateOrUpdateParameters.

func (Gen1EnvironmentCreateOrUpdateParameters) MarshalJSON 

func (g Gen1EnvironmentCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen1EnvironmentCreateOrUpdateParameters.

func (*Gen1EnvironmentCreateOrUpdateParameters) UnmarshalJSON 

func (g *Gen1EnvironmentCreateOrUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen1EnvironmentCreateOrUpdateParameters.

type Gen1EnvironmentCreationProperties 

type Gen1EnvironmentCreationProperties struct {
	// REQUIRED; ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
	DataRetentionTime *string `json:"dataRetentionTime,omitempty"`

	// The list of event properties which will be used to partition data in the environment. Currently, only a single partition
	// key property is supported.
	PartitionKeyProperties []*TimeSeriesIDProperty `json:"partitionKeyProperties,omitempty"`

	// The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress"
	// is specified, new events will not be read from the event source. If
	// "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The
	// default behavior is PurgeOldData.
	StorageLimitExceededBehavior *StorageLimitExceededBehavior `json:"storageLimitExceededBehavior,omitempty"`
}

Gen1EnvironmentCreationProperties - Properties used to create a Gen1 environment.

func (Gen1EnvironmentCreationProperties) MarshalJSON 

func (g Gen1EnvironmentCreationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen1EnvironmentCreationProperties.

type Gen1EnvironmentMutableProperties 

type Gen1EnvironmentMutableProperties struct {
	// ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
	DataRetentionTime *string `json:"dataRetentionTime,omitempty"`

	// The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress"
	// is specified, new events will not be read from the event source. If
	// "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The
	// default behavior is PurgeOldData.
	StorageLimitExceededBehavior *StorageLimitExceededBehavior `json:"storageLimitExceededBehavior,omitempty"`
}

Gen1EnvironmentMutableProperties - An object that represents a set of mutable Gen1 environment resource properties.

type Gen1EnvironmentResource 

type Gen1EnvironmentResource struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentResourceKind `json:"kind,omitempty"`

	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the Gen1 environment.
	Properties *Gen1EnvironmentResourceProperties `json:"properties,omitempty"`

	// REQUIRED; The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku
	// determines the capacity of the environment, the ingress rate, and the billing rate.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Gen1EnvironmentResource - An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1 environments have data retention limits.

func (*Gen1EnvironmentResource) GetEnvironmentResource 

func (g *Gen1EnvironmentResource) GetEnvironmentResource() *EnvironmentResource

GetEnvironmentResource implements the EnvironmentResourceClassification interface for type Gen1EnvironmentResource.

func (*Gen1EnvironmentResource) UnmarshalJSON 

func (g *Gen1EnvironmentResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen1EnvironmentResource.

type Gen1EnvironmentResourceProperties 

type Gen1EnvironmentResourceProperties struct {
	// REQUIRED; ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
	DataRetentionTime *string `json:"dataRetentionTime,omitempty"`

	// The list of event properties which will be used to partition data in the environment. Currently, only a single partition
	// key property is supported.
	PartitionKeyProperties []*TimeSeriesIDProperty `json:"partitionKeyProperties,omitempty"`

	// The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress"
	// is specified, new events will not be read from the event source. If
	// "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The
	// default behavior is PurgeOldData.
	StorageLimitExceededBehavior *StorageLimitExceededBehavior `json:"storageLimitExceededBehavior,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; The fully qualified domain name used to access the environment data, e.g. to query the environment's events
	// or upload reference data for the environment.
	DataAccessFqdn *string `json:"dataAccessFqdn,omitempty" azure:"ro"`

	// READ-ONLY; An id used to access the environment data, e.g. to query the environment's events or upload reference data for
	// the environment.
	DataAccessID *string `json:"dataAccessId,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; An object that represents the status of the environment, and its internal state in the Time Series Insights
	// service.
	Status *EnvironmentStatus `json:"status,omitempty" azure:"ro"`
}

Gen1EnvironmentResourceProperties - Properties of the Gen1 environment.

func (Gen1EnvironmentResourceProperties) MarshalJSON 

func (g Gen1EnvironmentResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen1EnvironmentResourceProperties.

func (*Gen1EnvironmentResourceProperties) UnmarshalJSON 

func (g *Gen1EnvironmentResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen1EnvironmentResourceProperties.

type Gen1EnvironmentUpdateParameters 

type Gen1EnvironmentUpdateParameters struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentKind `json:"kind,omitempty"`

	// Properties of the Gen1 environment.
	Properties *Gen1EnvironmentMutableProperties `json:"properties,omitempty"`

	// The sku of the environment.
	SKU *SKU `json:"sku,omitempty"`

	// Key-value pairs of additional properties for the environment.
	Tags map[string]*string `json:"tags,omitempty"`
}

Gen1EnvironmentUpdateParameters - Parameters supplied to the Update Environment operation to update a Gen1 environment.

func (*Gen1EnvironmentUpdateParameters) GetEnvironmentUpdateParameters 

func (g *Gen1EnvironmentUpdateParameters) GetEnvironmentUpdateParameters() *EnvironmentUpdateParameters

GetEnvironmentUpdateParameters implements the EnvironmentUpdateParametersClassification interface for type Gen1EnvironmentUpdateParameters.

func (Gen1EnvironmentUpdateParameters) MarshalJSON 

func (g Gen1EnvironmentUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen1EnvironmentUpdateParameters.

func (*Gen1EnvironmentUpdateParameters) UnmarshalJSON 

func (g *Gen1EnvironmentUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen1EnvironmentUpdateParameters.

type Gen2EnvironmentCreateOrUpdateParameters 

type Gen2EnvironmentCreateOrUpdateParameters struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentKind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties used to create a Gen2 environment.
	Properties *Gen2EnvironmentCreationProperties `json:"properties,omitempty"`

	// REQUIRED; The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku
	// determines the capacity of the environment, the ingress rate, and the billing rate.
	SKU *SKU `json:"sku,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

Gen2EnvironmentCreateOrUpdateParameters - Parameters supplied to the Create or Update Environment operation for a Gen2 environment.

func (*Gen2EnvironmentCreateOrUpdateParameters) GetEnvironmentCreateOrUpdateParameters 

func (g *Gen2EnvironmentCreateOrUpdateParameters) GetEnvironmentCreateOrUpdateParameters() *EnvironmentCreateOrUpdateParameters

GetEnvironmentCreateOrUpdateParameters implements the EnvironmentCreateOrUpdateParametersClassification interface for type Gen2EnvironmentCreateOrUpdateParameters.

func (Gen2EnvironmentCreateOrUpdateParameters) MarshalJSON 

func (g Gen2EnvironmentCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen2EnvironmentCreateOrUpdateParameters.

func (*Gen2EnvironmentCreateOrUpdateParameters) UnmarshalJSON 

func (g *Gen2EnvironmentCreateOrUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen2EnvironmentCreateOrUpdateParameters.

type Gen2EnvironmentCreationProperties 

type Gen2EnvironmentCreationProperties struct {
	// REQUIRED; The storage configuration provides the connection details that allows the Time Series Insights service to connect
	// to the customer storage account that is used to store the environment's data.
	StorageConfiguration *Gen2StorageConfigurationInput `json:"storageConfiguration,omitempty"`

	// REQUIRED; The list of event properties which will be used to define the environment's time series id.
	TimeSeriesIDProperties []*TimeSeriesIDProperty `json:"timeSeriesIdProperties,omitempty"`

	// The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's
	// data available for faster query.
	WarmStoreConfiguration *WarmStoreConfigurationProperties `json:"warmStoreConfiguration,omitempty"`
}

Gen2EnvironmentCreationProperties - Properties used to create a Gen2 environment.

func (Gen2EnvironmentCreationProperties) MarshalJSON 

func (g Gen2EnvironmentCreationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen2EnvironmentCreationProperties.

type Gen2EnvironmentMutableProperties 

type Gen2EnvironmentMutableProperties struct {
	// The storage configuration provides the connection details that allows the Time Series Insights service to connect to the
	// customer storage account that is used to store the environment's data.
	StorageConfiguration *Gen2StorageConfigurationMutableProperties `json:"storageConfiguration,omitempty"`

	// The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's
	// data available for faster query.
	WarmStoreConfiguration *WarmStoreConfigurationProperties `json:"warmStoreConfiguration,omitempty"`
}

Gen2EnvironmentMutableProperties - An object that represents a set of mutable Gen2 environment resource properties.

type Gen2EnvironmentResource 

type Gen2EnvironmentResource struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentResourceKind `json:"kind,omitempty"`

	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the Gen2 environment.
	Properties *Gen2EnvironmentResourceProperties `json:"properties,omitempty"`

	// REQUIRED; The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku
	// determines the capacity of the environment, the ingress rate, and the billing rate.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Gen2EnvironmentResource - An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen2 environments do not have set data retention limits.

func (*Gen2EnvironmentResource) GetEnvironmentResource 

func (g *Gen2EnvironmentResource) GetEnvironmentResource() *EnvironmentResource

GetEnvironmentResource implements the EnvironmentResourceClassification interface for type Gen2EnvironmentResource.

func (*Gen2EnvironmentResource) UnmarshalJSON 

func (g *Gen2EnvironmentResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen2EnvironmentResource.

type Gen2EnvironmentResourceProperties 

type Gen2EnvironmentResourceProperties struct {
	// REQUIRED; The storage configuration provides the connection details that allows the Time Series Insights service to connect
	// to the customer storage account that is used to store the environment's data.
	StorageConfiguration *Gen2StorageConfigurationOutput `json:"storageConfiguration,omitempty"`

	// REQUIRED; The list of event properties which will be used to define the environment's time series id.
	TimeSeriesIDProperties []*TimeSeriesIDProperty `json:"timeSeriesIdProperties,omitempty"`

	// The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's
	// data available for faster query.
	WarmStoreConfiguration *WarmStoreConfigurationProperties `json:"warmStoreConfiguration,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; The fully qualified domain name used to access the environment data, e.g. to query the environment's events
	// or upload reference data for the environment.
	DataAccessFqdn *string `json:"dataAccessFqdn,omitempty" azure:"ro"`

	// READ-ONLY; An id used to access the environment data, e.g. to query the environment's events or upload reference data for
	// the environment.
	DataAccessID *string `json:"dataAccessId,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; An object that represents the status of the environment, and its internal state in the Time Series Insights
	// service.
	Status *EnvironmentStatus `json:"status,omitempty" azure:"ro"`
}

Gen2EnvironmentResourceProperties - Properties of the Gen2 environment.

func (Gen2EnvironmentResourceProperties) MarshalJSON 

func (g Gen2EnvironmentResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen2EnvironmentResourceProperties.

func (*Gen2EnvironmentResourceProperties) UnmarshalJSON 

func (g *Gen2EnvironmentResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen2EnvironmentResourceProperties.

type Gen2EnvironmentUpdateParameters 

type Gen2EnvironmentUpdateParameters struct {
	// REQUIRED; The kind of the environment.
	Kind *EnvironmentKind `json:"kind,omitempty"`

	// Properties of the Gen2 environment.
	Properties *Gen2EnvironmentMutableProperties `json:"properties,omitempty"`

	// Key-value pairs of additional properties for the environment.
	Tags map[string]*string `json:"tags,omitempty"`
}

Gen2EnvironmentUpdateParameters - Parameters supplied to the Update Environment operation to update a Gen2 environment.

func (*Gen2EnvironmentUpdateParameters) GetEnvironmentUpdateParameters 

func (g *Gen2EnvironmentUpdateParameters) GetEnvironmentUpdateParameters() *EnvironmentUpdateParameters

GetEnvironmentUpdateParameters implements the EnvironmentUpdateParametersClassification interface for type Gen2EnvironmentUpdateParameters.

func (Gen2EnvironmentUpdateParameters) MarshalJSON 

func (g Gen2EnvironmentUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Gen2EnvironmentUpdateParameters.

func (*Gen2EnvironmentUpdateParameters) UnmarshalJSON 

func (g *Gen2EnvironmentUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Gen2EnvironmentUpdateParameters.

type Gen2StorageConfigurationInput 

type Gen2StorageConfigurationInput struct {
	// REQUIRED; The name of the storage account that will hold the environment's Gen2 data.
	AccountName *string `json:"accountName,omitempty"`

	// REQUIRED; The value of the management key that grants the Time Series Insights service write access to the storage account.
	// This property is not shown in environment responses.
	ManagementKey *string `json:"managementKey,omitempty"`
}

Gen2StorageConfigurationInput - The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.

type Gen2StorageConfigurationMutableProperties 

type Gen2StorageConfigurationMutableProperties struct {
	// REQUIRED; The value of the management key that grants the Time Series Insights service write access to the storage account.
	// This property is not shown in environment responses.
	ManagementKey *string `json:"managementKey,omitempty"`
}

Gen2StorageConfigurationMutableProperties - The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.

type Gen2StorageConfigurationOutput 

type Gen2StorageConfigurationOutput struct {
	// REQUIRED; The name of the storage account that will hold the environment's Gen2 data.
	AccountName *string `json:"accountName,omitempty"`
}

Gen2StorageConfigurationOutput - The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data.

type IngressEnvironmentStatus 

type IngressEnvironmentStatus struct {
	// This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused"
	// or "Unknown"
	State *IngressState `json:"state,omitempty"`

	// READ-ONLY; An object that contains the details about an environment's state.
	StateDetails *EnvironmentStateDetails `json:"stateDetails,omitempty" azure:"ro"`
}

IngressEnvironmentStatus - An object that represents the status of ingress on an environment.

type IngressStartAtProperties 

type IngressStartAtProperties struct {
	// ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the
	// starting point for Events to be consumed.
	Time *string `json:"time,omitempty"`

	// The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
	Type *IngressStartAtType `json:"type,omitempty"`
}

IngressStartAtProperties - An object that contains the details about the starting point in time to ingest events.

type IngressStartAtType 

type IngressStartAtType string

IngressStartAtType - The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". 

const (
	IngressStartAtTypeCustomEnqueuedTime      IngressStartAtType = "CustomEnqueuedTime"
	IngressStartAtTypeEarliestAvailable       IngressStartAtType = "EarliestAvailable"
	IngressStartAtTypeEventSourceCreationTime IngressStartAtType = "EventSourceCreationTime"
)

func PossibleIngressStartAtTypeValues 

func PossibleIngressStartAtTypeValues() []IngressStartAtType

PossibleIngressStartAtTypeValues returns the possible values for the IngressStartAtType const type.

type IngressState 

type IngressState string

IngressState - This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown" 

const (
	IngressStateDisabled IngressState = "Disabled"
	IngressStatePaused   IngressState = "Paused"
	IngressStateReady    IngressState = "Ready"
	IngressStateRunning  IngressState = "Running"
	IngressStateUnknown  IngressState = "Unknown"
)

func PossibleIngressStateValues 

func PossibleIngressStateValues() []IngressState

PossibleIngressStateValues returns the possible values for the IngressState const type.

type IoTHubEventSourceCommonProperties 

type IoTHubEventSourceCommonProperties struct {
	// REQUIRED; The name of the iot hub's consumer group that holds the partitions from which events will be read.
	ConsumerGroupName *string `json:"consumerGroupName,omitempty"`

	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// REQUIRED; The name of the iot hub.
	IotHubName *string `json:"iotHubName,omitempty"`

	// REQUIRED; The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub.
	// This shared access policy key must grant 'service connect' permissions to the iot hub.
	KeyName *string `json:"keyName,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IoTHubEventSourceCommonProperties - Properties of the IoTHub event source.

func (IoTHubEventSourceCommonProperties) MarshalJSON 

func (i IoTHubEventSourceCommonProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTHubEventSourceCommonProperties.

func (*IoTHubEventSourceCommonProperties) UnmarshalJSON 

func (i *IoTHubEventSourceCommonProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTHubEventSourceCommonProperties.

type IoTHubEventSourceCreateOrUpdateParameters 

type IoTHubEventSourceCreateOrUpdateParameters struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceKind `json:"kind,omitempty"`

	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the IoTHub event source that are required on create or update requests.
	Properties *IoTHubEventSourceCreationProperties `json:"properties,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

IoTHubEventSourceCreateOrUpdateParameters - Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.

func (*IoTHubEventSourceCreateOrUpdateParameters) GetEventSourceCreateOrUpdateParameters 

func (i *IoTHubEventSourceCreateOrUpdateParameters) GetEventSourceCreateOrUpdateParameters() *EventSourceCreateOrUpdateParameters

GetEventSourceCreateOrUpdateParameters implements the EventSourceCreateOrUpdateParametersClassification interface for type IoTHubEventSourceCreateOrUpdateParameters.

func (IoTHubEventSourceCreateOrUpdateParameters) MarshalJSON 

func (i IoTHubEventSourceCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTHubEventSourceCreateOrUpdateParameters.

func (*IoTHubEventSourceCreateOrUpdateParameters) UnmarshalJSON 

func (i *IoTHubEventSourceCreateOrUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTHubEventSourceCreateOrUpdateParameters.

type IoTHubEventSourceCreationProperties 

type IoTHubEventSourceCreationProperties struct {
	// REQUIRED; The name of the iot hub's consumer group that holds the partitions from which events will be read.
	ConsumerGroupName *string `json:"consumerGroupName,omitempty"`

	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// REQUIRED; The name of the iot hub.
	IotHubName *string `json:"iotHubName,omitempty"`

	// REQUIRED; The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub.
	// This shared access policy key must grant 'service connect' permissions to the iot hub.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot
	// hub. This property is not shown in event source responses.
	SharedAccessKey *string `json:"sharedAccessKey,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IoTHubEventSourceCreationProperties - Properties of the IoTHub event source that are required on create or update requests.

func (IoTHubEventSourceCreationProperties) MarshalJSON 

func (i IoTHubEventSourceCreationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTHubEventSourceCreationProperties.

func (*IoTHubEventSourceCreationProperties) UnmarshalJSON 

func (i *IoTHubEventSourceCreationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTHubEventSourceCreationProperties.

type IoTHubEventSourceMutableProperties 

type IoTHubEventSourceMutableProperties struct {
	// The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property
	// is not shown in event source responses.
	SharedAccessKey *string `json:"sharedAccessKey,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`
}

IoTHubEventSourceMutableProperties - An object that represents a set of mutable IoTHub event source resource properties.

type IoTHubEventSourceResource 

type IoTHubEventSourceResource struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceResourceKind `json:"kind,omitempty"`

	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the IoTHub event source resource.
	Properties *IoTHubEventSourceResourceProperties `json:"properties,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

IoTHubEventSourceResource - An event source that receives its data from an Azure IoTHub.

func (*IoTHubEventSourceResource) GetEventSourceResource 

func (i *IoTHubEventSourceResource) GetEventSourceResource() *EventSourceResource

GetEventSourceResource implements the EventSourceResourceClassification interface for type IoTHubEventSourceResource.

func (*IoTHubEventSourceResource) UnmarshalJSON 

func (i *IoTHubEventSourceResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTHubEventSourceResource.

type IoTHubEventSourceResourceProperties 

type IoTHubEventSourceResourceProperties struct {
	// REQUIRED; The name of the iot hub's consumer group that holds the partitions from which events will be read.
	ConsumerGroupName *string `json:"consumerGroupName,omitempty"`

	// REQUIRED; The resource id of the event source in Azure Resource Manager.
	EventSourceResourceID *string `json:"eventSourceResourceId,omitempty"`

	// REQUIRED; The name of the iot hub.
	IotHubName *string `json:"iotHubName,omitempty"`

	// REQUIRED; The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub.
	// This shared access policy key must grant 'service connect' permissions to the iot hub.
	KeyName *string `json:"keyName,omitempty"`

	// An object that contains the details about the starting point in time to ingest events.
	IngressStartAt *IngressStartAtProperties `json:"ingressStartAt,omitempty"`

	// An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used
	// and the corresponding timezone offset information. If a value isn't specified
	// for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
	LocalTimestamp *LocalTimestamp `json:"localTimestamp,omitempty"`

	// The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName,
	// or if null or empty-string is specified, the event creation time will be
	// used.
	TimestampPropertyName *string `json:"timestampPropertyName,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IoTHubEventSourceResourceProperties - Properties of the IoTHub event source resource.

func (IoTHubEventSourceResourceProperties) MarshalJSON 

func (i IoTHubEventSourceResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTHubEventSourceResourceProperties.

func (*IoTHubEventSourceResourceProperties) UnmarshalJSON 

func (i *IoTHubEventSourceResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTHubEventSourceResourceProperties.

type IoTHubEventSourceUpdateParameters 

type IoTHubEventSourceUpdateParameters struct {
	// REQUIRED; The kind of the event source.
	Kind *EventSourceKind `json:"kind,omitempty"`

	// Properties of the IoTHub event source.
	Properties *IoTHubEventSourceMutableProperties `json:"properties,omitempty"`

	// Key-value pairs of additional properties for the event source.
	Tags map[string]*string `json:"tags,omitempty"`
}

IoTHubEventSourceUpdateParameters - Parameters supplied to the Update Event Source operation to update an IoTHub event source.

func (*IoTHubEventSourceUpdateParameters) GetEventSourceUpdateParameters 

func (i *IoTHubEventSourceUpdateParameters) GetEventSourceUpdateParameters() *EventSourceUpdateParameters

GetEventSourceUpdateParameters implements the EventSourceUpdateParametersClassification interface for type IoTHubEventSourceUpdateParameters.

func (IoTHubEventSourceUpdateParameters) MarshalJSON 

func (i IoTHubEventSourceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IoTHubEventSourceUpdateParameters.

func (*IoTHubEventSourceUpdateParameters) UnmarshalJSON 

func (i *IoTHubEventSourceUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IoTHubEventSourceUpdateParameters.

type LocalTimestamp 

type LocalTimestamp struct {
	// An enum that represents the format of the local timestamp property that needs to be set.
	Format *LocalTimestampFormat `json:"format,omitempty"`

	// An object that represents the offset information for the local timestamp format specified. Should not be specified for
	// LocalTimestampFormat - Embedded.
	TimeZoneOffset *LocalTimestampTimeZoneOffset `json:"timeZoneOffset,omitempty"`
}

LocalTimestamp - An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

type LocalTimestampFormat 

type LocalTimestampFormat string

LocalTimestampFormat - An enum that represents the format of the local timestamp property that needs to be set. 

const (
	LocalTimestampFormatEmbedded LocalTimestampFormat = "Embedded"
)

func PossibleLocalTimestampFormatValues 

func PossibleLocalTimestampFormatValues() []LocalTimestampFormat

PossibleLocalTimestampFormatValues returns the possible values for the LocalTimestampFormat const type.

type LocalTimestampTimeZoneOffset 

type LocalTimestampTimeZoneOffset struct {
	// The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat
	// is Iana, the property name will contain the name of the column which
	// contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of
	// property which contains values representing the offset (eg: P1D or 1.00:00:00)
	PropertyName *string `json:"propertyName,omitempty"`
}

LocalTimestampTimeZoneOffset - An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

type LogSpecification 

type LogSpecification struct {
	// Log display name.
	DisplayName *string `json:"displayName,omitempty"`

	// Log name.
	Name *string `json:"name,omitempty"`
}

LogSpecification - The specification of an Azure Monitoring log.

type MetricAvailability 

type MetricAvailability struct {
	BlobDuration *string `json:"blobDuration,omitempty"`
	TimeGrain    *string `json:"timeGrain,omitempty"`
}

MetricAvailability - Retention policy of a resource metric.

type MetricSpecification 

type MetricSpecification struct {
	// Aggregation type could be Average.
	AggregationType *string `json:"aggregationType,omitempty"`

	// Retention policies of a resource metric.
	Availabilities []*MetricAvailability `json:"availabilities,omitempty"`

	// The category this metric specification belong to, could be Capacity.
	Category *string `json:"category,omitempty"`

	// Dimensions of blobs, including blob type and access tier.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

	// Display description of metric specification.
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// Display name of metric specification.
	DisplayName *string `json:"displayName,omitempty"`

	// Name of metric specification.
	Name *string `json:"name,omitempty"`

	// Account Resource Id.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`

	// Unit could be Bytes or Count.
	Unit *string `json:"unit,omitempty"`
}

MetricSpecification - Metric specification of operation.

type Operation 

type Operation struct {
	// Properties of operation, include metric specifications.
	OperationProperties *OperationProperties `json:"properties,omitempty"`

	// The intended executor of the operation.
	Origin *string `json:"origin,omitempty"`

	// READ-ONLY; Contains the localized display information for this particular operation / action.
	Display *OperationDisplay `json:"display,omitempty" azure:"ro"`

	// READ-ONLY; The name of the operation being performed on this particular object.
	Name *string `json:"name,omitempty" azure:"ro"`
}

Operation - A Time Series Insights REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The localized friendly description for the operation.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The localized friendly name for the operation.
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; The localized friendly form of the resource provider name.
	Provider *string `json:"provider,omitempty" azure:"ro"`

	// READ-ONLY; The localized friendly form of the resource type related to this action/operation.
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

OperationDisplay - Contains the localized display information for this particular operation / action.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of Time Series Insights operations supported by the Microsoft.TimeSeriesInsights resource provider.
	Value []*Operation `json:"value,omitempty" azure:"ro"`
}

OperationListResult - Result of the request to list Time Series Insights operations. It contains a list of operations and a URL link to get the next set of results.

type OperationProperties 

type OperationProperties struct {
	// One property of operation, include metric specifications.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - Properties of operation, include metric specifications.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available Time Series Insights related operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PropertyType 

type PropertyType string

PropertyType - The type of the property. 

const (
	PropertyTypeString PropertyType = "String"
)

func PossiblePropertyTypeValues 

func PossiblePropertyTypeValues() []PropertyType

PossiblePropertyTypeValues returns the possible values for the PropertyType const type.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the resource. 

const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ReferenceDataKeyPropertyType 

type ReferenceDataKeyPropertyType string

ReferenceDataKeyPropertyType - The type of the key property. 

const (
	ReferenceDataKeyPropertyTypeBool     ReferenceDataKeyPropertyType = "Bool"
	ReferenceDataKeyPropertyTypeDateTime ReferenceDataKeyPropertyType = "DateTime"
	ReferenceDataKeyPropertyTypeDouble   ReferenceDataKeyPropertyType = "Double"
	ReferenceDataKeyPropertyTypeString   ReferenceDataKeyPropertyType = "String"
)

func PossibleReferenceDataKeyPropertyTypeValues 

func PossibleReferenceDataKeyPropertyTypeValues() []ReferenceDataKeyPropertyType

PossibleReferenceDataKeyPropertyTypeValues returns the possible values for the ReferenceDataKeyPropertyType const type.

type ReferenceDataSetCreateOrUpdateParameters 

type ReferenceDataSetCreateOrUpdateParameters struct {
	// REQUIRED; The location of the resource.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties used to create a reference data set.
	Properties *ReferenceDataSetCreationProperties `json:"properties,omitempty"`

	// Key-value pairs of additional properties for the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

func (ReferenceDataSetCreateOrUpdateParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ReferenceDataSetCreateOrUpdateParameters.

type ReferenceDataSetCreationProperties 

type ReferenceDataSetCreationProperties struct {
	// REQUIRED; The list of key properties for the reference data set.
	KeyProperties []*ReferenceDataSetKeyProperty `json:"keyProperties,omitempty"`

	// The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which
	// means case sensitive key comparison will be performed while joining reference
	// data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will
	// be used.
	DataStringComparisonBehavior *DataStringComparisonBehavior `json:"dataStringComparisonBehavior,omitempty"`
}

ReferenceDataSetCreationProperties - Properties used to create a reference data set.

func (ReferenceDataSetCreationProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ReferenceDataSetCreationProperties.

type ReferenceDataSetKeyProperty 

type ReferenceDataSetKeyProperty struct {
	// The name of the key property.
	Name *string `json:"name,omitempty"`

	// The type of the key property.
	Type *ReferenceDataKeyPropertyType `json:"type,omitempty"`
}

ReferenceDataSetKeyProperty - A key property for the reference data set. A reference data set can have multiple key properties.

type ReferenceDataSetListResponse 

type ReferenceDataSetListResponse struct {
	// Result of the List Reference Data Sets operation.
	Value []*ReferenceDataSetResource `json:"value,omitempty"`
}

ReferenceDataSetListResponse - The response of the List Reference Data Sets operation.

type ReferenceDataSetResource 

type ReferenceDataSetResource struct {
	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// Properties of the reference data set.
	Properties *ReferenceDataSetResourceProperties `json:"properties,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

ReferenceDataSetResource - A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs.

type ReferenceDataSetResourceProperties 

type ReferenceDataSetResourceProperties struct {
	// REQUIRED; The list of key properties for the reference data set.
	KeyProperties []*ReferenceDataSetKeyProperty `json:"keyProperties,omitempty"`

	// The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which
	// means case sensitive key comparison will be performed while joining reference
	// data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will
	// be used.
	DataStringComparisonBehavior *DataStringComparisonBehavior `json:"dataStringComparisonBehavior,omitempty"`

	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ReferenceDataSetResourceProperties - Properties of the reference data set.

func (ReferenceDataSetResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ReferenceDataSetResourceProperties.

func (*ReferenceDataSetResourceProperties) UnmarshalJSON 

func (r *ReferenceDataSetResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReferenceDataSetResourceProperties.

type ReferenceDataSetUpdateParameters 

type ReferenceDataSetUpdateParameters struct {
	// Key-value pairs of additional properties for the reference data set.
	Tags map[string]*string `json:"tags,omitempty"`
}

ReferenceDataSetUpdateParameters - Parameters supplied to the Update Reference Data Set operation.

func (ReferenceDataSetUpdateParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ReferenceDataSetUpdateParameters.

type ReferenceDataSetsClient 

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

ReferenceDataSetsClient contains the methods for the ReferenceDataSets group. Don't use this type directly, use NewReferenceDataSetsClient() instead.

func NewReferenceDataSetsClient 

func NewReferenceDataSetsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ReferenceDataSetsClient, error)

NewReferenceDataSetsClient creates a new instance of ReferenceDataSetsClient with the specified values. subscriptionID - Azure Subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ReferenceDataSetsClient) CreateOrUpdate 

func (client *ReferenceDataSetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, referenceDataSetName string, parameters ReferenceDataSetCreateOrUpdateParameters, options *ReferenceDataSetsClientCreateOrUpdateOptions) (ReferenceDataSetsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update a reference data set in the specified environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. referenceDataSetName - Name of the reference data set. parameters - Parameters for creating a reference data set. options - ReferenceDataSetsClientCreateOrUpdateOptions contains the optional parameters for the ReferenceDataSetsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewReferenceDataSetsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg1",
		"env1",
		"rds1",
		armtimeseriesinsights.ReferenceDataSetCreateOrUpdateParameters{
			Location: to.Ptr("West US"),
			Properties: &armtimeseriesinsights.ReferenceDataSetCreationProperties{
				KeyProperties: []*armtimeseriesinsights.ReferenceDataSetKeyProperty{
					{
						Name: to.Ptr("DeviceId1"),
						Type: to.Ptr(armtimeseriesinsights.ReferenceDataKeyPropertyTypeString),
					},
					{
						Name: to.Ptr("DeviceFloor"),
						Type: to.Ptr(armtimeseriesinsights.ReferenceDataKeyPropertyTypeDouble),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ReferenceDataSetsClient) Delete 

func (client *ReferenceDataSetsClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, referenceDataSetName string, options *ReferenceDataSetsClientDeleteOptions) (ReferenceDataSetsClientDeleteResponse, error)

Delete - Deletes the reference data set with the specified name in the specified subscription, resource group, and environment If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. referenceDataSetName - The name of the Time Series Insights reference data set associated with the specified environment. options - ReferenceDataSetsClientDeleteOptions contains the optional parameters for the ReferenceDataSetsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewReferenceDataSetsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg1",
		"env1",
		"rds1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ReferenceDataSetsClient) Get 

func (client *ReferenceDataSetsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, referenceDataSetName string, options *ReferenceDataSetsClientGetOptions) (ReferenceDataSetsClientGetResponse, error)

Get - Gets the reference data set with the specified name in the specified environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. referenceDataSetName - The name of the Time Series Insights reference data set associated with the specified environment. options - ReferenceDataSetsClientGetOptions contains the optional parameters for the ReferenceDataSetsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewReferenceDataSetsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"env1",
		"rds1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ReferenceDataSetsClient) ListByEnvironment 

func (client *ReferenceDataSetsClient) ListByEnvironment(ctx context.Context, resourceGroupName string, environmentName string, options *ReferenceDataSetsClientListByEnvironmentOptions) (ReferenceDataSetsClientListByEnvironmentResponse, error)

ListByEnvironment - Lists all the available reference data sets associated with the subscription and within the specified resource group and environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. options - ReferenceDataSetsClientListByEnvironmentOptions contains the optional parameters for the ReferenceDataSetsClient.ListByEnvironment method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsListByEnvironment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewReferenceDataSetsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByEnvironment(ctx,
		"rg1",
		"env1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ReferenceDataSetsClient) Update 

func (client *ReferenceDataSetsClient) Update(ctx context.Context, resourceGroupName string, environmentName string, referenceDataSetName string, referenceDataSetUpdateParameters ReferenceDataSetUpdateParameters, options *ReferenceDataSetsClientUpdateOptions) (ReferenceDataSetsClientUpdateResponse, error)

Update - Updates the reference data set with the specified name in the specified subscription, resource group, and environment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-05-15 resourceGroupName - Name of an Azure Resource group. environmentName - The name of the Time Series Insights environment associated with the specified resource group. referenceDataSetName - The name of the Time Series Insights reference data set associated with the specified environment. referenceDataSetUpdateParameters - Request object that contains the updated information for the reference data set. options - ReferenceDataSetsClientUpdateOptions contains the optional parameters for the ReferenceDataSetsClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsPatchTags.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armtimeseriesinsights.NewReferenceDataSetsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg1",
		"env1",
		"rds1",
		armtimeseriesinsights.ReferenceDataSetUpdateParameters{
			Tags: map[string]*string{
				"someKey": to.Ptr("someValue"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type ReferenceDataSetsClientCreateOrUpdateOptions 

type ReferenceDataSetsClientCreateOrUpdateOptions struct {
}

ReferenceDataSetsClientCreateOrUpdateOptions contains the optional parameters for the ReferenceDataSetsClient.CreateOrUpdate method.

type ReferenceDataSetsClientCreateOrUpdateResponse 

type ReferenceDataSetsClientCreateOrUpdateResponse struct {
	ReferenceDataSetResource
}

ReferenceDataSetsClientCreateOrUpdateResponse contains the response from method ReferenceDataSetsClient.CreateOrUpdate.

type ReferenceDataSetsClientDeleteOptions 

type ReferenceDataSetsClientDeleteOptions struct {
}

ReferenceDataSetsClientDeleteOptions contains the optional parameters for the ReferenceDataSetsClient.Delete method.

type ReferenceDataSetsClientDeleteResponse 

type ReferenceDataSetsClientDeleteResponse struct {
}

ReferenceDataSetsClientDeleteResponse contains the response from method ReferenceDataSetsClient.Delete.

type ReferenceDataSetsClientGetOptions 

type ReferenceDataSetsClientGetOptions struct {
}

ReferenceDataSetsClientGetOptions contains the optional parameters for the ReferenceDataSetsClient.Get method.

type ReferenceDataSetsClientGetResponse 

type ReferenceDataSetsClientGetResponse struct {
	ReferenceDataSetResource
}

ReferenceDataSetsClientGetResponse contains the response from method ReferenceDataSetsClient.Get.

type ReferenceDataSetsClientListByEnvironmentOptions 

type ReferenceDataSetsClientListByEnvironmentOptions struct {
}

ReferenceDataSetsClientListByEnvironmentOptions contains the optional parameters for the ReferenceDataSetsClient.ListByEnvironment method.

type ReferenceDataSetsClientListByEnvironmentResponse 

type ReferenceDataSetsClientListByEnvironmentResponse struct {
	ReferenceDataSetListResponse
}

ReferenceDataSetsClientListByEnvironmentResponse contains the response from method ReferenceDataSetsClient.ListByEnvironment.

type ReferenceDataSetsClientUpdateOptions 

type ReferenceDataSetsClientUpdateOptions struct {
}

ReferenceDataSetsClientUpdateOptions contains the optional parameters for the ReferenceDataSetsClient.Update method.

type ReferenceDataSetsClientUpdateResponse 

type ReferenceDataSetsClientUpdateResponse struct {
	ReferenceDataSetResource
}

ReferenceDataSetsClientUpdateResponse contains the response from method ReferenceDataSetsClient.Update.

type Resource 

type Resource struct {
	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Time Series Insights resource

type ResourceProperties 

type ResourceProperties struct {
	// READ-ONLY; The time the resource was created.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ResourceProperties - Properties that are common to all tracked resources.

func (ResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceProperties.

func (*ResourceProperties) UnmarshalJSON 

func (r *ResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProperties.

type SKU 

type SKU struct {
	// REQUIRED; The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments
	// after they have been created.
	Capacity *int32 `json:"capacity,omitempty"`

	// REQUIRED; The name of this SKU.
	Name *SKUName `json:"name,omitempty"`
}

SKU - The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

type SKUName 

type SKUName string

SKUName - The name of this SKU. 

const (
	SKUNameL1 SKUName = "L1"
	SKUNameP1 SKUName = "P1"
	SKUNameS1 SKUName = "S1"
	SKUNameS2 SKUName = "S2"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type ServiceSpecification 

type ServiceSpecification struct {
	// A list of Azure Monitoring log definitions.
	LogSpecifications []*LogSpecification `json:"logSpecifications,omitempty"`

	// Metric specifications of operation.
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification - One property of operation, include metric specifications.

type StorageLimitExceededBehavior 

type StorageLimitExceededBehavior string

StorageLimitExceededBehavior - The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. 

const (
	StorageLimitExceededBehaviorPauseIngress StorageLimitExceededBehavior = "PauseIngress"
	StorageLimitExceededBehaviorPurgeOldData StorageLimitExceededBehavior = "PurgeOldData"
)

func PossibleStorageLimitExceededBehaviorValues 

func PossibleStorageLimitExceededBehaviorValues() []StorageLimitExceededBehavior

PossibleStorageLimitExceededBehaviorValues returns the possible values for the StorageLimitExceededBehavior const type.

type TimeSeriesIDProperty 

type TimeSeriesIDProperty struct {
	// The name of the property.
	Name *string `json:"name,omitempty"`

	// The type of the property.
	Type *PropertyType `json:"type,omitempty"`
}

TimeSeriesIDProperty - The structure of the property that a time series id can have. An environment can have multiple such properties.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - Time Series Insights resource that is tracked by Azure Resource Manager.

type WarmStorageEnvironmentStatus 

type WarmStorageEnvironmentStatus struct {
	// READ-ONLY; An object that contains the status of warm storage properties usage.
	PropertiesUsage *WarmStoragePropertiesUsage `json:"propertiesUsage,omitempty" azure:"ro"`
}

WarmStorageEnvironmentStatus - An object that represents the status of warm storage on an environment.

type WarmStoragePropertiesState 

type WarmStoragePropertiesState string

WarmStoragePropertiesState - This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown". 

const (
	WarmStoragePropertiesStateError   WarmStoragePropertiesState = "Error"
	WarmStoragePropertiesStateOk      WarmStoragePropertiesState = "Ok"
	WarmStoragePropertiesStateUnknown WarmStoragePropertiesState = "Unknown"
)

func PossibleWarmStoragePropertiesStateValues 

func PossibleWarmStoragePropertiesStateValues() []WarmStoragePropertiesState

PossibleWarmStoragePropertiesStateValues returns the possible values for the WarmStoragePropertiesState const type.

type WarmStoragePropertiesUsage 

type WarmStoragePropertiesUsage struct {
	// This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
	State *WarmStoragePropertiesState `json:"state,omitempty"`

	// READ-ONLY; An object that contains the details about warm storage properties usage state.
	StateDetails *WarmStoragePropertiesUsageStateDetails `json:"stateDetails,omitempty" azure:"ro"`
}

WarmStoragePropertiesUsage - An object that contains the status of warm storage properties usage.

type WarmStoragePropertiesUsageStateDetails 

type WarmStoragePropertiesUsageStateDetails struct {
	// A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by
	// Warm Store for PAYG SKU
	CurrentCount *int32 `json:"currentCount,omitempty"`

	// A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number
	// of properties allowed by Warm Store for PAYG SKU.
	MaxCount *int32 `json:"maxCount,omitempty"`
}

WarmStoragePropertiesUsageStateDetails - An object that contains the details about warm storage properties usage state.

type WarmStoreConfigurationProperties 

type WarmStoreConfigurationProperties struct {
	// REQUIRED; ISO8601 timespan specifying the number of days the environment's events will be available for query from the
	// warm store.
	DataRetention *string `json:"dataRetention,omitempty"`
}

WarmStoreConfigurationProperties - The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.

Source Files

View all Source files

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.