contentpackages

package
v0.20240320.1105218 Latest Latest
Warning

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

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

README

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

The contentpackages 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/contentpackages"

Client Initialization

client := contentpackages.NewContentPackagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContentPackagesClient.ContentPackageInstall

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

payload := contentpackages.PackageModel{
	// ...
}


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

Example Usage: ContentPackagesClient.ContentPackageUninstall

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

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

Example Usage: ContentPackagesClient.Get

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

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: ContentPackagesClient.List

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

// alternatively `client.List(ctx, id, contentpackages.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, contentpackages.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 ValidateContentPackageID 

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

ValidateContentPackageID checks that 'input' can be parsed as a Content Package 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 ContentPackageId 

type ContentPackageId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	PackageId         string
}

ContentPackageId is a struct representing the Resource ID for a Content Package

func NewContentPackageID 

func NewContentPackageID(subscriptionId string, resourceGroupName string, workspaceName string, packageId string) ContentPackageId

NewContentPackageID returns a new ContentPackageId struct

func ParseContentPackageID 

func ParseContentPackageID(input string) (*ContentPackageId, error)

ParseContentPackageID parses 'input' into a ContentPackageId

func ParseContentPackageIDInsensitively 

func ParseContentPackageIDInsensitively(input string) (*ContentPackageId, error)

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

func (*ContentPackageId) FromParseResult 

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

func (ContentPackageId) ID 

func (id ContentPackageId) ID() string

ID returns the formatted Content Package ID

func (ContentPackageId) Segments 

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

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

func (ContentPackageId) String 

func (id ContentPackageId) String() string

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

type ContentPackageInstallOperationResponse 

type ContentPackageInstallOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PackageModel
}

type ContentPackageUninstallOperationResponse 

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

type ContentPackagesClient 

type ContentPackagesClient struct {
	Client *resourcemanager.Client
}

func NewContentPackagesClientWithBaseURI 

func NewContentPackagesClientWithBaseURI(sdkApi sdkEnv.Api) (*ContentPackagesClient, error)

func (ContentPackagesClient) ContentPackageInstall 

func (c ContentPackagesClient) ContentPackageInstall(ctx context.Context, id ContentPackageId, input PackageModel) (result ContentPackageInstallOperationResponse, err error)

ContentPackageInstall ...

func (ContentPackagesClient) ContentPackageUninstall 

func (c ContentPackagesClient) ContentPackageUninstall(ctx context.Context, id ContentPackageId) (result ContentPackageUninstallOperationResponse, err error)

ContentPackageUninstall ...

func (ContentPackagesClient) Get 

func (c ContentPackagesClient) Get(ctx context.Context, id ContentPackageId) (result GetOperationResponse, err error)

Get ...

func (ContentPackagesClient) List 

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

List ...

func (ContentPackagesClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ContentPackagesClient) ListCompleteMatchingPredicate 

func (c ContentPackagesClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate PackageModelOperationPredicate) (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 GetOperationResponse 

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

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              []PackageModel
}

type ListOperationOptions 

type ListOperationOptions struct {
	Count   *bool
	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        *[]PackageModel
}

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 PackageBaseProperties 

type PackageBaseProperties struct {
	Author                   *MetadataAuthor       `json:"author,omitempty"`
	Categories               *MetadataCategories   `json:"categories,omitempty"`
	ContentId                *string               `json:"contentId,omitempty"`
	ContentKind              *PackageKind          `json:"contentKind,omitempty"`
	ContentProductId         *string               `json:"contentProductId,omitempty"`
	ContentSchemaVersion     *string               `json:"contentSchemaVersion,omitempty"`
	Dependencies             *MetadataDependencies `json:"dependencies,omitempty"`
	Description              *string               `json:"description,omitempty"`
	DisplayName              *string               `json:"displayName,omitempty"`
	FirstPublishDate         *string               `json:"firstPublishDate,omitempty"`
	Icon                     *string               `json:"icon,omitempty"`
	IsDeprecated             *Flag                 `json:"isDeprecated,omitempty"`
	IsFeatured               *Flag                 `json:"isFeatured,omitempty"`
	IsNew                    *Flag                 `json:"isNew,omitempty"`
	IsPreview                *Flag                 `json:"isPreview,omitempty"`
	LastPublishDate          *string               `json:"lastPublishDate,omitempty"`
	Providers                *[]string             `json:"providers,omitempty"`
	PublisherDisplayName     *string               `json:"publisherDisplayName,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 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 PackageModel 

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

type PackageModelOperationPredicate 

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

func (PackageModelOperationPredicate) Matches 

func (p PackageModelOperationPredicate) Matches(input PackageModel) bool

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.