prefixlistglobalrulestack

package
v0.20230808.1103829 Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/paloaltonetworks/2022-08-29/prefixlistglobalrulestack Documentation

The prefixlistglobalrulestack SDK allows for interaction with the Azure Resource Manager Service paloaltonetworks (API Version 2022-08-29).

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/paloaltonetworks/2022-08-29/prefixlistglobalrulestack"

Client Initialization

client := prefixlistglobalrulestack.NewPrefixListGlobalRulestackClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrefixListGlobalRulestackClient.CreateOrUpdate

ctx := context.TODO()
id := prefixlistglobalrulestack.NewPrefixListID("globalRulestackValue", "prefixListValue")

payload := prefixlistglobalrulestack.PrefixListGlobalRulestackResource{
	// ...
}


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

Example Usage: PrefixListGlobalRulestackClient.Delete

ctx := context.TODO()
id := prefixlistglobalrulestack.NewPrefixListID("globalRulestackValue", "prefixListValue")

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

Example Usage: PrefixListGlobalRulestackClient.Get

ctx := context.TODO()
id := prefixlistglobalrulestack.NewPrefixListID("globalRulestackValue", "prefixListValue")

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

ctx := context.TODO()
id := prefixlistglobalrulestack.NewGlobalRulestackID("globalRulestackValue")

// 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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateGlobalRulestackID added in v0.20230720.1190320 

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

ValidateGlobalRulestackID checks that 'input' can be parsed as a Global Rulestack ID

func ValidatePrefixListID 

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

ValidatePrefixListID checks that 'input' can be parsed as a Prefix List ID

Types

type CreateOrUpdateOperationResponse 

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

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

type GlobalRulestackId added in v0.20230720.1190320 

type GlobalRulestackId struct {
	GlobalRulestackName string
}

GlobalRulestackId is a struct representing the Resource ID for a Global Rulestack

func NewGlobalRulestackID added in v0.20230720.1190320 

func NewGlobalRulestackID(globalRulestackName string) GlobalRulestackId

NewGlobalRulestackID returns a new GlobalRulestackId struct

func ParseGlobalRulestackID added in v0.20230720.1190320 

func ParseGlobalRulestackID(input string) (*GlobalRulestackId, error)

ParseGlobalRulestackID parses 'input' into a GlobalRulestackId

func ParseGlobalRulestackIDInsensitively added in v0.20230720.1190320 

func ParseGlobalRulestackIDInsensitively(input string) (*GlobalRulestackId, error)

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

func (GlobalRulestackId) ID added in v0.20230720.1190320 

func (id GlobalRulestackId) ID() string

ID returns the formatted Global Rulestack ID

func (GlobalRulestackId) Segments added in v0.20230720.1190320 

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

Segments returns a slice of Resource ID Segments which comprise this Global Rulestack ID

func (GlobalRulestackId) String added in v0.20230720.1190320 

func (id GlobalRulestackId) String() string

String returns a human-readable description of this Global Rulestack ID

type ListCompleteResult 

type ListCompleteResult struct {
	Items []PrefixListGlobalRulestackResource
}

type ListOperationResponse 

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

type PrefixListGlobalRulestackClient 

type PrefixListGlobalRulestackClient struct {
	Client *resourcemanager.Client
}

func NewPrefixListGlobalRulestackClientWithBaseURI 

func NewPrefixListGlobalRulestackClientWithBaseURI(sdkApi sdkEnv.Api) (*PrefixListGlobalRulestackClient, error)

func (PrefixListGlobalRulestackClient) CreateOrUpdate 

func (c PrefixListGlobalRulestackClient) CreateOrUpdate(ctx context.Context, id PrefixListId, input PrefixListGlobalRulestackResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrefixListGlobalRulestackClient) CreateOrUpdateThenPoll 

func (c PrefixListGlobalRulestackClient) CreateOrUpdateThenPoll(ctx context.Context, id PrefixListId, input PrefixListGlobalRulestackResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PrefixListGlobalRulestackClient) Delete 

func (c PrefixListGlobalRulestackClient) Delete(ctx context.Context, id PrefixListId) (result DeleteOperationResponse, err error)

Delete ...

func (PrefixListGlobalRulestackClient) DeleteThenPoll 

func (c PrefixListGlobalRulestackClient) DeleteThenPoll(ctx context.Context, id PrefixListId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrefixListGlobalRulestackClient) Get 

func (c PrefixListGlobalRulestackClient) Get(ctx context.Context, id PrefixListId) (result GetOperationResponse, err error)

Get ...

func (PrefixListGlobalRulestackClient) List 

func (c PrefixListGlobalRulestackClient) List(ctx context.Context, id GlobalRulestackId) (result ListOperationResponse, err error)

List ...

func (PrefixListGlobalRulestackClient) ListComplete 

func (c PrefixListGlobalRulestackClient) ListComplete(ctx context.Context, id GlobalRulestackId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrefixListGlobalRulestackClient) ListCompleteMatchingPredicate 

func (c PrefixListGlobalRulestackClient) ListCompleteMatchingPredicate(ctx context.Context, id GlobalRulestackId, predicate PrefixListGlobalRulestackResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrefixListGlobalRulestackResource 

type PrefixListGlobalRulestackResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties PrefixObject           `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type PrefixListGlobalRulestackResourceOperationPredicate 

type PrefixListGlobalRulestackResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PrefixListGlobalRulestackResourceOperationPredicate) Matches 

func (p PrefixListGlobalRulestackResourceOperationPredicate) Matches(input PrefixListGlobalRulestackResource) bool

type PrefixListId 

type PrefixListId struct {
	GlobalRulestackName string
	PrefixListName      string
}

PrefixListId is a struct representing the Resource ID for a Prefix List

func NewPrefixListID 

func NewPrefixListID(globalRulestackName string, prefixListName string) PrefixListId

NewPrefixListID returns a new PrefixListId struct

func ParsePrefixListID 

func ParsePrefixListID(input string) (*PrefixListId, error)

ParsePrefixListID parses 'input' into a PrefixListId

func ParsePrefixListIDInsensitively 

func ParsePrefixListIDInsensitively(input string) (*PrefixListId, error)

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

func (PrefixListId) ID 

func (id PrefixListId) ID() string

ID returns the formatted Prefix List ID

func (PrefixListId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Prefix List ID

func (PrefixListId) String 

func (id PrefixListId) String() string

String returns a human-readable description of this Prefix List ID

type PrefixObject 

type PrefixObject struct {
	AuditComment      *string            `json:"auditComment,omitempty"`
	Description       *string            `json:"description,omitempty"`
	Etag              *string            `json:"etag,omitempty"`
	PrefixList        []string           `json:"prefixList"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

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.