README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2021-09-01-preview/incidentcomments
Documentation
The incidentcomments
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/incidentcomments"
Client Initialization
client := incidentcomments.NewIncidentCommentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: IncidentCommentsClient.CreateOrUpdate
ctx := context.TODO()
id := incidentcomments.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "incidentIdValue", "incidentCommentIdValue")
payload := incidentcomments.IncidentComment{
// ...
}
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: IncidentCommentsClient.Delete
ctx := context.TODO()
id := incidentcomments.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "incidentIdValue", "incidentCommentIdValue")
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: IncidentCommentsClient.Get
ctx := context.TODO()
id := incidentcomments.NewCommentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "incidentIdValue", "incidentCommentIdValue")
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: IncidentCommentsClient.List
ctx := context.TODO()
id := incidentcomments.NewIncidentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "incidentIdValue")
// alternatively `client.List(ctx, id, incidentcomments.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, incidentcomments.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func ValidateCommentID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateIncidentID(input interface{}, key string) (warnings []string, errors []error)
- type ClientInfo
- type CommentId
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type IncidentComment
- type IncidentCommentOperationPredicate
- type IncidentCommentProperties
- func (o *IncidentCommentProperties) GetCreatedTimeUtcAsTime() (*time.Time, error)
- func (o *IncidentCommentProperties) GetLastModifiedTimeUtcAsTime() (*time.Time, error)
- func (o *IncidentCommentProperties) SetCreatedTimeUtcAsTime(input time.Time)
- func (o *IncidentCommentProperties) SetLastModifiedTimeUtcAsTime(input time.Time)
- type IncidentCommentsClient
- func (c IncidentCommentsClient) CreateOrUpdate(ctx context.Context, id CommentId, input IncidentComment) (result CreateOrUpdateOperationResponse, err error)
- func (c IncidentCommentsClient) Delete(ctx context.Context, id CommentId) (result DeleteOperationResponse, err error)
- func (c IncidentCommentsClient) Get(ctx context.Context, id CommentId) (result GetOperationResponse, err error)
- func (c IncidentCommentsClient) List(ctx context.Context, id IncidentId, options ListOperationOptions) (resp ListOperationResponse, err error)
- func (c IncidentCommentsClient) ListComplete(ctx context.Context, id IncidentId, options ListOperationOptions) (ListCompleteResult, error)
- func (c IncidentCommentsClient) ListCompleteMatchingPredicate(ctx context.Context, id IncidentId, options ListOperationOptions, ...) (resp ListCompleteResult, err error)
- type IncidentId
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateCommentID ¶
ValidateCommentID checks that 'input' can be parsed as a Comment ID
func ValidateIncidentID ¶
ValidateIncidentID checks that 'input' can be parsed as a Incident ID
Types ¶
type ClientInfo ¶
type CommentId ¶
type CommentId struct { SubscriptionId string ResourceGroupName string WorkspaceName string IncidentId string IncidentCommentId string }
CommentId is a struct representing the Resource ID for a Comment
func NewCommentID ¶
func NewCommentID(subscriptionId string, resourceGroupName string, workspaceName string, incidentId string, incidentCommentId string) CommentId
NewCommentID returns a new CommentId struct
func ParseCommentID ¶
ParseCommentID parses 'input' into a CommentId
func ParseCommentIDInsensitively ¶
ParseCommentIDInsensitively parses 'input' case-insensitively into a CommentId note: this method should only be used for API response data and not user input
func (CommentId) Segments ¶
func (id CommentId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Comment ID
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response Model *IncidentComment }
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *IncidentComment }
type IncidentComment ¶
type IncidentComment struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *IncidentCommentProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type IncidentCommentOperationPredicate ¶
func (IncidentCommentOperationPredicate) Matches ¶
func (p IncidentCommentOperationPredicate) Matches(input IncidentComment) bool
type IncidentCommentProperties ¶
type IncidentCommentProperties struct { Author *ClientInfo `json:"author,omitempty"` CreatedTimeUtc *string `json:"createdTimeUtc,omitempty"` LastModifiedTimeUtc *string `json:"lastModifiedTimeUtc,omitempty"` Message string `json:"message"` }
func (*IncidentCommentProperties) GetCreatedTimeUtcAsTime ¶
func (o *IncidentCommentProperties) GetCreatedTimeUtcAsTime() (*time.Time, error)
func (*IncidentCommentProperties) GetLastModifiedTimeUtcAsTime ¶
func (o *IncidentCommentProperties) GetLastModifiedTimeUtcAsTime() (*time.Time, error)
func (*IncidentCommentProperties) SetCreatedTimeUtcAsTime ¶
func (o *IncidentCommentProperties) SetCreatedTimeUtcAsTime(input time.Time)
func (*IncidentCommentProperties) SetLastModifiedTimeUtcAsTime ¶
func (o *IncidentCommentProperties) SetLastModifiedTimeUtcAsTime(input time.Time)
type IncidentCommentsClient ¶
type IncidentCommentsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewIncidentCommentsClientWithBaseURI ¶
func NewIncidentCommentsClientWithBaseURI(endpoint string) IncidentCommentsClient
func (IncidentCommentsClient) CreateOrUpdate ¶
func (c IncidentCommentsClient) CreateOrUpdate(ctx context.Context, id CommentId, input IncidentComment) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (IncidentCommentsClient) Delete ¶
func (c IncidentCommentsClient) Delete(ctx context.Context, id CommentId) (result DeleteOperationResponse, err error)
Delete ...
func (IncidentCommentsClient) Get ¶
func (c IncidentCommentsClient) Get(ctx context.Context, id CommentId) (result GetOperationResponse, err error)
Get ...
func (IncidentCommentsClient) List ¶
func (c IncidentCommentsClient) List(ctx context.Context, id IncidentId, options ListOperationOptions) (resp ListOperationResponse, err error)
List ...
func (IncidentCommentsClient) ListComplete ¶
func (c IncidentCommentsClient) ListComplete(ctx context.Context, id IncidentId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (IncidentCommentsClient) ListCompleteMatchingPredicate ¶
func (c IncidentCommentsClient) ListCompleteMatchingPredicate(ctx context.Context, id IncidentId, options ListOperationOptions, predicate IncidentCommentOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
type IncidentId ¶
type IncidentId struct { SubscriptionId string ResourceGroupName string WorkspaceName string IncidentId string }
IncidentId is a struct representing the Resource ID for a Incident
func NewIncidentID ¶
func NewIncidentID(subscriptionId string, resourceGroupName string, workspaceName string, incidentId string) IncidentId
NewIncidentID returns a new IncidentId struct
func ParseIncidentID ¶
func ParseIncidentID(input string) (*IncidentId, error)
ParseIncidentID parses 'input' into a IncidentId
func ParseIncidentIDInsensitively ¶
func ParseIncidentIDInsensitively(input string) (*IncidentId, error)
ParseIncidentIDInsensitively parses 'input' case-insensitively into a IncidentId note: this method should only be used for API response data and not user input
func (IncidentId) Segments ¶
func (id IncidentId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Incident ID
func (IncidentId) String ¶
func (id IncidentId) String() string
String returns a human-readable description of this Incident ID
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []IncidentComment
}
type ListOperationOptions ¶
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]IncidentComment // contains filtered or unexported fields }
func (ListOperationResponse) HasMore ¶
func (r ListOperationResponse) HasMore() bool
func (ListOperationResponse) LoadMore ¶
func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)