dataconnectors

package
v0.20230731.1080956 Latest Latest
Warning

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

Go to latest
Published: Jul 31, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2023-02-01/dataconnectors Documentation

The dataconnectors SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2023-02-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/2023-02-01/dataconnectors"

Client Initialization

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

Example Usage: DataConnectorsClient.DataConnectorsCreateOrUpdate

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

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


read, err := client.DataConnectorsCreateOrUpdate(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.DataConnectorsDelete

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

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

Example Usage: DataConnectorsClient.DataConnectorsGet

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

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

Example Usage: DataConnectorsClient.DataConnectorsList

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

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

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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"`

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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"`

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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"`

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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 DataConnector

type DataConnector interface {
}

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) 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"
)

type DataConnectorOperationPredicate

type DataConnectorOperationPredicate struct {
}

func (DataConnectorOperationPredicate) Matches

type DataConnectorsClient

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

func NewDataConnectorsClientWithBaseURI

func NewDataConnectorsClientWithBaseURI(endpoint string) DataConnectorsClient

func (DataConnectorsClient) DataConnectorsCreateOrUpdate

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

DataConnectorsCreateOrUpdate ...

func (DataConnectorsClient) DataConnectorsDelete

DataConnectorsDelete ...

func (DataConnectorsClient) DataConnectorsGet

DataConnectorsGet ...

func (DataConnectorsClient) DataConnectorsList

DataConnectorsList ...

func (DataConnectorsClient) DataConnectorsListComplete

func (c DataConnectorsClient) DataConnectorsListComplete(ctx context.Context, id WorkspaceId) (DataConnectorsListCompleteResult, error)

DataConnectorsListComplete retrieves all of the results into a single object

func (DataConnectorsClient) DataConnectorsListCompleteMatchingPredicate

func (c DataConnectorsClient) DataConnectorsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate DataConnectorOperationPredicate) (resp DataConnectorsListCompleteResult, err error)

DataConnectorsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type DataConnectorsCreateOrUpdateOperationResponse

type DataConnectorsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *DataConnector
}

type DataConnectorsDeleteOperationResponse

type DataConnectorsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type DataConnectorsGetOperationResponse

type DataConnectorsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *DataConnector
}

type DataConnectorsListCompleteResult

type DataConnectorsListCompleteResult struct {
	Items []DataConnector
}

type DataConnectorsListOperationResponse

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

func (DataConnectorsListOperationResponse) HasMore

func (DataConnectorsListOperationResponse) LoadMore

type DataTypeState

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

type MCASDataConnector

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

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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"`

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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"`

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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 TIDataConnector

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

	// Fields inherited from DataConnector
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

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) 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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL