package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

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

The incidentcomments 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/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
}

# Functions

No description provided by the author
NewCommentID returns a new CommentId struct.
No description provided by the author
NewIncidentID returns a new IncidentId struct.
ParseCommentID parses 'input' into a CommentId.
ParseCommentIDInsensitively parses 'input' case-insensitively into a CommentId note: this method should only be used for API response data and not user input.
ParseIncidentID parses 'input' into a IncidentId.
ParseIncidentIDInsensitively parses 'input' case-insensitively into a IncidentId note: this method should only be used for API response data and not user input.
ValidateCommentID checks that 'input' can be parsed as a Comment ID.
ValidateIncidentID checks that 'input' can be parsed as a Incident ID.

# Structs

No description provided by the author
CommentId is a struct representing the Resource ID for a Comment.
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
IncidentId is a struct representing the Resource ID for a Incident.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author