connectordefinitions

package
v0.20241209.1115630 Latest Latest
Warning

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

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

README

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

The connectordefinitions 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/connectordefinitions"

Client Initialization

client := connectordefinitions.NewConnectorDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectorDefinitionsClient.DataConnectorDefinitionsCreateOrUpdate

ctx := context.TODO()
id := connectordefinitions.NewDataConnectorDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "dataConnectorDefinitionName")

payload := connectordefinitions.DataConnectorDefinition{
	// ...
}


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

Example Usage: ConnectorDefinitionsClient.DataConnectorDefinitionsDelete

ctx := context.TODO()
id := connectordefinitions.NewDataConnectorDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "dataConnectorDefinitionName")

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

Example Usage: ConnectorDefinitionsClient.DataConnectorDefinitionsGet

ctx := context.TODO()
id := connectordefinitions.NewDataConnectorDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "dataConnectorDefinitionName")

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

Example Usage: ConnectorDefinitionsClient.DataConnectorDefinitionsList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataConnectorDefinitionKind 

func PossibleValuesForDataConnectorDefinitionKind() []string

func PossibleValuesForProviderPermissionsScope 

func PossibleValuesForProviderPermissionsScope() []string

func ValidateDataConnectorDefinitionID 

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

ValidateDataConnectorDefinitionID checks that 'input' can be parsed as a Data Connector Definition ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type BaseDataConnectorDefinitionImpl 

type BaseDataConnectorDefinitionImpl struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Kind       DataConnectorDefinitionKind `json:"kind"`
	Name       *string                     `json:"name,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

func (BaseDataConnectorDefinitionImpl) DataConnectorDefinition 

func (s BaseDataConnectorDefinitionImpl) DataConnectorDefinition() BaseDataConnectorDefinitionImpl

type ConnectivityCriterion 

type ConnectivityCriterion struct {
	Type  string    `json:"type"`
	Value *[]string `json:"value,omitempty"`
}

type ConnectorDataType 

type ConnectorDataType struct {
	LastDataReceivedQuery string `json:"lastDataReceivedQuery"`
	Name                  string `json:"name"`
}

type ConnectorDefinitionsAvailability 

type ConnectorDefinitionsAvailability struct {
	IsPreview *bool  `json:"isPreview,omitempty"`
	Status    *int64 `json:"status,omitempty"`
}

type ConnectorDefinitionsClient 

type ConnectorDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewConnectorDefinitionsClientWithBaseURI 

func NewConnectorDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectorDefinitionsClient, error)

func (ConnectorDefinitionsClient) DataConnectorDefinitionsCreateOrUpdate 

func (c ConnectorDefinitionsClient) DataConnectorDefinitionsCreateOrUpdate(ctx context.Context, id DataConnectorDefinitionId, input DataConnectorDefinition) (result DataConnectorDefinitionsCreateOrUpdateOperationResponse, err error)

DataConnectorDefinitionsCreateOrUpdate ...

func (ConnectorDefinitionsClient) DataConnectorDefinitionsDelete 

func (c ConnectorDefinitionsClient) DataConnectorDefinitionsDelete(ctx context.Context, id DataConnectorDefinitionId) (result DataConnectorDefinitionsDeleteOperationResponse, err error)

DataConnectorDefinitionsDelete ...

func (ConnectorDefinitionsClient) DataConnectorDefinitionsGet 

func (c ConnectorDefinitionsClient) DataConnectorDefinitionsGet(ctx context.Context, id DataConnectorDefinitionId) (result DataConnectorDefinitionsGetOperationResponse, err error)

DataConnectorDefinitionsGet ...

func (ConnectorDefinitionsClient) DataConnectorDefinitionsList 

func (c ConnectorDefinitionsClient) DataConnectorDefinitionsList(ctx context.Context, id WorkspaceId) (result DataConnectorDefinitionsListOperationResponse, err error)

DataConnectorDefinitionsList ...

func (ConnectorDefinitionsClient) DataConnectorDefinitionsListComplete 

func (c ConnectorDefinitionsClient) DataConnectorDefinitionsListComplete(ctx context.Context, id WorkspaceId) (DataConnectorDefinitionsListCompleteResult, error)

DataConnectorDefinitionsListComplete retrieves all the results into a single object

func (ConnectorDefinitionsClient) DataConnectorDefinitionsListCompleteMatchingPredicate 

func (c ConnectorDefinitionsClient) DataConnectorDefinitionsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate DataConnectorDefinitionOperationPredicate) (result DataConnectorDefinitionsListCompleteResult, err error)

DataConnectorDefinitionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ConnectorDefinitionsPermissions 

type ConnectorDefinitionsPermissions struct {
	Customs          *[]CustomPermissionDetails              `json:"customs,omitempty"`
	Licenses         *[]string                               `json:"licenses,omitempty"`
	ResourceProvider *[]ConnectorDefinitionsResourceProvider `json:"resourceProvider,omitempty"`
	Tenant           *[]string                               `json:"tenant,omitempty"`
}

type ConnectorDefinitionsResourceProvider 

type ConnectorDefinitionsResourceProvider struct {
	PermissionsDisplayText string                              `json:"permissionsDisplayText"`
	Provider               string                              `json:"provider"`
	ProviderDisplayName    string                              `json:"providerDisplayName"`
	RequiredPermissions    ResourceProviderRequiredPermissions `json:"requiredPermissions"`
	Scope                  ProviderPermissionsScope            `json:"scope"`
}

type CustomPermissionDetails 

type CustomPermissionDetails struct {
	Description string `json:"description"`
	Name        string `json:"name"`
}

type CustomizableConnectionsConfig 

type CustomizableConnectionsConfig struct {
	TemplateSpecName    string `json:"templateSpecName"`
	TemplateSpecVersion string `json:"templateSpecVersion"`
}

type CustomizableConnectorDefinition 

type CustomizableConnectorDefinition struct {
	Properties *CustomizableConnectorDefinitionProperties `json:"properties,omitempty"`

	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Kind       DataConnectorDefinitionKind `json:"kind"`
	Name       *string                     `json:"name,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

