workspacemanagergroups

package
v0.20250129.1111950 Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2025 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2023-12-01-preview/workspacemanagergroups Documentation

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

Client Initialization

client := workspacemanagergroups.NewWorkspaceManagerGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspaceManagerGroupsClient.CreateOrUpdate

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

payload := workspacemanagergroups.WorkspaceManagerGroup{
	// ...
}


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: WorkspaceManagerGroupsClient.Delete

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

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

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

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

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

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

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

func ValidateWorkspaceManagerGroupID 

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

ValidateWorkspaceManagerGroupID checks that 'input' can be parsed as a Workspace Manager Group ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Orderby *string
	Top     *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

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

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

type WorkspaceManagerGroup 

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

type WorkspaceManagerGroupId 

type WorkspaceManagerGroupId struct {
	SubscriptionId            string
	ResourceGroupName         string
	WorkspaceName             string
	WorkspaceManagerGroupName string
}

WorkspaceManagerGroupId is a struct representing the Resource ID for a Workspace Manager Group

func NewWorkspaceManagerGroupID 

func NewWorkspaceManagerGroupID(subscriptionId string, resourceGroupName string, workspaceName string, workspaceManagerGroupName string) WorkspaceManagerGroupId

NewWorkspaceManagerGroupID returns a new WorkspaceManagerGroupId struct

func ParseWorkspaceManagerGroupID 

func ParseWorkspaceManagerGroupID(input string) (*WorkspaceManagerGroupId, error)

ParseWorkspaceManagerGroupID parses 'input' into a WorkspaceManagerGroupId

func ParseWorkspaceManagerGroupIDInsensitively 

func ParseWorkspaceManagerGroupIDInsensitively(input string) (*WorkspaceManagerGroupId, error)

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

func (*WorkspaceManagerGroupId) FromParseResult 

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

func (WorkspaceManagerGroupId) ID 

func (id WorkspaceManagerGroupId) ID() string

ID returns the formatted Workspace Manager Group ID

func (WorkspaceManagerGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Manager Group ID

func (WorkspaceManagerGroupId) String 

func (id WorkspaceManagerGroupId) String() string

String returns a human-readable description of this Workspace Manager Group ID

type WorkspaceManagerGroupOperationPredicate 

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

func (WorkspaceManagerGroupOperationPredicate) Matches 

func (p WorkspaceManagerGroupOperationPredicate) Matches(input WorkspaceManagerGroup) bool

type WorkspaceManagerGroupProperties 

type WorkspaceManagerGroupProperties struct {
	Description         *string  `json:"description,omitempty"`
	DisplayName         string   `json:"displayName"`
	MemberResourceNames []string `json:"memberResourceNames"`
}

type WorkspaceManagerGroupsClient 

type WorkspaceManagerGroupsClient struct {
	Client *resourcemanager.Client
}

func NewWorkspaceManagerGroupsClientWithBaseURI 

func NewWorkspaceManagerGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspaceManagerGroupsClient, error)

func (WorkspaceManagerGroupsClient) CreateOrUpdate 

func (c WorkspaceManagerGroupsClient) CreateOrUpdate(ctx context.Context, id WorkspaceManagerGroupId, input WorkspaceManagerGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (WorkspaceManagerGroupsClient) Delete 

func (c WorkspaceManagerGroupsClient) Delete(ctx context.Context, id WorkspaceManagerGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (WorkspaceManagerGroupsClient) Get 

func (c WorkspaceManagerGroupsClient) Get(ctx context.Context, id WorkspaceManagerGroupId) (result GetOperationResponse, err error)

Get ...

func (WorkspaceManagerGroupsClient) List 

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

List ...

func (WorkspaceManagerGroupsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (WorkspaceManagerGroupsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.