contenttemplates

package
v0.20240923.1151247 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2023-11-01/contenttemplates Documentation

The contenttemplates SDK allows for interaction with Azure Resource Manager securityinsights (API Version 2023-11-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/securityinsights/2023-11-01/contenttemplates"

Client Initialization

client := contenttemplates.NewContentTemplatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContentTemplatesClient.ContentTemplateDelete

ctx := context.TODO()
id := contenttemplates.NewContentTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "templateId")

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

Example Usage: ContentTemplatesClient.ContentTemplateGet

ctx := context.TODO()
id := contenttemplates.NewContentTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "templateId")

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

Example Usage: ContentTemplatesClient.ContentTemplateInstall

ctx := context.TODO()
id := contenttemplates.NewContentTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "templateId")

payload := contenttemplates.TemplateModel{
	// ...
}


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

Example Usage: ContentTemplatesClient.List

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

// alternatively `client.List(ctx, id, contenttemplates.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, contenttemplates.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForFlag 

func PossibleValuesForFlag() []string

func PossibleValuesForKind 

func PossibleValuesForKind() []string

func PossibleValuesForOperator 

func PossibleValuesForOperator() []string

func PossibleValuesForPackageKind 

func PossibleValuesForPackageKind() []string

func PossibleValuesForSourceKind 

func PossibleValuesForSourceKind() []string

func PossibleValuesForSupportTier 

func PossibleValuesForSupportTier() []string

func ValidateContentTemplateID 

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

ValidateContentTemplateID checks that 'input' can be parsed as a Content Template 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 ContentTemplateDeleteOperationResponse 

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

type ContentTemplateGetOperationResponse 

type ContentTemplateGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TemplateModel
}

type ContentTemplateId 

type ContentTemplateId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	TemplateId        string
}

ContentTemplateId is a struct representing the Resource ID for a Content Template

func NewContentTemplateID 

func NewContentTemplateID(subscriptionId string, resourceGroupName string, workspaceName string, templateId string) ContentTemplateId

NewContentTemplateID returns a new ContentTemplateId struct

func ParseContentTemplateID 

func ParseContentTemplateID(input string) (*ContentTemplateId, error)

ParseContentTemplateID parses 'input' into a ContentTemplateId

func ParseContentTemplateIDInsensitively 

func ParseContentTemplateIDInsensitively(input string) (*ContentTemplateId, error)

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

func (*ContentTemplateId) FromParseResult 

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

func (ContentTemplateId) ID 

func (id ContentTemplateId) ID() string

ID returns the formatted Content Template ID

func (ContentTemplateId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Content Template ID

func (ContentTemplateId) String 

func (id ContentTemplateId) String() string

String returns a human-readable description of this Content Template ID

type ContentTemplateInstallOperationResponse 

type ContentTemplateInstallOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TemplateModel
}

type ContentTemplatesClient 

type ContentTemplatesClient struct {
	Client *resourcemanager.Client
}

func NewContentTemplatesClientWithBaseURI 

func NewContentTemplatesClientWithBaseURI(sdkApi sdkEnv.Api) (*ContentTemplatesClient, error)

func (ContentTemplatesClient) ContentTemplateDelete 

func (c ContentTemplatesClient) ContentTemplateDelete(ctx context.Context, id ContentTemplateId) (result ContentTemplateDeleteOperationResponse, err error)

ContentTemplateDelete ...

func (ContentTemplatesClient) ContentTemplateGet 

func (c ContentTemplatesClient) ContentTemplateGet(ctx context.Context, id ContentTemplateId) (result ContentTemplateGetOperationResponse, err error)

ContentTemplateGet ...

func (ContentTemplatesClient) ContentTemplateInstall 

func (c ContentTemplatesClient) ContentTemplateInstall(ctx context.Context, id ContentTemplateId, input TemplateModel) (result ContentTemplateInstallOperationResponse, err error)

ContentTemplateInstall ...

func (ContentTemplatesClient) List 

