dataconnectors

package
v0.20241004.1180715 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := dataconnectors.NewDataConnectorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataConnectorsClient.CreateOrUpdate

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

payload := dataconnectors.DataConnector{
	// ...
}


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

Example Usage: DataConnectorsClient.Delete

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

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

Example Usage: DataConnectorsClient.Get

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

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

Example Usage: DataConnectorsClient.List

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

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(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 PossibleValuesForDataConnectorKind 

func PossibleValuesForDataConnectorKind() []string

func PossibleValuesForDataTypeState 

func PossibleValuesForDataTypeState() []string

func ValidateDataConnectorID 

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

ValidateDataConnectorID checks that 'input' can be parsed as a Data Connector 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 AADDataConnector 

type AADDataConnector struct {
	Properties *AADDataConnectorProperties `json:"properties,omitempty"`

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

func (AADDataConnector) DataConnector added in v0.20240920.1135249 

func (s AADDataConnector) DataConnector() BaseDataConnectorImpl

func (AADDataConnector) MarshalJSON 

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

type AADDataConnectorProperties 

type AADDataConnectorProperties struct {
	DataTypes *AlertsDataTypeOfDataConnector `json:"dataTypes,omitempty"`
	TenantId  *string                        `json:"tenantId,omitempty"`
}

type AATPDataConnector 

type AATPDataConnector struct {
	Properties *AATPDataConnectorProperties `json:"properties,omitempty"`

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

func (AATPDataConnector) DataConnector added in v0.20240920.1135249 

func (s AATPDataConnector) DataConnector() BaseDataConnectorImpl

func (AATPDataConnector) MarshalJSON 

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

type AATPDataConnectorProperties 

type AATPDataConnectorProperties struct {
	DataTypes *AlertsDataTypeOfDataConnector `json:"dataTypes,omitempty"`
	TenantId  *string                        `json:"tenantId,omitempty"`
}

type ASCDataConnector 

type ASCDataConnector struct {
	Properties *ASCDataConnectorProperties `json:"properties,omitempty"`

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

func (ASCDataConnector) DataConnector added in v0.20240920.1135249 

func (s ASCDataConnector) DataConnector() BaseDataConnectorImpl

func (ASCDataConnector) MarshalJSON 

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

type ASCDataConnectorProperties 

type ASCDataConnectorProperties struct {
	DataTypes      *AlertsDataTypeOfDataConnector `json:"dataTypes,omitempty"`
	SubscriptionId *string                        `json:"subscriptionId,omitempty"`
}

type AlertsDataTypeOfDataConnector 

type AlertsDataTypeOfDataConnector struct {
	Alerts *DataConnectorDataTypeCommon `json:"alerts,omitempty"`
}

type AwsCloudTrailDataConnector 

type AwsCloudTrailDataConnector struct {
	Properties *AwsCloudTrailDataConnectorProperties `json:"properties,omitempty"`

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

func (AwsCloudTrailDataConnector) DataConnector added in v0.20240920.1135249 

func (s AwsCloudTrailDataConnector) DataConnector() BaseDataConnectorImpl

func (AwsCloudTrailDataConnector) MarshalJSON 

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

type AwsCloudTrailDataConnectorDataTypes 

type AwsCloudTrailDataConnectorDataTypes struct {
	Logs *DataConnectorDataTypeCommon `json:"logs,omitempty"`
}

type AwsCloudTrailDataConnectorProperties 

type AwsCloudTrailDataConnectorProperties struct {
	AwsRoleArn *string                              `json:"awsRoleArn,omitempty"`
	DataTypes  *AwsCloudTrailDataConnectorDataTypes `json:"dataTypes,omitempty"`
}

type BaseDataConnectorImpl added in v0.20240920.1135249 

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

func (BaseDataConnectorImpl) DataConnector added in v0.20240920.1135249 

func (s BaseDataConnectorImpl) DataConnector() BaseDataConnectorImpl

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        DataConnector
}

type DataConnector 

type DataConnector interface {
	DataConnector() BaseDataConnectorImpl
}

func UnmarshalDataConnectorImplementation added in v0.20240920.1135249 

func UnmarshalDataConnectorImplementation(input []byte) (DataConnector, error)

type DataConnectorDataTypeCommon 

type DataConnectorDataTypeCommon struct {
	State *DataTypeState `json:"state,omitempty"`
}

type DataConnectorId 

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

DataConnectorId is a struct representing the Resource ID for a Data Connector

func NewDataConnectorID 

func NewDataConnectorID(subscriptionId string, resourceGroupName string, workspaceName string, dataConnectorId string) DataConnectorId

NewDataConnectorID returns a new DataConnectorId struct

func ParseDataConnectorID 

func ParseDataConnectorID(input string) (*DataConnectorId, error)

ParseDataConnectorID parses 'input' into a DataConnectorId

func ParseDataConnectorIDInsensitively 

func ParseDataConnectorIDInsensitively(input string) (*DataConnectorId, error)

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

func (*DataConnectorId) FromParseResult 

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

func (DataConnectorId) ID 

func (id DataConnectorId) ID() string

ID returns the formatted Data Connector ID

func (DataConnectorId) Segments 

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

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

func (DataConnectorId) String 

func (id DataConnectorId) String() string

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

type DataConnectorKind 

type DataConnectorKind string
const (
	DataConnectorKindAmazonWebServicesCloudTrail               DataConnectorKind = "AmazonWebServicesCloudTrail"
	DataConnectorKindAzureActiveDirectory                      DataConnectorKind = "AzureActiveDirectory"
	DataConnectorKindAzureAdvancedThreatProtection             DataConnectorKind = "AzureAdvancedThreatProtection"
	DataConnectorKindAzureSecurityCenter                       DataConnectorKind = "AzureSecurityCenter"
	DataConnectorKindMicrosoftCloudAppSecurity                 DataConnectorKind = "MicrosoftCloudAppSecurity"
	DataConnectorKindMicrosoftDefenderAdvancedThreatProtection DataConnectorKind = "MicrosoftDefenderAdvancedThreatProtection"
	DataConnectorKindOfficeThreeSixFive                        DataConnectorKind = "Office365"
	DataConnectorKindThreatIntelligence                        DataConnectorKind = "ThreatIntelligence"
)

func (*DataConnectorKind) UnmarshalJSON 

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

type DataConnectorOperationPredicate 

type DataConnectorOperationPredicate struct {
}

func (DataConnectorOperationPredicate) Matches 

func (p DataConnectorOperationPredicate) Matches(input DataConnector) bool

type DataConnectorsClient 

type DataConnectorsClient struct {
	Client *resourcemanager.Client
}

func NewDataConnectorsClientWithBaseURI 

func NewDataConnectorsClientWithBaseURI(sdkApi sdkEnv.Api) (*DataConnectorsClient, error)

func (DataConnectorsClient) CreateOrUpdate 

func (c DataConnectorsClient) CreateOrUpdate(ctx context.Context, id DataConnectorId, input DataConnector) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DataConnectorsClient) Delete 

func (c DataConnectorsClient) Delete(ctx context.Context, id DataConnectorId) (result DeleteOperationResponse, err error)

Delete ...

func (DataConnectorsClient) Get 

func (c DataConnectorsClient) Get(ctx context.Context, id DataConnectorId) (result GetOperationResponse, err error)

Get ...

func (DataConnectorsClient) List 

func (c DataConnectorsClient) List(ctx context.Context, id WorkspaceId) (result ListOperationResponse, err error)

List ...

func (DataConnectorsClient) ListComplete 

func (c DataConnectorsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DataConnectorsClient) ListCompleteMatchingPredicate 

func (c DataConnectorsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate DataConnectorOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DataTypeState 

type DataTypeState string
const (
	DataTypeStateDisabled DataTypeState = "Disabled"
	DataTypeStateEnabled  DataTypeState = "Enabled"
)

func (*DataTypeState) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        DataConnector
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataConnector
}

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataConnector
}

type MCASDataConnector 

type MCASDataConnector struct {
	Properties *MCASDataConnectorProperties `json:"properties,omitempty"`

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

func (MCASDataConnector) DataConnector added in v0.20240920.1135249 

func (s MCASDataConnector) DataConnector() BaseDataConnectorImpl

func (MCASDataConnector) MarshalJSON 

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

type MCASDataConnectorDataTypes 

type MCASDataConnectorDataTypes struct {
	Alerts        *DataConnectorDataTypeCommon `json:"alerts,omitempty"`
	DiscoveryLogs *DataConnectorDataTypeCommon `json:"discoveryLogs,omitempty"`
}

type MCASDataConnectorProperties 

type MCASDataConnectorProperties struct {
	DataTypes *MCASDataConnectorDataTypes `json:"dataTypes,omitempty"`
	TenantId  *string                     `json:"tenantId,omitempty"`
}

type MDATPDataConnector 

type MDATPDataConnector struct {
	Properties *MDATPDataConnectorProperties `json:"properties,omitempty"`

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

func (MDATPDataConnector) DataConnector added in v0.20240920.1135249 

func (s MDATPDataConnector) DataConnector() BaseDataConnectorImpl

func (MDATPDataConnector) MarshalJSON 

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

type MDATPDataConnectorProperties 

type MDATPDataConnectorProperties struct {
	DataTypes *AlertsDataTypeOfDataConnector `json:"dataTypes,omitempty"`
	TenantId  *string                        `json:"tenantId,omitempty"`
}

type OfficeDataConnector 

type OfficeDataConnector struct {
	Properties *OfficeDataConnectorProperties `json:"properties,omitempty"`

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

func (OfficeDataConnector) DataConnector added in v0.20240920.1135249 

func (s OfficeDataConnector) DataConnector() BaseDataConnectorImpl

func (OfficeDataConnector) MarshalJSON 

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

type OfficeDataConnectorDataTypes 

type OfficeDataConnectorDataTypes struct {
	Exchange   *DataConnectorDataTypeCommon `json:"exchange,omitempty"`
	SharePoint *DataConnectorDataTypeCommon `json:"sharePoint,omitempty"`
	Teams      *DataConnectorDataTypeCommon `json:"teams,omitempty"`
}

type OfficeDataConnectorProperties 

type OfficeDataConnectorProperties struct {
	DataTypes *OfficeDataConnectorDataTypes `json:"dataTypes,omitempty"`
	TenantId  *string                       `json:"tenantId,omitempty"`
}

type RawDataConnectorImpl 

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

RawDataConnectorImpl 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 (RawDataConnectorImpl) DataConnector added in v0.20240920.1135249 

func (s RawDataConnectorImpl) DataConnector() BaseDataConnectorImpl

type TIDataConnector 

type TIDataConnector struct {
	Properties *TIDataConnectorProperties `json:"properties,omitempty"`

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

func (TIDataConnector) DataConnector added in v0.20240920.1135249 

func (s TIDataConnector) DataConnector() BaseDataConnectorImpl

func (TIDataConnector) MarshalJSON 

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

type TIDataConnectorDataTypes 

type TIDataConnectorDataTypes struct {
	Indicators *DataConnectorDataTypeCommon `json:"indicators,omitempty"`
}

type TIDataConnectorProperties 

type TIDataConnectorProperties struct {
	DataTypes         *TIDataConnectorDataTypes `json:"dataTypes,omitempty"`
	TenantId          *string                   `json:"tenantId,omitempty"`
	TipLookbackPeriod *string                   `json:"tipLookbackPeriod,omitempty"`
}

func (*TIDataConnectorProperties) GetTipLookbackPeriodAsTime 

func (o *TIDataConnectorProperties) GetTipLookbackPeriodAsTime() (*time.Time, error)

func (*TIDataConnectorProperties) SetTipLookbackPeriodAsTime 

func (o *TIDataConnectorProperties) SetTipLookbackPeriodAsTime(input time.Time)

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.