workspaces

package
v0.20230901.1170029 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2023 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2020-08-01/workspaces Documentation

The workspaces SDK allows for interaction with the Azure Resource Manager Service operationalinsights (API Version 2020-08-01).

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-sdk/resource-manager/operationalinsights/2020-08-01/workspaces"

Client Initialization

client := workspaces.NewWorkspacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspacesClient.CreateOrUpdate

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

payload := workspaces.Workspace{
	// ...
}


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

Example Usage: WorkspacesClient.Delete

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

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

Example Usage: WorkspacesClient.GatewaysDelete

ctx := context.TODO()
id := workspaces.NewGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "gatewayIdValue")

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

Example Usage: WorkspacesClient.Get

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

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

Example Usage: WorkspacesClient.IntelligencePacksDisable

ctx := context.TODO()
id := workspaces.NewIntelligencePackID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "intelligencePackValue")

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

Example Usage: WorkspacesClient.IntelligencePacksEnable

ctx := context.TODO()
id := workspaces.NewIntelligencePackID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "intelligencePackValue")

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

Example Usage: WorkspacesClient.IntelligencePacksList

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

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

Example Usage: WorkspacesClient.List

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

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

Example Usage: WorkspacesClient.ListByResourceGroup

ctx := context.TODO()
id := workspaces.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: WorkspacesClient.ManagementGroupsList

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

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

Example Usage: WorkspacesClient.SchemaGet

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

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

Example Usage: WorkspacesClient.SharedKeysGetSharedKeys

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

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

Example Usage: WorkspacesClient.SharedKeysRegenerate

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

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

Example Usage: WorkspacesClient.Update

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

payload := workspaces.WorkspacePatch{
	// ...
}


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

Example Usage: WorkspacesClient.UsagesList

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

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

Example Usage: WorkspacesClient.WorkspacePurgeGetPurgeStatus

ctx := context.TODO()
id := workspaces.NewOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "purgeIdValue")

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

Example Usage: WorkspacesClient.WorkspacePurgePurge

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

