securityuserconfigurations

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-03-01/securityuserconfigurations Documentation

The securityuserconfigurations SDK allows for interaction with Azure Resource Manager network (API Version 2024-03-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/2024-03-01/securityuserconfigurations"

Client Initialization

client := securityuserconfigurations.NewSecurityUserConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecurityUserConfigurationsClient.CreateOrUpdate

ctx := context.TODO()
id := securityuserconfigurations.NewSecurityUserConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "securityUserConfigurationName")

payload := securityuserconfigurations.SecurityUserConfiguration{
	// ...
}


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: SecurityUserConfigurationsClient.Delete

ctx := context.TODO()
id := securityuserconfigurations.NewSecurityUserConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "securityUserConfigurationName")

if err := client.DeleteThenPoll(ctx, id, securityuserconfigurations.DefaultDeleteOperationOptions()); err != nil {
	// handle the error
}

Example Usage: SecurityUserConfigurationsClient.Get

ctx := context.TODO()
id := securityuserconfigurations.NewSecurityUserConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "securityUserConfigurationName")

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

ctx := context.TODO()
id := securityuserconfigurations.NewNetworkManagerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName")

// alternatively `client.List(ctx, id, securityuserconfigurations.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, securityuserconfigurations.DefaultListOperationOptions())
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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateNetworkManagerID 

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

ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager ID

func ValidateSecurityUserConfigurationID 

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

ValidateSecurityUserConfigurationID checks that 'input' can be parsed as a Security User Configuration ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SecurityUserConfiguration
}

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 DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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

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

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

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

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 SecurityUserConfiguration 

type SecurityUserConfiguration struct {
	Etag       *string                                    `json:"etag,omitempty"`
	Id         *string                                    `json:"id,omitempty"`
	Name       *string                                    `json:"name,omitempty"`
	Properties *SecurityUserConfigurationPropertiesFormat `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                     `json:"systemData,omitempty"`
	Type       *string                                    `json:"type,omitempty"`
}

type SecurityUserConfigurationId 

type SecurityUserConfigurationId struct {
	SubscriptionId                string
	ResourceGroupName             string
	NetworkManagerName            string
	SecurityUserConfigurationName string
}

SecurityUserConfigurationId is a struct representing the Resource ID for a Security User Configuration

func NewSecurityUserConfigurationID 

func NewSecurityUserConfigurationID(subscriptionId string, resourceGroupName string, networkManagerName string, securityUserConfigurationName string) SecurityUserConfigurationId

NewSecurityUserConfigurationID returns a new SecurityUserConfigurationId struct

func ParseSecurityUserConfigurationID 

func ParseSecurityUserConfigurationID(input string) (*SecurityUserConfigurationId, error)

ParseSecurityUserConfigurationID parses 'input' into a SecurityUserConfigurationId

func ParseSecurityUserConfigurationIDInsensitively 

func ParseSecurityUserConfigurationIDInsensitively(input string) (*SecurityUserConfigurationId, error)

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

func (*SecurityUserConfigurationId) FromParseResult 

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

func (SecurityUserConfigurationId) ID 

func (id SecurityUserConfigurationId) ID() string

ID returns the formatted Security User Configuration ID

func (SecurityUserConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Security User Configuration ID

func (SecurityUserConfigurationId) String 

func (id SecurityUserConfigurationId) String() string

String returns a human-readable description of this Security User Configuration ID

type SecurityUserConfigurationOperationPredicate 

type SecurityUserConfigurationOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (SecurityUserConfigurationOperationPredicate) Matches 

func (p SecurityUserConfigurationOperationPredicate) Matches(input SecurityUserConfiguration) bool

type SecurityUserConfigurationPropertiesFormat 

type SecurityUserConfigurationPropertiesFormat struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceGuid      *string            `json:"resourceGuid,omitempty"`
}

type SecurityUserConfigurationsClient 

type SecurityUserConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewSecurityUserConfigurationsClientWithBaseURI 

func NewSecurityUserConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*SecurityUserConfigurationsClient, error)

func (SecurityUserConfigurationsClient) CreateOrUpdate 

func (c SecurityUserConfigurationsClient) CreateOrUpdate(ctx context.Context, id SecurityUserConfigurationId, input SecurityUserConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SecurityUserConfigurationsClient) Delete 

func (c SecurityUserConfigurationsClient) Delete(ctx context.Context, id SecurityUserConfigurationId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (SecurityUserConfigurationsClient) DeleteThenPoll 

func (c SecurityUserConfigurationsClient) DeleteThenPoll(ctx context.Context, id SecurityUserConfigurationId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (SecurityUserConfigurationsClient) Get 

func (c SecurityUserConfigurationsClient) Get(ctx context.Context, id SecurityUserConfigurationId) (result GetOperationResponse, err error)

Get ...

func (SecurityUserConfigurationsClient) List 

func (c SecurityUserConfigurationsClient) List(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (SecurityUserConfigurationsClient) ListComplete 

func (c SecurityUserConfigurationsClient) ListComplete(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SecurityUserConfigurationsClient) ListCompleteMatchingPredicate 

func (c SecurityUserConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkManagerId, options ListOperationOptions, predicate SecurityUserConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.