customipprefixes

package
v0.20230516.1215417 Latest Latest
Warning

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

Go to latest
Published: May 16, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2022-09-01/customipprefixes Documentation

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

Client Initialization

client := customipprefixes.NewCustomIPPrefixesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CustomIPPrefixesClient.CreateOrUpdate

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

payload := customipprefixes.CustomIPPrefix{
	// ...
}


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

Example Usage: CustomIPPrefixesClient.Delete

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

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

Example Usage: CustomIPPrefixesClient.Get

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

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

Example Usage: CustomIPPrefixesClient.List

ctx := context.TODO()
id := customipprefixes.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: CustomIPPrefixesClient.ListAll

ctx := context.TODO()
id := customipprefixes.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: CustomIPPrefixesClient.UpdateTags

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

payload := customipprefixes.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 PossibleValuesForCommissionedState

func PossibleValuesForCommissionedState() []string

func PossibleValuesForCustomIPPrefixType

func PossibleValuesForCustomIPPrefixType() []string

func PossibleValuesForGeo

func PossibleValuesForGeo() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateCustomIPPrefixID

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

ValidateCustomIPPrefixID checks that 'input' can be parsed as a Custom I P Prefix ID

Types

type CommissionedState

type CommissionedState string
const (
	CommissionedStateCommissioned                    CommissionedState = "Commissioned"
	CommissionedStateCommissionedNoInternetAdvertise CommissionedState = "CommissionedNoInternetAdvertise"
	CommissionedStateCommissioning                   CommissionedState = "Commissioning"
	CommissionedStateDecommissioning                 CommissionedState = "Decommissioning"
	CommissionedStateDeprovisioned                   CommissionedState = "Deprovisioned"
	CommissionedStateDeprovisioning                  CommissionedState = "Deprovisioning"
	CommissionedStateProvisioned                     CommissionedState = "Provisioned"
	CommissionedStateProvisioning                    CommissionedState = "Provisioning"
)

func (*CommissionedState) UnmarshalJSON

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

type CreateOrUpdateOperationResponse

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

type CustomIPPrefix

type CustomIPPrefix 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       *CustomIPPrefixPropertiesFormat `json:"properties,omitempty"`
	Tags             *map[string]string              `json:"tags,omitempty"`
	Type             *string                         `json:"type,omitempty"`
	Zones            *zones.Schema                   `json:"zones,omitempty"`
}

type CustomIPPrefixId

type CustomIPPrefixId struct {
	SubscriptionId     string
	ResourceGroupName  string
	CustomIPPrefixName string
}

CustomIPPrefixId is a struct representing the Resource ID for a Custom I P Prefix

func NewCustomIPPrefixID

func NewCustomIPPrefixID(subscriptionId string, resourceGroupName string, customIPPrefixName string) CustomIPPrefixId

NewCustomIPPrefixID returns a new CustomIPPrefixId struct

func ParseCustomIPPrefixID

func ParseCustomIPPrefixID(input string) (*CustomIPPrefixId, error)

ParseCustomIPPrefixID parses 'input' into a CustomIPPrefixId

func ParseCustomIPPrefixIDInsensitively

func ParseCustomIPPrefixIDInsensitively(input string) (*CustomIPPrefixId, error)

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

func (CustomIPPrefixId) ID

func (id CustomIPPrefixId) ID() string

ID returns the formatted Custom I P Prefix ID

func (CustomIPPrefixId) Segments

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

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

func (CustomIPPrefixId) String

func (id CustomIPPrefixId) String() string

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

type CustomIPPrefixOperationPredicate

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

func (CustomIPPrefixOperationPredicate) Matches

type CustomIPPrefixPropertiesFormat

type CustomIPPrefixPropertiesFormat struct {
	Asn                   *string             `json:"asn,omitempty"`
	AuthorizationMessage  *string             `json:"authorizationMessage,omitempty"`
	ChildCustomIPPrefixes *[]SubResource      `json:"childCustomIpPrefixes,omitempty"`
	Cidr                  *string             `json:"cidr,omitempty"`
	CommissionedState     *CommissionedState  `json:"commissionedState,omitempty"`
	CustomIPPrefixParent  *SubResource        `json:"customIpPrefixParent,omitempty"`
	ExpressRouteAdvertise *bool               `json:"expressRouteAdvertise,omitempty"`
	FailedReason          *string             `json:"failedReason,omitempty"`
	Geo                   *Geo                `json:"geo,omitempty"`
	NoInternetAdvertise   *bool               `json:"noInternetAdvertise,omitempty"`
	PrefixType            *CustomIPPrefixType `json:"prefixType,omitempty"`
	ProvisioningState     *ProvisioningState  `json:"provisioningState,omitempty"`
	PublicIPPrefixes      *[]SubResource      `json:"publicIpPrefixes,omitempty"`
	ResourceGuid          *string             `json:"resourceGuid,omitempty"`
	SignedMessage         *string             `json:"signedMessage,omitempty"`
}

type CustomIPPrefixType

type CustomIPPrefixType string
const (
	CustomIPPrefixTypeChild    CustomIPPrefixType = "Child"
	CustomIPPrefixTypeParent   CustomIPPrefixType = "Parent"
	CustomIPPrefixTypeSingular CustomIPPrefixType = "Singular"
)

func (*CustomIPPrefixType) UnmarshalJSON

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

type CustomIPPrefixesClient

type CustomIPPrefixesClient struct {
	Client *resourcemanager.Client
}

func NewCustomIPPrefixesClientWithBaseURI

func NewCustomIPPrefixesClientWithBaseURI(api environments.Api) (*CustomIPPrefixesClient, error)

func (CustomIPPrefixesClient) CreateOrUpdate

CreateOrUpdate ...

func (CustomIPPrefixesClient) CreateOrUpdateThenPoll

func (c CustomIPPrefixesClient) CreateOrUpdateThenPoll(ctx context.Context, id CustomIPPrefixId, input CustomIPPrefix) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (CustomIPPrefixesClient) Delete

Delete ...

func (CustomIPPrefixesClient) DeleteThenPoll

func (c CustomIPPrefixesClient) DeleteThenPoll(ctx context.Context, id CustomIPPrefixId) error

DeleteThenPoll performs Delete then polls until it's completed

func (CustomIPPrefixesClient) Get

Get ...

func (CustomIPPrefixesClient) List

List ...

func (CustomIPPrefixesClient) ListAll

ListAll ...

func (CustomIPPrefixesClient) ListAllComplete

ListAllComplete retrieves all the results into a single object

func (CustomIPPrefixesClient) ListAllCompleteMatchingPredicate

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

ListAllCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CustomIPPrefixesClient) ListComplete

ListComplete retrieves all the results into a single object

func (CustomIPPrefixesClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CustomIPPrefixesClient) UpdateTags

UpdateTags ...

type DeleteOperationResponse

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

type Geo

type Geo string
const (
	GeoAFRI    Geo = "AFRI"
	GeoAPAC    Geo = "APAC"
	GeoAQ      Geo = "AQ"
	GeoEURO    Geo = "EURO"
	GeoGLOBAL  Geo = "GLOBAL"
	GeoLATAM   Geo = "LATAM"
	GeoME      Geo = "ME"
	GeoNAM     Geo = "NAM"
	GeoOCEANIA Geo = "OCEANIA"
)

func (*Geo) UnmarshalJSON

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

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

type ListAllCompleteResult

type ListAllCompleteResult struct {
	Items []CustomIPPrefix
}

type ListAllOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []CustomIPPrefix
}

type ListOperationResponse

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

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

Jump to

Keyboard shortcuts

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