applicationsecuritygroups

package
v0.20240425.1225320 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-05-01/applicationsecuritygroups Documentation

The applicationsecuritygroups SDK allows for interaction with the Azure Resource Manager Service network (API Version 2023-05-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/network/2023-05-01/applicationsecuritygroups"

Client Initialization

client := applicationsecuritygroups.NewApplicationSecurityGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApplicationSecurityGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := applicationsecuritygroups.NewApplicationSecurityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationSecurityGroupValue")

payload := applicationsecuritygroups.ApplicationSecurityGroup{
	// ...
}


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

Example Usage: ApplicationSecurityGroupsClient.Delete

ctx := context.TODO()
id := applicationsecuritygroups.NewApplicationSecurityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationSecurityGroupValue")

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

Example Usage: ApplicationSecurityGroupsClient.Get

ctx := context.TODO()
id := applicationsecuritygroups.NewApplicationSecurityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationSecurityGroupValue")

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

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

// 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: ApplicationSecurityGroupsClient.ListAll

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

// alternatively `client.ListAll(ctx, id)` can be used to do batched pagination
items, err := client.ListAllComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ApplicationSecurityGroupsClient.UpdateTags

ctx := context.TODO()
id := applicationsecuritygroups.NewApplicationSecurityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "applicationSecurityGroupValue")

payload := applicationsecuritygroups.TagsObject{
	// ...
}


read, err := client.UpdateTags(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateApplicationSecurityGroupID 

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

ValidateApplicationSecurityGroupID checks that 'input' can be parsed as a Application Security Group ID

Types

type ApplicationSecurityGroup 

type ApplicationSecurityGroup struct {
	Etag       *string                                   `json:"etag,omitempty"`
	Id         *string                                   `json:"id,omitempty"`
	Location   *string                                   `json:"location,omitempty"`
	Name       *string                                   `json:"name,omitempty"`
	Properties *ApplicationSecurityGroupPropertiesFormat `json:"properties,omitempty"`
	Tags       *map[string]string                        `json:"tags,omitempty"`
	Type       *string                                   `json:"type,omitempty"`
}

type ApplicationSecurityGroupId 

type ApplicationSecurityGroupId struct {
	SubscriptionId               string
	ResourceGroupName            string
	ApplicationSecurityGroupName string
}

ApplicationSecurityGroupId is a struct representing the Resource ID for a Application Security Group

func NewApplicationSecurityGroupID 

func NewApplicationSecurityGroupID(subscriptionId string, resourceGroupName string, applicationSecurityGroupName string) ApplicationSecurityGroupId

NewApplicationSecurityGroupID returns a new ApplicationSecurityGroupId struct

func ParseApplicationSecurityGroupID 

func ParseApplicationSecurityGroupID(input string) (*ApplicationSecurityGroupId, error)

ParseApplicationSecurityGroupID parses 'input' into a ApplicationSecurityGroupId

func ParseApplicationSecurityGroupIDInsensitively 

func ParseApplicationSecurityGroupIDInsensitively(input string) (*ApplicationSecurityGroupId, error)

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

func (*ApplicationSecurityGroupId) FromParseResult 

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

func (ApplicationSecurityGroupId) ID 

func (id ApplicationSecurityGroupId) ID() string

ID returns the formatted Application Security Group ID

func (ApplicationSecurityGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Application Security Group ID

func (ApplicationSecurityGroupId) String 

func (id ApplicationSecurityGroupId) String() string

String returns a human-readable description of this Application Security Group ID

type ApplicationSecurityGroupOperationPredicate 

type ApplicationSecurityGroupOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ApplicationSecurityGroupOperationPredicate) Matches 

func (p ApplicationSecurityGroupOperationPredicate) Matches(input ApplicationSecurityGroup) bool

type ApplicationSecurityGroupPropertiesFormat 

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

type ApplicationSecurityGroupsClient 

type ApplicationSecurityGroupsClient struct {
	Client *resourcemanager.Client
}

func NewApplicationSecurityGroupsClientWithBaseURI 

func NewApplicationSecurityGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationSecurityGroupsClient, error)

func (ApplicationSecurityGroupsClient) CreateOrUpdate 

func (c ApplicationSecurityGroupsClient) CreateOrUpdate(ctx context.Context, id ApplicationSecurityGroupId, input ApplicationSecurityGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApplicationSecurityGroupsClient) CreateOrUpdateThenPoll 

func (c ApplicationSecurityGroupsClient) CreateOrUpdateThenPoll(ctx context.Context, id ApplicationSecurityGroupId, input ApplicationSecurityGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ApplicationSecurityGroupsClient) Delete 

func (c ApplicationSecurityGroupsClient) Delete(ctx context.Context, id ApplicationSecurityGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (ApplicationSecurityGroupsClient) DeleteThenPoll 

func (c ApplicationSecurityGroupsClient) DeleteThenPoll(ctx context.Context, id ApplicationSecurityGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ApplicationSecurityGroupsClient) Get 

func (c ApplicationSecurityGroupsClient) Get(ctx context.Context, id ApplicationSecurityGroupId) (result GetOperationResponse, err error)

Get ...

func (ApplicationSecurityGroupsClient) List 

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

List ...

func (ApplicationSecurityGroupsClient) ListAll 

func (c ApplicationSecurityGroupsClient) ListAll(ctx context.Context, id commonids.SubscriptionId) (result ListAllOperationResponse, err error)

ListAll ...

func (ApplicationSecurityGroupsClient) ListAllComplete 

func (c ApplicationSecurityGroupsClient) ListAllComplete(ctx context.Context, id commonids.SubscriptionId) (ListAllCompleteResult, error)

ListAllComplete retrieves all the results into a single object

func (ApplicationSecurityGroupsClient) ListAllCompleteMatchingPredicate 

func (c ApplicationSecurityGroupsClient) ListAllCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ApplicationSecurityGroupOperationPredicate) (result ListAllCompleteResult, err error)

ListAllCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationSecurityGroupsClient) ListComplete 

func (c ApplicationSecurityGroupsClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ApplicationSecurityGroupsClient) ListCompleteMatchingPredicate 

func (c ApplicationSecurityGroupsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ApplicationSecurityGroupOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationSecurityGroupsClient) UpdateTags 

func (c ApplicationSecurityGroupsClient) UpdateTags(ctx context.Context, id ApplicationSecurityGroupId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationSecurityGroup
}

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        *ApplicationSecurityGroup
}

type ListAllCompleteResult 

type ListAllCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationSecurityGroup
}

type ListAllOperationResponse 

type ListAllOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationSecurityGroup
}

type ListCompleteResult 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationSecurityGroup
}

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 TagsObject 

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse 

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationSecurityGroup
}

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.