securitypartnerproviders

package
v0.20241212.1154051 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-03-01/securitypartnerproviders Documentation

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

Client Initialization

client := securitypartnerproviders.NewSecurityPartnerProvidersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecurityPartnerProvidersClient.CreateOrUpdate

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

payload := securitypartnerproviders.SecurityPartnerProvider{
	// ...
}


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

Example Usage: SecurityPartnerProvidersClient.Delete

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

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

Example Usage: SecurityPartnerProvidersClient.Get

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

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

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

// 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: SecurityPartnerProvidersClient.ListByResourceGroup

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

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

Example Usage: SecurityPartnerProvidersClient.UpdateTags

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

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

func PossibleValuesForSecurityPartnerProviderConnectionStatus() []string

func PossibleValuesForSecurityProviderName 

func PossibleValuesForSecurityProviderName() []string

func ValidateSecurityPartnerProviderID 

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

ValidateSecurityPartnerProviderID checks that 'input' can be parsed as a Security Partner Provider ID

Types

type CreateOrUpdateOperationResponse 

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

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SecurityPartnerProvider
}

type ListByResourceGroupCustomPager 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SecurityPartnerProvider
}

type ListCompleteResult 

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

type ListCustomPager 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

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

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 SecurityPartnerProvider 

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

type SecurityPartnerProviderConnectionStatus 

type SecurityPartnerProviderConnectionStatus string
const (
	SecurityPartnerProviderConnectionStatusConnected          SecurityPartnerProviderConnectionStatus = "Connected"
	SecurityPartnerProviderConnectionStatusNotConnected       SecurityPartnerProviderConnectionStatus = "NotConnected"
	SecurityPartnerProviderConnectionStatusPartiallyConnected SecurityPartnerProviderConnectionStatus = "PartiallyConnected"
	SecurityPartnerProviderConnectionStatusUnknown            SecurityPartnerProviderConnectionStatus = "Unknown"
)

func (*SecurityPartnerProviderConnectionStatus) UnmarshalJSON 

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

type SecurityPartnerProviderId 

type SecurityPartnerProviderId struct {
	SubscriptionId              string
	ResourceGroupName           string
	SecurityPartnerProviderName string
}

SecurityPartnerProviderId is a struct representing the Resource ID for a Security Partner Provider

func NewSecurityPartnerProviderID 

func NewSecurityPartnerProviderID(subscriptionId string, resourceGroupName string, securityPartnerProviderName string) SecurityPartnerProviderId

NewSecurityPartnerProviderID returns a new SecurityPartnerProviderId struct

func ParseSecurityPartnerProviderID 

func ParseSecurityPartnerProviderID(input string) (*SecurityPartnerProviderId, error)

ParseSecurityPartnerProviderID parses 'input' into a SecurityPartnerProviderId

func ParseSecurityPartnerProviderIDInsensitively 

func ParseSecurityPartnerProviderIDInsensitively(input string) (*SecurityPartnerProviderId, error)

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

func (*SecurityPartnerProviderId) FromParseResult 

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

func (SecurityPartnerProviderId) ID 

func (id SecurityPartnerProviderId) ID() string

ID returns the formatted Security Partner Provider ID

func (SecurityPartnerProviderId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Security Partner Provider ID

func (SecurityPartnerProviderId) String 

func (id SecurityPartnerProviderId) String() string

String returns a human-readable description of this Security Partner Provider ID

type SecurityPartnerProviderOperationPredicate 

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

func (SecurityPartnerProviderOperationPredicate) Matches 

func (p SecurityPartnerProviderOperationPredicate) Matches(input SecurityPartnerProvider) bool

type SecurityPartnerProviderPropertiesFormat 

type SecurityPartnerProviderPropertiesFormat struct {
	ConnectionStatus     *SecurityPartnerProviderConnectionStatus `json:"connectionStatus,omitempty"`
	ProvisioningState    *ProvisioningState                       `json:"provisioningState,omitempty"`
	SecurityProviderName *SecurityProviderName                    `json:"securityProviderName,omitempty"`
	VirtualHub           *SubResource                             `json:"virtualHub,omitempty"`
}

type SecurityPartnerProvidersClient 

type SecurityPartnerProvidersClient struct {
	Client *resourcemanager.Client
}

func NewSecurityPartnerProvidersClientWithBaseURI 

func NewSecurityPartnerProvidersClientWithBaseURI(sdkApi sdkEnv.Api) (*SecurityPartnerProvidersClient, error)

func (SecurityPartnerProvidersClient) CreateOrUpdate 

func (c SecurityPartnerProvidersClient) CreateOrUpdate(ctx context.Context, id SecurityPartnerProviderId, input SecurityPartnerProvider) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SecurityPartnerProvidersClient) CreateOrUpdateThenPoll 

func (c SecurityPartnerProvidersClient) CreateOrUpdateThenPoll(ctx context.Context, id SecurityPartnerProviderId, input SecurityPartnerProvider) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SecurityPartnerProvidersClient) Delete 

func (c SecurityPartnerProvidersClient) Delete(ctx context.Context, id SecurityPartnerProviderId) (result DeleteOperationResponse, err error)

Delete ...

func (SecurityPartnerProvidersClient) DeleteThenPoll 

func (c SecurityPartnerProvidersClient) DeleteThenPoll(ctx context.Context, id SecurityPartnerProviderId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SecurityPartnerProvidersClient) Get 

func (c SecurityPartnerProvidersClient) Get(ctx context.Context, id SecurityPartnerProviderId) (result GetOperationResponse, err error)

Get ...

func (SecurityPartnerProvidersClient) List 

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

List ...

func (SecurityPartnerProvidersClient) ListByResourceGroup 

func (c SecurityPartnerProvidersClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (SecurityPartnerProvidersClient) ListByResourceGroupComplete 

func (c SecurityPartnerProvidersClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (SecurityPartnerProvidersClient) ListByResourceGroupCompleteMatchingPredicate 

func (c SecurityPartnerProvidersClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate SecurityPartnerProviderOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SecurityPartnerProvidersClient) ListComplete 

func (c SecurityPartnerProvidersClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SecurityPartnerProvidersClient) ListCompleteMatchingPredicate 

func (c SecurityPartnerProvidersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SecurityPartnerProviderOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SecurityPartnerProvidersClient) UpdateTags 

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

UpdateTags ...

type SecurityProviderName 

type SecurityProviderName string
const (
	SecurityProviderNameCheckpoint SecurityProviderName = "Checkpoint"
	SecurityProviderNameIBoss      SecurityProviderName = "IBoss"
	SecurityProviderNameZScaler    SecurityProviderName = "ZScaler"
)

func (*SecurityProviderName) UnmarshalJSON 

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

type SubResource 

type SubResource struct {
	Id *string `json:"id,omitempty"`
}

type TagsObject 

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

type UpdateTagsOperationResponse 

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

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.