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.CreateOrUpdate
ctx := context.TODO()
id := dataconnectors.NewDataConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "dataConnectorIdValue")
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", "workspaceValue", "dataConnectorIdValue")
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", "workspaceValue", "dataConnectorIdValue")
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", "workspaceValue")
// 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 ¶
- func PossibleValuesForDataConnectorKind() []string
- func PossibleValuesForDataTypeState() []string
- func ValidateDataConnectorID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
- type AADDataConnector
- type AADDataConnectorProperties
- type AATPDataConnector
- type AATPDataConnectorProperties
- type ASCDataConnector
- type ASCDataConnectorProperties
- type AlertsDataTypeOfDataConnector
- type AwsCloudTrailDataConnector
- type AwsCloudTrailDataConnectorDataTypes
- type AwsCloudTrailDataConnectorProperties
- type CreateOrUpdateOperationResponse
- type DataConnector
- type DataConnectorDataTypeCommon
- type DataConnectorId
- type DataConnectorKind
- type DataConnectorOperationPredicate
- type DataConnectorsClient
- func (c DataConnectorsClient) CreateOrUpdate(ctx context.Context, id DataConnectorId, input DataConnector) (result CreateOrUpdateOperationResponse, err error)
- func (c DataConnectorsClient) Delete(ctx context.Context, id DataConnectorId) (result DeleteOperationResponse, err error)
- func (c DataConnectorsClient) Get(ctx context.Context, id DataConnectorId) (result GetOperationResponse, err error)
- func (c DataConnectorsClient) List(ctx context.Context, id WorkspaceId) (result ListOperationResponse, err error)
- func (c DataConnectorsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)
- func (c DataConnectorsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate DataConnectorOperationPredicate) (result ListCompleteResult, err error)
- type DataTypeState
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type MCASDataConnector
- type MCASDataConnectorDataTypes
- type MCASDataConnectorProperties
- type MDATPDataConnector
- type MDATPDataConnectorProperties
- type OfficeDataConnector
- type OfficeDataConnectorDataTypes
- type OfficeDataConnectorProperties
- type RawDataConnectorImpl
- type TIDataConnector
- type TIDataConnectorDataTypes
- type TIDataConnectorProperties
- type WorkspaceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForDataConnectorKind ¶
func PossibleValuesForDataConnectorKind() []string
func PossibleValuesForDataTypeState ¶
func PossibleValuesForDataTypeState() []string
func ValidateDataConnectorID ¶
ValidateDataConnectorID checks that 'input' can be parsed as a Data Connector ID
func ValidateWorkspaceID ¶
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 CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *DataConnector }
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) 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 ¶ added in v0.20240221.1115631
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 ¶ added in v0.20240221.1115631
func (s *DataTypeState) UnmarshalJSON(bytes []byte) error
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *DataConnector }
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response Items []DataConnector }
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]DataConnector }
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"` Teams *DataConnectorDataTypeCommon `json:"teams,omitempty"` }
type OfficeDataConnectorProperties ¶
type OfficeDataConnectorProperties struct { DataTypes *OfficeDataConnectorDataTypes `json:"dataTypes,omitempty"` TenantId *string `json:"tenantId,omitempty"` }
type RawDataConnectorImpl ¶
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).
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 ¶
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) 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 ¶
- client.go
- constants.go
- id_dataconnector.go
- id_workspace.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- model_aaddataconnector.go
- model_aaddataconnectorproperties.go
- model_aatpdataconnector.go
- model_aatpdataconnectorproperties.go
- model_alertsdatatypeofdataconnector.go
- model_ascdataconnector.go
- model_ascdataconnectorproperties.go
- model_awscloudtraildataconnector.go
- model_awscloudtraildataconnectordatatypes.go
- model_awscloudtraildataconnectorproperties.go
- model_dataconnector.go
- model_dataconnectordatatypecommon.go
- model_mcasdataconnector.go
- model_mcasdataconnectordatatypes.go
- model_mcasdataconnectorproperties.go
- model_mdatpdataconnector.go
- model_mdatpdataconnectorproperties.go
- model_officedataconnector.go
- model_officedataconnectordatatypes.go
- model_officedataconnectorproperties.go
- model_tidataconnector.go
- model_tidataconnectordatatypes.go
- model_tidataconnectorproperties.go
- predicates.go
- version.go