globalrulestack

package
v0.20240131.1125554 Latest Latest
Warning

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

Go to latest
Published: Jan 31, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

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

The globalrulestack 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/globalrulestack"

Client Initialization

client := globalrulestack.NewGlobalRulestackClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GlobalRulestackClient.Commit

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

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

Example Usage: GlobalRulestackClient.CreateOrUpdate

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

payload := globalrulestack.GlobalRulestackResource{
	// ...
}


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

Example Usage: GlobalRulestackClient.Delete

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

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

Example Usage: GlobalRulestackClient.Get

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

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: GlobalRulestackClient.GetChangeLog

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

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

Example Usage: GlobalRulestackClient.List

ctx := context.TODO()


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

Example Usage: GlobalRulestackClient.ListAdvancedSecurityObjects

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

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

Example Usage: GlobalRulestackClient.ListAppIds

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

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

Example Usage: GlobalRulestackClient.ListCountries

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

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

Example Usage: GlobalRulestackClient.ListFirewalls

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

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

Example Usage: GlobalRulestackClient.ListPredefinedUrlCategories

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

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

Example Usage: GlobalRulestackClient.ListSecurityServices

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

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

Example Usage: GlobalRulestackClient.Revert

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

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

Example Usage: GlobalRulestackClient.Update

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

payload := globalrulestack.GlobalRulestackResourceUpdate{
	// ...
}


