publicipprefixes

package
v0.20240903.1131440 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/publicipprefixes Documentation

The publicipprefixes SDK allows for interaction with the Azure Resource Manager Service network (API Version 2023-11-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/2023-11-01/publicipprefixes"

Client Initialization

client := publicipprefixes.NewPublicIPPrefixesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PublicIPPrefixesClient.CreateOrUpdate

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

payload := publicipprefixes.PublicIPPrefix{
	// ...
}


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

Example Usage: PublicIPPrefixesClient.Delete

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

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

Example Usage: PublicIPPrefixesClient.Get

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

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

Example Usage: PublicIPPrefixesClient.List

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

// 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: PublicIPPrefixesClient.ListAll

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

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

Example Usage: PublicIPPrefixesClient.UpdateTags

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

payload := publicipprefixes.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 PossibleValuesForIPVersion 

func PossibleValuesForIPVersion() []string

func PossibleValuesForNatGatewaySkuName 

func PossibleValuesForNatGatewaySkuName() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicIPPrefixSkuName 

func PossibleValuesForPublicIPPrefixSkuName() []string

func PossibleValuesForPublicIPPrefixSkuTier 

func PossibleValuesForPublicIPPrefixSkuTier() []string

func ValidatePublicIPPrefixID 

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

ValidatePublicIPPrefixID checks that 'input' can be parsed as a Public I P Prefix ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

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

func (GetOperationOptions) ToOData 

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

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

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

type IPTag 

type IPTag struct {
	IPTagType *string `json:"ipTagType,omitempty"`
	Tag       *string `json:"tag,omitempty"`
}

type IPVersion 

type IPVersion string
const (
	IPVersionIPvFour IPVersion = "IPv4"
	IPVersionIPvSix  IPVersion = "IPv6"
)

func (*IPVersion) UnmarshalJSON 

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

type ListAllCompleteResult 

type ListAllCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PublicIPPrefix
}

type ListAllCustomPager added in v0.20240628.1153531 

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

type ListAllOperationResponse 

type ListAllOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PublicIPPrefix
}

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type NatGateway 

