graphqueries

README

github.com/hashicorp/go-azure-sdk/resource-manager/resourcegraph/2024-04-01/graphqueries Documentation

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

Client Initialization

client := graphqueries.NewGraphqueriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GraphqueriesClient.GraphQueryUpdate

ctx := context.TODO()
id := graphqueries.NewQueryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "queryName")

payload := graphqueries.GraphQueryUpdateParameters{
	// ...
}


read, err := client.GraphQueryUpdate(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 PossibleValuesForResultKind() []string
• func ValidateQueryID(input interface{}, key string) (warnings []string, errors []error)
• type GraphQueryProperties
  • func (o *GraphQueryProperties) GetTimeModifiedAsTime() (*time.Time, error)
  • func (o *GraphQueryProperties) SetTimeModifiedAsTime(input time.Time)
• type GraphQueryPropertiesUpdateParameters
• type GraphQueryResource
• type GraphQueryUpdateOperationResponse
• type GraphQueryUpdateParameters
• type GraphqueriesClient
  • func NewGraphqueriesClientWithBaseURI(sdkApi sdkEnv.Api) (*GraphqueriesClient, error)
  • func (c GraphqueriesClient) GraphQueryUpdate(ctx context.Context, id QueryId, input GraphQueryUpdateParameters) (result GraphQueryUpdateOperationResponse, err error)
• type QueryId
  • func NewQueryID(subscriptionId string, resourceGroupName string, queryName string) QueryId
  • func ParseQueryID(input string) (*QueryId, error)
  • func ParseQueryIDInsensitively(input string) (*QueryId, error)
  • func (id *QueryId) FromParseResult(input resourceids.ParseResult) error
  • func (id QueryId) ID() string
  • func (id QueryId) Segments() []resourceids.Segment
  • func (id QueryId) String() string
• type ResultKind
  • func (s *ResultKind) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForResultKind

func PossibleValuesForResultKind() []string

func ValidateQueryID

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

ValidateQueryID checks that 'input' can be parsed as a Query ID

Types

type GraphQueryProperties

type GraphQueryProperties struct {
	Description  *string     `json:"description,omitempty"`
	Query        string      `json:"query"`
	ResultKind   *ResultKind `json:"resultKind,omitempty"`
	TimeModified *string     `json:"timeModified,omitempty"`
}

func (*GraphQueryProperties) GetTimeModifiedAsTime

func (o *GraphQueryProperties) GetTimeModifiedAsTime() (*time.Time, error)

func (*GraphQueryProperties) SetTimeModifiedAsTime

func (o *GraphQueryProperties) SetTimeModifiedAsTime(input time.Time)

type GraphQueryPropertiesUpdateParameters

type GraphQueryPropertiesUpdateParameters struct {
	Description *string `json:"description,omitempty"`
	Query       *string `json:"query,omitempty"`
}

type GraphQueryResource

type GraphQueryResource struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *GraphQueryProperties  `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type GraphQueryUpdateOperationResponse

type GraphQueryUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GraphQueryResource
}

type GraphQueryUpdateParameters

type GraphQueryUpdateParameters struct {
	Etag       *string                               `json:"etag,omitempty"`
	Properties *GraphQueryPropertiesUpdateParameters `json:"properties,omitempty"`
	Tags       *map[string]string                    `json:"tags,omitempty"`
}

type GraphqueriesClient

type GraphqueriesClient struct {
	Client *resourcemanager.Client
}

func NewGraphqueriesClientWithBaseURI

func NewGraphqueriesClientWithBaseURI(sdkApi sdkEnv.Api) (*GraphqueriesClient, error)

func (GraphqueriesClient) GraphQueryUpdate

func (c GraphqueriesClient) GraphQueryUpdate(ctx context.Context, id QueryId, input GraphQueryUpdateParameters) (result GraphQueryUpdateOperationResponse, err error)

GraphQueryUpdate ...

type QueryId

type QueryId struct {
	SubscriptionId    string
	ResourceGroupName string
	QueryName         string
}

QueryId is a struct representing the Resource ID for a Query

func NewQueryID

func NewQueryID(subscriptionId string, resourceGroupName string, queryName string) QueryId

NewQueryID returns a new QueryId struct

func ParseQueryID

func ParseQueryID(input string) (*QueryId, error)

ParseQueryID parses 'input' into a QueryId

func ParseQueryIDInsensitively

func ParseQueryIDInsensitively(input string) (*QueryId, error)

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

func (*QueryId) FromParseResult

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

func (QueryId) ID

func (id QueryId) ID() string

ID returns the formatted Query ID

func (QueryId) Segments

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

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

func (QueryId) String

func (id QueryId) String() string

String returns a human-readable description of this Query ID

type ResultKind

type ResultKind string

const (
	ResultKindBasic ResultKind = "basic"
)

func (*ResultKind) UnmarshalJSON

func (s *ResultKind) UnmarshalJSON(bytes []byte) error