read, err := client.Update(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 PossibleValuesForAdvSecurityObjectTypeEnum

func PossibleValuesForAdvSecurityObjectTypeEnum() []string

func PossibleValuesForDefaultMode

func PossibleValuesForDefaultMode() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForScopeType

func PossibleValuesForScopeType() []string

func PossibleValuesForSecurityServicesTypeEnum

func PossibleValuesForSecurityServicesTypeEnum() []string

func ValidateGlobalRulestackID

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

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

Types

type AdvSecurityObjectListResponse

type AdvSecurityObjectListResponse struct {
	NextLink *string                `json:"nextLink,omitempty"`
	Value    AdvSecurityObjectModel `json:"value"`
}

type AdvSecurityObjectModel

type AdvSecurityObjectModel struct {
	Entry []NameDescriptionObject `json:"entry"`
	Type  *string                 `json:"type,omitempty"`
}

type AdvSecurityObjectTypeEnum

type AdvSecurityObjectTypeEnum string
const (
	AdvSecurityObjectTypeEnumFeeds     AdvSecurityObjectTypeEnum = "feeds"
	AdvSecurityObjectTypeEnumUrlCustom AdvSecurityObjectTypeEnum = "urlCustom"
)

func (*AdvSecurityObjectTypeEnum) UnmarshalJSON

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

type Changelog

type Changelog struct {
	Changes       []string `json:"changes"`
	LastCommitted *string  `json:"lastCommitted,omitempty"`
	LastModified  *string  `json:"lastModified,omitempty"`
}

func (*Changelog) GetLastCommittedAsTime

func (o *Changelog) GetLastCommittedAsTime() (*time.Time, error)

func (*Changelog) GetLastModifiedAsTime

func (o *Changelog) GetLastModifiedAsTime() (*time.Time, error)

func (*Changelog) SetLastCommittedAsTime

func (o *Changelog) SetLastCommittedAsTime(input time.Time)

func (*Changelog) SetLastModifiedAsTime

func (o *Changelog) SetLastModifiedAsTime(input time.Time)

type CommitOperationResponse

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

type CountriesResponse

type CountriesResponse struct {
	NextLink *string   `json:"nextLink,omitempty"`
	Value    []Country `json:"value"`
}

type Country

type Country struct {
	Code        string  `json:"code"`
	Description *string `json:"description,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DefaultMode

type DefaultMode string
const (
	DefaultModeFIREWALL DefaultMode = "FIREWALL"
	DefaultModeIPS      DefaultMode = "IPS"
	DefaultModeNONE     DefaultMode = "NONE"
)

func (*DefaultMode) UnmarshalJSON

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

type DeleteOperationResponse

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

type GetChangeLogOperationResponse

type GetChangeLogOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Changelog
}

type GetOperationResponse

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

type GlobalRulestackClient

type GlobalRulestackClient struct {
	Client *resourcemanager.Client
}

func NewGlobalRulestackClientWithBaseURI

func NewGlobalRulestackClientWithBaseURI(sdkApi sdkEnv.Api) (*GlobalRulestackClient, error)

func (GlobalRulestackClient) Commit

Commit ...

func (GlobalRulestackClient) CommitThenPoll

func (c GlobalRulestackClient) CommitThenPoll(ctx context.Context, id GlobalRulestackId) error

CommitThenPoll performs Commit then polls until it's completed

func (GlobalRulestackClient) CreateOrUpdate

CreateOrUpdate ...

func (GlobalRulestackClient) CreateOrUpdateThenPoll

func (c GlobalRulestackClient) CreateOrUpdateThenPoll(ctx context.Context, id GlobalRulestackId, input GlobalRulestackResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (GlobalRulestackClient) Delete

Delete ...

func (GlobalRulestackClient) DeleteThenPoll

func (c GlobalRulestackClient) DeleteThenPoll(ctx context.Context, id GlobalRulestackId) error

DeleteThenPoll performs Delete then polls until it's completed

func (GlobalRulestackClient) Get

Get ...

func (GlobalRulestackClient) GetChangeLog

GetChangeLog ...

func (GlobalRulestackClient) List

List ...

func (GlobalRulestackClient) ListAdvancedSecurityObjects

ListAdvancedSecurityObjects ...

func (GlobalRulestackClient) ListAppIds

ListAppIds ...

func (GlobalRulestackClient) ListComplete

ListComplete retrieves all the results into a single object

func (GlobalRulestackClient) ListCompleteMatchingPredicate

func (c GlobalRulestackClient) ListCompleteMatchingPredicate(ctx context.Context, predicate GlobalRulestackResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GlobalRulestackClient) ListCountries

ListCountries ...

func (GlobalRulestackClient) ListFirewalls

ListFirewalls ...

func (GlobalRulestackClient) ListPredefinedUrlCategories

ListPredefinedUrlCategories ...

func (GlobalRulestackClient) ListSecurityServices

ListSecurityServices ...

func (GlobalRulestackClient) Revert

Revert ...

func (GlobalRulestackClient) Update

Update ...

type GlobalRulestackId

type GlobalRulestackId struct {
	GlobalRulestackName string
}

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

func NewGlobalRulestackID

func NewGlobalRulestackID(globalRulestackName string) GlobalRulestackId

NewGlobalRulestackID returns a new GlobalRulestackId struct

func ParseGlobalRulestackID

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

ParseGlobalRulestackID parses 'input' into a GlobalRulestackId

func ParseGlobalRulestackIDInsensitively

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

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

func (GlobalRulestackId) ID

func (id GlobalRulestackId) ID() string

ID returns the formatted Global Rulestack ID

func (GlobalRulestackId) Segments

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

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

func (GlobalRulestackId) String

func (id GlobalRulestackId) String() string

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

type GlobalRulestackResource

type GlobalRulestackResource struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties RulestackProperties                      `json:"properties"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type GlobalRulestackResourceOperationPredicate

type GlobalRulestackResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (GlobalRulestackResourceOperationPredicate) Matches

type GlobalRulestackResourceUpdate

type GlobalRulestackResourceUpdate struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                                  `json:"location,omitempty"`
	Properties *GlobalRulestackResourceUpdateProperties `json:"properties,omitempty"`
}

type GlobalRulestackResourceUpdateProperties

type GlobalRulestackResourceUpdateProperties struct {
	AssociatedSubscriptions *[]string         `json:"associatedSubscriptions,omitempty"`
	DefaultMode             *DefaultMode      `json:"defaultMode,omitempty"`
	Description             *string           `json:"description,omitempty"`
	MinAppIdVersion         *string           `json:"minAppIdVersion,omitempty"`
	PanEtag                 *string           `json:"panEtag,omitempty"`
	PanLocation             *string           `json:"panLocation,omitempty"`
	Scope                   *ScopeType        `json:"scope,omitempty"`
	SecurityServices        *SecurityServices `json:"securityServices,omitempty"`
}

type ListAdvancedSecurityObjectsOperationOptions

type ListAdvancedSecurityObjectsOperationOptions struct {
	Skip *string
	Top  *int64
	Type *AdvSecurityObjectTypeEnum
}

func DefaultListAdvancedSecurityObjectsOperationOptions

func DefaultListAdvancedSecurityObjectsOperationOptions() ListAdvancedSecurityObjectsOperationOptions

func (ListAdvancedSecurityObjectsOperationOptions) ToHeaders

func (ListAdvancedSecurityObjectsOperationOptions) ToOData

func (ListAdvancedSecurityObjectsOperationOptions) ToQuery

type ListAdvancedSecurityObjectsOperationResponse

type ListAdvancedSecurityObjectsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AdvSecurityObjectListResponse
}