type NatGateway struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *NatGatewayPropertiesFormat `json:"properties,omitempty"`
	Sku        *NatGatewaySku              `json:"sku,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
	Zones      *zones.Schema               `json:"zones,omitempty"`
}

type NatGatewayPropertiesFormat 

type NatGatewayPropertiesFormat struct {
	IdleTimeoutInMinutes *int64             `json:"idleTimeoutInMinutes,omitempty"`
	ProvisioningState    *ProvisioningState `json:"provisioningState,omitempty"`
	PublicIPAddresses    *[]SubResource     `json:"publicIpAddresses,omitempty"`
	PublicIPPrefixes     *[]SubResource     `json:"publicIpPrefixes,omitempty"`
	ResourceGuid         *string            `json:"resourceGuid,omitempty"`
	Subnets              *[]SubResource     `json:"subnets,omitempty"`
}

type NatGatewaySku 

type NatGatewaySku struct {
	Name *NatGatewaySkuName `json:"name,omitempty"`
}

type NatGatewaySkuName 

type NatGatewaySkuName string
const (
	NatGatewaySkuNameStandard NatGatewaySkuName = "Standard"
)

func (*NatGatewaySkuName) UnmarshalJSON 

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

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 PublicIPPrefix 

type PublicIPPrefix struct {
	Etag             *string                         `json:"etag,omitempty"`
	ExtendedLocation *edgezones.Model                `json:"extendedLocation,omitempty"`
	Id               *string                         `json:"id,omitempty"`
	Location         *string                         `json:"location,omitempty"`
	Name             *string                         `json:"name,omitempty"`
	Properties       *PublicIPPrefixPropertiesFormat `json:"properties,omitempty"`
	Sku              *PublicIPPrefixSku              `json:"sku,omitempty"`
	Tags             *map[string]string              `json:"tags,omitempty"`
	Type             *string                         `json:"type,omitempty"`
	Zones            *zones.Schema                   `json:"zones,omitempty"`
}

type PublicIPPrefixId 

type PublicIPPrefixId struct {
	SubscriptionId     string
	ResourceGroupName  string
	PublicIPPrefixName string
}

PublicIPPrefixId is a struct representing the Resource ID for a Public I P Prefix

func NewPublicIPPrefixID 

func NewPublicIPPrefixID(subscriptionId string, resourceGroupName string, publicIPPrefixName string) PublicIPPrefixId

NewPublicIPPrefixID returns a new PublicIPPrefixId struct

func ParsePublicIPPrefixID 

func ParsePublicIPPrefixID(input string) (*PublicIPPrefixId, error)

ParsePublicIPPrefixID parses 'input' into a PublicIPPrefixId

func ParsePublicIPPrefixIDInsensitively 

func ParsePublicIPPrefixIDInsensitively(input string) (*PublicIPPrefixId, error)

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

func (*PublicIPPrefixId) FromParseResult 

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

func (PublicIPPrefixId) ID 

func (id PublicIPPrefixId) ID() string

ID returns the formatted Public I P Prefix ID

func (PublicIPPrefixId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Public I P Prefix ID

func (PublicIPPrefixId) String 

func (id PublicIPPrefixId) String() string

String returns a human-readable description of this Public I P Prefix ID

type PublicIPPrefixOperationPredicate 

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

func (PublicIPPrefixOperationPredicate) Matches 

func (p PublicIPPrefixOperationPredicate) Matches(input PublicIPPrefix) bool

type PublicIPPrefixPropertiesFormat 

type PublicIPPrefixPropertiesFormat struct {
	CustomIPPrefix                      *SubResource                 `json:"customIPPrefix,omitempty"`
	IPPrefix                            *string                      `json:"ipPrefix,omitempty"`
	IPTags                              *[]IPTag                     `json:"ipTags,omitempty"`
	LoadBalancerFrontendIPConfiguration *SubResource                 `json:"loadBalancerFrontendIpConfiguration,omitempty"`
	NatGateway                          *NatGateway                  `json:"natGateway,omitempty"`
	PrefixLength                        *int64                       `json:"prefixLength,omitempty"`
	ProvisioningState                   *ProvisioningState           `json:"provisioningState,omitempty"`
	PublicIPAddressVersion              *IPVersion                   `json:"publicIPAddressVersion,omitempty"`
	PublicIPAddresses                   *[]ReferencedPublicIPAddress `json:"publicIPAddresses,omitempty"`
	ResourceGuid                        *string                      `json:"resourceGuid,omitempty"`
}

type PublicIPPrefixSku 

type PublicIPPrefixSku struct {
	Name *PublicIPPrefixSkuName `json:"name,omitempty"`
	Tier *PublicIPPrefixSkuTier `json:"tier,omitempty"`
}

type PublicIPPrefixSkuName 

type PublicIPPrefixSkuName string
const (
	PublicIPPrefixSkuNameStandard PublicIPPrefixSkuName = "Standard"
)

func (*PublicIPPrefixSkuName) UnmarshalJSON 

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

type PublicIPPrefixSkuTier 

type PublicIPPrefixSkuTier string
const (
	PublicIPPrefixSkuTierGlobal   PublicIPPrefixSkuTier = "Global"
	PublicIPPrefixSkuTierRegional PublicIPPrefixSkuTier = "Regional"
)

func (*PublicIPPrefixSkuTier) UnmarshalJSON 

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

type PublicIPPrefixesClient 

type PublicIPPrefixesClient struct {
	Client *resourcemanager.Client
}

func NewPublicIPPrefixesClientWithBaseURI 

func NewPublicIPPrefixesClientWithBaseURI(sdkApi sdkEnv.Api) (*PublicIPPrefixesClient, error)

func (PublicIPPrefixesClient) CreateOrUpdate 

func (c PublicIPPrefixesClient) CreateOrUpdate(ctx context.Context, id PublicIPPrefixId, input PublicIPPrefix) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PublicIPPrefixesClient) CreateOrUpdateThenPoll 

func (c PublicIPPrefixesClient) CreateOrUpdateThenPoll(ctx context.Context, id PublicIPPrefixId, input PublicIPPrefix) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PublicIPPrefixesClient) Delete 

func (c PublicIPPrefixesClient) Delete(ctx context.Context, id PublicIPPrefixId) (result DeleteOperationResponse, err error)

Delete ...

func (PublicIPPrefixesClient) DeleteThenPoll 

func (c PublicIPPrefixesClient) DeleteThenPoll(ctx context.Context, id PublicIPPrefixId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PublicIPPrefixesClient) Get 

func (c PublicIPPrefixesClient) Get(ctx context.Context, id PublicIPPrefixId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (PublicIPPrefixesClient) List 

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

List ...

func (PublicIPPrefixesClient) ListAll 

func (c PublicIPPrefixesClient) ListAll(ctx context.Context, id commonids.SubscriptionId) (result ListAllOperationResponse, err error)

ListAll ...

func (PublicIPPrefixesClient) ListAllComplete 

func (c PublicIPPrefixesClient) ListAllComplete(ctx context.Context, id commonids.SubscriptionId) (ListAllCompleteResult, error)

ListAllComplete retrieves all the results into a single object

func (PublicIPPrefixesClient) ListAllCompleteMatchingPredicate 

func (c PublicIPPrefixesClient) ListAllCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate PublicIPPrefixOperationPredicate) (result ListAllCompleteResult, err error)

ListAllCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PublicIPPrefixesClient) ListComplete 

func (c PublicIPPrefixesClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PublicIPPrefixesClient) ListCompleteMatchingPredicate 

func (c PublicIPPrefixesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PublicIPPrefixOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PublicIPPrefixesClient) UpdateTags 

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

UpdateTags ...

type ReferencedPublicIPAddress 

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

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

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.