environments

package
v0.20240920.1081703 Latest Latest
Warning

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

Go to latest
Published: Sep 20, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/timeseriesinsights/2020-05-15/environments Documentation

The environments SDK allows for interaction with the Azure Resource Manager Service timeseriesinsights (API Version 2020-05-15).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/timeseriesinsights/2020-05-15/environments"

Client Initialization

client := environments.NewEnvironmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EnvironmentsClient.CreateOrUpdate

ctx := context.TODO()
id := environments.NewEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue")

payload := environments.EnvironmentCreateOrUpdateParameters{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: EnvironmentsClient.Delete

ctx := context.TODO()
id := environments.NewEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EnvironmentsClient.Get

ctx := context.TODO()
id := environments.NewEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue")

read, err := client.Get(ctx, id, environments.DefaultGetOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EnvironmentsClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

read, err := client.ListByResourceGroup(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EnvironmentsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.ListBySubscription(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EnvironmentsClient.Update

ctx := context.TODO()
id := environments.NewEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue")

payload := environments.EnvironmentUpdateParameters{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEnvironmentKind

func PossibleValuesForEnvironmentKind() []string

func PossibleValuesForIngressState

func PossibleValuesForIngressState() []string

func PossibleValuesForKind

func PossibleValuesForKind() []string

func PossibleValuesForPropertyType

func PossibleValuesForPropertyType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForStorageLimitExceededBehavior

func PossibleValuesForStorageLimitExceededBehavior() []string

func PossibleValuesForWarmStoragePropertiesState

func PossibleValuesForWarmStoragePropertiesState() []string

func ValidateEnvironmentID

func ValidateEnvironmentID(input interface{}, key string) (warnings []string, errors []error)

ValidateEnvironmentID checks that 'input' can be parsed as a Environment ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentResource
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type EnvironmentCreateOrUpdateParameters

type EnvironmentCreateOrUpdateParameters interface {
}

type EnvironmentId

type EnvironmentId struct {
	SubscriptionId    string
	ResourceGroupName string
	EnvironmentName   string
}

EnvironmentId is a struct representing the Resource ID for a Environment

func NewEnvironmentID

func NewEnvironmentID(subscriptionId string, resourceGroupName string, environmentName string) EnvironmentId

NewEnvironmentID returns a new EnvironmentId struct

func ParseEnvironmentID

func ParseEnvironmentID(input string) (*EnvironmentId, error)

ParseEnvironmentID parses 'input' into a EnvironmentId

func ParseEnvironmentIDInsensitively

func ParseEnvironmentIDInsensitively(input string) (*EnvironmentId, error)

ParseEnvironmentIDInsensitively parses 'input' case-insensitively into a EnvironmentId note: this method should only be used for API response data and not user input

func (*EnvironmentId) FromParseResult

func (id *EnvironmentId) FromParseResult(input resourceids.ParseResult) error

func (EnvironmentId) ID

func (id EnvironmentId) ID() string

ID returns the formatted Environment ID

func (EnvironmentId) Segments

func (id EnvironmentId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Environment ID

func (EnvironmentId) String

func (id EnvironmentId) String() string

String returns a human-readable description of this Environment ID

type EnvironmentKind

type EnvironmentKind string
const (
	EnvironmentKindGenOne EnvironmentKind = "Gen1"
	EnvironmentKindGenTwo EnvironmentKind = "Gen2"
)

func (*EnvironmentKind) UnmarshalJSON added in v0.20240214.1142753

func (s *EnvironmentKind) UnmarshalJSON(bytes []byte) error

type EnvironmentListResponse

type EnvironmentListResponse struct {
	Value *[]EnvironmentResource `json:"value,omitempty"`
}

func (*EnvironmentListResponse) UnmarshalJSON

func (s *EnvironmentListResponse) UnmarshalJSON(bytes []byte) error

type EnvironmentResource

type EnvironmentResource interface {
}

type EnvironmentStateDetails

type EnvironmentStateDetails struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type EnvironmentStatus

type EnvironmentStatus struct {
	Ingress     *IngressEnvironmentStatus     `json:"ingress,omitempty"`
	WarmStorage *WarmStorageEnvironmentStatus `json:"warmStorage,omitempty"`
}

type EnvironmentUpdateParameters

type EnvironmentUpdateParameters interface {
}

type EnvironmentsClient

type EnvironmentsClient struct {
	Client *resourcemanager.Client
}

func NewEnvironmentsClientWithBaseURI

func NewEnvironmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*EnvironmentsClient, error)

func (EnvironmentsClient) CreateOrUpdate

CreateOrUpdate ...

func (EnvironmentsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (EnvironmentsClient) Delete

Delete ...

func (EnvironmentsClient) Get

Get ...

func (EnvironmentsClient) ListByResourceGroup

ListByResourceGroup ...

func (EnvironmentsClient) ListBySubscription

ListBySubscription ...

func (EnvironmentsClient) Update

Update ...

func (EnvironmentsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type Gen1EnvironmentCreateOrUpdateParameters

type Gen1EnvironmentCreateOrUpdateParameters struct {
	Properties Gen1EnvironmentCreationProperties `json:"properties"`

	// Fields inherited from EnvironmentCreateOrUpdateParameters
	Location string             `json:"location"`
	Sku      Sku                `json:"sku"`
	Tags     *map[string]string `json:"tags,omitempty"`
}

func (Gen1EnvironmentCreateOrUpdateParameters) MarshalJSON

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

type Gen1EnvironmentCreationProperties

type Gen1EnvironmentCreationProperties struct {
	DataRetentionTime            string                        `json:"dataRetentionTime"`
	PartitionKeyProperties       *[]TimeSeriesIdProperty       `json:"partitionKeyProperties,omitempty"`
	StorageLimitExceededBehavior *StorageLimitExceededBehavior `json:"storageLimitExceededBehavior,omitempty"`
}

type Gen1EnvironmentMutableProperties

type Gen1EnvironmentMutableProperties struct {
	DataRetentionTime            *string                       `json:"dataRetentionTime,omitempty"`
	StorageLimitExceededBehavior *StorageLimitExceededBehavior `json:"storageLimitExceededBehavior,omitempty"`
}

type Gen1EnvironmentResource

type Gen1EnvironmentResource struct {
	Properties Gen1EnvironmentResourceProperties `json:"properties"`

	// Fields inherited from EnvironmentResource
	Id       *string            `json:"id,omitempty"`
	Location string             `json:"location"`
	Name     *string            `json:"name,omitempty"`
	Sku      Sku                `json:"sku"`
	Tags     *map[string]string `json:"tags,omitempty"`
	Type     *string            `json:"type,omitempty"`
}

func (Gen1EnvironmentResource) MarshalJSON

func (s Gen1EnvironmentResource) MarshalJSON() ([]byte, error)

type Gen1EnvironmentResourceProperties

type Gen1EnvironmentResourceProperties struct {
	CreationTime                 *string                       `json:"creationTime,omitempty"`
	DataAccessFqdn               *string                       `json:"dataAccessFqdn,omitempty"`
	DataAccessId                 *string                       `json:"dataAccessId,omitempty"`
	DataRetentionTime            string                        `json:"dataRetentionTime"`
	PartitionKeyProperties       *[]TimeSeriesIdProperty       `json:"partitionKeyProperties,omitempty"`
	ProvisioningState            *ProvisioningState            `json:"provisioningState,omitempty"`
	Status                       *EnvironmentStatus            `json:"status,omitempty"`
	StorageLimitExceededBehavior *StorageLimitExceededBehavior `json:"storageLimitExceededBehavior,omitempty"`
}

func (*Gen1EnvironmentResourceProperties) GetCreationTimeAsTime

func (o *Gen1EnvironmentResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*Gen1EnvironmentResourceProperties) SetCreationTimeAsTime

func (o *Gen1EnvironmentResourceProperties) SetCreationTimeAsTime(input time.Time)

type Gen1EnvironmentUpdateParameters

type Gen1EnvironmentUpdateParameters struct {
	Properties *Gen1EnvironmentMutableProperties `json:"properties,omitempty"`
	Sku        *Sku                              `json:"sku,omitempty"`

	// Fields inherited from EnvironmentUpdateParameters
	Tags *map[string]string `json:"tags,omitempty"`
}

func (Gen1EnvironmentUpdateParameters) MarshalJSON

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

type Gen2EnvironmentCreateOrUpdateParameters

type Gen2EnvironmentCreateOrUpdateParameters struct {
	Properties Gen2EnvironmentCreationProperties `json:"properties"`

	// Fields inherited from EnvironmentCreateOrUpdateParameters
	Location string             `json:"location"`
	Sku      Sku                `json:"sku"`
	Tags     *map[string]string `json:"tags,omitempty"`
}

func (Gen2EnvironmentCreateOrUpdateParameters) MarshalJSON

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

type Gen2EnvironmentCreationProperties

type Gen2EnvironmentCreationProperties struct {
	StorageConfiguration   Gen2StorageConfigurationInput     `json:"storageConfiguration"`
	TimeSeriesIdProperties []TimeSeriesIdProperty            `json:"timeSeriesIdProperties"`
	WarmStoreConfiguration *WarmStoreConfigurationProperties `json:"warmStoreConfiguration,omitempty"`
}

type Gen2EnvironmentMutableProperties

type Gen2EnvironmentMutableProperties struct {
	StorageConfiguration   *Gen2StorageConfigurationMutableProperties `json:"storageConfiguration,omitempty"`
	WarmStoreConfiguration *WarmStoreConfigurationProperties          `json:"warmStoreConfiguration,omitempty"`
}

type Gen2EnvironmentResource

type Gen2EnvironmentResource struct {
	Properties Gen2EnvironmentResourceProperties `json:"properties"`

	// Fields inherited from EnvironmentResource
	Id       *string            `json:"id,omitempty"`
	Location string             `json:"location"`
	Name     *string            `json:"name,omitempty"`
	Sku      Sku                `json:"sku"`
	Tags     *map[string]string `json:"tags,omitempty"`
	Type     *string            `json:"type,omitempty"`
}

func (Gen2EnvironmentResource) MarshalJSON

func (s Gen2EnvironmentResource) MarshalJSON() ([]byte, error)

type Gen2EnvironmentResourceProperties

type Gen2EnvironmentResourceProperties struct {
	CreationTime           *string                           `json:"creationTime,omitempty"`
	DataAccessFqdn         *string                           `json:"dataAccessFqdn,omitempty"`
	DataAccessId           *string                           `json:"dataAccessId,omitempty"`
	ProvisioningState      *ProvisioningState                `json:"provisioningState,omitempty"`
	Status                 *EnvironmentStatus                `json:"status,omitempty"`
	StorageConfiguration   Gen2StorageConfigurationOutput    `json:"storageConfiguration"`
	TimeSeriesIdProperties []TimeSeriesIdProperty            `json:"timeSeriesIdProperties"`
	WarmStoreConfiguration *WarmStoreConfigurationProperties `json:"warmStoreConfiguration,omitempty"`
}

func (*Gen2EnvironmentResourceProperties) GetCreationTimeAsTime

func (o *Gen2EnvironmentResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*Gen2EnvironmentResourceProperties) SetCreationTimeAsTime

func (o *Gen2EnvironmentResourceProperties) SetCreationTimeAsTime(input time.Time)

type Gen2EnvironmentUpdateParameters

type Gen2EnvironmentUpdateParameters struct {
	Properties *Gen2EnvironmentMutableProperties `json:"properties,omitempty"`

	// Fields inherited from EnvironmentUpdateParameters
	Tags *map[string]string `json:"tags,omitempty"`
}

func (Gen2EnvironmentUpdateParameters) MarshalJSON

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

type Gen2StorageConfigurationInput

type Gen2StorageConfigurationInput struct {
	AccountName   string `json:"accountName"`
	ManagementKey string `json:"managementKey"`
}

type Gen2StorageConfigurationMutableProperties

type Gen2StorageConfigurationMutableProperties struct {
	ManagementKey string `json:"managementKey"`
}

type Gen2StorageConfigurationOutput

type Gen2StorageConfigurationOutput struct {
	AccountName string `json:"accountName"`
}

type GetOperationOptions

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders added in v0.20240214.1142753

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData added in v0.20240214.1142753

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery added in v0.20240214.1142753

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentResource
}

type IngressEnvironmentStatus

type IngressEnvironmentStatus struct {
	State        *IngressState            `json:"state,omitempty"`
	StateDetails *EnvironmentStateDetails `json:"stateDetails,omitempty"`
}

type IngressState

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

func (*IngressState) UnmarshalJSON added in v0.20240214.1142753

func (s *IngressState) UnmarshalJSON(bytes []byte) error

type Kind

type Kind string
const (
	KindGenOne Kind = "Gen1"
	KindGenTwo Kind = "Gen2"
)

func (*Kind) UnmarshalJSON added in v0.20240214.1142753

func (s *Kind) UnmarshalJSON(bytes []byte) error

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentListResponse
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentListResponse
}

type PropertyType

type PropertyType string
const (
	PropertyTypeString PropertyType = "String"
)

func (*PropertyType) UnmarshalJSON added in v0.20240214.1142753

func (s *PropertyType) UnmarshalJSON(bytes []byte) error

type ProvisioningState

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

func (*ProvisioningState) UnmarshalJSON added in v0.20240214.1142753

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type RawEnvironmentCreateOrUpdateParametersImpl

type RawEnvironmentCreateOrUpdateParametersImpl struct {
	Type   string
	Values map[string]interface{}
}

RawEnvironmentCreateOrUpdateParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawEnvironmentResourceImpl

type RawEnvironmentResourceImpl struct {
	Type   string
	Values map[string]interface{}
}

RawEnvironmentResourceImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawEnvironmentUpdateParametersImpl

type RawEnvironmentUpdateParametersImpl struct {
	Type   string
	Values map[string]interface{}
}

RawEnvironmentUpdateParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type Sku

type Sku struct {
	Capacity int64   `json:"capacity"`
	Name     SkuName `json:"name"`
}

type SkuName

type SkuName string
const (
	SkuNameLOne SkuName = "L1"
	SkuNamePOne SkuName = "P1"
	SkuNameSOne SkuName = "S1"
	SkuNameSTwo SkuName = "S2"
)

func (*SkuName) UnmarshalJSON added in v0.20240214.1142753

func (s *SkuName) UnmarshalJSON(bytes []byte) error

type StorageLimitExceededBehavior

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

func (*StorageLimitExceededBehavior) UnmarshalJSON added in v0.20240214.1142753

func (s *StorageLimitExceededBehavior) UnmarshalJSON(bytes []byte) error

type TimeSeriesIdProperty

type TimeSeriesIdProperty struct {
	Name *string       `json:"name,omitempty"`
	Type *PropertyType `json:"type,omitempty"`
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentResource
}

type WarmStorageEnvironmentStatus

type WarmStorageEnvironmentStatus struct {
	PropertiesUsage *WarmStoragePropertiesUsage `json:"propertiesUsage,omitempty"`
}

type WarmStoragePropertiesState

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

func (*WarmStoragePropertiesState) UnmarshalJSON added in v0.20240214.1142753

func (s *WarmStoragePropertiesState) UnmarshalJSON(bytes []byte) error

type WarmStoragePropertiesUsage

type WarmStoragePropertiesUsage struct {
	State        *WarmStoragePropertiesState             `json:"state,omitempty"`
	StateDetails *WarmStoragePropertiesUsageStateDetails `json:"stateDetails,omitempty"`
}

type WarmStoragePropertiesUsageStateDetails

type WarmStoragePropertiesUsageStateDetails struct {
	CurrentCount *int64 `json:"currentCount,omitempty"`
	MaxCount     *int64 `json:"maxCount,omitempty"`
}

type WarmStoreConfigurationProperties

type WarmStoreConfigurationProperties struct {
	DataRetention string `json:"dataRetention"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL