serviceendpointpolicydefinitions

package
v0.20241209.1115630 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-05-01/serviceendpointpolicydefinitions Documentation

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

Client Initialization

client := serviceendpointpolicydefinitions.NewServiceEndpointPolicyDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServiceEndpointPolicyDefinitionsClient.CreateOrUpdate

ctx := context.TODO()
id := serviceendpointpolicydefinitions.NewServiceEndpointPolicyDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceEndpointPolicyName", "serviceEndpointPolicyDefinitionName")

payload := serviceendpointpolicydefinitions.ServiceEndpointPolicyDefinition{
	// ...
}


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

Example Usage: ServiceEndpointPolicyDefinitionsClient.Delete

ctx := context.TODO()
id := serviceendpointpolicydefinitions.NewServiceEndpointPolicyDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceEndpointPolicyName", "serviceEndpointPolicyDefinitionName")

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

Example Usage: ServiceEndpointPolicyDefinitionsClient.Get

ctx := context.TODO()
id := serviceendpointpolicydefinitions.NewServiceEndpointPolicyDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceEndpointPolicyName", "serviceEndpointPolicyDefinitionName")

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: ServiceEndpointPolicyDefinitionsClient.ListByResourceGroup

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateServiceEndpointPolicyDefinitionID 

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

ValidateServiceEndpointPolicyDefinitionID checks that 'input' can be parsed as a Service Endpoint Policy Definition ID

func ValidateServiceEndpointPolicyID 

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

ValidateServiceEndpointPolicyID checks that 'input' can be parsed as a Service Endpoint Policy ID

Types

type CreateOrUpdateOperationResponse 

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

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

type ListByResourceGroupCompleteResult 

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

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        *[]ServiceEndpointPolicyDefinition
}

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 ServiceEndpointPolicyDefinition 

type ServiceEndpointPolicyDefinition struct {
	Etag       *string                                          `json:"etag,omitempty"`
	Id         *string                                          `json:"id,omitempty"`
	Name       *string                                          `json:"name,omitempty"`
	Properties *ServiceEndpointPolicyDefinitionPropertiesFormat `json:"properties,omitempty"`
	Type       *string                                          `json:"type,omitempty"`
}

type ServiceEndpointPolicyDefinitionId 

type ServiceEndpointPolicyDefinitionId struct {
	SubscriptionId                      string
	ResourceGroupName                   string
	ServiceEndpointPolicyName           string
	ServiceEndpointPolicyDefinitionName string
}

ServiceEndpointPolicyDefinitionId is a struct representing the Resource ID for a Service Endpoint Policy Definition

func NewServiceEndpointPolicyDefinitionID 

func NewServiceEndpointPolicyDefinitionID(subscriptionId string, resourceGroupName string, serviceEndpointPolicyName string, serviceEndpointPolicyDefinitionName string) ServiceEndpointPolicyDefinitionId

NewServiceEndpointPolicyDefinitionID returns a new ServiceEndpointPolicyDefinitionId struct

func ParseServiceEndpointPolicyDefinitionID 

func ParseServiceEndpointPolicyDefinitionID(input string) (*ServiceEndpointPolicyDefinitionId, error)

ParseServiceEndpointPolicyDefinitionID parses 'input' into a ServiceEndpointPolicyDefinitionId

func ParseServiceEndpointPolicyDefinitionIDInsensitively 

func ParseServiceEndpointPolicyDefinitionIDInsensitively(input string) (*ServiceEndpointPolicyDefinitionId, error)

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

func (*ServiceEndpointPolicyDefinitionId) FromParseResult 

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

func (ServiceEndpointPolicyDefinitionId) ID 

func (id ServiceEndpointPolicyDefinitionId) ID() string

ID returns the formatted Service Endpoint Policy Definition ID

func (ServiceEndpointPolicyDefinitionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Service Endpoint Policy Definition ID

func (ServiceEndpointPolicyDefinitionId) String 

func (id ServiceEndpointPolicyDefinitionId) String() string

String returns a human-readable description of this Service Endpoint Policy Definition ID

type ServiceEndpointPolicyDefinitionOperationPredicate 

type ServiceEndpointPolicyDefinitionOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ServiceEndpointPolicyDefinitionOperationPredicate) Matches 

func (p ServiceEndpointPolicyDefinitionOperationPredicate) Matches(input ServiceEndpointPolicyDefinition) bool

type ServiceEndpointPolicyDefinitionPropertiesFormat 

type ServiceEndpointPolicyDefinitionPropertiesFormat struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	Service           *string            `json:"service,omitempty"`
	ServiceResources  *[]string          `json:"serviceResources,omitempty"`
}

type ServiceEndpointPolicyDefinitionsClient 

type ServiceEndpointPolicyDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewServiceEndpointPolicyDefinitionsClientWithBaseURI 

func NewServiceEndpointPolicyDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServiceEndpointPolicyDefinitionsClient, error)

func (ServiceEndpointPolicyDefinitionsClient) CreateOrUpdate 

func (c ServiceEndpointPolicyDefinitionsClient) CreateOrUpdate(ctx context.Context, id ServiceEndpointPolicyDefinitionId, input ServiceEndpointPolicyDefinition) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServiceEndpointPolicyDefinitionsClient) CreateOrUpdateThenPoll 

func (c ServiceEndpointPolicyDefinitionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ServiceEndpointPolicyDefinitionId, input ServiceEndpointPolicyDefinition) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServiceEndpointPolicyDefinitionsClient) Delete 

func (c ServiceEndpointPolicyDefinitionsClient) Delete(ctx context.Context, id ServiceEndpointPolicyDefinitionId) (result DeleteOperationResponse, err error)

Delete ...

func (ServiceEndpointPolicyDefinitionsClient) DeleteThenPoll 

func (c ServiceEndpointPolicyDefinitionsClient) DeleteThenPoll(ctx context.Context, id ServiceEndpointPolicyDefinitionId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServiceEndpointPolicyDefinitionsClient) Get 

func (c ServiceEndpointPolicyDefinitionsClient) Get(ctx context.Context, id ServiceEndpointPolicyDefinitionId) (result GetOperationResponse, err error)

Get ...

func (ServiceEndpointPolicyDefinitionsClient) ListByResourceGroup 

func (c ServiceEndpointPolicyDefinitionsClient) ListByResourceGroup(ctx context.Context, id ServiceEndpointPolicyId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ServiceEndpointPolicyDefinitionsClient) ListByResourceGroupComplete 

func (c ServiceEndpointPolicyDefinitionsClient) ListByResourceGroupComplete(ctx context.Context, id ServiceEndpointPolicyId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ServiceEndpointPolicyDefinitionsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ServiceEndpointPolicyDefinitionsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id ServiceEndpointPolicyId, predicate ServiceEndpointPolicyDefinitionOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ServiceEndpointPolicyId 

type ServiceEndpointPolicyId struct {
	SubscriptionId            string
	ResourceGroupName         string
	ServiceEndpointPolicyName string
}

ServiceEndpointPolicyId is a struct representing the Resource ID for a Service Endpoint Policy

func NewServiceEndpointPolicyID 

func NewServiceEndpointPolicyID(subscriptionId string, resourceGroupName string, serviceEndpointPolicyName string) ServiceEndpointPolicyId

NewServiceEndpointPolicyID returns a new ServiceEndpointPolicyId struct

func ParseServiceEndpointPolicyID 

func ParseServiceEndpointPolicyID(input string) (*ServiceEndpointPolicyId, error)

ParseServiceEndpointPolicyID parses 'input' into a ServiceEndpointPolicyId

func ParseServiceEndpointPolicyIDInsensitively 

func ParseServiceEndpointPolicyIDInsensitively(input string) (*ServiceEndpointPolicyId, error)

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

func (*ServiceEndpointPolicyId) FromParseResult 

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

func (ServiceEndpointPolicyId) ID 

func (id ServiceEndpointPolicyId) ID() string

ID returns the formatted Service Endpoint Policy ID

func (ServiceEndpointPolicyId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Service Endpoint Policy ID

func (ServiceEndpointPolicyId) String 

func (id ServiceEndpointPolicyId) String() string

String returns a human-readable description of this Service Endpoint Policy ID

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.