func (c ContentTemplatesClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (ContentTemplatesClient) ListComplete 

func (c ContentTemplatesClient) ListComplete(ctx context.Context, id WorkspaceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ContentTemplatesClient) ListCompleteMatchingPredicate 

func (c ContentTemplatesClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate TemplateModelOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type Flag 

type Flag string
const (
	FlagFalse Flag = "false"
	FlagTrue  Flag = "true"
)

func (*Flag) UnmarshalJSON added in v0.20240221.1115631 

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

type Kind 

type Kind string
const (
	KindAnalyticsRule            Kind = "AnalyticsRule"
	KindAnalyticsRuleTemplate    Kind = "AnalyticsRuleTemplate"
	KindAutomationRule           Kind = "AutomationRule"
	KindAzureFunction            Kind = "AzureFunction"
	KindDataConnector            Kind = "DataConnector"
	KindDataType                 Kind = "DataType"
	KindHuntingQuery             Kind = "HuntingQuery"
	KindInvestigationQuery       Kind = "InvestigationQuery"
	KindLogicAppsCustomConnector Kind = "LogicAppsCustomConnector"
	KindParser                   Kind = "Parser"
	KindPlaybook                 Kind = "Playbook"
	KindPlaybookTemplate         Kind = "PlaybookTemplate"
	KindSolution                 Kind = "Solution"
	KindWatchlist                Kind = "Watchlist"
	KindWatchlistTemplate        Kind = "WatchlistTemplate"
	KindWorkbook                 Kind = "Workbook"
	KindWorkbookTemplate         Kind = "WorkbookTemplate"
)

func (*Kind) UnmarshalJSON added in v0.20240221.1115631 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TemplateModel
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions 

type ListOperationOptions struct {
	Count   *bool
	Expand  *string
	Filter  *string
	Orderby *string
	Search  *string
	Skip    *int64
	Top     *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20240221.1115631 

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

func (ListOperationOptions) ToOData added in v0.20240221.1115631 

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

func (ListOperationOptions) ToQuery added in v0.20240221.1115631 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TemplateModel
}

type MetadataAuthor 

type MetadataAuthor struct {
	Email *string `json:"email,omitempty"`
	Link  *string `json:"link,omitempty"`
	Name  *string `json:"name,omitempty"`
}

type MetadataCategories 

type MetadataCategories struct {
	Domains   *[]string `json:"domains,omitempty"`
	Verticals *[]string `json:"verticals,omitempty"`
}

type MetadataDependencies 

type MetadataDependencies struct {
	ContentId *string                 `json:"contentId,omitempty"`
	Criteria  *[]MetadataDependencies `json:"criteria,omitempty"`
	Kind      *Kind                   `json:"kind,omitempty"`
	Name      *string                 `json:"name,omitempty"`
	Operator  *Operator               `json:"operator,omitempty"`
	Version   *string                 `json:"version,omitempty"`
}

type MetadataSource 

type MetadataSource struct {
	Kind     SourceKind `json:"kind"`
	Name     *string    `json:"name,omitempty"`
	SourceId *string    `json:"sourceId,omitempty"`
}

type MetadataSupport 

type MetadataSupport struct {
	Email *string     `json:"email,omitempty"`
	Link  *string     `json:"link,omitempty"`
	Name  *string     `json:"name,omitempty"`
	Tier  SupportTier `json:"tier"`
}

type Operator 

type Operator string
const (
	OperatorAND Operator = "AND"
	OperatorOR  Operator = "OR"
)

func (*Operator) UnmarshalJSON added in v0.20240221.1115631 

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

type PackageKind 

type PackageKind string
const (
	PackageKindSolution   PackageKind = "Solution"
	PackageKindStandalone PackageKind = "Standalone"
)

func (*PackageKind) UnmarshalJSON added in v0.20240221.1115631 

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

type SourceKind 

type SourceKind string
const (
	SourceKindCommunity        SourceKind = "Community"
	SourceKindLocalWorkspace   SourceKind = "LocalWorkspace"
	SourceKindSolution         SourceKind = "Solution"
	SourceKindSourceRepository SourceKind = "SourceRepository"
)

func (*SourceKind) UnmarshalJSON added in v0.20240221.1115631 

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

type SupportTier 

type SupportTier string
const (
	SupportTierCommunity SupportTier = "Community"
	SupportTierMicrosoft SupportTier = "Microsoft"
	SupportTierPartner   SupportTier = "Partner"
)

func (*SupportTier) UnmarshalJSON added in v0.20240221.1115631 

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

type TemplateModel 

type TemplateModel struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *TemplateProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type TemplateModelOperationPredicate 

type TemplateModelOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (TemplateModelOperationPredicate) Matches 

func (p TemplateModelOperationPredicate) Matches(input TemplateModel) bool

type TemplateProperties 

type TemplateProperties struct {
	Author                   *MetadataAuthor       `json:"author,omitempty"`
	Categories               *MetadataCategories   `json:"categories,omitempty"`
	ContentId                *string               `json:"contentId,omitempty"`
	ContentKind              *Kind                 `json:"contentKind,omitempty"`
	ContentProductId         *string               `json:"contentProductId,omitempty"`
	ContentSchemaVersion     *string               `json:"contentSchemaVersion,omitempty"`
	CustomVersion            *string               `json:"customVersion,omitempty"`
	DependantTemplates       *[]TemplateProperties `json:"dependantTemplates,omitempty"`
	Dependencies             *MetadataDependencies `json:"dependencies,omitempty"`
	DisplayName              *string               `json:"displayName,omitempty"`
	FirstPublishDate         *string               `json:"firstPublishDate,omitempty"`
	Icon                     *string               `json:"icon,omitempty"`
	IsDeprecated             *Flag                 `json:"isDeprecated,omitempty"`
	LastPublishDate          *string               `json:"lastPublishDate,omitempty"`
	MainTemplate             *interface{}          `json:"mainTemplate,omitempty"`
	PackageId                *string               `json:"packageId,omitempty"`
	PackageKind              *PackageKind          `json:"packageKind,omitempty"`
	PackageName              *string               `json:"packageName,omitempty"`
	PackageVersion           *string               `json:"packageVersion,omitempty"`
	PreviewImages            *[]string             `json:"previewImages,omitempty"`
	PreviewImagesDark        *[]string             `json:"previewImagesDark,omitempty"`
	Providers                *[]string             `json:"providers,omitempty"`
	Source                   *MetadataSource       `json:"source,omitempty"`
	Support                  *MetadataSupport      `json:"support,omitempty"`
	ThreatAnalysisTactics    *[]string             `json:"threatAnalysisTactics,omitempty"`
	ThreatAnalysisTechniques *[]string             `json:"threatAnalysisTechniques,omitempty"`
	Version                  *string               `json:"version,omitempty"`
}

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) FromParseResult 

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

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

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.