README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/settings
Documentation
The settings
SDK allows for interaction with the Azure Resource Manager Service security
(API Version 2017-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/settings"
Client Initialization
client := settings.NewSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SettingsClient.Get
ctx := context.TODO()
id := settings.NewSettingID("12345678-1234-9876-4563-123456789012", "MCAS")
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: SettingsClient.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: SettingsClient.Update
ctx := context.TODO()
id := settings.NewSettingID("12345678-1234-9876-4563-123456789012", "MCAS")
payload := settings.Setting{
// ...
}
read, err := client.Update(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForSettingKind() []string
- func PossibleValuesForSettingName() []string
- func ValidateSettingID(input interface{}, key string) (warnings []string, errors []error)
- type DataExportSetting
- type DataExportSettingProperties
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type RawSettingImpl
- type Setting
- type SettingId
- type SettingKind
- type SettingName
- type SettingOperationPredicate
- type SettingsClient
- func (c SettingsClient) Get(ctx context.Context, id SettingId) (result GetOperationResponse, err error)
- func (c SettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
- func (c SettingsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
- func (c SettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
- func (c SettingsClient) Update(ctx context.Context, id SettingId, input Setting) (result UpdateOperationResponse, err error)
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForSettingKind ¶
func PossibleValuesForSettingKind() []string
func PossibleValuesForSettingName ¶
func PossibleValuesForSettingName() []string
func ValidateSettingID ¶
ValidateSettingID checks that 'input' can be parsed as a Setting ID
Types ¶
type DataExportSetting ¶
type DataExportSetting struct { Properties *DataExportSettingProperties `json:"properties,omitempty"` // Fields inherited from Setting Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` }
func (DataExportSetting) MarshalJSON ¶
func (s DataExportSetting) MarshalJSON() ([]byte, error)
type DataExportSettingProperties ¶
type DataExportSettingProperties struct {
Enabled bool `json:"enabled"`
}
type GetOperationResponse ¶
type ListCompleteResult ¶
type ListOperationResponse ¶
type RawSettingImpl ¶
RawSettingImpl 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 SettingId ¶
type SettingId struct { SubscriptionId string SettingName SettingName }
SettingId is a struct representing the Resource ID for a Setting
func NewSettingID ¶
func NewSettingID(subscriptionId string, settingName SettingName) SettingId
NewSettingID returns a new SettingId struct
func ParseSettingID ¶
ParseSettingID parses 'input' into a SettingId
func ParseSettingIDInsensitively ¶
ParseSettingIDInsensitively parses 'input' case-insensitively into a SettingId note: this method should only be used for API response data and not user input
func (*SettingId) FromParseResult ¶
func (id *SettingId) FromParseResult(input resourceids.ParseResult) error
func (SettingId) Segments ¶
func (id SettingId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Setting ID
type SettingKind ¶
type SettingKind string
const ( SettingKindAlertSuppressionSetting SettingKind = "AlertSuppressionSetting" SettingKindDataExportSetting SettingKind = "DataExportSetting" )
func (*SettingKind) UnmarshalJSON ¶ added in v0.20240228.1142829
func (s *SettingKind) UnmarshalJSON(bytes []byte) error
type SettingName ¶
type SettingName string
const ( SettingNameMCAS SettingName = "MCAS" SettingNameWDATP SettingName = "WDATP" )
func (*SettingName) UnmarshalJSON ¶ added in v0.20240228.1142829
func (s *SettingName) UnmarshalJSON(bytes []byte) error
type SettingOperationPredicate ¶
type SettingOperationPredicate struct { }
func (SettingOperationPredicate) Matches ¶
func (p SettingOperationPredicate) Matches(input Setting) bool
type SettingsClient ¶
type SettingsClient struct {
Client *resourcemanager.Client
}
func NewSettingsClientWithBaseURI ¶
func NewSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SettingsClient, error)
func (SettingsClient) Get ¶
func (c SettingsClient) Get(ctx context.Context, id SettingId) (result GetOperationResponse, err error)
Get ...
func (SettingsClient) List ¶
func (c SettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
List ...
func (SettingsClient) ListComplete ¶
func (c SettingsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (SettingsClient) ListCompleteMatchingPredicate ¶
func (c SettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SettingOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (SettingsClient) Update ¶
func (c SettingsClient) Update(ctx context.Context, id SettingId, input Setting) (result UpdateOperationResponse, err error)
Update ...