type ListAppIdResponse

type ListAppIdResponse struct {
	NextLink *string  `json:"nextLink,omitempty"`
	Value    []string `json:"value"`
}

type ListAppIdsOperationOptions

type ListAppIdsOperationOptions struct {
	AppIdVersion *string
	AppPrefix    *string
	Skip         *string
	Top          *int64
}

func DefaultListAppIdsOperationOptions

func DefaultListAppIdsOperationOptions() ListAppIdsOperationOptions

func (ListAppIdsOperationOptions) ToHeaders

func (o ListAppIdsOperationOptions) ToHeaders() *client.Headers

func (ListAppIdsOperationOptions) ToOData

func (o ListAppIdsOperationOptions) ToOData() *odata.Query

func (ListAppIdsOperationOptions) ToQuery

type ListAppIdsOperationResponse

type ListAppIdsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListAppIdResponse
}

type ListCompleteResult

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

type ListCountriesOperationOptions

type ListCountriesOperationOptions struct {
	Skip *string
	Top  *int64
}

func DefaultListCountriesOperationOptions

func DefaultListCountriesOperationOptions() ListCountriesOperationOptions

func (ListCountriesOperationOptions) ToHeaders

func (ListCountriesOperationOptions) ToOData

func (ListCountriesOperationOptions) ToQuery

type ListCountriesOperationResponse

type ListCountriesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CountriesResponse
}

type ListFirewallsOperationResponse

type ListFirewallsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListFirewallsResponse
}

type ListFirewallsResponse

type ListFirewallsResponse struct {
	NextLink *string  `json:"nextLink,omitempty"`
	Value    []string `json:"value"`
}

type ListOperationResponse

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

type ListPredefinedUrlCategoriesOperationOptions

type ListPredefinedUrlCategoriesOperationOptions struct {
	Skip *string
	Top  *int64
}

func DefaultListPredefinedUrlCategoriesOperationOptions

func DefaultListPredefinedUrlCategoriesOperationOptions() ListPredefinedUrlCategoriesOperationOptions

func (ListPredefinedUrlCategoriesOperationOptions) ToHeaders

func (ListPredefinedUrlCategoriesOperationOptions) ToOData

func (ListPredefinedUrlCategoriesOperationOptions) ToQuery

type ListPredefinedUrlCategoriesOperationResponse

type ListPredefinedUrlCategoriesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PredefinedUrlCategoriesResponse
}

type ListSecurityServicesOperationOptions

type ListSecurityServicesOperationOptions struct {
	Skip *string
	Top  *int64
	Type *SecurityServicesTypeEnum
}

func DefaultListSecurityServicesOperationOptions

