sentinelonboardingstates

package
v0.20240314.1083835 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2023-02-01/sentinelonboardingstates Documentation

The sentinelonboardingstates SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2023-02-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-02-01/sentinelonboardingstates"

Client Initialization

client := sentinelonboardingstates.NewSentinelOnboardingStatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SentinelOnboardingStatesClient.Create

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

payload := sentinelonboardingstates.SentinelOnboardingState{
	// ...
}


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

Example Usage: SentinelOnboardingStatesClient.Delete

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

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

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateOnboardingStateID

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

ValidateOnboardingStateID checks that 'input' can be parsed as a Onboarding State 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 CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SentinelOnboardingState
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SentinelOnboardingStatesList
}

type OnboardingStateId

type OnboardingStateId struct {
	SubscriptionId      string
	ResourceGroupName   string
	WorkspaceName       string
	OnboardingStateName string
}

OnboardingStateId is a struct representing the Resource ID for a Onboarding State

func NewOnboardingStateID

func NewOnboardingStateID(subscriptionId string, resourceGroupName string, workspaceName string, onboardingStateName string) OnboardingStateId

NewOnboardingStateID returns a new OnboardingStateId struct

func ParseOnboardingStateID

func ParseOnboardingStateID(input string) (*OnboardingStateId, error)

ParseOnboardingStateID parses 'input' into a OnboardingStateId

func ParseOnboardingStateIDInsensitively

func ParseOnboardingStateIDInsensitively(input string) (*OnboardingStateId, error)

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

func (*OnboardingStateId) FromParseResult

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

func (OnboardingStateId) ID

func (id OnboardingStateId) ID() string

ID returns the formatted Onboarding State ID

func (OnboardingStateId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Onboarding State ID

func (OnboardingStateId) String

func (id OnboardingStateId) String() string

String returns a human-readable description of this Onboarding State ID

type SentinelOnboardingState

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

type SentinelOnboardingStateProperties

type SentinelOnboardingStateProperties struct {
	CustomerManagedKey *bool `json:"customerManagedKey,omitempty"`
}

type SentinelOnboardingStatesClient

type SentinelOnboardingStatesClient struct {
	Client *resourcemanager.Client
}

func NewSentinelOnboardingStatesClientWithBaseURI

func NewSentinelOnboardingStatesClientWithBaseURI(sdkApi sdkEnv.Api) (*SentinelOnboardingStatesClient, error)

func (SentinelOnboardingStatesClient) Create

Create ...

func (SentinelOnboardingStatesClient) Delete

Delete ...

func (SentinelOnboardingStatesClient) Get

Get ...

func (SentinelOnboardingStatesClient) List

List ...

type SentinelOnboardingStatesList

type SentinelOnboardingStatesList struct {
	Value []SentinelOnboardingState `json:"value"`
}

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL