dnsprivatezones

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/dnsprivatezones Documentation

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

Client Initialization

client := dnsprivatezones.NewDnsPrivateZonesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DnsPrivateZonesClient.Get

ctx := context.TODO()
id := dnsprivatezones.NewDnsPrivateZoneID("12345678-1234-9876-4563-123456789012", "locationName", "dnsPrivateZoneName")

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: DnsPrivateZonesClient.ListByLocation

ctx := context.TODO()
id := dnsprivatezones.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

// alternatively `client.ListByLocation(ctx, id)` can be used to do batched pagination
items, err := client.ListByLocationComplete(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 PossibleValuesForDnsPrivateZonesLifecycleState 

func PossibleValuesForDnsPrivateZonesLifecycleState() []string

func PossibleValuesForResourceProvisioningState 

func PossibleValuesForResourceProvisioningState() []string

func PossibleValuesForZoneType 

func PossibleValuesForZoneType() []string

func ValidateDnsPrivateZoneID 

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

ValidateDnsPrivateZoneID checks that 'input' can be parsed as a Dns Private Zone ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type DnsPrivateZone 

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

type DnsPrivateZoneId 

type DnsPrivateZoneId struct {
	SubscriptionId     string
	LocationName       string
	DnsPrivateZoneName string
}

DnsPrivateZoneId is a struct representing the Resource ID for a Dns Private Zone

func NewDnsPrivateZoneID 

func NewDnsPrivateZoneID(subscriptionId string, locationName string, dnsPrivateZoneName string) DnsPrivateZoneId

NewDnsPrivateZoneID returns a new DnsPrivateZoneId struct

func ParseDnsPrivateZoneID 

func ParseDnsPrivateZoneID(input string) (*DnsPrivateZoneId, error)

ParseDnsPrivateZoneID parses 'input' into a DnsPrivateZoneId

func ParseDnsPrivateZoneIDInsensitively 

func ParseDnsPrivateZoneIDInsensitively(input string) (*DnsPrivateZoneId, error)

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

func (*DnsPrivateZoneId) FromParseResult 

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

func (DnsPrivateZoneId) ID 

func (id DnsPrivateZoneId) ID() string

ID returns the formatted Dns Private Zone ID

func (DnsPrivateZoneId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dns Private Zone ID

func (DnsPrivateZoneId) String 

func (id DnsPrivateZoneId) String() string

String returns a human-readable description of this Dns Private Zone ID

type DnsPrivateZoneOperationPredicate 

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

func (DnsPrivateZoneOperationPredicate) Matches 

func (p DnsPrivateZoneOperationPredicate) Matches(input DnsPrivateZone) bool

type DnsPrivateZoneProperties 

type DnsPrivateZoneProperties struct {
	IsProtected       bool                          `json:"isProtected"`
	LifecycleState    DnsPrivateZonesLifecycleState `json:"lifecycleState"`
	Ocid              string                        `json:"ocid"`
	ProvisioningState *ResourceProvisioningState    `json:"provisioningState,omitempty"`
	Self              string                        `json:"self"`
	Serial            int64                         `json:"serial"`
	TimeCreated       string                        `json:"timeCreated"`
	Version           string                        `json:"version"`
	ViewId            *string                       `json:"viewId,omitempty"`
	ZoneType          ZoneType                      `json:"zoneType"`
}

func (*DnsPrivateZoneProperties) GetTimeCreatedAsTime 

func (o *DnsPrivateZoneProperties) GetTimeCreatedAsTime() (*time.Time, error)

func (*DnsPrivateZoneProperties) SetTimeCreatedAsTime 

func (o *DnsPrivateZoneProperties) SetTimeCreatedAsTime(input time.Time)

type DnsPrivateZonesClient 

type DnsPrivateZonesClient struct {
	Client *resourcemanager.Client
}

func NewDnsPrivateZonesClientWithBaseURI 

func NewDnsPrivateZonesClientWithBaseURI(sdkApi sdkEnv.Api) (*DnsPrivateZonesClient, error)

func (DnsPrivateZonesClient) Get 

func (c DnsPrivateZonesClient) Get(ctx context.Context, id DnsPrivateZoneId) (result GetOperationResponse, err error)

Get ...

func (DnsPrivateZonesClient) ListByLocation 

func (c DnsPrivateZonesClient) ListByLocation(ctx context.Context, id LocationId) (result ListByLocationOperationResponse, err error)

ListByLocation ...

func (DnsPrivateZonesClient) ListByLocationComplete 

func (c DnsPrivateZonesClient) ListByLocationComplete(ctx context.Context, id LocationId) (ListByLocationCompleteResult, error)

ListByLocationComplete retrieves all the results into a single object

func (DnsPrivateZonesClient) ListByLocationCompleteMatchingPredicate 

func (c DnsPrivateZonesClient) ListByLocationCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate DnsPrivateZoneOperationPredicate) (result ListByLocationCompleteResult, err error)

ListByLocationCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DnsPrivateZonesLifecycleState 

type DnsPrivateZonesLifecycleState string
const (
	DnsPrivateZonesLifecycleStateActive   DnsPrivateZonesLifecycleState = "Active"
	DnsPrivateZonesLifecycleStateCreating DnsPrivateZonesLifecycleState = "Creating"
	DnsPrivateZonesLifecycleStateDeleted  DnsPrivateZonesLifecycleState = "Deleted"
	DnsPrivateZonesLifecycleStateDeleting DnsPrivateZonesLifecycleState = "Deleting"
	DnsPrivateZonesLifecycleStateUpdating DnsPrivateZonesLifecycleState = "Updating"
)

func (*DnsPrivateZonesLifecycleState) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByLocationCompleteResult 

type ListByLocationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DnsPrivateZone
}

type ListByLocationCustomPager 

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

type ListByLocationOperationResponse 

type ListByLocationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DnsPrivateZone
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ResourceProvisioningState 

type ResourceProvisioningState string
const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
)

func (*ResourceProvisioningState) UnmarshalJSON 

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

type ZoneType 

type ZoneType string
const (
	ZoneTypePrimary   ZoneType = "Primary"
	ZoneTypeSecondary ZoneType = "Secondary"
)

func (*ZoneType) UnmarshalJSON 

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

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.