manualtrigger

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2024-03-01/manualtrigger Documentation

The manualtrigger SDK allows for interaction with Azure Resource Manager securityinsights (API Version 2024-03-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/2024-03-01/manualtrigger"

Client Initialization

client := manualtrigger.NewManualTriggerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManualTriggerClient.EntitiesRunPlaybook

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

payload := manualtrigger.EntityManualTriggerRequestBody{
	// ...
}


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

Example Usage: ManualTriggerClient.IncidentsRunPlaybook

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

payload := manualtrigger.ManualTriggerRequestBody{
	// ...
}


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

Documentation

Index

• func ValidateEntityID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateIncidentID(input interface{}, key string) (warnings []string, errors []error)
• type EntitiesRunPlaybookOperationResponse
• type EntityId
  • func NewEntityID(subscriptionId string, resourceGroupName string, workspaceName string, ...) EntityId
  • func ParseEntityID(input string) (*EntityId, error)
  • func ParseEntityIDInsensitively(input string) (*EntityId, error)
  • func (id *EntityId) FromParseResult(input resourceids.ParseResult) error
  • func (id EntityId) ID() string
  • func (id EntityId) Segments() []resourceids.Segment
  • func (id EntityId) String() string
• type EntityManualTriggerRequestBody
• type IncidentId
  • func NewIncidentID(subscriptionId string, resourceGroupName string, workspaceName string, ...) IncidentId
  • func ParseIncidentID(input string) (*IncidentId, error)
  • func ParseIncidentIDInsensitively(input string) (*IncidentId, error)
  • func (id *IncidentId) FromParseResult(input resourceids.ParseResult) error
  • func (id IncidentId) ID() string
  • func (id IncidentId) Segments() []resourceids.Segment
  • func (id IncidentId) String() string
• type IncidentsRunPlaybookOperationResponse
• type ManualTriggerClient
  • func NewManualTriggerClientWithBaseURI(sdkApi sdkEnv.Api) (*ManualTriggerClient, error)
  • func (c ManualTriggerClient) EntitiesRunPlaybook(ctx context.Context, id EntityId, input EntityManualTriggerRequestBody) (result EntitiesRunPlaybookOperationResponse, err error)
  • func (c ManualTriggerClient) IncidentsRunPlaybook(ctx context.Context, id IncidentId, input ManualTriggerRequestBody) (result IncidentsRunPlaybookOperationResponse, err error)
• type ManualTriggerRequestBody

Functions

func ValidateEntityID

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

ValidateEntityID checks that 'input' can be parsed as a Entity ID

func ValidateIncidentID

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

ValidateIncidentID checks that 'input' can be parsed as a Incident ID

Types

type EntitiesRunPlaybookOperationResponse

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

type EntityId

type EntityId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	EntityIdentifier  string
}

EntityId is a struct representing the Resource ID for a Entity

func NewEntityID

func NewEntityID(subscriptionId string, resourceGroupName string, workspaceName string, entityIdentifier string) EntityId

NewEntityID returns a new EntityId struct

func ParseEntityID

func ParseEntityID(input string) (*EntityId, error)

ParseEntityID parses 'input' into a EntityId

func ParseEntityIDInsensitively

func ParseEntityIDInsensitively(input string) (*EntityId, error)

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

func (*EntityId) FromParseResult

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

func (EntityId) ID

func (id EntityId) ID() string

ID returns the formatted Entity ID

func (EntityId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Entity ID

func (EntityId) String

func (id EntityId) String() string

String returns a human-readable description of this Entity ID

type EntityManualTriggerRequestBody

type EntityManualTriggerRequestBody struct {
	IncidentArmId       *string `json:"incidentArmId,omitempty"`
	LogicAppsResourceId string  `json:"logicAppsResourceId"`
	TenantId            *string `json:"tenantId,omitempty"`
}

type IncidentId

type IncidentId struct {
	SubscriptionId     string
	ResourceGroupName  string
	WorkspaceName      string
	IncidentIdentifier string
}

IncidentId is a struct representing the Resource ID for a Incident

func NewIncidentID

func NewIncidentID(subscriptionId string, resourceGroupName string, workspaceName string, incidentIdentifier 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) FromParseResult

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

func (IncidentId) ID

func (id IncidentId) ID() string

ID returns the formatted Incident ID

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 IncidentsRunPlaybookOperationResponse

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

type ManualTriggerClient

type ManualTriggerClient struct {
	Client *resourcemanager.Client
}

func NewManualTriggerClientWithBaseURI

func NewManualTriggerClientWithBaseURI(sdkApi sdkEnv.Api) (*ManualTriggerClient, error)

func (ManualTriggerClient) EntitiesRunPlaybook

func (c ManualTriggerClient) EntitiesRunPlaybook(ctx context.Context, id EntityId, input EntityManualTriggerRequestBody) (result EntitiesRunPlaybookOperationResponse, err error)

EntitiesRunPlaybook ...

func (ManualTriggerClient) IncidentsRunPlaybook

func (c ManualTriggerClient) IncidentsRunPlaybook(ctx context.Context, id IncidentId, input ManualTriggerRequestBody) (result IncidentsRunPlaybookOperationResponse, err error)

IncidentsRunPlaybook ...

type ManualTriggerRequestBody

type ManualTriggerRequestBody struct {
	LogicAppsResourceId string  `json:"logicAppsResourceId"`
	TenantId            *string `json:"tenantId,omitempty"`
}