func (CustomizableConnectorDefinition) DataConnectorDefinition 

func (s CustomizableConnectorDefinition) DataConnectorDefinition() BaseDataConnectorDefinitionImpl

func (CustomizableConnectorDefinition) MarshalJSON 

func (s CustomizableConnectorDefinition) MarshalJSON() ([]byte, error)

type CustomizableConnectorDefinitionProperties 

type CustomizableConnectorDefinitionProperties struct {
	ConnectionsConfig *CustomizableConnectionsConfig `json:"connectionsConfig,omitempty"`
	ConnectorUiConfig CustomizableConnectorUiConfig  `json:"connectorUiConfig"`
	CreatedTimeUtc    *string                        `json:"createdTimeUtc,omitempty"`
	LastModifiedUtc   *string                        `json:"lastModifiedUtc,omitempty"`
}

func (*CustomizableConnectorDefinitionProperties) GetCreatedTimeUtcAsTime 

func (o *CustomizableConnectorDefinitionProperties) GetCreatedTimeUtcAsTime() (*time.Time, error)

func (*CustomizableConnectorDefinitionProperties) GetLastModifiedUtcAsTime 

func (o *CustomizableConnectorDefinitionProperties) GetLastModifiedUtcAsTime() (*time.Time, error)

func (*CustomizableConnectorDefinitionProperties) SetCreatedTimeUtcAsTime 

func (o *CustomizableConnectorDefinitionProperties) SetCreatedTimeUtcAsTime(input time.Time)

func (*CustomizableConnectorDefinitionProperties) SetLastModifiedUtcAsTime 

func (o *CustomizableConnectorDefinitionProperties) SetLastModifiedUtcAsTime(input time.Time)

type CustomizableConnectorUiConfig 

type CustomizableConnectorUiConfig struct {
	Availability                     *ConnectorDefinitionsAvailability `json:"availability,omitempty"`
	ConnectivityCriteria             []ConnectivityCriterion           `json:"connectivityCriteria"`
	DataTypes                        []ConnectorDataType               `json:"dataTypes"`
	DescriptionMarkdown              string                            `json:"descriptionMarkdown"`
	GraphQueries                     []GraphQuery                      `json:"graphQueries"`
	GraphQueriesTableName            *string                           `json:"graphQueriesTableName,omitempty"`
	Id                               *string                           `json:"id,omitempty"`
	InstructionSteps                 []InstructionStep                 `json:"instructionSteps"`
	IsConnectivityCriteriasMatchSome *bool                             `json:"isConnectivityCriteriasMatchSome,omitempty"`
	Permissions                      ConnectorDefinitionsPermissions   `json:"permissions"`
	Publisher                        string                            `json:"publisher"`
	SampleQueries                    []SampleQuery                     `json:"sampleQueries"`
	Title                            string                            `json:"title"`
}

type DataConnectorDefinition 

type DataConnectorDefinition interface {
	DataConnectorDefinition() BaseDataConnectorDefinitionImpl
}

func UnmarshalDataConnectorDefinitionImplementation 

