README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-02-01/securityadminconfigurations
Documentation
The securityadminconfigurations
SDK allows for interaction with the Azure Resource Manager Service network
(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/network/2023-02-01/securityadminconfigurations"
Client Initialization
client := securityadminconfigurations.NewSecurityAdminConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SecurityAdminConfigurationsClient.CreateOrUpdate
ctx := context.TODO()
id := securityadminconfigurations.NewSecurityAdminConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "securityAdminConfigurationValue")
payload := securityadminconfigurations.SecurityAdminConfiguration{
// ...
}
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: SecurityAdminConfigurationsClient.Delete
ctx := context.TODO()
id := securityadminconfigurations.NewSecurityAdminConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "securityAdminConfigurationValue")
if err := client.DeleteThenPoll(ctx, id, securityadminconfigurations.DefaultDeleteOperationOptions()); err != nil {
// handle the error
}
Example Usage: SecurityAdminConfigurationsClient.Get
ctx := context.TODO()
id := securityadminconfigurations.NewSecurityAdminConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "securityAdminConfigurationValue")
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: SecurityAdminConfigurationsClient.List
ctx := context.TODO()
id := securityadminconfigurations.NewNetworkManagerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue")
// alternatively `client.List(ctx, id, securityadminconfigurations.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, securityadminconfigurations.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForNetworkIntentPolicyBasedService() []string
- func PossibleValuesForProvisioningState() []string
- func ValidateNetworkManagerID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateSecurityAdminConfigurationID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
- type NetworkIntentPolicyBasedService
- type NetworkManagerId
- type ProvisioningState
- type SecurityAdminConfiguration
- type SecurityAdminConfigurationId
- func NewSecurityAdminConfigurationID(subscriptionId string, resourceGroupName string, networkManagerName string, ...) SecurityAdminConfigurationId
- func ParseSecurityAdminConfigurationID(input string) (*SecurityAdminConfigurationId, error)
- func ParseSecurityAdminConfigurationIDInsensitively(input string) (*SecurityAdminConfigurationId, error)
- type SecurityAdminConfigurationOperationPredicate
- type SecurityAdminConfigurationPropertiesFormat
- type SecurityAdminConfigurationsClient
- func (c SecurityAdminConfigurationsClient) CreateOrUpdate(ctx context.Context, id SecurityAdminConfigurationId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c SecurityAdminConfigurationsClient) Delete(ctx context.Context, id SecurityAdminConfigurationId, ...) (result DeleteOperationResponse, err error)
- func (c SecurityAdminConfigurationsClient) DeleteThenPoll(ctx context.Context, id SecurityAdminConfigurationId, ...) error
- func (c SecurityAdminConfigurationsClient) Get(ctx context.Context, id SecurityAdminConfigurationId) (result GetOperationResponse, err error)
- func (c SecurityAdminConfigurationsClient) List(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (result ListOperationResponse, err error)
- func (c SecurityAdminConfigurationsClient) ListComplete(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (ListCompleteResult, error)
- func (c SecurityAdminConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkManagerId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForNetworkIntentPolicyBasedService ¶
func PossibleValuesForNetworkIntentPolicyBasedService() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateNetworkManagerID ¶
ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager ID
func ValidateSecurityAdminConfigurationID ¶
func ValidateSecurityAdminConfigurationID(input interface{}, key string) (warnings []string, errors []error)
ValidateSecurityAdminConfigurationID checks that 'input' can be parsed as a Security Admin Configuration ID
Types ¶
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *SecurityAdminConfiguration }
type DeleteOperationOptions ¶
type DeleteOperationOptions struct {
Force *bool
}
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
func (DeleteOperationOptions) ToHeaders ¶
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *SecurityAdminConfiguration }
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []SecurityAdminConfiguration
}
type ListOperationOptions ¶
type ListOperationOptions struct {
Top *int64
}
func DefaultListOperationOptions ¶
func DefaultListOperationOptions() ListOperationOptions
func (ListOperationOptions) ToHeaders ¶
func (o ListOperationOptions) ToHeaders() *client.Headers
func (ListOperationOptions) ToOData ¶
func (o ListOperationOptions) ToOData() *odata.Query
func (ListOperationOptions) ToQuery ¶
func (o ListOperationOptions) ToQuery() *client.QueryParams
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]SecurityAdminConfiguration }
type NetworkIntentPolicyBasedService ¶
type NetworkIntentPolicyBasedService string
const ( NetworkIntentPolicyBasedServiceAll NetworkIntentPolicyBasedService = "All" NetworkIntentPolicyBasedServiceAllowRulesOnly NetworkIntentPolicyBasedService = "AllowRulesOnly" NetworkIntentPolicyBasedServiceNone NetworkIntentPolicyBasedService = "None" )
func (*NetworkIntentPolicyBasedService) UnmarshalJSON ¶
func (s *NetworkIntentPolicyBasedService) UnmarshalJSON(bytes []byte) error
type NetworkManagerId ¶
type NetworkManagerId struct { SubscriptionId string ResourceGroupName string NetworkManagerName string }
NetworkManagerId is a struct representing the Resource ID for a Network Manager
func NewNetworkManagerID ¶
func NewNetworkManagerID(subscriptionId string, resourceGroupName string, networkManagerName string) NetworkManagerId
NewNetworkManagerID returns a new NetworkManagerId struct
func ParseNetworkManagerID ¶
func ParseNetworkManagerID(input string) (*NetworkManagerId, error)
ParseNetworkManagerID parses 'input' into a NetworkManagerId
func ParseNetworkManagerIDInsensitively ¶
func ParseNetworkManagerIDInsensitively(input string) (*NetworkManagerId, error)
ParseNetworkManagerIDInsensitively parses 'input' case-insensitively into a NetworkManagerId note: this method should only be used for API response data and not user input
func (NetworkManagerId) ID ¶
func (id NetworkManagerId) ID() string
ID returns the formatted Network Manager ID
func (NetworkManagerId) Segments ¶
func (id NetworkManagerId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Network Manager ID
func (NetworkManagerId) String ¶
func (id NetworkManagerId) String() string
String returns a human-readable description of this Network Manager ID
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUpdating ProvisioningState = "Updating" )
func (*ProvisioningState) UnmarshalJSON ¶
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
type SecurityAdminConfiguration ¶
type SecurityAdminConfiguration struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *SecurityAdminConfigurationPropertiesFormat `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type SecurityAdminConfigurationId ¶
type SecurityAdminConfigurationId struct { SubscriptionId string ResourceGroupName string NetworkManagerName string SecurityAdminConfigurationName string }
SecurityAdminConfigurationId is a struct representing the Resource ID for a Security Admin Configuration
func NewSecurityAdminConfigurationID ¶
func NewSecurityAdminConfigurationID(subscriptionId string, resourceGroupName string, networkManagerName string, securityAdminConfigurationName string) SecurityAdminConfigurationId
NewSecurityAdminConfigurationID returns a new SecurityAdminConfigurationId struct
func ParseSecurityAdminConfigurationID ¶
func ParseSecurityAdminConfigurationID(input string) (*SecurityAdminConfigurationId, error)
ParseSecurityAdminConfigurationID parses 'input' into a SecurityAdminConfigurationId
func ParseSecurityAdminConfigurationIDInsensitively ¶
func ParseSecurityAdminConfigurationIDInsensitively(input string) (*SecurityAdminConfigurationId, error)
ParseSecurityAdminConfigurationIDInsensitively parses 'input' case-insensitively into a SecurityAdminConfigurationId note: this method should only be used for API response data and not user input
func (SecurityAdminConfigurationId) ID ¶
func (id SecurityAdminConfigurationId) ID() string
ID returns the formatted Security Admin Configuration ID
func (SecurityAdminConfigurationId) Segments ¶
func (id SecurityAdminConfigurationId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Security Admin Configuration ID
func (SecurityAdminConfigurationId) String ¶
func (id SecurityAdminConfigurationId) String() string
String returns a human-readable description of this Security Admin Configuration ID
type SecurityAdminConfigurationOperationPredicate ¶
type SecurityAdminConfigurationOperationPredicate struct { Etag *string Id *string Name *string Type *string }
func (SecurityAdminConfigurationOperationPredicate) Matches ¶
func (p SecurityAdminConfigurationOperationPredicate) Matches(input SecurityAdminConfiguration) bool
type SecurityAdminConfigurationPropertiesFormat ¶
type SecurityAdminConfigurationPropertiesFormat struct { ApplyOnNetworkIntentPolicyBasedServices *[]NetworkIntentPolicyBasedService `json:"applyOnNetworkIntentPolicyBasedServices,omitempty"` Description *string `json:"description,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` ResourceGuid *string `json:"resourceGuid,omitempty"` }
type SecurityAdminConfigurationsClient ¶
type SecurityAdminConfigurationsClient struct {
Client *resourcemanager.Client
}
func NewSecurityAdminConfigurationsClientWithBaseURI ¶
func NewSecurityAdminConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecurityAdminConfigurationsClient, error)
func (SecurityAdminConfigurationsClient) CreateOrUpdate ¶
func (c SecurityAdminConfigurationsClient) CreateOrUpdate(ctx context.Context, id SecurityAdminConfigurationId, input SecurityAdminConfiguration) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (SecurityAdminConfigurationsClient) Delete ¶
func (c SecurityAdminConfigurationsClient) Delete(ctx context.Context, id SecurityAdminConfigurationId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (SecurityAdminConfigurationsClient) DeleteThenPoll ¶
func (c SecurityAdminConfigurationsClient) DeleteThenPoll(ctx context.Context, id SecurityAdminConfigurationId, options DeleteOperationOptions) error
DeleteThenPoll performs Delete then polls until it's completed
func (SecurityAdminConfigurationsClient) Get ¶
func (c SecurityAdminConfigurationsClient) Get(ctx context.Context, id SecurityAdminConfigurationId) (result GetOperationResponse, err error)
Get ...
func (SecurityAdminConfigurationsClient) List ¶
func (c SecurityAdminConfigurationsClient) List(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (result ListOperationResponse, err error)
List ...
func (SecurityAdminConfigurationsClient) ListComplete ¶
func (c SecurityAdminConfigurationsClient) ListComplete(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (SecurityAdminConfigurationsClient) ListCompleteMatchingPredicate ¶
func (c SecurityAdminConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkManagerId, options ListOperationOptions, predicate SecurityAdminConfigurationOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate