ddoscustompolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-09-01/ddoscustompolicies Documentation

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

Client Initialization

client := ddoscustompolicies.NewDdosCustomPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DdosCustomPoliciesClient.CreateOrUpdate

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

payload := ddoscustompolicies.DdosCustomPolicy{
	// ...
}


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

Example Usage: DdosCustomPoliciesClient.Delete

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

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

Example Usage: DdosCustomPoliciesClient.Get

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

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: DdosCustomPoliciesClient.UpdateTags

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

payload := ddoscustompolicies.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

• func PossibleValuesForProvisioningState() []string
• func ValidateDdosCustomPolicyID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DdosCustomPoliciesClient
  • func NewDdosCustomPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*DdosCustomPoliciesClient, error)
  • func (c DdosCustomPoliciesClient) CreateOrUpdate(ctx context.Context, id DdosCustomPolicyId, input DdosCustomPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c DdosCustomPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id DdosCustomPolicyId, input DdosCustomPolicy) error
  • func (c DdosCustomPoliciesClient) Delete(ctx context.Context, id DdosCustomPolicyId) (result DeleteOperationResponse, err error)
  • func (c DdosCustomPoliciesClient) DeleteThenPoll(ctx context.Context, id DdosCustomPolicyId) error
  • func (c DdosCustomPoliciesClient) Get(ctx context.Context, id DdosCustomPolicyId) (result GetOperationResponse, err error)
  • func (c DdosCustomPoliciesClient) UpdateTags(ctx context.Context, id DdosCustomPolicyId, input TagsObject) (result UpdateTagsOperationResponse, err error)
• type DdosCustomPolicy
• type DdosCustomPolicyId
  • func NewDdosCustomPolicyID(subscriptionId string, resourceGroupName string, ddosCustomPolicyName string) DdosCustomPolicyId
  • func ParseDdosCustomPolicyID(input string) (*DdosCustomPolicyId, error)
  • func ParseDdosCustomPolicyIDInsensitively(input string) (*DdosCustomPolicyId, error)
  • func (id *DdosCustomPolicyId) FromParseResult(input resourceids.ParseResult) error
  • func (id DdosCustomPolicyId) ID() string
  • func (id DdosCustomPolicyId) Segments() []resourceids.Segment
  • func (id DdosCustomPolicyId) String() string
• type DdosCustomPolicyPropertiesFormat
• type DeleteOperationResponse
• type GetOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type TagsObject
• type UpdateTagsOperationResponse

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateDdosCustomPolicyID

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

ValidateDdosCustomPolicyID checks that 'input' can be parsed as a Ddos Custom Policy ID

Types

type CreateOrUpdateOperationResponse

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

type DdosCustomPoliciesClient

type DdosCustomPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewDdosCustomPoliciesClientWithBaseURI

func NewDdosCustomPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*DdosCustomPoliciesClient, error)

func (DdosCustomPoliciesClient) CreateOrUpdate

func (c DdosCustomPoliciesClient) CreateOrUpdate(ctx context.Context, id DdosCustomPolicyId, input DdosCustomPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DdosCustomPoliciesClient) CreateOrUpdateThenPoll

func (c DdosCustomPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id DdosCustomPolicyId, input DdosCustomPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DdosCustomPoliciesClient) Delete

func (c DdosCustomPoliciesClient) Delete(ctx context.Context, id DdosCustomPolicyId) (result DeleteOperationResponse, err error)

Delete ...

func (DdosCustomPoliciesClient) DeleteThenPoll

func (c DdosCustomPoliciesClient) DeleteThenPoll(ctx context.Context, id DdosCustomPolicyId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DdosCustomPoliciesClient) Get

func (c DdosCustomPoliciesClient) Get(ctx context.Context, id DdosCustomPolicyId) (result GetOperationResponse, err error)

Get ...

func (DdosCustomPoliciesClient) UpdateTags

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

UpdateTags ...

type DdosCustomPolicy

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

type DdosCustomPolicyId

type DdosCustomPolicyId struct {
	SubscriptionId       string
	ResourceGroupName    string
	DdosCustomPolicyName string
}

DdosCustomPolicyId is a struct representing the Resource ID for a Ddos Custom Policy

func NewDdosCustomPolicyID

func NewDdosCustomPolicyID(subscriptionId string, resourceGroupName string, ddosCustomPolicyName string) DdosCustomPolicyId

NewDdosCustomPolicyID returns a new DdosCustomPolicyId struct

func ParseDdosCustomPolicyID

func ParseDdosCustomPolicyID(input string) (*DdosCustomPolicyId, error)

ParseDdosCustomPolicyID parses 'input' into a DdosCustomPolicyId

func ParseDdosCustomPolicyIDInsensitively

func ParseDdosCustomPolicyIDInsensitively(input string) (*DdosCustomPolicyId, error)

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

func (*DdosCustomPolicyId) FromParseResult

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

func (DdosCustomPolicyId) ID

func (id DdosCustomPolicyId) ID() string

ID returns the formatted Ddos Custom Policy ID

func (DdosCustomPolicyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Ddos Custom Policy ID

func (DdosCustomPolicyId) String

func (id DdosCustomPolicyId) String() string

String returns a human-readable description of this Ddos Custom Policy ID

type DdosCustomPolicyPropertiesFormat

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

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

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