entityrelations

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-10-01-preview/entityrelations Documentation

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

Client Initialization

client := entityrelations.NewEntityRelationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EntityRelationsClient.EntitiesRelationsList

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

// alternatively `client.EntitiesRelationsList(ctx, id, entityrelations.DefaultEntitiesRelationsListOperationOptions())` can be used to do batched pagination
items, err := client.EntitiesRelationsListComplete(ctx, id, entityrelations.DefaultEntitiesRelationsListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: EntityRelationsClient.GetRelation

ctx := context.TODO()
id := entityrelations.NewRelationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "entityIdValue", "relationValue")

read, err := client.GetRelation(ctx, id)
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 ValidateRelationID(input interface{}, key string) (warnings []string, errors []error)
• type EntitiesRelationsListCompleteResult
• type EntitiesRelationsListOperationOptions
  • func DefaultEntitiesRelationsListOperationOptions() EntitiesRelationsListOperationOptions
• type EntitiesRelationsListOperationResponse
  • func (r EntitiesRelationsListOperationResponse) HasMore() bool
  • func (r EntitiesRelationsListOperationResponse) LoadMore(ctx context.Context) (resp EntitiesRelationsListOperationResponse, err error)
• 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 EntityRelationsClient
  • func NewEntityRelationsClientWithBaseURI(endpoint string) EntityRelationsClient
  • func (c EntityRelationsClient) EntitiesRelationsList(ctx context.Context, id EntityId, ...) (resp EntitiesRelationsListOperationResponse, err error)
  • func (c EntityRelationsClient) EntitiesRelationsListComplete(ctx context.Context, id EntityId, ...) (EntitiesRelationsListCompleteResult, error)
  • func (c EntityRelationsClient) EntitiesRelationsListCompleteMatchingPredicate(ctx context.Context, id EntityId, ...) (resp EntitiesRelationsListCompleteResult, err error)
  • func (c EntityRelationsClient) GetRelation(ctx context.Context, id RelationId) (result GetRelationOperationResponse, err error)
• type GetRelationOperationResponse
• type Relation
• type RelationId
  • func NewRelationID(subscriptionId string, resourceGroupName string, workspaceName string, ...) RelationId
  • func ParseRelationID(input string) (*RelationId, error)
  • func ParseRelationIDInsensitively(input string) (*RelationId, error)
  • func (id *RelationId) FromParseResult(input resourceids.ParseResult) error
  • func (id RelationId) ID() string
  • func (id RelationId) Segments() []resourceids.Segment
  • func (id RelationId) String() string
• type RelationOperationPredicate
  • func (p RelationOperationPredicate) Matches(input Relation) bool
• type RelationProperties

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 ValidateRelationID

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

ValidateRelationID checks that 'input' can be parsed as a Relation ID

Types

type EntitiesRelationsListCompleteResult

type EntitiesRelationsListCompleteResult struct {
	Items []Relation
}

type EntitiesRelationsListOperationOptions

type EntitiesRelationsListOperationOptions struct {
	Filter  *string
	Orderby *string
	Top     *int64
}

func DefaultEntitiesRelationsListOperationOptions

func DefaultEntitiesRelationsListOperationOptions() EntitiesRelationsListOperationOptions

type EntitiesRelationsListOperationResponse

type EntitiesRelationsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Relation
	// contains filtered or unexported fields
}

func (EntitiesRelationsListOperationResponse) HasMore

func (r EntitiesRelationsListOperationResponse) HasMore() bool

func (EntitiesRelationsListOperationResponse) LoadMore

func (r EntitiesRelationsListOperationResponse) LoadMore(ctx context.Context) (resp EntitiesRelationsListOperationResponse, err error)

type EntityId

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

EntityId is a struct representing the Resource ID for a Entity

func NewEntityID

func NewEntityID(subscriptionId string, resourceGroupName string, workspaceName string, entityId 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 EntityRelationsClient

type EntityRelationsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewEntityRelationsClientWithBaseURI

func NewEntityRelationsClientWithBaseURI(endpoint string) EntityRelationsClient

func (EntityRelationsClient) EntitiesRelationsList

func (c EntityRelationsClient) EntitiesRelationsList(ctx context.Context, id EntityId, options EntitiesRelationsListOperationOptions) (resp EntitiesRelationsListOperationResponse, err error)

EntitiesRelationsList ...

func (EntityRelationsClient) EntitiesRelationsListComplete

func (c EntityRelationsClient) EntitiesRelationsListComplete(ctx context.Context, id EntityId, options EntitiesRelationsListOperationOptions) (EntitiesRelationsListCompleteResult, error)

EntitiesRelationsListComplete retrieves all of the results into a single object

func (EntityRelationsClient) EntitiesRelationsListCompleteMatchingPredicate

func (c EntityRelationsClient) EntitiesRelationsListCompleteMatchingPredicate(ctx context.Context, id EntityId, options EntitiesRelationsListOperationOptions, predicate RelationOperationPredicate) (resp EntitiesRelationsListCompleteResult, err error)

EntitiesRelationsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (EntityRelationsClient) GetRelation

func (c EntityRelationsClient) GetRelation(ctx context.Context, id RelationId) (result GetRelationOperationResponse, err error)

GetRelation ...

type GetRelationOperationResponse

type GetRelationOperationResponse struct {
	HttpResponse *http.Response
	Model        *Relation
}

type Relation

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

type RelationId

type RelationId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	EntityId          string
	RelationName      string
}

RelationId is a struct representing the Resource ID for a Relation

func NewRelationID

func NewRelationID(subscriptionId string, resourceGroupName string, workspaceName string, entityId string, relationName string) RelationId

NewRelationID returns a new RelationId struct

func ParseRelationID

func ParseRelationID(input string) (*RelationId, error)

ParseRelationID parses 'input' into a RelationId

func ParseRelationIDInsensitively

func ParseRelationIDInsensitively(input string) (*RelationId, error)

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

func (*RelationId) FromParseResult

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

func (RelationId) ID

func (id RelationId) ID() string

ID returns the formatted Relation ID

func (RelationId) Segments

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

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

func (RelationId) String

func (id RelationId) String() string

String returns a human-readable description of this Relation ID

type RelationOperationPredicate

type RelationOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (RelationOperationPredicate) Matches

func (p RelationOperationPredicate) Matches(input Relation) bool

type RelationProperties

type RelationProperties struct {
	RelatedResourceId   string  `json:"relatedResourceId"`
	RelatedResourceKind *string `json:"relatedResourceKind,omitempty"`
	RelatedResourceName *string `json:"relatedResourceName,omitempty"`
	RelatedResourceType *string `json:"relatedResourceType,omitempty"`
}