package
0.20240125.1100331
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-08-01/bookmarks
Documentation
The bookmarks
SDK allows for interaction with the Azure Resource Manager Service securityinsights
(API Version 2022-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/securityinsights/2022-08-01/bookmarks"
Client Initialization
client := bookmarks.NewBookmarksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: BookmarksClient.CreateOrUpdate
ctx := context.TODO()
id := bookmarks.NewBookmarkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue")
payload := bookmarks.Bookmark{
// ...
}
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: BookmarksClient.Delete
ctx := context.TODO()
id := bookmarks.NewBookmarkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue")
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: BookmarksClient.Get
ctx := context.TODO()
id := bookmarks.NewBookmarkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue")
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: BookmarksClient.List
ctx := context.TODO()
id := bookmarks.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
NewBookmarkID returns a new BookmarkId struct.
No description provided by the author
NewWorkspaceID returns a new WorkspaceId struct.
ParseBookmarkID parses 'input' into a BookmarkId.
ParseBookmarkIDInsensitively parses 'input' case-insensitively into a BookmarkId note: this method should only be used for API response data and not user input.
ParseWorkspaceID parses 'input' into a WorkspaceId.
ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateBookmarkID checks that 'input' can be parsed as a Bookmark ID.
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
BookmarkId is a struct representing the Resource ID for a Bookmark.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WorkspaceId is a struct representing the Resource ID for a Workspace.
# Type aliases
No description provided by the author