payload := workspaces.WorkspacePurgeBody{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataIngestionStatus 

func PossibleValuesForDataIngestionStatus() []string

func PossibleValuesForPublicNetworkAccessType 

func PossibleValuesForPublicNetworkAccessType() []string

func PossibleValuesForPurgeState 

func PossibleValuesForPurgeState() []string

func PossibleValuesForSearchSortEnum 

func PossibleValuesForSearchSortEnum() []string

func PossibleValuesForWorkspaceEntityStatus 

func PossibleValuesForWorkspaceEntityStatus() []string

func PossibleValuesForWorkspaceSkuNameEnum 

func PossibleValuesForWorkspaceSkuNameEnum() []string

func ValidateGatewayID 

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

ValidateGatewayID checks that 'input' can be parsed as a Gateway ID

func ValidateIntelligencePackID 

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

ValidateIntelligencePackID checks that 'input' can be parsed as a Intelligence Pack ID

func ValidateOperationID 

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

ValidateOperationID checks that 'input' can be parsed as a Operation ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CoreSummary 

type CoreSummary struct {
	NumberOfDocuments int64   `json:"numberOfDocuments"`
	Status            *string `json:"status,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DataIngestionStatus 

type DataIngestionStatus string
const (
	DataIngestionStatusApproachingQuota      DataIngestionStatus = "ApproachingQuota"
	DataIngestionStatusForceOff              DataIngestionStatus = "ForceOff"
	DataIngestionStatusForceOn               DataIngestionStatus = "ForceOn"
	DataIngestionStatusOverQuota             DataIngestionStatus = "OverQuota"
	DataIngestionStatusRespectQuota          DataIngestionStatus = "RespectQuota"
	DataIngestionStatusSubscriptionSuspended DataIngestionStatus = "SubscriptionSuspended"
)

func (*DataIngestionStatus) UnmarshalJSON added in v0.20230825.1030756 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	Force *bool
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders added in v0.20230825.1030756 

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

func (DeleteOperationOptions) ToOData added in v0.20230825.1030756 

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

func (DeleteOperationOptions) ToQuery added in v0.20230825.1030756 

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

type DeleteOperationResponse 

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

type GatewayId 

type GatewayId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	GatewayId         string
}

GatewayId is a struct representing the Resource ID for a Gateway

func NewGatewayID 

func NewGatewayID(subscriptionId string, resourceGroupName string, workspaceName string, gatewayId string) GatewayId

NewGatewayID returns a new GatewayId struct

func ParseGatewayID 

func ParseGatewayID(input string) (*GatewayId, error)

ParseGatewayID parses 'input' into a GatewayId

func ParseGatewayIDInsensitively 

func ParseGatewayIDInsensitively(input string) (*GatewayId, error)

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

func (GatewayId) ID 

func (id GatewayId) ID() string

ID returns the formatted Gateway ID

func (GatewayId) Segments 

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

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

func (GatewayId) String 

func (id GatewayId) String() string

String returns a human-readable description of this Gateway ID

type GatewaysDeleteOperationResponse 

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

type GetOperationResponse 

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

type IntelligencePack 

type IntelligencePack struct {
	DisplayName *string `json:"displayName,omitempty"`
	Enabled     *bool   `json:"enabled,omitempty"`
	Name        *string `json:"name,omitempty"`
}

type IntelligencePackId 

type IntelligencePackId struct {
	SubscriptionId       string
	ResourceGroupName    string
	WorkspaceName        string
	IntelligencePackName string
}

IntelligencePackId is a struct representing the Resource ID for a Intelligence Pack

func NewIntelligencePackID 

func NewIntelligencePackID(subscriptionId string, resourceGroupName string, workspaceName string, intelligencePackName string) IntelligencePackId

NewIntelligencePackID returns a new IntelligencePackId struct

func ParseIntelligencePackID 

func ParseIntelligencePackID(input string) (*IntelligencePackId, error)

ParseIntelligencePackID parses 'input' into a IntelligencePackId

func ParseIntelligencePackIDInsensitively 

func ParseIntelligencePackIDInsensitively(input string) (*IntelligencePackId, error)

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

func (IntelligencePackId) ID 

func (id IntelligencePackId) ID() string

ID returns the formatted Intelligence Pack ID

func (IntelligencePackId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Intelligence Pack ID

func (IntelligencePackId) String 

func (id IntelligencePackId) String() string

String returns a human-readable description of this Intelligence Pack ID

type IntelligencePacksDisableOperationResponse 

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

type IntelligencePacksEnableOperationResponse 

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

type IntelligencePacksListOperationResponse 

type IntelligencePacksListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IntelligencePack
}

type ListByResourceGroupOperationResponse 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkspaceListResult
}

type ManagementGroup 

type ManagementGroup struct {
	Properties *ManagementGroupProperties `json:"properties,omitempty"`
}

type ManagementGroupProperties 

type ManagementGroupProperties struct {
	Created      *string `json:"created,omitempty"`
	DataReceived *string `json:"dataReceived,omitempty"`
	Id           *string `json:"id,omitempty"`
	IsGateway    *bool   `json:"isGateway,omitempty"`
	Name         *string `json:"name,omitempty"`
	ServerCount  *int64  `json:"serverCount,omitempty"`
	Sku          *string `json:"sku,omitempty"`
	Version      *string `json:"version,omitempty"`
}

func (*ManagementGroupProperties) GetCreatedAsTime 

func (o *ManagementGroupProperties) GetCreatedAsTime() (*time.Time, error)

func (*ManagementGroupProperties) GetDataReceivedAsTime 

func (o *ManagementGroupProperties) GetDataReceivedAsTime() (*time.Time, error)

func (*ManagementGroupProperties) SetCreatedAsTime 

func (o *ManagementGroupProperties) SetCreatedAsTime(input time.Time)

func (*ManagementGroupProperties) SetDataReceivedAsTime 

func (o *ManagementGroupProperties) SetDataReceivedAsTime(input time.Time)

type ManagementGroupsListOperationResponse 

type ManagementGroupsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkspaceListManagementGroupsResult
}

type MetricName 

type MetricName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type OperationId 

type OperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	PurgeId           string
}

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID 

func NewOperationID(subscriptionId string, resourceGroupName string, workspaceName string, purgeId string) OperationId

NewOperationID returns a new OperationId struct

func ParseOperationID 

func ParseOperationID(input string) (*OperationId, error)

ParseOperationID parses 'input' into a OperationId

func ParseOperationIDInsensitively 

func ParseOperationIDInsensitively(input string) (*OperationId, error)

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

func (OperationId) ID 

func (id OperationId) ID() string

ID returns the formatted Operation ID

func (OperationId) Segments 

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

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

func (OperationId) String 

func (id OperationId) String() string

String returns a human-readable description of this Operation ID

type PrivateLinkScopedResource 

type PrivateLinkScopedResource struct {
	ResourceId *string `json:"resourceId,omitempty"`
	ScopeId    *string `json:"scopeId,omitempty"`
}

type PublicNetworkAccessType 

type PublicNetworkAccessType string
const (
	PublicNetworkAccessTypeDisabled PublicNetworkAccessType = "Disabled"
	PublicNetworkAccessTypeEnabled  PublicNetworkAccessType = "Enabled"
)

func (*PublicNetworkAccessType) UnmarshalJSON added in v0.20230825.1030756 

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

type PurgeState 

type PurgeState string
const (
	PurgeStateCompleted PurgeState = "completed"
	PurgeStatePending   PurgeState = "pending"
)

func (*PurgeState) UnmarshalJSON added in v0.20230825.1030756 

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

type SchemaGetOperationResponse 

type SchemaGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SearchGetSchemaResponse
}

type SearchGetSchemaResponse 

type SearchGetSchemaResponse struct {
	Metadata *SearchMetadata      `json:"metadata,omitempty"`
	Value    *[]SearchSchemaValue `json:"value,omitempty"`
}

type SearchMetadata 

type SearchMetadata struct {
	AggregatedGroupingFields *string               `json:"aggregatedGroupingFields,omitempty"`
	AggregatedValueField     *string               `json:"aggregatedValueField,omitempty"`
	CoreSummaries            *[]CoreSummary        `json:"coreSummaries,omitempty"`
	ETag                     *string               `json:"eTag,omitempty"`
	Id                       *string               `json:"id,omitempty"`
	LastUpdated              *string               `json:"lastUpdated,omitempty"`
	Max                      *int64                `json:"max,omitempty"`
	RequestId                *string               `json:"requestId,omitempty"`
	RequestTime              *int64                `json:"requestTime,omitempty"`
	ResultType               *string               `json:"resultType,omitempty"`
	Schema                   *SearchMetadataSchema `json:"schema,omitempty"`
	Sort                     *[]SearchSort         `json:"sort,omitempty"`
	StartTime                *string               `json:"startTime,omitempty"`
	Status                   *string               `json:"status,omitempty"`
	Sum                      *int64                `json:"sum,omitempty"`
	Top                      *int64                `json:"top,omitempty"`
	Total                    *int64                `json:"total,omitempty"`
}

func (*SearchMetadata) GetLastUpdatedAsTime 

func (o *SearchMetadata) GetLastUpdatedAsTime() (*time.Time, error)

func (*SearchMetadata) GetStartTimeAsTime 

func (o *SearchMetadata) GetStartTimeAsTime() (*time.Time, error)

func (*SearchMetadata) SetLastUpdatedAsTime 

func (o *SearchMetadata) SetLastUpdatedAsTime(input time.Time)

func (*SearchMetadata) SetStartTimeAsTime 

func (o *SearchMetadata) SetStartTimeAsTime(input time.Time)

type SearchMetadataSchema 

type SearchMetadataSchema struct {
	Name    *string `json:"name,omitempty"`
	Version *int64  `json:"version,omitempty"`
}

type SearchSchemaValue 

type SearchSchemaValue struct {
	DisplayName *string   `json:"displayName,omitempty"`
	Facet       bool      `json:"facet"`
	Indexed     bool      `json:"indexed"`
	Name        *string   `json:"name,omitempty"`
	OwnerType   *[]string `json:"ownerType,omitempty"`
	Stored      bool      `json:"stored"`
	Type        *string   `json:"type,omitempty"`
}

type SearchSort 

type SearchSort struct {
	Name  *string         `json:"name,omitempty"`
	Order *SearchSortEnum `json:"order,omitempty"`
}

type SearchSortEnum 

type SearchSortEnum string
const (
	SearchSortEnumAsc  SearchSortEnum = "asc"
	SearchSortEnumDesc SearchSortEnum = "desc"
)

func (*SearchSortEnum) UnmarshalJSON added in v0.20230825.1030756 

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

type SharedKeys 

type SharedKeys struct {
	PrimarySharedKey   *string `json:"primarySharedKey,omitempty"`
	SecondarySharedKey *string `json:"secondarySharedKey,omitempty"`
}

type SharedKeysGetSharedKeysOperationResponse 

type SharedKeysGetSharedKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SharedKeys
}

type SharedKeysRegenerateOperationResponse 

type SharedKeysRegenerateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SharedKeys
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Workspace
}

type UsageMetric 

type UsageMetric struct {
	CurrentValue  *float64    `json:"currentValue,omitempty"`
	Limit         *float64    `json:"limit,omitempty"`
	Name          *MetricName `json:"name,omitempty"`
	NextResetTime *string     `json:"nextResetTime,omitempty"`
	QuotaPeriod   *string     `json:"quotaPeriod,omitempty"`
	Unit          *string     `json:"unit,omitempty"`
}

func (*UsageMetric) GetNextResetTimeAsTime 

func (o *UsageMetric) GetNextResetTimeAsTime() (*time.Time, error)

func (*UsageMetric) SetNextResetTimeAsTime 

func (o *UsageMetric) SetNextResetTimeAsTime(input time.Time)

type UsagesListOperationResponse 

type UsagesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkspaceListUsagesResult
}

type Workspace 

type Workspace struct {
	ETag       *string              `json:"eTag,omitempty"`
	Id         *string              `json:"id,omitempty"`
	Location   string               `json:"location"`
	Name       *string              `json:"name,omitempty"`
	Properties *WorkspaceProperties `json:"properties,omitempty"`
	Tags       *map[string]string   `json:"tags,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type WorkspaceCapping 

type WorkspaceCapping struct {
	DailyQuotaGb        *float64             `json:"dailyQuotaGb,omitempty"`
	DataIngestionStatus *DataIngestionStatus `json:"dataIngestionStatus,omitempty"`
	QuotaNextResetTime  *string              `json:"quotaNextResetTime,omitempty"`
}

type WorkspaceEntityStatus 

type WorkspaceEntityStatus string
const (
	WorkspaceEntityStatusCanceled            WorkspaceEntityStatus = "Canceled"
	WorkspaceEntityStatusCreating            WorkspaceEntityStatus = "Creating"
	WorkspaceEntityStatusDeleting            WorkspaceEntityStatus = "Deleting"
	WorkspaceEntityStatusFailed              WorkspaceEntityStatus = "Failed"
	WorkspaceEntityStatusProvisioningAccount WorkspaceEntityStatus = "ProvisioningAccount"
	WorkspaceEntityStatusSucceeded           WorkspaceEntityStatus = "Succeeded"
	WorkspaceEntityStatusUpdating            WorkspaceEntityStatus = "Updating"
)

func (*WorkspaceEntityStatus) UnmarshalJSON added in v0.20230825.1030756 

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

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

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

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

type WorkspaceListManagementGroupsResult 

type WorkspaceListManagementGroupsResult struct {
	Value *[]ManagementGroup `json:"value,omitempty"`
}

type WorkspaceListResult 

type WorkspaceListResult struct {
	Value *[]Workspace `json:"value,omitempty"`
}

type WorkspaceListUsagesResult 

type WorkspaceListUsagesResult struct {
	Value *[]UsageMetric `json:"value,omitempty"`
}

type WorkspacePatch 

type WorkspacePatch struct {
	Etag       *string              `json:"etag,omitempty"`
	Id         *string              `json:"id,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *WorkspaceProperties `json:"properties,omitempty"`
	Tags       *map[string]string   `json:"tags,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type WorkspaceProperties 

type WorkspaceProperties struct {
	CreatedDate                     *string                      `json:"createdDate,omitempty"`
	CustomerId                      *string                      `json:"customerId,omitempty"`
	Features                        *interface{}                 `json:"features,omitempty"`
	ForceCmkForQuery                *bool                        `json:"forceCmkForQuery,omitempty"`
	ModifiedDate                    *string                      `json:"modifiedDate,omitempty"`
	PrivateLinkScopedResources      *[]PrivateLinkScopedResource `json:"privateLinkScopedResources,omitempty"`
	ProvisioningState               *WorkspaceEntityStatus       `json:"provisioningState,omitempty"`
	PublicNetworkAccessForIngestion *PublicNetworkAccessType     `json:"publicNetworkAccessForIngestion,omitempty"`
	PublicNetworkAccessForQuery     *PublicNetworkAccessType     `json:"publicNetworkAccessForQuery,omitempty"`
	RetentionInDays                 *int64                       `json:"retentionInDays,omitempty"`
	Sku                             *WorkspaceSku                `json:"sku,omitempty"`
	WorkspaceCapping                *WorkspaceCapping            `json:"workspaceCapping,omitempty"`
}

type WorkspacePurgeBody 

type WorkspacePurgeBody struct {
	Filters []WorkspacePurgeBodyFilters `json:"filters"`
	Table   string                      `json:"table"`
}

type WorkspacePurgeBodyFilters 

type WorkspacePurgeBodyFilters struct {
	Column   *string      `json:"column,omitempty"`
	Key      *string      `json:"key,omitempty"`
	Operator *string      `json:"operator,omitempty"`
	Value    *interface{} `json:"value,omitempty"`
}

type WorkspacePurgeGetPurgeStatusOperationResponse 

type WorkspacePurgeGetPurgeStatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkspacePurgeStatusResponse
}

type WorkspacePurgePurgeOperationResponse 

type WorkspacePurgePurgeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkspacePurgeResponse
}

type WorkspacePurgeResponse 

type WorkspacePurgeResponse struct {
	OperationId string `json:"operationId"`
}

type WorkspacePurgeStatusResponse 

type WorkspacePurgeStatusResponse struct {
	Status PurgeState `json:"status"`
}

type WorkspaceSku 

type WorkspaceSku struct {
	CapacityReservationLevel    *int64               `json:"capacityReservationLevel,omitempty"`
	LastSkuUpdate               *string              `json:"lastSkuUpdate,omitempty"`
	MaxCapacityReservationLevel *int64               `json:"maxCapacityReservationLevel,omitempty"`
	Name                        WorkspaceSkuNameEnum `json:"name"`
}

type WorkspaceSkuNameEnum 

type WorkspaceSkuNameEnum string
const (
	WorkspaceSkuNameEnumCapacityReservation  WorkspaceSkuNameEnum = "CapacityReservation"
	WorkspaceSkuNameEnumFree                 WorkspaceSkuNameEnum = "Free"
	WorkspaceSkuNameEnumLACluster            WorkspaceSkuNameEnum = "LACluster"
	WorkspaceSkuNameEnumPerGBTwoZeroOneEight WorkspaceSkuNameEnum = "PerGB2018"
	WorkspaceSkuNameEnumPerNode              WorkspaceSkuNameEnum = "PerNode"
	WorkspaceSkuNameEnumPremium              WorkspaceSkuNameEnum = "Premium"
	WorkspaceSkuNameEnumStandalone           WorkspaceSkuNameEnum = "Standalone"
	WorkspaceSkuNameEnumStandard             WorkspaceSkuNameEnum = "Standard"
)

func (*WorkspaceSkuNameEnum) UnmarshalJSON added in v0.20230825.1030756 

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

type WorkspacesClient 

type WorkspacesClient struct {
	Client *resourcemanager.Client
}

func NewWorkspacesClientWithBaseURI 

func NewWorkspacesClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspacesClient, error)