func DefaultListSecurityServicesOperationOptions() ListSecurityServicesOperationOptions

func (ListSecurityServicesOperationOptions) ToHeaders

func (ListSecurityServicesOperationOptions) ToOData

func (ListSecurityServicesOperationOptions) ToQuery

type ListSecurityServicesOperationResponse

type ListSecurityServicesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SecurityServicesResponse
}

type NameDescriptionObject

type NameDescriptionObject struct {
	Description *string `json:"description,omitempty"`
	Name        string  `json:"name"`
}

type PredefinedUrlCategoriesResponse

type PredefinedUrlCategoriesResponse struct {
	NextLink *string                 `json:"nextLink,omitempty"`
	Value    []PredefinedUrlCategory `json:"value"`
}

type PredefinedUrlCategory

type PredefinedUrlCategory struct {
	Action string `json:"action"`
	Name   string `json:"name"`
}

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

type RevertOperationResponse

type RevertOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type RulestackProperties

type RulestackProperties struct {
	AssociatedSubscriptions *[]string          `json:"associatedSubscriptions,omitempty"`
	DefaultMode             *DefaultMode       `json:"defaultMode,omitempty"`
	Description             *string            `json:"description,omitempty"`
	MinAppIdVersion         *string            `json:"minAppIdVersion,omitempty"`
	PanEtag                 *string            `json:"panEtag,omitempty"`
	PanLocation             *string            `json:"panLocation,omitempty"`
	ProvisioningState       *ProvisioningState `json:"provisioningState,omitempty"`
	Scope                   *ScopeType         `json:"scope,omitempty"`
	SecurityServices        *SecurityServices  `json:"securityServices,omitempty"`
}

type ScopeType

type ScopeType string
const (
	ScopeTypeGLOBAL ScopeType = "GLOBAL"
	ScopeTypeLOCAL  ScopeType = "LOCAL"
)

func (*ScopeType) UnmarshalJSON

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

type SecurityServices

type SecurityServices struct {
	AntiSpywareProfile         *string `json:"antiSpywareProfile,omitempty"`
	AntiVirusProfile           *string `json:"antiVirusProfile,omitempty"`
	DnsSubscription            *string `json:"dnsSubscription,omitempty"`
	FileBlockingProfile        *string `json:"fileBlockingProfile,omitempty"`
	OutboundTrustCertificate   *string `json:"outboundTrustCertificate,omitempty"`
	OutboundUnTrustCertificate *string `json:"outboundUnTrustCertificate,omitempty"`
	UrlFilteringProfile        *string `json:"urlFilteringProfile,omitempty"`
	VulnerabilityProfile       *string `json:"vulnerabilityProfile,omitempty"`
}

type SecurityServicesResponse

type SecurityServicesResponse struct {
	NextLink *string                  `json:"nextLink,omitempty"`
	Value    SecurityServicesTypeList `json:"value"`
}

type SecurityServicesTypeEnum

type SecurityServicesTypeEnum string
const (
	SecurityServicesTypeEnumAntiSpyware      SecurityServicesTypeEnum = "antiSpyware"
	SecurityServicesTypeEnumAntiVirus        SecurityServicesTypeEnum = "antiVirus"
	SecurityServicesTypeEnumDnsSubscription  SecurityServicesTypeEnum = "dnsSubscription"
	SecurityServicesTypeEnumFileBlocking     SecurityServicesTypeEnum = "fileBlocking"
	SecurityServicesTypeEnumIPsVulnerability SecurityServicesTypeEnum = "ipsVulnerability"
	SecurityServicesTypeEnumUrlFiltering     SecurityServicesTypeEnum = "urlFiltering"
)

func (*SecurityServicesTypeEnum) UnmarshalJSON

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

type SecurityServicesTypeList

type SecurityServicesTypeList struct {
	Entry []NameDescriptionObject `json:"entry"`
	Type  *string                 `json:"type,omitempty"`
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GlobalRulestackResource
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL