contentproducttemplates

package
v0.20240223.1130721 Latest Latest
Warning

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

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

README

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

The contentproducttemplates SDK allows for interaction with the Azure Resource Manager Service 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/contentproducttemplates"

Client Initialization

client := contentproducttemplates.NewContentProductTemplatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContentProductTemplatesClient.ProductTemplateGet

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

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

Example Usage: ContentProductTemplatesClient.ProductTemplatesList

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

// alternatively `client.ProductTemplatesList(ctx, id, contentproducttemplates.DefaultProductTemplatesListOperationOptions())` can be used to do batched pagination
items, err := client.ProductTemplatesListComplete(ctx, id, contentproducttemplates.DefaultProductTemplatesListOperationOptions())
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 ValidateContentproducttemplateID 

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

ValidateContentproducttemplateID checks that 'input' can be parsed as a Contentproducttemplate 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 ContentProductTemplatesClient 

type ContentProductTemplatesClient struct {
	Client *resourcemanager.Client
}

func NewContentProductTemplatesClientWithBaseURI 

func NewContentProductTemplatesClientWithBaseURI(sdkApi sdkEnv.Api) (*ContentProductTemplatesClient, error)

func (ContentProductTemplatesClient) ProductTemplateGet 

func (c ContentProductTemplatesClient) ProductTemplateGet(ctx context.Context, id ContentproducttemplateId) (result ProductTemplateGetOperationResponse, err error)

ProductTemplateGet ...

func (ContentProductTemplatesClient) ProductTemplatesList 

func (c ContentProductTemplatesClient) ProductTemplatesList(ctx context.Context, id WorkspaceId, options ProductTemplatesListOperationOptions) (result ProductTemplatesListOperationResponse, err error)

ProductTemplatesList ...

func (ContentProductTemplatesClient) ProductTemplatesListComplete 

func (c ContentProductTemplatesClient) ProductTemplatesListComplete(ctx context.Context, id WorkspaceId, options ProductTemplatesListOperationOptions) (ProductTemplatesListCompleteResult, error)

ProductTemplatesListComplete retrieves all the results into a single object

func (ContentProductTemplatesClient) ProductTemplatesListCompleteMatchingPredicate 

func (c ContentProductTemplatesClient) ProductTemplatesListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ProductTemplatesListOperationOptions, predicate ProductTemplateModelOperationPredicate) (result ProductTemplatesListCompleteResult, err error)

ProductTemplatesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ContentproducttemplateId 

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

ContentproducttemplateId is a struct representing the Resource ID for a Contentproducttemplate

func NewContentproducttemplateID 

func NewContentproducttemplateID(subscriptionId string, resourceGroupName string, workspaceName string, templateId string) ContentproducttemplateId

NewContentproducttemplateID returns a new ContentproducttemplateId struct

func ParseContentproducttemplateID 

func ParseContentproducttemplateID(input string) (*ContentproducttemplateId, error)

ParseContentproducttemplateID parses 'input' into a ContentproducttemplateId

func ParseContentproducttemplateIDInsensitively 

func ParseContentproducttemplateIDInsensitively(input string) (*ContentproducttemplateId, error)

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

func (*ContentproducttemplateId) FromParseResult 

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

func (ContentproducttemplateId) ID 

func (id ContentproducttemplateId) ID() string

ID returns the formatted Contentproducttemplate ID

func (ContentproducttemplateId) Segments 

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

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

func (ContentproducttemplateId) String 

func (id ContentproducttemplateId) String() string

String returns a human-readable description of this Contentproducttemplate ID

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 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 ProductTemplateGetOperationResponse 

type ProductTemplateGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProductTemplateModel
}

type ProductTemplateModel 

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

type ProductTemplateModelOperationPredicate 

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

func (ProductTemplateModelOperationPredicate) Matches 

func (p ProductTemplateModelOperationPredicate) Matches(input ProductTemplateModel) bool

type ProductTemplateProperties 

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

type ProductTemplatesListCompleteResult 

type ProductTemplatesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProductTemplateModel
}

type ProductTemplatesListOperationOptions 

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

func DefaultProductTemplatesListOperationOptions 

func DefaultProductTemplatesListOperationOptions() ProductTemplatesListOperationOptions

func (ProductTemplatesListOperationOptions) ToHeaders added in v0.20240221.1115631 

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

func (ProductTemplatesListOperationOptions) ToOData added in v0.20240221.1115631 

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

func (ProductTemplatesListOperationOptions) ToQuery added in v0.20240221.1115631 

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

type ProductTemplatesListOperationResponse 

type ProductTemplatesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProductTemplateModel
}

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 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.