firewallstatus

README

github.com/hashicorp/go-azure-sdk/resource-manager/paloaltonetworks/2023-09-01/firewallstatus Documentation

The firewallstatus SDK allows for interaction with the Azure Resource Manager Service paloaltonetworks (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/paloaltonetworks/2023-09-01/firewallstatus"

Client Initialization

client := firewallstatus.NewFirewallStatusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FirewallStatusClient.Get

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

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: FirewallStatusClient.ListByFirewalls

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

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

Documentation

Index

• func PossibleValuesForBooleanEnum() []string
• func PossibleValuesForHealthStatus() []string
• func PossibleValuesForReadOnlyProvisioningState() []string
• func PossibleValuesForServerStatus() []string
• func ValidateFirewallID(input interface{}, key string) (warnings []string, errors []error)
• type BooleanEnum
  • func (s *BooleanEnum) UnmarshalJSON(bytes []byte) error
• type FirewallId
  • func NewFirewallID(subscriptionId string, resourceGroupName string, firewallName string) FirewallId
  • func ParseFirewallID(input string) (*FirewallId, error)
  • func ParseFirewallIDInsensitively(input string) (*FirewallId, error)
  • func (id *FirewallId) FromParseResult(input resourceids.ParseResult) error
  • func (id FirewallId) ID() string
  • func (id FirewallId) Segments() []resourceids.Segment
  • func (id FirewallId) String() string
• type FirewallStatusClient
  • func NewFirewallStatusClientWithBaseURI(sdkApi sdkEnv.Api) (*FirewallStatusClient, error)
  • func (c FirewallStatusClient) Get(ctx context.Context, id FirewallId) (result GetOperationResponse, err error)
  • func (c FirewallStatusClient) ListByFirewalls(ctx context.Context, id FirewallId) (result ListByFirewallsOperationResponse, err error)
  • func (c FirewallStatusClient) ListByFirewallsComplete(ctx context.Context, id FirewallId) (ListByFirewallsCompleteResult, error)
  • func (c FirewallStatusClient) ListByFirewallsCompleteMatchingPredicate(ctx context.Context, id FirewallId, ...) (result ListByFirewallsCompleteResult, err error)
• type FirewallStatusProperty
• type FirewallStatusResource
• type FirewallStatusResourceOperationPredicate
  • func (p FirewallStatusResourceOperationPredicate) Matches(input FirewallStatusResource) bool
• type GetOperationResponse
• type HealthStatus
  • func (s *HealthStatus) UnmarshalJSON(bytes []byte) error
• type ListByFirewallsCompleteResult
• type ListByFirewallsOperationResponse
• type PanoramaStatus
• type ReadOnlyProvisioningState
  • func (s *ReadOnlyProvisioningState) UnmarshalJSON(bytes []byte) error
• type ServerStatus
  • func (s *ServerStatus) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForBooleanEnum

func PossibleValuesForBooleanEnum() []string

func PossibleValuesForHealthStatus

func PossibleValuesForHealthStatus() []string

func PossibleValuesForReadOnlyProvisioningState

func PossibleValuesForReadOnlyProvisioningState() []string

func PossibleValuesForServerStatus

func PossibleValuesForServerStatus() []string

func ValidateFirewallID

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

ValidateFirewallID checks that 'input' can be parsed as a Firewall ID

Types

type BooleanEnum

type BooleanEnum string

const (
	BooleanEnumFALSE BooleanEnum = "FALSE"
	BooleanEnumTRUE  BooleanEnum = "TRUE"
)

func (*BooleanEnum) UnmarshalJSON

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

type FirewallId

type FirewallId struct {
	SubscriptionId    string
	ResourceGroupName string
	FirewallName      string
}

FirewallId is a struct representing the Resource ID for a Firewall

func NewFirewallID

func NewFirewallID(subscriptionId string, resourceGroupName string, firewallName string) FirewallId

NewFirewallID returns a new FirewallId struct

func ParseFirewallID

func ParseFirewallID(input string) (*FirewallId, error)

ParseFirewallID parses 'input' into a FirewallId

func ParseFirewallIDInsensitively

func ParseFirewallIDInsensitively(input string) (*FirewallId, error)

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

func (*FirewallId) FromParseResult

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

func (FirewallId) ID

func (id FirewallId) ID() string

ID returns the formatted Firewall ID

func (FirewallId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Firewall ID

func (FirewallId) String

func (id FirewallId) String() string

String returns a human-readable description of this Firewall ID

type FirewallStatusClient

type FirewallStatusClient struct {
	Client *resourcemanager.Client
}

func NewFirewallStatusClientWithBaseURI

func NewFirewallStatusClientWithBaseURI(sdkApi sdkEnv.Api) (*FirewallStatusClient, error)

func (FirewallStatusClient) Get

func (c FirewallStatusClient) Get(ctx context.Context, id FirewallId) (result GetOperationResponse, err error)

Get ...

func (FirewallStatusClient) ListByFirewalls

func (c FirewallStatusClient) ListByFirewalls(ctx context.Context, id FirewallId) (result ListByFirewallsOperationResponse, err error)

ListByFirewalls ...

func (FirewallStatusClient) ListByFirewallsComplete

func (c FirewallStatusClient) ListByFirewallsComplete(ctx context.Context, id FirewallId) (ListByFirewallsCompleteResult, error)

ListByFirewallsComplete retrieves all the results into a single object

func (FirewallStatusClient) ListByFirewallsCompleteMatchingPredicate

func (c FirewallStatusClient) ListByFirewallsCompleteMatchingPredicate(ctx context.Context, id FirewallId, predicate FirewallStatusResourceOperationPredicate) (result ListByFirewallsCompleteResult, err error)

ListByFirewallsCompleteMatchingPredicate retrieves all the results and then applies the predicate

type FirewallStatusProperty

type FirewallStatusProperty struct {
	HealthReason      *string                    `json:"healthReason,omitempty"`
	HealthStatus      *HealthStatus              `json:"healthStatus,omitempty"`
	IsPanoramaManaged *BooleanEnum               `json:"isPanoramaManaged,omitempty"`
	PanoramaStatus    *PanoramaStatus            `json:"panoramaStatus,omitempty"`
	ProvisioningState *ReadOnlyProvisioningState `json:"provisioningState,omitempty"`
}

type FirewallStatusResource

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

type FirewallStatusResourceOperationPredicate

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

func (FirewallStatusResourceOperationPredicate) Matches

func (p FirewallStatusResourceOperationPredicate) Matches(input FirewallStatusResource) bool

type GetOperationResponse

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

type HealthStatus

type HealthStatus string

const (
	HealthStatusGREEN        HealthStatus = "GREEN"
	HealthStatusINITIALIZING HealthStatus = "INITIALIZING"
	HealthStatusRED          HealthStatus = "RED"
	HealthStatusYELLOW       HealthStatus = "YELLOW"
)

func (*HealthStatus) UnmarshalJSON

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

type ListByFirewallsCompleteResult

type ListByFirewallsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []FirewallStatusResource
}

type ListByFirewallsOperationResponse

type ListByFirewallsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FirewallStatusResource
}

type PanoramaStatus

type PanoramaStatus struct {
	PanoramaServer2Status *ServerStatus `json:"panoramaServer2Status,omitempty"`
	PanoramaServerStatus  *ServerStatus `json:"panoramaServerStatus,omitempty"`
}

type ReadOnlyProvisioningState

type ReadOnlyProvisioningState string

const (
	ReadOnlyProvisioningStateDeleted   ReadOnlyProvisioningState = "Deleted"
	ReadOnlyProvisioningStateFailed    ReadOnlyProvisioningState = "Failed"
	ReadOnlyProvisioningStateSucceeded ReadOnlyProvisioningState = "Succeeded"
)

func (*ReadOnlyProvisioningState) UnmarshalJSON

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

type ServerStatus

type ServerStatus string

const (
	ServerStatusDOWN ServerStatus = "DOWN"
	ServerStatusUP   ServerStatus = "UP"
)

func (*ServerStatus) UnmarshalJSON

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