officeconsents

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2021-09-01-preview/officeconsents Documentation

The officeconsents SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2021-09-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/2021-09-01-preview/officeconsents"

Client Initialization

client := officeconsents.NewOfficeConsentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OfficeConsentsClient.Delete

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

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

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

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

ctx := context.TODO()
id := officeconsents.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
}

Documentation

Index

• func ValidateOfficeConsentID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type OfficeConsent
• type OfficeConsentId
  • func NewOfficeConsentID(subscriptionId string, resourceGroupName string, workspaceName string, ...) OfficeConsentId
  • func ParseOfficeConsentID(input string) (*OfficeConsentId, error)
  • func ParseOfficeConsentIDInsensitively(input string) (*OfficeConsentId, error)
  • func (id *OfficeConsentId) FromParseResult(input resourceids.ParseResult) error
  • func (id OfficeConsentId) ID() string
  • func (id OfficeConsentId) Segments() []resourceids.Segment
  • func (id OfficeConsentId) String() string
• type OfficeConsentOperationPredicate
  • func (p OfficeConsentOperationPredicate) Matches(input OfficeConsent) bool
• type OfficeConsentProperties
• type OfficeConsentsClient
  • func NewOfficeConsentsClientWithBaseURI(sdkApi sdkEnv.Api) (*OfficeConsentsClient, error)
  • func (c OfficeConsentsClient) Delete(ctx context.Context, id OfficeConsentId) (result DeleteOperationResponse, err error)
  • func (c OfficeConsentsClient) Get(ctx context.Context, id OfficeConsentId) (result GetOperationResponse, err error)
  • func (c OfficeConsentsClient) List(ctx context.Context, id WorkspaceId) (result ListOperationResponse, err error)
  • func (c OfficeConsentsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)
  • func (c OfficeConsentsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate OfficeConsentOperationPredicate) (result ListCompleteResult, err error)
• type WorkspaceId
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string

Functions

func ValidateOfficeConsentID

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

ValidateOfficeConsentID checks that 'input' can be parsed as a Office Consent 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 DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type OfficeConsent

type OfficeConsent struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *OfficeConsentProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type OfficeConsentId

type OfficeConsentId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ConsentId         string
}

OfficeConsentId is a struct representing the Resource ID for a Office Consent

func NewOfficeConsentID

func NewOfficeConsentID(subscriptionId string, resourceGroupName string, workspaceName string, consentId string) OfficeConsentId

NewOfficeConsentID returns a new OfficeConsentId struct

func ParseOfficeConsentID

func ParseOfficeConsentID(input string) (*OfficeConsentId, error)

ParseOfficeConsentID parses 'input' into a OfficeConsentId

func ParseOfficeConsentIDInsensitively

func ParseOfficeConsentIDInsensitively(input string) (*OfficeConsentId, error)

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

func (*OfficeConsentId) FromParseResult

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

func (OfficeConsentId) ID

func (id OfficeConsentId) ID() string

ID returns the formatted Office Consent ID

func (OfficeConsentId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Office Consent ID

func (OfficeConsentId) String

func (id OfficeConsentId) String() string

String returns a human-readable description of this Office Consent ID

type OfficeConsentOperationPredicate

type OfficeConsentOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (OfficeConsentOperationPredicate) Matches

func (p OfficeConsentOperationPredicate) Matches(input OfficeConsent) bool

type OfficeConsentProperties

type OfficeConsentProperties struct {
	ConsentId *string `json:"consentId,omitempty"`
	TenantId  *string `json:"tenantId,omitempty"`
}

type OfficeConsentsClient

type OfficeConsentsClient struct {
	Client *resourcemanager.Client
}

func NewOfficeConsentsClientWithBaseURI

func NewOfficeConsentsClientWithBaseURI(sdkApi sdkEnv.Api) (*OfficeConsentsClient, error)

func (OfficeConsentsClient) Delete

func (c OfficeConsentsClient) Delete(ctx context.Context, id OfficeConsentId) (result DeleteOperationResponse, err error)

Delete ...

func (OfficeConsentsClient) Get

func (c OfficeConsentsClient) Get(ctx context.Context, id OfficeConsentId) (result GetOperationResponse, err error)

Get ...

func (OfficeConsentsClient) List

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

List ...

func (OfficeConsentsClient) ListComplete

func (c OfficeConsentsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (OfficeConsentsClient) ListCompleteMatchingPredicate

func (c OfficeConsentsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate OfficeConsentOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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