externalsecuritysolutions

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: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/externalsecuritysolutions Documentation

The externalsecuritysolutions SDK allows for interaction with Azure Resource Manager security (API Version 2020-01-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/externalsecuritysolutions"

Client Initialization

client := externalsecuritysolutions.NewExternalSecuritySolutionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExternalSecuritySolutionsClient.Get

ctx := context.TODO()
id := externalsecuritysolutions.NewExternalSecuritySolutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "ascLocation", "externalSecuritySolutionsName")

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: ExternalSecuritySolutionsClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// 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
}

Example Usage: ExternalSecuritySolutionsClient.ListByHomeRegion

ctx := context.TODO()
id := externalsecuritysolutions.NewLocationID("12345678-1234-9876-4563-123456789012", "ascLocation")

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

func PossibleValuesForAadConnectivityState() []string

func PossibleValuesForExternalSecuritySolutionKind 

func PossibleValuesForExternalSecuritySolutionKind() []string

func ValidateExternalSecuritySolutionID 

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

ValidateExternalSecuritySolutionID checks that 'input' can be parsed as a External Security Solution ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type AadConnectivityState 

type AadConnectivityState string
const (
	AadConnectivityStateConnected   AadConnectivityState = "Connected"
	AadConnectivityStateDiscovered  AadConnectivityState = "Discovered"
	AadConnectivityStateNotLicensed AadConnectivityState = "NotLicensed"
)

func (*AadConnectivityState) UnmarshalJSON added in v0.20240228.1142829 

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

type AadExternalSecuritySolution 

type AadExternalSecuritySolution struct {
	Properties *AadSolutionProperties `json:"properties,omitempty"`

	Id       *string                       `json:"id,omitempty"`
	Kind     *ExternalSecuritySolutionKind `json:"kind,omitempty"`
	Location *string                       `json:"location,omitempty"`
	Name     *string                       `json:"name,omitempty"`
	Type     *string                       `json:"type,omitempty"`
}

func (AadExternalSecuritySolution) ExternalSecuritySolution added in v0.20240920.1135249 

func (s AadExternalSecuritySolution) ExternalSecuritySolution() BaseExternalSecuritySolutionImpl

func (AadExternalSecuritySolution) MarshalJSON 

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

type AadSolutionProperties 

type AadSolutionProperties struct {
	ConnectivityState *AadConnectivityState `json:"connectivityState,omitempty"`
	DeviceType        *string               `json:"deviceType,omitempty"`
	DeviceVendor      *string               `json:"deviceVendor,omitempty"`
	Workspace         *ConnectedWorkspace   `json:"workspace,omitempty"`
}

type AtaExternalSecuritySolution 

type AtaExternalSecuritySolution struct {
	Properties *AtaSolutionProperties `json:"properties,omitempty"`

	Id       *string                       `json:"id,omitempty"`
	Kind     *ExternalSecuritySolutionKind `json:"kind,omitempty"`
	Location *string                       `json:"location,omitempty"`
	Name     *string                       `json:"name,omitempty"`
	Type     *string                       `json:"type,omitempty"`
}

func (AtaExternalSecuritySolution) ExternalSecuritySolution added in v0.20240920.1135249 

func (s AtaExternalSecuritySolution) ExternalSecuritySolution() BaseExternalSecuritySolutionImpl

func (AtaExternalSecuritySolution) MarshalJSON 

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

type AtaSolutionProperties 

type AtaSolutionProperties struct {
	DeviceType        *string             `json:"deviceType,omitempty"`
	DeviceVendor      *string             `json:"deviceVendor,omitempty"`
	LastEventReceived *string             `json:"lastEventReceived,omitempty"`
	Workspace         *ConnectedWorkspace `json:"workspace,omitempty"`
}

type BaseExternalSecuritySolutionImpl added in v0.20240920.1135249 

type BaseExternalSecuritySolutionImpl struct {
	Id       *string                       `json:"id,omitempty"`
	Kind     *ExternalSecuritySolutionKind `json:"kind,omitempty"`
	Location *string                       `json:"location,omitempty"`
	Name     *string                       `json:"name,omitempty"`
	Type     *string                       `json:"type,omitempty"`
}

func (BaseExternalSecuritySolutionImpl) ExternalSecuritySolution added in v0.20240920.1135249 

func (s BaseExternalSecuritySolutionImpl) ExternalSecuritySolution() BaseExternalSecuritySolutionImpl

type CefExternalSecuritySolution 

type CefExternalSecuritySolution struct {
	Properties *CefSolutionProperties `json:"properties,omitempty"`

	Id       *string                       `json:"id,omitempty"`
	Kind     *ExternalSecuritySolutionKind `json:"kind,omitempty"`
	Location *string                       `json:"location,omitempty"`
	Name     *string                       `json:"name,omitempty"`
	Type     *string                       `json:"type,omitempty"`
}

func (CefExternalSecuritySolution) ExternalSecuritySolution added in v0.20240920.1135249 

func (s CefExternalSecuritySolution) ExternalSecuritySolution() BaseExternalSecuritySolutionImpl

func (CefExternalSecuritySolution) MarshalJSON 

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

type CefSolutionProperties 

