bookmarkrelations

package
v0.20240507.1095453 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-10-01-preview/bookmarkrelations Documentation

The bookmarkrelations SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2022-10-01-preview).

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/2022-10-01-preview/bookmarkrelations"

Client Initialization

client := bookmarkrelations.NewBookmarkRelationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BookmarkRelationsClient.CreateOrUpdate

ctx := context.TODO()
id := bookmarkrelations.NewBookmarkRelationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue", "relationValue")

payload := bookmarkrelations.Relation{
	// ...
}


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

Example Usage: BookmarkRelationsClient.Delete

ctx := context.TODO()
id := bookmarkrelations.NewBookmarkRelationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue", "relationValue")

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: BookmarkRelationsClient.Get

ctx := context.TODO()
id := bookmarkrelations.NewBookmarkRelationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue", "relationValue")

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

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

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

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

ValidateBookmarkID checks that 'input' can be parsed as a Bookmark ID

func ValidateBookmarkRelationID 

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

ValidateBookmarkRelationID checks that 'input' can be parsed as a Bookmark Relation ID

Types

type BookmarkId 

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

BookmarkId is a struct representing the Resource ID for a Bookmark

func NewBookmarkID 

func NewBookmarkID(subscriptionId string, resourceGroupName string, workspaceName string, bookmarkId string) BookmarkId

NewBookmarkID returns a new BookmarkId struct

func ParseBookmarkID 

func ParseBookmarkID(input string) (*BookmarkId, error)

ParseBookmarkID parses 'input' into a BookmarkId

func ParseBookmarkIDInsensitively 

func ParseBookmarkIDInsensitively(input string) (*BookmarkId, error)

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

func (*BookmarkId) FromParseResult 

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

func (BookmarkId) ID 

func (id BookmarkId) ID() string

ID returns the formatted Bookmark ID

func (BookmarkId) Segments 

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

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

func (BookmarkId) String 

func (id BookmarkId) String() string

String returns a human-readable description of this Bookmark ID

type BookmarkRelationId 

type BookmarkRelationId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	BookmarkId        string
	RelationName      string
}

BookmarkRelationId is a struct representing the Resource ID for a Bookmark Relation

func NewBookmarkRelationID 

func NewBookmarkRelationID(subscriptionId string, resourceGroupName string, workspaceName string, bookmarkId string, relationName string) BookmarkRelationId

NewBookmarkRelationID returns a new BookmarkRelationId struct

func ParseBookmarkRelationID 

func ParseBookmarkRelationID(input string) (*BookmarkRelationId, error)

ParseBookmarkRelationID parses 'input' into a BookmarkRelationId

func ParseBookmarkRelationIDInsensitively 

func ParseBookmarkRelationIDInsensitively(input string) (*BookmarkRelationId, error)

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

func (*BookmarkRelationId) FromParseResult 

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

func (BookmarkRelationId) ID 

func (id BookmarkRelationId) ID() string

ID returns the formatted Bookmark Relation ID

func (BookmarkRelationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Bookmark Relation ID

func (BookmarkRelationId) String 

func (id BookmarkRelationId) String() string

String returns a human-readable description of this Bookmark Relation ID

type BookmarkRelationsClient 

type BookmarkRelationsClient struct {
	Client *resourcemanager.Client
}

func NewBookmarkRelationsClientWithBaseURI 

func NewBookmarkRelationsClientWithBaseURI(sdkApi sdkEnv.Api) (*BookmarkRelationsClient, error)

func (BookmarkRelationsClient) CreateOrUpdate 

func (c BookmarkRelationsClient) CreateOrUpdate(ctx context.Context, id BookmarkRelationId, input Relation) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (BookmarkRelationsClient) Delete 

func (c BookmarkRelationsClient) Delete(ctx context.Context, id BookmarkRelationId) (result DeleteOperationResponse, err error)

Delete ...

func (BookmarkRelationsClient) Get 

func (c BookmarkRelationsClient) Get(ctx context.Context, id BookmarkRelationId) (result GetOperationResponse, err error)

Get ...

func (BookmarkRelationsClient) List 

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

List ...

func (BookmarkRelationsClient) ListComplete 

func (c BookmarkRelationsClient) ListComplete(ctx context.Context, id BookmarkId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (BookmarkRelationsClient) ListCompleteMatchingPredicate 

func (c BookmarkRelationsClient) ListCompleteMatchingPredicate(ctx context.Context, id BookmarkId, options ListOperationOptions, predicate RelationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Relation
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Filter  *string
	Orderby *string
	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        *[]Relation
}

type Relation 

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

type RelationOperationPredicate 

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

func (RelationOperationPredicate) Matches 

func (p RelationOperationPredicate) Matches(input Relation) bool

type RelationProperties 

type RelationProperties struct {
	RelatedResourceId   string  `json:"relatedResourceId"`
	RelatedResourceKind *string `json:"relatedResourceKind,omitempty"`
	RelatedResourceName *string `json:"relatedResourceName,omitempty"`
	RelatedResourceType *string `json:"relatedResourceType,omitempty"`
}

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.