func (WorkspacesClient) CreateOrUpdate 

func (c WorkspacesClient) CreateOrUpdate(ctx context.Context, id WorkspaceId, input Workspace) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (WorkspacesClient) CreateOrUpdateThenPoll 

func (c WorkspacesClient) CreateOrUpdateThenPoll(ctx context.Context, id WorkspaceId, input Workspace) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (WorkspacesClient) Delete 

func (c WorkspacesClient) Delete(ctx context.Context, id WorkspaceId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (WorkspacesClient) DeleteThenPoll 

func (c WorkspacesClient) DeleteThenPoll(ctx context.Context, id WorkspaceId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (WorkspacesClient) GatewaysDelete 

func (c WorkspacesClient) GatewaysDelete(ctx context.Context, id GatewayId) (result GatewaysDeleteOperationResponse, err error)

GatewaysDelete ...

func (WorkspacesClient) Get 

func (c WorkspacesClient) Get(ctx context.Context, id WorkspaceId) (result GetOperationResponse, err error)

Get ...

func (WorkspacesClient) IntelligencePacksDisable 

func (c WorkspacesClient) IntelligencePacksDisable(ctx context.Context, id IntelligencePackId) (result IntelligencePacksDisableOperationResponse, err error)

IntelligencePacksDisable ...

func (WorkspacesClient) IntelligencePacksEnable 

func (c WorkspacesClient) IntelligencePacksEnable(ctx context.Context, id IntelligencePackId) (result IntelligencePacksEnableOperationResponse, err error)

IntelligencePacksEnable ...

func (WorkspacesClient) IntelligencePacksList 

func (c WorkspacesClient) IntelligencePacksList(ctx context.Context, id WorkspaceId) (result IntelligencePacksListOperationResponse, err error)

IntelligencePacksList ...

func (WorkspacesClient) List 

func (c WorkspacesClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (WorkspacesClient) ListByResourceGroup 

func (c WorkspacesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (WorkspacesClient) ManagementGroupsList 

func (c WorkspacesClient) ManagementGroupsList(ctx context.Context, id WorkspaceId) (result ManagementGroupsListOperationResponse, err error)

ManagementGroupsList ...

func (WorkspacesClient) SchemaGet 

func (c WorkspacesClient) SchemaGet(ctx context.Context, id WorkspaceId) (result SchemaGetOperationResponse, err error)

SchemaGet ...

func (WorkspacesClient) SharedKeysGetSharedKeys 

func (c WorkspacesClient) SharedKeysGetSharedKeys(ctx context.Context, id WorkspaceId) (result SharedKeysGetSharedKeysOperationResponse, err error)

SharedKeysGetSharedKeys ...

func (WorkspacesClient) SharedKeysRegenerate 

func (c WorkspacesClient) SharedKeysRegenerate(ctx context.Context, id WorkspaceId) (result SharedKeysRegenerateOperationResponse, err error)

SharedKeysRegenerate ...

func (WorkspacesClient) Update 

func (c WorkspacesClient) Update(ctx context.Context, id WorkspaceId, input WorkspacePatch) (result UpdateOperationResponse, err error)

Update ...

func (WorkspacesClient) UsagesList 

func (c WorkspacesClient) UsagesList(ctx context.Context, id WorkspaceId) (result UsagesListOperationResponse, err error)

UsagesList ...

func (WorkspacesClient) WorkspacePurgeGetPurgeStatus 

func (c WorkspacesClient) WorkspacePurgeGetPurgeStatus(ctx context.Context, id OperationId) (result WorkspacePurgeGetPurgeStatusOperationResponse, err error)

WorkspacePurgeGetPurgeStatus ...

func (WorkspacesClient) WorkspacePurgePurge 

func (c WorkspacesClient) WorkspacePurgePurge(ctx context.Context, id WorkspaceId, input WorkspacePurgeBody) (result WorkspacePurgePurgeOperationResponse, err error)

WorkspacePurgePurge ...

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.