dnsforwardingrulesets

package
v0.20240621.1124930 Latest Latest
Warning

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

Go to latest
Published: Jun 21, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/dnsresolver/2022-07-01/dnsforwardingrulesets Documentation

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

Client Initialization

client := dnsforwardingrulesets.NewDnsForwardingRulesetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DnsForwardingRulesetsClient.CreateOrUpdate

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

payload := dnsforwardingrulesets.DnsForwardingRuleset{
	// ...
}


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

Example Usage: DnsForwardingRulesetsClient.Delete

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

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

Example Usage: DnsForwardingRulesetsClient.Get

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

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

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

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

Example Usage: DnsForwardingRulesetsClient.ListByResourceGroup

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

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

Example Usage: DnsForwardingRulesetsClient.ListByVirtualNetwork

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

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

Example Usage: DnsForwardingRulesetsClient.Update

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

payload := dnsforwardingrulesets.DnsForwardingRulesetPatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateDnsForwardingRulesetID

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

ValidateDnsForwardingRulesetID checks that 'input' can be parsed as a Dns Forwarding Ruleset ID

Types

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders

func (CreateOrUpdateOperationOptions) ToOData

func (CreateOrUpdateOperationOptions) ToQuery

type CreateOrUpdateOperationResponse

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

type DeleteOperationOptions

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders

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

func (DeleteOperationOptions) ToOData

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

func (DeleteOperationOptions) ToQuery

type DeleteOperationResponse

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

type DnsForwardingRuleset

type DnsForwardingRuleset struct {
	Etag       *string                        `json:"etag,omitempty"`
	Id         *string                        `json:"id,omitempty"`
	Location   string                         `json:"location"`
	Name       *string                        `json:"name,omitempty"`
	Properties DnsForwardingRulesetProperties `json:"properties"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type DnsForwardingRulesetId

type DnsForwardingRulesetId struct {
	SubscriptionId           string
	ResourceGroupName        string
	DnsForwardingRulesetName string
}

DnsForwardingRulesetId is a struct representing the Resource ID for a Dns Forwarding Ruleset

func NewDnsForwardingRulesetID

func NewDnsForwardingRulesetID(subscriptionId string, resourceGroupName string, dnsForwardingRulesetName string) DnsForwardingRulesetId

NewDnsForwardingRulesetID returns a new DnsForwardingRulesetId struct

func ParseDnsForwardingRulesetID

func ParseDnsForwardingRulesetID(input string) (*DnsForwardingRulesetId, error)

ParseDnsForwardingRulesetID parses 'input' into a DnsForwardingRulesetId

func ParseDnsForwardingRulesetIDInsensitively

func ParseDnsForwardingRulesetIDInsensitively(input string) (*DnsForwardingRulesetId, error)

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

func (*DnsForwardingRulesetId) FromParseResult

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

func (DnsForwardingRulesetId) ID

ID returns the formatted Dns Forwarding Ruleset ID

func (DnsForwardingRulesetId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Dns Forwarding Ruleset ID

func (DnsForwardingRulesetId) String

func (id DnsForwardingRulesetId) String() string

String returns a human-readable description of this Dns Forwarding Ruleset ID

type DnsForwardingRulesetOperationPredicate

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

func (DnsForwardingRulesetOperationPredicate) Matches

type DnsForwardingRulesetPatch

type DnsForwardingRulesetPatch struct {
	DnsResolverOutboundEndpoints *[]SubResource     `json:"dnsResolverOutboundEndpoints,omitempty"`
	Tags                         *map[string]string `json:"tags,omitempty"`
}

type DnsForwardingRulesetProperties

type DnsForwardingRulesetProperties struct {
	DnsResolverOutboundEndpoints []SubResource      `json:"dnsResolverOutboundEndpoints"`
	ProvisioningState            *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceGuid                 *string            `json:"resourceGuid,omitempty"`
}

type DnsForwardingRulesetsClient

type DnsForwardingRulesetsClient struct {
	Client *resourcemanager.Client
}

func NewDnsForwardingRulesetsClientWithBaseURI

func NewDnsForwardingRulesetsClientWithBaseURI(sdkApi sdkEnv.Api) (*DnsForwardingRulesetsClient, error)

func (DnsForwardingRulesetsClient) CreateOrUpdate

CreateOrUpdate ...

func (DnsForwardingRulesetsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DnsForwardingRulesetsClient) Delete

Delete ...

func (DnsForwardingRulesetsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (DnsForwardingRulesetsClient) Get

Get ...

func (DnsForwardingRulesetsClient) List

List ...

func (DnsForwardingRulesetsClient) ListByResourceGroup

ListByResourceGroup ...

func (DnsForwardingRulesetsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (DnsForwardingRulesetsClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DnsForwardingRulesetsClient) ListByVirtualNetwork

ListByVirtualNetwork ...

func (DnsForwardingRulesetsClient) ListByVirtualNetworkComplete

ListByVirtualNetworkComplete retrieves all the results into a single object

func (DnsForwardingRulesetsClient) ListByVirtualNetworkCompleteMatchingPredicate

ListByVirtualNetworkCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DnsForwardingRulesetsClient) ListComplete

ListComplete retrieves all the results into a single object

func (DnsForwardingRulesetsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DnsForwardingRulesetsClient) Update

Update ...

func (DnsForwardingRulesetsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupOperationOptions

type ListByResourceGroupOperationOptions struct {
	Top *int64
}

func DefaultListByResourceGroupOperationOptions

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders

func (ListByResourceGroupOperationOptions) ToOData

func (ListByResourceGroupOperationOptions) ToQuery

type ListByResourceGroupOperationResponse

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

type ListByVirtualNetworkCompleteResult

type ListByVirtualNetworkCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VirtualNetworkDnsForwardingRuleset
}

type ListByVirtualNetworkOperationOptions

type ListByVirtualNetworkOperationOptions struct {
	Top *int64
}

func DefaultListByVirtualNetworkOperationOptions

func DefaultListByVirtualNetworkOperationOptions() ListByVirtualNetworkOperationOptions

func (ListByVirtualNetworkOperationOptions) ToHeaders

func (ListByVirtualNetworkOperationOptions) ToOData

func (ListByVirtualNetworkOperationOptions) ToQuery

type ListByVirtualNetworkOperationResponse

type ListByVirtualNetworkOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VirtualNetworkDnsForwardingRuleset
}

type ListCompleteResult

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

type ListOperationOptions

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

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

func (ListOperationOptions) ToOData

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

func (ListOperationOptions) ToQuery

type ListOperationResponse

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

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	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"`
}

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders

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

func (UpdateOperationOptions) ToOData

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

func (UpdateOperationOptions) ToQuery

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DnsForwardingRuleset
}

type VirtualNetworkDnsForwardingRuleset

type VirtualNetworkDnsForwardingRuleset struct {
	Id         *string                                  `json:"id,omitempty"`
	Properties *VirtualNetworkLinkSubResourceProperties `json:"properties,omitempty"`
}

type VirtualNetworkDnsForwardingRulesetOperationPredicate

type VirtualNetworkDnsForwardingRulesetOperationPredicate struct {
	Id *string
}

func (VirtualNetworkDnsForwardingRulesetOperationPredicate) Matches

type VirtualNetworkLinkSubResourceProperties

type VirtualNetworkLinkSubResourceProperties struct {
	VirtualNetworkLink *SubResource `json:"virtualNetworkLink,omitempty"`
}

Jump to

Keyboard shortcuts

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