func UnmarshalDataConnectorDefinitionImplementation(input []byte) (DataConnectorDefinition, error)

type DataConnectorDefinitionId 

type DataConnectorDefinitionId struct {
	SubscriptionId              string
	ResourceGroupName           string
	WorkspaceName               string
	DataConnectorDefinitionName string
}

DataConnectorDefinitionId is a struct representing the Resource ID for a Data Connector Definition

func NewDataConnectorDefinitionID 

func NewDataConnectorDefinitionID(subscriptionId string, resourceGroupName string, workspaceName string, dataConnectorDefinitionName string) DataConnectorDefinitionId

NewDataConnectorDefinitionID returns a new DataConnectorDefinitionId struct

func ParseDataConnectorDefinitionID 

func ParseDataConnectorDefinitionID(input string) (*DataConnectorDefinitionId, error)

ParseDataConnectorDefinitionID parses 'input' into a DataConnectorDefinitionId

func ParseDataConnectorDefinitionIDInsensitively 

func ParseDataConnectorDefinitionIDInsensitively(input string) (*DataConnectorDefinitionId, error)

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

func (*DataConnectorDefinitionId) FromParseResult 

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

func (DataConnectorDefinitionId) ID 

func (id DataConnectorDefinitionId) ID() string

ID returns the formatted Data Connector Definition ID

func (DataConnectorDefinitionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Connector Definition ID

func (DataConnectorDefinitionId) String 

func (id DataConnectorDefinitionId) String() string

String returns a human-readable description of this Data Connector Definition ID

type DataConnectorDefinitionKind 

type DataConnectorDefinitionKind string
const (
	DataConnectorDefinitionKindCustomizable DataConnectorDefinitionKind = "Customizable"
)

func (*DataConnectorDefinitionKind) UnmarshalJSON 

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

type DataConnectorDefinitionOperationPredicate 

type DataConnectorDefinitionOperationPredicate struct {
}

func (DataConnectorDefinitionOperationPredicate) Matches 

func (p DataConnectorDefinitionOperationPredicate) Matches(input DataConnectorDefinition) bool

type DataConnectorDefinitionsCreateOrUpdateOperationResponse 

type DataConnectorDefinitionsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        DataConnectorDefinition
}

type DataConnectorDefinitionsDeleteOperationResponse 

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

type DataConnectorDefinitionsGetOperationResponse 

type DataConnectorDefinitionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        DataConnectorDefinition
}

type DataConnectorDefinitionsListCompleteResult 

type DataConnectorDefinitionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataConnectorDefinition
}

type DataConnectorDefinitionsListCustomPager 

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

type DataConnectorDefinitionsListOperationResponse 

type DataConnectorDefinitionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataConnectorDefinition
}

type GraphQuery 

type GraphQuery struct {
	BaseQuery  string `json:"baseQuery"`
	Legend     string `json:"legend"`
	MetricName string `json:"metricName"`
}

type InstructionStep 

type InstructionStep struct {
	Description  *string                   `json:"description,omitempty"`
	InnerSteps   *[]InstructionStep        `json:"innerSteps,omitempty"`
	Instructions *[]InstructionStepDetails `json:"instructions,omitempty"`
	Title        *string                   `json:"title,omitempty"`
}

type InstructionStepDetails 

type InstructionStepDetails struct {
	Parameters interface{} `json:"parameters"`
	Type       string      `json:"type"`
}

type ProviderPermissionsScope 

type ProviderPermissionsScope string
const (
	ProviderPermissionsScopeResourceGroup ProviderPermissionsScope = "ResourceGroup"
	ProviderPermissionsScopeSubscription  ProviderPermissionsScope = "Subscription"
	ProviderPermissionsScopeWorkspace     ProviderPermissionsScope = "Workspace"
)

func (*ProviderPermissionsScope) UnmarshalJSON 

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

type RawDataConnectorDefinitionImpl 

type RawDataConnectorDefinitionImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawDataConnectorDefinitionImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawDataConnectorDefinitionImpl) DataConnectorDefinition 

func (s RawDataConnectorDefinitionImpl) DataConnectorDefinition() BaseDataConnectorDefinitionImpl

type ResourceProviderRequiredPermissions 

type ResourceProviderRequiredPermissions struct {
	Action *bool `json:"action,omitempty"`
	Delete *bool `json:"delete,omitempty"`
	Read   *bool `json:"read,omitempty"`
	Write  *bool `json:"write,omitempty"`
}

type SampleQuery 

type SampleQuery struct {
	Description string `json:"description"`
	Query       string `json:"query"`
}

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

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

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

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.