type CefSolutionProperties struct {
	Agent             *string             `json:"agent,omitempty"`
	DeviceType        *string             `json:"deviceType,omitempty"`
	DeviceVendor      *string             `json:"deviceVendor,omitempty"`
	Hostname          *string             `json:"hostname,omitempty"`
	LastEventReceived *string             `json:"lastEventReceived,omitempty"`
	Workspace         *ConnectedWorkspace `json:"workspace,omitempty"`
}

type ConnectedWorkspace 

type ConnectedWorkspace struct {
	Id *string `json:"id,omitempty"`
}

type ExternalSecuritySolution 

type ExternalSecuritySolution interface {
	ExternalSecuritySolution() BaseExternalSecuritySolutionImpl
}

func UnmarshalExternalSecuritySolutionImplementation added in v0.20240920.1135249 

func UnmarshalExternalSecuritySolutionImplementation(input []byte) (ExternalSecuritySolution, error)

type ExternalSecuritySolutionId 

type ExternalSecuritySolutionId struct {
	SubscriptionId               string
	ResourceGroupName            string
	LocationName                 string
	ExternalSecuritySolutionName string
}

ExternalSecuritySolutionId is a struct representing the Resource ID for a External Security Solution

func NewExternalSecuritySolutionID 

func NewExternalSecuritySolutionID(subscriptionId string, resourceGroupName string, locationName string, externalSecuritySolutionName string) ExternalSecuritySolutionId

NewExternalSecuritySolutionID returns a new ExternalSecuritySolutionId struct

func ParseExternalSecuritySolutionID 

func ParseExternalSecuritySolutionID(input string) (*ExternalSecuritySolutionId, error)

ParseExternalSecuritySolutionID parses 'input' into a ExternalSecuritySolutionId

func ParseExternalSecuritySolutionIDInsensitively 

func ParseExternalSecuritySolutionIDInsensitively(input string) (*ExternalSecuritySolutionId, error)

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

func (*ExternalSecuritySolutionId) FromParseResult 

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

func (ExternalSecuritySolutionId) ID 

func (id ExternalSecuritySolutionId) ID() string

ID returns the formatted External Security Solution ID

func (ExternalSecuritySolutionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this External Security Solution ID

func (ExternalSecuritySolutionId) String 

func (id ExternalSecuritySolutionId) String() string

String returns a human-readable description of this External Security Solution ID

type ExternalSecuritySolutionKind 

type ExternalSecuritySolutionKind string
const (
	ExternalSecuritySolutionKindAAD ExternalSecuritySolutionKind = "AAD"
	ExternalSecuritySolutionKindATA ExternalSecuritySolutionKind = "ATA"
	ExternalSecuritySolutionKindCEF ExternalSecuritySolutionKind = "CEF"
)

func (*ExternalSecuritySolutionKind) UnmarshalJSON added in v0.20240228.1142829 

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

type ExternalSecuritySolutionOperationPredicate 

type ExternalSecuritySolutionOperationPredicate struct {
}

func (ExternalSecuritySolutionOperationPredicate) Matches 

func (p ExternalSecuritySolutionOperationPredicate) Matches(input ExternalSecuritySolution) bool

type ExternalSecuritySolutionsClient 

type ExternalSecuritySolutionsClient struct {
	Client *resourcemanager.Client
}

func NewExternalSecuritySolutionsClientWithBaseURI 

func NewExternalSecuritySolutionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExternalSecuritySolutionsClient, error)

func (ExternalSecuritySolutionsClient) Get 

func (c ExternalSecuritySolutionsClient) Get(ctx context.Context, id ExternalSecuritySolutionId) (result GetOperationResponse, err error)

Get ...

func (ExternalSecuritySolutionsClient) List 

func (c ExternalSecuritySolutionsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (ExternalSecuritySolutionsClient) ListByHomeRegion 

func (c ExternalSecuritySolutionsClient) ListByHomeRegion(ctx context.Context, id LocationId) (result ListByHomeRegionOperationResponse, err error)

ListByHomeRegion ...

func (ExternalSecuritySolutionsClient) ListByHomeRegionComplete 

func (c ExternalSecuritySolutionsClient) ListByHomeRegionComplete(ctx context.Context, id LocationId) (ListByHomeRegionCompleteResult, error)

ListByHomeRegionComplete retrieves all the results into a single object

func (ExternalSecuritySolutionsClient) ListByHomeRegionCompleteMatchingPredicate 

func (c ExternalSecuritySolutionsClient) ListByHomeRegionCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ExternalSecuritySolutionOperationPredicate) (result ListByHomeRegionCompleteResult, err error)

ListByHomeRegionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ExternalSecuritySolutionsClient) ListComplete 

func (c ExternalSecuritySolutionsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ExternalSecuritySolutionsClient) ListCompleteMatchingPredicate 

func (c ExternalSecuritySolutionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ExternalSecuritySolutionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse 

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

type ListByHomeRegionCompleteResult 

type ListByHomeRegionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ExternalSecuritySolution
}

type ListByHomeRegionCustomPager added in v0.20240628.1153531 

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

type ListByHomeRegionOperationResponse 

type ListByHomeRegionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ExternalSecuritySolution
}

type ListCompleteResult 

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

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        *[]ExternalSecuritySolution
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type RawExternalSecuritySolutionImpl 

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

RawExternalSecuritySolutionImpl 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 (RawExternalSecuritySolutionImpl) ExternalSecuritySolution added in v0.20240920.1135249 

func (s RawExternalSecuritySolutionImpl) ExternalSecuritySolution() BaseExternalSecuritySolutionImpl

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.