entityrelations

package
v0.20241205.1102105 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

The entityrelations SDK allows for interaction with Azure Resource Manager securityinsights (API Version 2023-12-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/2023-12-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", "workspaceName", "entityIdentifier")

// 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.NewEntityRelationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "entityId", "relationName")

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

Constants

This section is empty.

Variables

This section is empty.

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 ValidateEntityRelationID 

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

ValidateEntityRelationID checks that 'input' can be parsed as a Entity Relation ID

Types

type EntitiesRelationsListCompleteResult 

type EntitiesRelationsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Relation
}

type EntitiesRelationsListCustomPager 

type EntitiesRelationsListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *EntitiesRelationsListCustomPager) NextPageLink() *odata.Link

type EntitiesRelationsListOperationOptions 

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

func DefaultEntitiesRelationsListOperationOptions 

func DefaultEntitiesRelationsListOperationOptions() EntitiesRelationsListOperationOptions

func (EntitiesRelationsListOperationOptions) ToHeaders 

func (o EntitiesRelationsListOperationOptions) ToHeaders() *client.Headers

func (EntitiesRelationsListOperationOptions) ToOData 

func (o EntitiesRelationsListOperationOptions) ToOData() *odata.Query

func (EntitiesRelationsListOperationOptions) ToQuery 

func (o EntitiesRelationsListOperationOptions) ToQuery() *client.QueryParams

type EntitiesRelationsListOperationResponse 

type EntitiesRelationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Relation
}

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 EntityRelationId 

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

EntityRelationId is a struct representing the Resource ID for a Entity Relation

func NewEntityRelationID 

func NewEntityRelationID(subscriptionId string, resourceGroupName string, workspaceName string, entityId string, relationName string) EntityRelationId

NewEntityRelationID returns a new EntityRelationId struct

func ParseEntityRelationID 

func ParseEntityRelationID(input string) (*EntityRelationId, error)

ParseEntityRelationID parses 'input' into a EntityRelationId

func ParseEntityRelationIDInsensitively 

func ParseEntityRelationIDInsensitively(input string) (*EntityRelationId, error)

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

func (*EntityRelationId) FromParseResult 

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

func (EntityRelationId) ID 

func (id EntityRelationId) ID() string

ID returns the formatted Entity Relation ID

func (EntityRelationId) Segments 

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

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

func (EntityRelationId) String 

func (id EntityRelationId) String() string

String returns a human-readable description of this Entity Relation ID

type EntityRelationsClient 

type EntityRelationsClient struct {
	Client *resourcemanager.Client
}

func NewEntityRelationsClientWithBaseURI 

func NewEntityRelationsClientWithBaseURI(sdkApi sdkEnv.Api) (*EntityRelationsClient, error)

func (EntityRelationsClient) EntitiesRelationsList 

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

EntitiesRelationsList ...

func (EntityRelationsClient) EntitiesRelationsListComplete 

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

EntitiesRelationsListComplete retrieves all the results into a single object

func (EntityRelationsClient) EntitiesRelationsListCompleteMatchingPredicate 

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

EntitiesRelationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EntityRelationsClient) GetRelation 

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

GetRelation ...

type GetRelationOperationResponse 

type GetRelationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	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 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"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.