armdnsresolver

package module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Feb 22, 2022 License: MIT Imports: 15 Imported by: 8

README

Azure DNS Private Resolver Module for Go

PkgGoDev

The armdnsresolver module provides operations for working with Azure DNS Private Resolver.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure DNS Private Resolver module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dnsresolver/armdnsresolver

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure DNS Private Resolver. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure DNS Private Resolver modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armdnsresolver.NewOutboundEndpointsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armdnsresolver.NewOutboundEndpointsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the DNS Private Resolver label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

func (CreatedByType) ToPtr

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type DNSForwardingRuleset

type DNSForwardingRuleset struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Properties of the DNS forwarding ruleset.
	Properties *DNSForwardingRulesetProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; ETag of the DNS forwarding ruleset.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DNSForwardingRuleset - Describes a DNS forwarding ruleset.

func (DNSForwardingRuleset) MarshalJSON

func (d DNSForwardingRuleset) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSForwardingRuleset.

type DNSForwardingRulesetListResult

type DNSForwardingRulesetListResult struct {
	// Enumeration of the DNS forwarding rulesets.
	Value []*DNSForwardingRuleset `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DNSForwardingRulesetListResult - The response to an enumeration operation on DNS forwarding rulesets.

func (DNSForwardingRulesetListResult) MarshalJSON

func (d DNSForwardingRulesetListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSForwardingRulesetListResult.

type DNSForwardingRulesetPatch

type DNSForwardingRulesetPatch struct {
	// Tags for DNS Resolver.
	Tags map[string]*string `json:"tags,omitempty"`
}

DNSForwardingRulesetPatch - Describes a DNS forwarding ruleset PATCH operation.

func (DNSForwardingRulesetPatch) MarshalJSON

func (d DNSForwardingRulesetPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSForwardingRulesetPatch.

type DNSForwardingRulesetProperties

type DNSForwardingRulesetProperties struct {
	// The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in
	// the ruleset to the target DNS servers.
	DNSResolverOutboundEndpoints []*SubResource `json:"dnsResolverOutboundEndpoints,omitempty"`

	// READ-ONLY; The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to
	// set this value will be ignored.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid for the DNS forwarding ruleset.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

DNSForwardingRulesetProperties - Represents the properties of a DNS forwarding ruleset.

func (DNSForwardingRulesetProperties) MarshalJSON

func (d DNSForwardingRulesetProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSForwardingRulesetProperties.

type DNSForwardingRulesetsClient

type DNSForwardingRulesetsClient struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClient contains the methods for the DNSForwardingRulesets group. Don't use this type directly, use NewDNSForwardingRulesetsClient() instead.

func NewDNSForwardingRulesetsClient

func NewDNSForwardingRulesetsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DNSForwardingRulesetsClient

NewDNSForwardingRulesetsClient creates a new instance of DNSForwardingRulesetsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DNSForwardingRulesetsClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. parameters - Parameters supplied to the CreateOrUpdate operation. options - DNSForwardingRulesetsClientBeginCreateOrUpdateOptions contains the optional parameters for the DNSForwardingRulesetsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_Put.json

Output:

func (*DNSForwardingRulesetsClient) BeginDelete

BeginDelete - Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. options - DNSForwardingRulesetsClientBeginDeleteOptions contains the optional parameters for the DNSForwardingRulesetsClient.BeginDelete method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_Delete.json

Output:

func (*DNSForwardingRulesetsClient) BeginUpdate

BeginUpdate - Updates a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. parameters - Parameters supplied to the Update operation. options - DNSForwardingRulesetsClientBeginUpdateOptions contains the optional parameters for the DNSForwardingRulesetsClient.BeginUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_Patch.json

Output:

func (*DNSForwardingRulesetsClient) Get

func (client *DNSForwardingRulesetsClient) Get(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, options *DNSForwardingRulesetsClientGetOptions) (DNSForwardingRulesetsClientGetResponse, error)

Get - Gets a DNS forwarding ruleset properties. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. options - DNSForwardingRulesetsClientGetOptions contains the optional parameters for the DNSForwardingRulesetsClient.Get method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_Get.json

Output:

func (*DNSForwardingRulesetsClient) List

List - Lists DNS forwarding rulesets in all resource groups of a subscription. If the operation fails it returns an *azcore.ResponseError type. options - DNSForwardingRulesetsClientListOptions contains the optional parameters for the DNSForwardingRulesetsClient.List method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json

Output:

func (*DNSForwardingRulesetsClient) ListByResourceGroup

ListByResourceGroup - Lists DNS forwarding rulesets within a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - DNSForwardingRulesetsClientListByResourceGroupOptions contains the optional parameters for the DNSForwardingRulesetsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json

Output:

func (*DNSForwardingRulesetsClient) ListByVirtualNetwork

ListByVirtualNetwork - Lists DNS forwarding ruleset resource IDs attached to a virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. virtualNetworkName - The name of the virtual network. options - DNSForwardingRulesetsClientListByVirtualNetworkOptions contains the optional parameters for the DNSForwardingRulesetsClient.ListByVirtualNetwork method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json

Output:

type DNSForwardingRulesetsClientBeginCreateOrUpdateOptions

type DNSForwardingRulesetsClientBeginCreateOrUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
	// Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
	IfNoneMatch *string
}

DNSForwardingRulesetsClientBeginCreateOrUpdateOptions contains the optional parameters for the DNSForwardingRulesetsClient.BeginCreateOrUpdate method.

type DNSForwardingRulesetsClientBeginDeleteOptions

type DNSForwardingRulesetsClientBeginDeleteOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

DNSForwardingRulesetsClientBeginDeleteOptions contains the optional parameters for the DNSForwardingRulesetsClient.BeginDelete method.

type DNSForwardingRulesetsClientBeginUpdateOptions

type DNSForwardingRulesetsClientBeginUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

DNSForwardingRulesetsClientBeginUpdateOptions contains the optional parameters for the DNSForwardingRulesetsClient.BeginUpdate method.

type DNSForwardingRulesetsClientCreateOrUpdatePoller

type DNSForwardingRulesetsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DNSForwardingRulesetsClientCreateOrUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*DNSForwardingRulesetsClientCreateOrUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DNSForwardingRulesetsClientCreateOrUpdateResponse will be returned.

func (*DNSForwardingRulesetsClientCreateOrUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DNSForwardingRulesetsClientCreateOrUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DNSForwardingRulesetsClientCreateOrUpdatePollerResponse

type DNSForwardingRulesetsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DNSForwardingRulesetsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientCreateOrUpdatePollerResponse contains the response from method DNSForwardingRulesetsClient.CreateOrUpdate.

func (DNSForwardingRulesetsClientCreateOrUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DNSForwardingRulesetsClientCreateOrUpdatePollerResponse) Resume

Resume rehydrates a DNSForwardingRulesetsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DNSForwardingRulesetsClientCreateOrUpdateResponse

type DNSForwardingRulesetsClientCreateOrUpdateResponse struct {
	DNSForwardingRulesetsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientCreateOrUpdateResponse contains the response from method DNSForwardingRulesetsClient.CreateOrUpdate.

type DNSForwardingRulesetsClientCreateOrUpdateResult

type DNSForwardingRulesetsClientCreateOrUpdateResult struct {
	DNSForwardingRuleset
}

DNSForwardingRulesetsClientCreateOrUpdateResult contains the result from method DNSForwardingRulesetsClient.CreateOrUpdate.

type DNSForwardingRulesetsClientDeletePoller

type DNSForwardingRulesetsClientDeletePoller struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DNSForwardingRulesetsClientDeletePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*DNSForwardingRulesetsClientDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DNSForwardingRulesetsClientDeleteResponse will be returned.

func (*DNSForwardingRulesetsClientDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DNSForwardingRulesetsClientDeletePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DNSForwardingRulesetsClientDeletePollerResponse

type DNSForwardingRulesetsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DNSForwardingRulesetsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientDeletePollerResponse contains the response from method DNSForwardingRulesetsClient.Delete.

func (DNSForwardingRulesetsClientDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DNSForwardingRulesetsClientDeletePollerResponse) Resume

Resume rehydrates a DNSForwardingRulesetsClientDeletePollerResponse from the provided client and resume token.

type DNSForwardingRulesetsClientDeleteResponse

type DNSForwardingRulesetsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientDeleteResponse contains the response from method DNSForwardingRulesetsClient.Delete.

type DNSForwardingRulesetsClientGetOptions

type DNSForwardingRulesetsClientGetOptions struct {
}

DNSForwardingRulesetsClientGetOptions contains the optional parameters for the DNSForwardingRulesetsClient.Get method.

type DNSForwardingRulesetsClientGetResponse

type DNSForwardingRulesetsClientGetResponse struct {
	DNSForwardingRulesetsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientGetResponse contains the response from method DNSForwardingRulesetsClient.Get.

type DNSForwardingRulesetsClientGetResult

type DNSForwardingRulesetsClientGetResult struct {
	DNSForwardingRuleset
}

DNSForwardingRulesetsClientGetResult contains the result from method DNSForwardingRulesetsClient.Get.

type DNSForwardingRulesetsClientListByResourceGroupOptions

type DNSForwardingRulesetsClientListByResourceGroupOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

DNSForwardingRulesetsClientListByResourceGroupOptions contains the optional parameters for the DNSForwardingRulesetsClient.ListByResourceGroup method.

type DNSForwardingRulesetsClientListByResourceGroupPager

type DNSForwardingRulesetsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*DNSForwardingRulesetsClientListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*DNSForwardingRulesetsClientListByResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DNSForwardingRulesetsClientListByResourceGroupPager) PageResponse

PageResponse returns the current DNSForwardingRulesetsClientListByResourceGroupResponse page.

type DNSForwardingRulesetsClientListByResourceGroupResponse

type DNSForwardingRulesetsClientListByResourceGroupResponse struct {
	DNSForwardingRulesetsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientListByResourceGroupResponse contains the response from method DNSForwardingRulesetsClient.ListByResourceGroup.

type DNSForwardingRulesetsClientListByResourceGroupResult

type DNSForwardingRulesetsClientListByResourceGroupResult struct {
	DNSForwardingRulesetListResult
}

DNSForwardingRulesetsClientListByResourceGroupResult contains the result from method DNSForwardingRulesetsClient.ListByResourceGroup.

type DNSForwardingRulesetsClientListByVirtualNetworkOptions

type DNSForwardingRulesetsClientListByVirtualNetworkOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

DNSForwardingRulesetsClientListByVirtualNetworkOptions contains the optional parameters for the DNSForwardingRulesetsClient.ListByVirtualNetwork method.

type DNSForwardingRulesetsClientListByVirtualNetworkPager

type DNSForwardingRulesetsClientListByVirtualNetworkPager struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClientListByVirtualNetworkPager provides operations for iterating over paged responses.

func (*DNSForwardingRulesetsClientListByVirtualNetworkPager) Err

Err returns the last error encountered while paging.

func (*DNSForwardingRulesetsClientListByVirtualNetworkPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DNSForwardingRulesetsClientListByVirtualNetworkPager) PageResponse

PageResponse returns the current DNSForwardingRulesetsClientListByVirtualNetworkResponse page.

type DNSForwardingRulesetsClientListByVirtualNetworkResponse

type DNSForwardingRulesetsClientListByVirtualNetworkResponse struct {
	DNSForwardingRulesetsClientListByVirtualNetworkResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientListByVirtualNetworkResponse contains the response from method DNSForwardingRulesetsClient.ListByVirtualNetwork.

type DNSForwardingRulesetsClientListByVirtualNetworkResult

type DNSForwardingRulesetsClientListByVirtualNetworkResult struct {
	VirtualNetworkDNSForwardingRulesetListResult
}

DNSForwardingRulesetsClientListByVirtualNetworkResult contains the result from method DNSForwardingRulesetsClient.ListByVirtualNetwork.

type DNSForwardingRulesetsClientListOptions

type DNSForwardingRulesetsClientListOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

DNSForwardingRulesetsClientListOptions contains the optional parameters for the DNSForwardingRulesetsClient.List method.

type DNSForwardingRulesetsClientListPager

type DNSForwardingRulesetsClientListPager struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClientListPager provides operations for iterating over paged responses.

func (*DNSForwardingRulesetsClientListPager) Err

Err returns the last error encountered while paging.

func (*DNSForwardingRulesetsClientListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DNSForwardingRulesetsClientListPager) PageResponse

PageResponse returns the current DNSForwardingRulesetsClientListResponse page.

type DNSForwardingRulesetsClientListResponse

type DNSForwardingRulesetsClientListResponse struct {
	DNSForwardingRulesetsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientListResponse contains the response from method DNSForwardingRulesetsClient.List.

type DNSForwardingRulesetsClientListResult

type DNSForwardingRulesetsClientListResult struct {
	DNSForwardingRulesetListResult
}

DNSForwardingRulesetsClientListResult contains the result from method DNSForwardingRulesetsClient.List.

type DNSForwardingRulesetsClientUpdatePoller

type DNSForwardingRulesetsClientUpdatePoller struct {
	// contains filtered or unexported fields
}

DNSForwardingRulesetsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DNSForwardingRulesetsClientUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*DNSForwardingRulesetsClientUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DNSForwardingRulesetsClientUpdateResponse will be returned.

func (*DNSForwardingRulesetsClientUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DNSForwardingRulesetsClientUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DNSForwardingRulesetsClientUpdatePollerResponse

type DNSForwardingRulesetsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DNSForwardingRulesetsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientUpdatePollerResponse contains the response from method DNSForwardingRulesetsClient.Update.

func (DNSForwardingRulesetsClientUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DNSForwardingRulesetsClientUpdatePollerResponse) Resume

Resume rehydrates a DNSForwardingRulesetsClientUpdatePollerResponse from the provided client and resume token.

type DNSForwardingRulesetsClientUpdateResponse

type DNSForwardingRulesetsClientUpdateResponse struct {
	DNSForwardingRulesetsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSForwardingRulesetsClientUpdateResponse contains the response from method DNSForwardingRulesetsClient.Update.

type DNSForwardingRulesetsClientUpdateResult

type DNSForwardingRulesetsClientUpdateResult struct {
	DNSForwardingRuleset
}

DNSForwardingRulesetsClientUpdateResult contains the result from method DNSForwardingRulesetsClient.Update.

type DNSResolver

type DNSResolver struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Properties of the DNS resolver.
	Properties *Properties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; ETag of the DNS resolver.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DNSResolver - Describes a DNS resolver.

func (DNSResolver) MarshalJSON

func (d DNSResolver) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSResolver.

type DNSResolverState

type DNSResolverState string

DNSResolverState - The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.

const (
	DNSResolverStateConnected    DNSResolverState = "Connected"
	DNSResolverStateDisconnected DNSResolverState = "Disconnected"
)

func PossibleDNSResolverStateValues

func PossibleDNSResolverStateValues() []DNSResolverState

PossibleDNSResolverStateValues returns the possible values for the DNSResolverState const type.

func (DNSResolverState) ToPtr

ToPtr returns a *DNSResolverState pointing to the current value.

type DNSResolversClient

type DNSResolversClient struct {
	// contains filtered or unexported fields
}

DNSResolversClient contains the methods for the DNSResolvers group. Don't use this type directly, use NewDNSResolversClient() instead.

func NewDNSResolversClient

func NewDNSResolversClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DNSResolversClient

NewDNSResolversClient creates a new instance of DNSResolversClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DNSResolversClient) BeginCreateOrUpdate

func (client *DNSResolversClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, dnsResolverName string, parameters DNSResolver, options *DNSResolversClientBeginCreateOrUpdateOptions) (DNSResolversClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. parameters - Parameters supplied to the CreateOrUpdate operation. options - DNSResolversClientBeginCreateOrUpdateOptions contains the optional parameters for the DNSResolversClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_Put.json

Output:

func (*DNSResolversClient) BeginDelete

func (client *DNSResolversClient) BeginDelete(ctx context.Context, resourceGroupName string, dnsResolverName string, options *DNSResolversClientBeginDeleteOptions) (DNSResolversClientDeletePollerResponse, error)

BeginDelete - Deletes a DNS resolver. WARNING: This operation cannot be undone. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. options - DNSResolversClientBeginDeleteOptions contains the optional parameters for the DNSResolversClient.BeginDelete method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_Delete.json

Output:

func (*DNSResolversClient) BeginUpdate

func (client *DNSResolversClient) BeginUpdate(ctx context.Context, resourceGroupName string, dnsResolverName string, parameters Patch, options *DNSResolversClientBeginUpdateOptions) (DNSResolversClientUpdatePollerResponse, error)

BeginUpdate - Updates a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. parameters - Parameters supplied to the Update operation. options - DNSResolversClientBeginUpdateOptions contains the optional parameters for the DNSResolversClient.BeginUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_Patch.json

Output:

func (*DNSResolversClient) Get

func (client *DNSResolversClient) Get(ctx context.Context, resourceGroupName string, dnsResolverName string, options *DNSResolversClientGetOptions) (DNSResolversClientGetResponse, error)

Get - Gets properties of a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. options - DNSResolversClientGetOptions contains the optional parameters for the DNSResolversClient.Get method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_Get.json

Output:

func (*DNSResolversClient) List

List - Lists DNS resolvers in all resource groups of a subscription. If the operation fails it returns an *azcore.ResponseError type. options - DNSResolversClientListOptions contains the optional parameters for the DNSResolversClient.List method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_ListBySubscription.json

Output:

func (*DNSResolversClient) ListByResourceGroup

ListByResourceGroup - Lists DNS resolvers within a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - DNSResolversClientListByResourceGroupOptions contains the optional parameters for the DNSResolversClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_ListByResourceGroup.json

Output:

func (*DNSResolversClient) ListByVirtualNetwork

func (client *DNSResolversClient) ListByVirtualNetwork(resourceGroupName string, virtualNetworkName string, options *DNSResolversClientListByVirtualNetworkOptions) *DNSResolversClientListByVirtualNetworkPager

ListByVirtualNetwork - Lists DNS resolver resource IDs linked to a virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. virtualNetworkName - The name of the virtual network. options - DNSResolversClientListByVirtualNetworkOptions contains the optional parameters for the DNSResolversClient.ListByVirtualNetwork method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsResolver_ListByVirtualNetwork.json

Output:

type DNSResolversClientBeginCreateOrUpdateOptions

type DNSResolversClientBeginCreateOrUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
	// Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
	IfNoneMatch *string
}

DNSResolversClientBeginCreateOrUpdateOptions contains the optional parameters for the DNSResolversClient.BeginCreateOrUpdate method.

type DNSResolversClientBeginDeleteOptions

type DNSResolversClientBeginDeleteOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

DNSResolversClientBeginDeleteOptions contains the optional parameters for the DNSResolversClient.BeginDelete method.

type DNSResolversClientBeginUpdateOptions

type DNSResolversClientBeginUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

DNSResolversClientBeginUpdateOptions contains the optional parameters for the DNSResolversClient.BeginUpdate method.

type DNSResolversClientCreateOrUpdatePoller

type DNSResolversClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

DNSResolversClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DNSResolversClientCreateOrUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*DNSResolversClientCreateOrUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DNSResolversClientCreateOrUpdateResponse will be returned.

func (*DNSResolversClientCreateOrUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DNSResolversClientCreateOrUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DNSResolversClientCreateOrUpdatePollerResponse

type DNSResolversClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DNSResolversClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientCreateOrUpdatePollerResponse contains the response from method DNSResolversClient.CreateOrUpdate.

func (DNSResolversClientCreateOrUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DNSResolversClientCreateOrUpdatePollerResponse) Resume

Resume rehydrates a DNSResolversClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DNSResolversClientCreateOrUpdateResponse

type DNSResolversClientCreateOrUpdateResponse struct {
	DNSResolversClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientCreateOrUpdateResponse contains the response from method DNSResolversClient.CreateOrUpdate.

type DNSResolversClientCreateOrUpdateResult

type DNSResolversClientCreateOrUpdateResult struct {
	DNSResolver
}

DNSResolversClientCreateOrUpdateResult contains the result from method DNSResolversClient.CreateOrUpdate.

type DNSResolversClientDeletePoller

type DNSResolversClientDeletePoller struct {
	// contains filtered or unexported fields
}

DNSResolversClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DNSResolversClientDeletePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*DNSResolversClientDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DNSResolversClientDeleteResponse will be returned.

func (*DNSResolversClientDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DNSResolversClientDeletePoller) ResumeToken

func (p *DNSResolversClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DNSResolversClientDeletePollerResponse

type DNSResolversClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DNSResolversClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientDeletePollerResponse contains the response from method DNSResolversClient.Delete.

func (DNSResolversClientDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DNSResolversClientDeletePollerResponse) Resume

Resume rehydrates a DNSResolversClientDeletePollerResponse from the provided client and resume token.

type DNSResolversClientDeleteResponse

type DNSResolversClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientDeleteResponse contains the response from method DNSResolversClient.Delete.

type DNSResolversClientGetOptions

type DNSResolversClientGetOptions struct {
}

DNSResolversClientGetOptions contains the optional parameters for the DNSResolversClient.Get method.

type DNSResolversClientGetResponse

type DNSResolversClientGetResponse struct {
	DNSResolversClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientGetResponse contains the response from method DNSResolversClient.Get.

type DNSResolversClientGetResult

type DNSResolversClientGetResult struct {
	DNSResolver
}

DNSResolversClientGetResult contains the result from method DNSResolversClient.Get.

type DNSResolversClientListByResourceGroupOptions

type DNSResolversClientListByResourceGroupOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

DNSResolversClientListByResourceGroupOptions contains the optional parameters for the DNSResolversClient.ListByResourceGroup method.

type DNSResolversClientListByResourceGroupPager

type DNSResolversClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

DNSResolversClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*DNSResolversClientListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*DNSResolversClientListByResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DNSResolversClientListByResourceGroupPager) PageResponse

PageResponse returns the current DNSResolversClientListByResourceGroupResponse page.

type DNSResolversClientListByResourceGroupResponse

type DNSResolversClientListByResourceGroupResponse struct {
	DNSResolversClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientListByResourceGroupResponse contains the response from method DNSResolversClient.ListByResourceGroup.

type DNSResolversClientListByResourceGroupResult

type DNSResolversClientListByResourceGroupResult struct {
	ListResult
}

DNSResolversClientListByResourceGroupResult contains the result from method DNSResolversClient.ListByResourceGroup.

type DNSResolversClientListByVirtualNetworkOptions

type DNSResolversClientListByVirtualNetworkOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

DNSResolversClientListByVirtualNetworkOptions contains the optional parameters for the DNSResolversClient.ListByVirtualNetwork method.

type DNSResolversClientListByVirtualNetworkPager

type DNSResolversClientListByVirtualNetworkPager struct {
	// contains filtered or unexported fields
}

DNSResolversClientListByVirtualNetworkPager provides operations for iterating over paged responses.

func (*DNSResolversClientListByVirtualNetworkPager) Err

Err returns the last error encountered while paging.

func (*DNSResolversClientListByVirtualNetworkPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DNSResolversClientListByVirtualNetworkPager) PageResponse

PageResponse returns the current DNSResolversClientListByVirtualNetworkResponse page.

type DNSResolversClientListByVirtualNetworkResponse

type DNSResolversClientListByVirtualNetworkResponse struct {
	DNSResolversClientListByVirtualNetworkResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientListByVirtualNetworkResponse contains the response from method DNSResolversClient.ListByVirtualNetwork.

type DNSResolversClientListByVirtualNetworkResult

type DNSResolversClientListByVirtualNetworkResult struct {
	SubResourceListResult
}

DNSResolversClientListByVirtualNetworkResult contains the result from method DNSResolversClient.ListByVirtualNetwork.

type DNSResolversClientListOptions

type DNSResolversClientListOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

DNSResolversClientListOptions contains the optional parameters for the DNSResolversClient.List method.

type DNSResolversClientListPager

type DNSResolversClientListPager struct {
	// contains filtered or unexported fields
}

DNSResolversClientListPager provides operations for iterating over paged responses.

func (*DNSResolversClientListPager) Err

Err returns the last error encountered while paging.

func (*DNSResolversClientListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DNSResolversClientListPager) PageResponse

PageResponse returns the current DNSResolversClientListResponse page.

type DNSResolversClientListResponse

type DNSResolversClientListResponse struct {
	DNSResolversClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientListResponse contains the response from method DNSResolversClient.List.

type DNSResolversClientListResult

type DNSResolversClientListResult struct {
	ListResult
}

DNSResolversClientListResult contains the result from method DNSResolversClient.List.

type DNSResolversClientUpdatePoller

type DNSResolversClientUpdatePoller struct {
	// contains filtered or unexported fields
}

DNSResolversClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DNSResolversClientUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*DNSResolversClientUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DNSResolversClientUpdateResponse will be returned.

func (*DNSResolversClientUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DNSResolversClientUpdatePoller) ResumeToken

func (p *DNSResolversClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DNSResolversClientUpdatePollerResponse

type DNSResolversClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DNSResolversClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientUpdatePollerResponse contains the response from method DNSResolversClient.Update.

func (DNSResolversClientUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DNSResolversClientUpdatePollerResponse) Resume

Resume rehydrates a DNSResolversClientUpdatePollerResponse from the provided client and resume token.

type DNSResolversClientUpdateResponse

type DNSResolversClientUpdateResponse struct {
	DNSResolversClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DNSResolversClientUpdateResponse contains the response from method DNSResolversClient.Update.

type DNSResolversClientUpdateResult

type DNSResolversClientUpdateResult struct {
	DNSResolver
}

DNSResolversClientUpdateResult contains the result from method DNSResolversClient.Update.

type ForwardingRule

type ForwardingRule struct {
	// Properties of the forwarding rule.
	Properties *ForwardingRuleProperties `json:"properties,omitempty"`

	// READ-ONLY; ETag of the forwarding rule.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ForwardingRule - Describes a forwarding rule within a DNS forwarding ruleset.

type ForwardingRuleListResult

type ForwardingRuleListResult struct {
	// Enumeration of the forwarding rules.
	Value []*ForwardingRule `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ForwardingRuleListResult - The response to an enumeration operation on forwarding rules within a DNS forwarding ruleset.

func (ForwardingRuleListResult) MarshalJSON

func (f ForwardingRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForwardingRuleListResult.

type ForwardingRulePatch

type ForwardingRulePatch struct {
	// Updatable properties of the forwarding rule.
	Properties *ForwardingRulePatchProperties `json:"properties,omitempty"`
}

ForwardingRulePatch - Describes a forwarding rule for PATCH operation.

func (ForwardingRulePatch) MarshalJSON

func (f ForwardingRulePatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForwardingRulePatch.

type ForwardingRulePatchProperties

type ForwardingRulePatchProperties struct {
	// The state of forwarding rule.
	ForwardingRuleState *ForwardingRuleState `json:"forwardingRuleState,omitempty"`

	// Metadata attached to the forwarding rule.
	Metadata map[string]*string `json:"metadata,omitempty"`

	// DNS servers to forward the DNS query to.
	TargetDNSServers []*TargetDNSServer `json:"targetDnsServers,omitempty"`
}

ForwardingRulePatchProperties - Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset.

func (ForwardingRulePatchProperties) MarshalJSON

func (f ForwardingRulePatchProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForwardingRulePatchProperties.

type ForwardingRuleProperties

type ForwardingRuleProperties struct {
	// REQUIRED; The domain name for the forwarding rule.
	DomainName *string `json:"domainName,omitempty"`

	// REQUIRED; DNS servers to forward the DNS query to.
	TargetDNSServers []*TargetDNSServer `json:"targetDnsServers,omitempty"`

	// The state of forwarding rule.
	ForwardingRuleState *ForwardingRuleState `json:"forwardingRuleState,omitempty"`

	// Metadata attached to the forwarding rule.
	Metadata map[string]*string `json:"metadata,omitempty"`

	// READ-ONLY; The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this
	// value will be ignored.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ForwardingRuleProperties - Represents the properties of a forwarding rule within a DNS forwarding ruleset.

func (ForwardingRuleProperties) MarshalJSON

func (f ForwardingRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForwardingRuleProperties.

type ForwardingRuleState

type ForwardingRuleState string

ForwardingRuleState - The state of forwarding rule.

const (
	ForwardingRuleStateDisabled ForwardingRuleState = "Disabled"
	ForwardingRuleStateEnabled  ForwardingRuleState = "Enabled"
)

func PossibleForwardingRuleStateValues

func PossibleForwardingRuleStateValues() []ForwardingRuleState

PossibleForwardingRuleStateValues returns the possible values for the ForwardingRuleState const type.

func (ForwardingRuleState) ToPtr

ToPtr returns a *ForwardingRuleState pointing to the current value.

type ForwardingRulesClient

type ForwardingRulesClient struct {
	// contains filtered or unexported fields
}

ForwardingRulesClient contains the methods for the ForwardingRules group. Don't use this type directly, use NewForwardingRulesClient() instead.

func NewForwardingRulesClient

func NewForwardingRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ForwardingRulesClient

NewForwardingRulesClient creates a new instance of ForwardingRulesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ForwardingRulesClient) CreateOrUpdate

func (client *ForwardingRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, forwardingRuleName string, parameters ForwardingRule, options *ForwardingRulesClientCreateOrUpdateOptions) (ForwardingRulesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a forwarding rule in a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. forwardingRuleName - The name of the forwarding rule. parameters - Parameters supplied to the CreateOrUpdate operation. options - ForwardingRulesClientCreateOrUpdateOptions contains the optional parameters for the ForwardingRulesClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/ForwardingRule_Put.json

Output:

func (*ForwardingRulesClient) Delete

func (client *ForwardingRulesClient) Delete(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, forwardingRuleName string, options *ForwardingRulesClientDeleteOptions) (ForwardingRulesClientDeleteResponse, error)

Delete - Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. forwardingRuleName - The name of the forwarding rule. options - ForwardingRulesClientDeleteOptions contains the optional parameters for the ForwardingRulesClient.Delete method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/ForwardingRule_Delete.json

Output:

func (*ForwardingRulesClient) Get

func (client *ForwardingRulesClient) Get(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, forwardingRuleName string, options *ForwardingRulesClientGetOptions) (ForwardingRulesClientGetResponse, error)

Get - Gets properties of a forwarding rule in a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. forwardingRuleName - The name of the forwarding rule. options - ForwardingRulesClientGetOptions contains the optional parameters for the ForwardingRulesClient.Get method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/ForwardingRule_Get.json

Output:

func (*ForwardingRulesClient) List

func (client *ForwardingRulesClient) List(resourceGroupName string, dnsForwardingRulesetName string, options *ForwardingRulesClientListOptions) *ForwardingRulesClientListPager

List - Lists forwarding rules in a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. options - ForwardingRulesClientListOptions contains the optional parameters for the ForwardingRulesClient.List method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/ForwardingRule_List.json

Output:

func (*ForwardingRulesClient) Update

func (client *ForwardingRulesClient) Update(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, forwardingRuleName string, parameters ForwardingRulePatch, options *ForwardingRulesClientUpdateOptions) (ForwardingRulesClientUpdateResponse, error)

Update - Updates a forwarding rule in a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. forwardingRuleName - The name of the forwarding rule. parameters - Parameters supplied to the Update operation. options - ForwardingRulesClientUpdateOptions contains the optional parameters for the ForwardingRulesClient.Update method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/ForwardingRule_Patch.json

Output:

type ForwardingRulesClientCreateOrUpdateOptions

type ForwardingRulesClientCreateOrUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
	// Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
	IfNoneMatch *string
}

ForwardingRulesClientCreateOrUpdateOptions contains the optional parameters for the ForwardingRulesClient.CreateOrUpdate method.

type ForwardingRulesClientCreateOrUpdateResponse

type ForwardingRulesClientCreateOrUpdateResponse struct {
	ForwardingRulesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ForwardingRulesClientCreateOrUpdateResponse contains the response from method ForwardingRulesClient.CreateOrUpdate.

type ForwardingRulesClientCreateOrUpdateResult

type ForwardingRulesClientCreateOrUpdateResult struct {
	ForwardingRule
}

ForwardingRulesClientCreateOrUpdateResult contains the result from method ForwardingRulesClient.CreateOrUpdate.

type ForwardingRulesClientDeleteOptions

type ForwardingRulesClientDeleteOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

ForwardingRulesClientDeleteOptions contains the optional parameters for the ForwardingRulesClient.Delete method.

type ForwardingRulesClientDeleteResponse

type ForwardingRulesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ForwardingRulesClientDeleteResponse contains the response from method ForwardingRulesClient.Delete.

type ForwardingRulesClientGetOptions

type ForwardingRulesClientGetOptions struct {
}

ForwardingRulesClientGetOptions contains the optional parameters for the ForwardingRulesClient.Get method.

type ForwardingRulesClientGetResponse

type ForwardingRulesClientGetResponse struct {
	ForwardingRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ForwardingRulesClientGetResponse contains the response from method ForwardingRulesClient.Get.

type ForwardingRulesClientGetResult

type ForwardingRulesClientGetResult struct {
	ForwardingRule
}

ForwardingRulesClientGetResult contains the result from method ForwardingRulesClient.Get.

type ForwardingRulesClientListOptions

type ForwardingRulesClientListOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

ForwardingRulesClientListOptions contains the optional parameters for the ForwardingRulesClient.List method.

type ForwardingRulesClientListPager

type ForwardingRulesClientListPager struct {
	// contains filtered or unexported fields
}

ForwardingRulesClientListPager provides operations for iterating over paged responses.

func (*ForwardingRulesClientListPager) Err

Err returns the last error encountered while paging.

func (*ForwardingRulesClientListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ForwardingRulesClientListPager) PageResponse

PageResponse returns the current ForwardingRulesClientListResponse page.

type ForwardingRulesClientListResponse

type ForwardingRulesClientListResponse struct {
	ForwardingRulesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ForwardingRulesClientListResponse contains the response from method ForwardingRulesClient.List.

type ForwardingRulesClientListResult

type ForwardingRulesClientListResult struct {
	ForwardingRuleListResult
}

ForwardingRulesClientListResult contains the result from method ForwardingRulesClient.List.

type ForwardingRulesClientUpdateOptions

type ForwardingRulesClientUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

ForwardingRulesClientUpdateOptions contains the optional parameters for the ForwardingRulesClient.Update method.

type ForwardingRulesClientUpdateResponse

type ForwardingRulesClientUpdateResponse struct {
	ForwardingRulesClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ForwardingRulesClientUpdateResponse contains the response from method ForwardingRulesClient.Update.

type ForwardingRulesClientUpdateResult

type ForwardingRulesClientUpdateResult struct {
	ForwardingRule
}

ForwardingRulesClientUpdateResult contains the result from method ForwardingRulesClient.Update.

type IPAllocationMethod

type IPAllocationMethod string

IPAllocationMethod - Private IP address allocation method.

const (
	IPAllocationMethodDynamic IPAllocationMethod = "Dynamic"
	IPAllocationMethodStatic  IPAllocationMethod = "Static"
)

func PossibleIPAllocationMethodValues

func PossibleIPAllocationMethodValues() []IPAllocationMethod

PossibleIPAllocationMethodValues returns the possible values for the IPAllocationMethod const type.

func (IPAllocationMethod) ToPtr

ToPtr returns a *IPAllocationMethod pointing to the current value.

type IPConfiguration

type IPConfiguration struct {
	// Private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIpAddress,omitempty"`

	// Private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIpAllocationMethod,omitempty"`

	// The reference to the subnet bound to the IP configuration.
	Subnet *SubResource `json:"subnet,omitempty"`
}

IPConfiguration - IP configuration.

type InboundEndpoint

type InboundEndpoint struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Properties of the inbound endpoint.
	Properties *InboundEndpointProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; ETag of the inbound endpoint.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

InboundEndpoint - Describes an inbound endpoint for a DNS resolver.

func (InboundEndpoint) MarshalJSON

func (i InboundEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundEndpoint.

type InboundEndpointListResult

type InboundEndpointListResult struct {
	// Enumeration of the inbound endpoints for a DNS resolver.
	Value []*InboundEndpoint `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

InboundEndpointListResult - The response to an enumeration operation on inbound endpoints for a DNS resolver.

func (InboundEndpointListResult) MarshalJSON

func (i InboundEndpointListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundEndpointListResult.

type InboundEndpointPatch

type InboundEndpointPatch struct {
	// Tags for inbound endpoint.
	Tags map[string]*string `json:"tags,omitempty"`
}

InboundEndpointPatch - Describes an inbound endpoint for a DNS resolver for PATCH operation.

func (InboundEndpointPatch) MarshalJSON

func (i InboundEndpointPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundEndpointPatch.

type InboundEndpointProperties

type InboundEndpointProperties struct {
	// IP configurations for the inbound endpoint.
	IPConfigurations []*IPConfiguration `json:"ipConfigurations,omitempty"`

	// READ-ONLY; The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set
	// this value will be ignored.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid property of the inbound endpoint resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

InboundEndpointProperties - Represents the properties of an inbound endpoint for a DNS resolver.

func (InboundEndpointProperties) MarshalJSON

func (i InboundEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundEndpointProperties.

type InboundEndpointsClient

type InboundEndpointsClient struct {
	// contains filtered or unexported fields
}

InboundEndpointsClient contains the methods for the InboundEndpoints group. Don't use this type directly, use NewInboundEndpointsClient() instead.

func NewInboundEndpointsClient

func NewInboundEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InboundEndpointsClient

NewInboundEndpointsClient creates a new instance of InboundEndpointsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InboundEndpointsClient) BeginCreateOrUpdate

func (client *InboundEndpointsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, dnsResolverName string, inboundEndpointName string, parameters InboundEndpoint, options *InboundEndpointsClientBeginCreateOrUpdateOptions) (InboundEndpointsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an inbound endpoint for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. inboundEndpointName - The name of the inbound endpoint for the DNS resolver. parameters - Parameters supplied to the CreateOrUpdate operation. options - InboundEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundEndpointsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/InboundEndpoint_Put.json

Output:

func (*InboundEndpointsClient) BeginDelete

func (client *InboundEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, dnsResolverName string, inboundEndpointName string, options *InboundEndpointsClientBeginDeleteOptions) (InboundEndpointsClientDeletePollerResponse, error)

BeginDelete - Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. inboundEndpointName - The name of the inbound endpoint for the DNS resolver. options - InboundEndpointsClientBeginDeleteOptions contains the optional parameters for the InboundEndpointsClient.BeginDelete method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/InboundEndpoint_Delete.json

Output:

func (*InboundEndpointsClient) BeginUpdate

func (client *InboundEndpointsClient) BeginUpdate(ctx context.Context, resourceGroupName string, dnsResolverName string, inboundEndpointName string, parameters InboundEndpointPatch, options *InboundEndpointsClientBeginUpdateOptions) (InboundEndpointsClientUpdatePollerResponse, error)

BeginUpdate - Updates an inbound endpoint for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. inboundEndpointName - The name of the inbound endpoint for the DNS resolver. parameters - Parameters supplied to the Update operation. options - InboundEndpointsClientBeginUpdateOptions contains the optional parameters for the InboundEndpointsClient.BeginUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/InboundEndpoint_Patch.json

Output:

func (*InboundEndpointsClient) Get

func (client *InboundEndpointsClient) Get(ctx context.Context, resourceGroupName string, dnsResolverName string, inboundEndpointName string, options *InboundEndpointsClientGetOptions) (InboundEndpointsClientGetResponse, error)

Get - Gets properties of an inbound endpoint for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. inboundEndpointName - The name of the inbound endpoint for the DNS resolver. options - InboundEndpointsClientGetOptions contains the optional parameters for the InboundEndpointsClient.Get method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/InboundEndpoint_Get.json

Output:

func (*InboundEndpointsClient) List

func (client *InboundEndpointsClient) List(resourceGroupName string, dnsResolverName string, options *InboundEndpointsClientListOptions) *InboundEndpointsClientListPager

List - Lists inbound endpoints for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. options - InboundEndpointsClientListOptions contains the optional parameters for the InboundEndpointsClient.List method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/InboundEndpoint_List.json

Output:

type InboundEndpointsClientBeginCreateOrUpdateOptions

type InboundEndpointsClientBeginCreateOrUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
	// Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
	IfNoneMatch *string
}

InboundEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundEndpointsClient.BeginCreateOrUpdate method.

type InboundEndpointsClientBeginDeleteOptions

type InboundEndpointsClientBeginDeleteOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

InboundEndpointsClientBeginDeleteOptions contains the optional parameters for the InboundEndpointsClient.BeginDelete method.

type InboundEndpointsClientBeginUpdateOptions

type InboundEndpointsClientBeginUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

InboundEndpointsClientBeginUpdateOptions contains the optional parameters for the InboundEndpointsClient.BeginUpdate method.

type InboundEndpointsClientCreateOrUpdatePoller

type InboundEndpointsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

InboundEndpointsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*InboundEndpointsClientCreateOrUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*InboundEndpointsClientCreateOrUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InboundEndpointsClientCreateOrUpdateResponse will be returned.

func (*InboundEndpointsClientCreateOrUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InboundEndpointsClientCreateOrUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InboundEndpointsClientCreateOrUpdatePollerResponse

type InboundEndpointsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InboundEndpointsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientCreateOrUpdatePollerResponse contains the response from method InboundEndpointsClient.CreateOrUpdate.

func (InboundEndpointsClientCreateOrUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InboundEndpointsClientCreateOrUpdatePollerResponse) Resume

Resume rehydrates a InboundEndpointsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type InboundEndpointsClientCreateOrUpdateResponse

type InboundEndpointsClientCreateOrUpdateResponse struct {
	InboundEndpointsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientCreateOrUpdateResponse contains the response from method InboundEndpointsClient.CreateOrUpdate.

type InboundEndpointsClientCreateOrUpdateResult

type InboundEndpointsClientCreateOrUpdateResult struct {
	InboundEndpoint
}

InboundEndpointsClientCreateOrUpdateResult contains the result from method InboundEndpointsClient.CreateOrUpdate.

type InboundEndpointsClientDeletePoller

type InboundEndpointsClientDeletePoller struct {
	// contains filtered or unexported fields
}

InboundEndpointsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*InboundEndpointsClientDeletePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*InboundEndpointsClientDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InboundEndpointsClientDeleteResponse will be returned.

func (*InboundEndpointsClientDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InboundEndpointsClientDeletePoller) ResumeToken

func (p *InboundEndpointsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InboundEndpointsClientDeletePollerResponse

type InboundEndpointsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InboundEndpointsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientDeletePollerResponse contains the response from method InboundEndpointsClient.Delete.

func (InboundEndpointsClientDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InboundEndpointsClientDeletePollerResponse) Resume

Resume rehydrates a InboundEndpointsClientDeletePollerResponse from the provided client and resume token.

type InboundEndpointsClientDeleteResponse

type InboundEndpointsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientDeleteResponse contains the response from method InboundEndpointsClient.Delete.

type InboundEndpointsClientGetOptions

type InboundEndpointsClientGetOptions struct {
}

InboundEndpointsClientGetOptions contains the optional parameters for the InboundEndpointsClient.Get method.

type InboundEndpointsClientGetResponse

type InboundEndpointsClientGetResponse struct {
	InboundEndpointsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientGetResponse contains the response from method InboundEndpointsClient.Get.

type InboundEndpointsClientGetResult

type InboundEndpointsClientGetResult struct {
	InboundEndpoint
}

InboundEndpointsClientGetResult contains the result from method InboundEndpointsClient.Get.

type InboundEndpointsClientListOptions

type InboundEndpointsClientListOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

InboundEndpointsClientListOptions contains the optional parameters for the InboundEndpointsClient.List method.

type InboundEndpointsClientListPager

type InboundEndpointsClientListPager struct {
	// contains filtered or unexported fields
}

InboundEndpointsClientListPager provides operations for iterating over paged responses.

func (*InboundEndpointsClientListPager) Err

Err returns the last error encountered while paging.

func (*InboundEndpointsClientListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InboundEndpointsClientListPager) PageResponse

PageResponse returns the current InboundEndpointsClientListResponse page.

type InboundEndpointsClientListResponse

type InboundEndpointsClientListResponse struct {
	InboundEndpointsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientListResponse contains the response from method InboundEndpointsClient.List.

type InboundEndpointsClientListResult

type InboundEndpointsClientListResult struct {
	InboundEndpointListResult
}

InboundEndpointsClientListResult contains the result from method InboundEndpointsClient.List.

type InboundEndpointsClientUpdatePoller

type InboundEndpointsClientUpdatePoller struct {
	// contains filtered or unexported fields
}

InboundEndpointsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*InboundEndpointsClientUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*InboundEndpointsClientUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InboundEndpointsClientUpdateResponse will be returned.

func (*InboundEndpointsClientUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InboundEndpointsClientUpdatePoller) ResumeToken

func (p *InboundEndpointsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InboundEndpointsClientUpdatePollerResponse

type InboundEndpointsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InboundEndpointsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientUpdatePollerResponse contains the response from method InboundEndpointsClient.Update.

func (InboundEndpointsClientUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InboundEndpointsClientUpdatePollerResponse) Resume

Resume rehydrates a InboundEndpointsClientUpdatePollerResponse from the provided client and resume token.

type InboundEndpointsClientUpdateResponse

type InboundEndpointsClientUpdateResponse struct {
	InboundEndpointsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundEndpointsClientUpdateResponse contains the response from method InboundEndpointsClient.Update.

type InboundEndpointsClientUpdateResult

type InboundEndpointsClientUpdateResult struct {
	InboundEndpoint
}

InboundEndpointsClientUpdateResult contains the result from method InboundEndpointsClient.Update.

type ListResult

type ListResult struct {
	// Enumeration of the DNS resolvers.
	Value []*DNSResolver `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ListResult - The response to an enumeration operation on DNS resolvers.

func (ListResult) MarshalJSON

func (l ListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListResult.

type OutboundEndpoint

type OutboundEndpoint struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Properties of the outbound endpoint.
	Properties *OutboundEndpointProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; ETag of the outbound endpoint.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

OutboundEndpoint - Describes an outbound endpoint for a DNS resolver.

func (OutboundEndpoint) MarshalJSON

func (o OutboundEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEndpoint.

type OutboundEndpointListResult

type OutboundEndpointListResult struct {
	// Enumeration of the outbound endpoints for a DNS resolver.
	Value []*OutboundEndpoint `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

OutboundEndpointListResult - The response to an enumeration operation on outbound endpoints for a DNS resolver.

func (OutboundEndpointListResult) MarshalJSON

func (o OutboundEndpointListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEndpointListResult.

type OutboundEndpointPatch

type OutboundEndpointPatch struct {
	// Tags for outbound endpoint.
	Tags map[string]*string `json:"tags,omitempty"`
}

OutboundEndpointPatch - Describes an outbound endpoint for a DNS resolver for PATCH operation.

func (OutboundEndpointPatch) MarshalJSON

func (o OutboundEndpointPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEndpointPatch.

type OutboundEndpointProperties

type OutboundEndpointProperties struct {
	// The reference to the subnet used for the outbound endpoint.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set
	// this value will be ignored.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid property of the outbound endpoint resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

OutboundEndpointProperties - Represents the properties of an outbound endpoint for a DNS resolver.

type OutboundEndpointsClient

type OutboundEndpointsClient struct {
	// contains filtered or unexported fields
}

OutboundEndpointsClient contains the methods for the OutboundEndpoints group. Don't use this type directly, use NewOutboundEndpointsClient() instead.

func NewOutboundEndpointsClient

func NewOutboundEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OutboundEndpointsClient

NewOutboundEndpointsClient creates a new instance of OutboundEndpointsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OutboundEndpointsClient) BeginCreateOrUpdate

func (client *OutboundEndpointsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, dnsResolverName string, outboundEndpointName string, parameters OutboundEndpoint, options *OutboundEndpointsClientBeginCreateOrUpdateOptions) (OutboundEndpointsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an outbound endpoint for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. outboundEndpointName - The name of the outbound endpoint for the DNS resolver. parameters - Parameters supplied to the CreateOrUpdate operation. options - OutboundEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the OutboundEndpointsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/OutboundEndpoint_Put.json

Output:

func (*OutboundEndpointsClient) BeginDelete

func (client *OutboundEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, dnsResolverName string, outboundEndpointName string, options *OutboundEndpointsClientBeginDeleteOptions) (OutboundEndpointsClientDeletePollerResponse, error)

BeginDelete - Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. outboundEndpointName - The name of the outbound endpoint for the DNS resolver. options - OutboundEndpointsClientBeginDeleteOptions contains the optional parameters for the OutboundEndpointsClient.BeginDelete method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/OutboundEndpoint_Delete.json

Output:

func (*OutboundEndpointsClient) BeginUpdate

func (client *OutboundEndpointsClient) BeginUpdate(ctx context.Context, resourceGroupName string, dnsResolverName string, outboundEndpointName string, parameters OutboundEndpointPatch, options *OutboundEndpointsClientBeginUpdateOptions) (OutboundEndpointsClientUpdatePollerResponse, error)

BeginUpdate - Updates an outbound endpoint for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. outboundEndpointName - The name of the outbound endpoint for the DNS resolver. parameters - Parameters supplied to the Update operation. options - OutboundEndpointsClientBeginUpdateOptions contains the optional parameters for the OutboundEndpointsClient.BeginUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/OutboundEndpoint_Patch.json

Output:

func (*OutboundEndpointsClient) Get

func (client *OutboundEndpointsClient) Get(ctx context.Context, resourceGroupName string, dnsResolverName string, outboundEndpointName string, options *OutboundEndpointsClientGetOptions) (OutboundEndpointsClientGetResponse, error)

Get - Gets properties of an outbound endpoint for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. outboundEndpointName - The name of the outbound endpoint for the DNS resolver. options - OutboundEndpointsClientGetOptions contains the optional parameters for the OutboundEndpointsClient.Get method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/OutboundEndpoint_Get.json

Output:

func (*OutboundEndpointsClient) List

func (client *OutboundEndpointsClient) List(resourceGroupName string, dnsResolverName string, options *OutboundEndpointsClientListOptions) *OutboundEndpointsClientListPager

List - Lists outbound endpoints for a DNS resolver. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsResolverName - The name of the DNS resolver. options - OutboundEndpointsClientListOptions contains the optional parameters for the OutboundEndpointsClient.List method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/OutboundEndpoint_List.json

Output:

type OutboundEndpointsClientBeginCreateOrUpdateOptions

type OutboundEndpointsClientBeginCreateOrUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
	// Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
	IfNoneMatch *string
}

OutboundEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the OutboundEndpointsClient.BeginCreateOrUpdate method.

type OutboundEndpointsClientBeginDeleteOptions

type OutboundEndpointsClientBeginDeleteOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

OutboundEndpointsClientBeginDeleteOptions contains the optional parameters for the OutboundEndpointsClient.BeginDelete method.

type OutboundEndpointsClientBeginUpdateOptions

type OutboundEndpointsClientBeginUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

OutboundEndpointsClientBeginUpdateOptions contains the optional parameters for the OutboundEndpointsClient.BeginUpdate method.

type OutboundEndpointsClientCreateOrUpdatePoller

type OutboundEndpointsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

OutboundEndpointsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*OutboundEndpointsClientCreateOrUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*OutboundEndpointsClientCreateOrUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final OutboundEndpointsClientCreateOrUpdateResponse will be returned.

func (*OutboundEndpointsClientCreateOrUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*OutboundEndpointsClientCreateOrUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type OutboundEndpointsClientCreateOrUpdatePollerResponse

type OutboundEndpointsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *OutboundEndpointsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientCreateOrUpdatePollerResponse contains the response from method OutboundEndpointsClient.CreateOrUpdate.

func (OutboundEndpointsClientCreateOrUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*OutboundEndpointsClientCreateOrUpdatePollerResponse) Resume

Resume rehydrates a OutboundEndpointsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type OutboundEndpointsClientCreateOrUpdateResponse

type OutboundEndpointsClientCreateOrUpdateResponse struct {
	OutboundEndpointsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientCreateOrUpdateResponse contains the response from method OutboundEndpointsClient.CreateOrUpdate.

type OutboundEndpointsClientCreateOrUpdateResult

type OutboundEndpointsClientCreateOrUpdateResult struct {
	OutboundEndpoint
}

OutboundEndpointsClientCreateOrUpdateResult contains the result from method OutboundEndpointsClient.CreateOrUpdate.

type OutboundEndpointsClientDeletePoller

type OutboundEndpointsClientDeletePoller struct {
	// contains filtered or unexported fields
}

OutboundEndpointsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*OutboundEndpointsClientDeletePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*OutboundEndpointsClientDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final OutboundEndpointsClientDeleteResponse will be returned.

func (*OutboundEndpointsClientDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*OutboundEndpointsClientDeletePoller) ResumeToken

func (p *OutboundEndpointsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type OutboundEndpointsClientDeletePollerResponse

type OutboundEndpointsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *OutboundEndpointsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientDeletePollerResponse contains the response from method OutboundEndpointsClient.Delete.

func (OutboundEndpointsClientDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*OutboundEndpointsClientDeletePollerResponse) Resume

Resume rehydrates a OutboundEndpointsClientDeletePollerResponse from the provided client and resume token.

type OutboundEndpointsClientDeleteResponse

type OutboundEndpointsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientDeleteResponse contains the response from method OutboundEndpointsClient.Delete.

type OutboundEndpointsClientGetOptions

type OutboundEndpointsClientGetOptions struct {
}

OutboundEndpointsClientGetOptions contains the optional parameters for the OutboundEndpointsClient.Get method.

type OutboundEndpointsClientGetResponse

type OutboundEndpointsClientGetResponse struct {
	OutboundEndpointsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientGetResponse contains the response from method OutboundEndpointsClient.Get.

type OutboundEndpointsClientGetResult

type OutboundEndpointsClientGetResult struct {
	OutboundEndpoint
}

OutboundEndpointsClientGetResult contains the result from method OutboundEndpointsClient.Get.

type OutboundEndpointsClientListOptions

type OutboundEndpointsClientListOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

OutboundEndpointsClientListOptions contains the optional parameters for the OutboundEndpointsClient.List method.

type OutboundEndpointsClientListPager

type OutboundEndpointsClientListPager struct {
	// contains filtered or unexported fields
}

OutboundEndpointsClientListPager provides operations for iterating over paged responses.

func (*OutboundEndpointsClientListPager) Err

Err returns the last error encountered while paging.

func (*OutboundEndpointsClientListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OutboundEndpointsClientListPager) PageResponse

PageResponse returns the current OutboundEndpointsClientListResponse page.

type OutboundEndpointsClientListResponse

type OutboundEndpointsClientListResponse struct {
	OutboundEndpointsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientListResponse contains the response from method OutboundEndpointsClient.List.

type OutboundEndpointsClientListResult

type OutboundEndpointsClientListResult struct {
	OutboundEndpointListResult
}

OutboundEndpointsClientListResult contains the result from method OutboundEndpointsClient.List.

type OutboundEndpointsClientUpdatePoller

type OutboundEndpointsClientUpdatePoller struct {
	// contains filtered or unexported fields
}

OutboundEndpointsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*OutboundEndpointsClientUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*OutboundEndpointsClientUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final OutboundEndpointsClientUpdateResponse will be returned.

func (*OutboundEndpointsClientUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*OutboundEndpointsClientUpdatePoller) ResumeToken

func (p *OutboundEndpointsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type OutboundEndpointsClientUpdatePollerResponse

type OutboundEndpointsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *OutboundEndpointsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientUpdatePollerResponse contains the response from method OutboundEndpointsClient.Update.

func (OutboundEndpointsClientUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*OutboundEndpointsClientUpdatePollerResponse) Resume

Resume rehydrates a OutboundEndpointsClientUpdatePollerResponse from the provided client and resume token.

type OutboundEndpointsClientUpdateResponse

type OutboundEndpointsClientUpdateResponse struct {
	OutboundEndpointsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OutboundEndpointsClientUpdateResponse contains the response from method OutboundEndpointsClient.Update.

type OutboundEndpointsClientUpdateResult

type OutboundEndpointsClientUpdateResult struct {
	OutboundEndpoint
}

OutboundEndpointsClientUpdateResult contains the result from method OutboundEndpointsClient.Update.

type Patch

type Patch struct {
	// Tags for DNS Resolver.
	Tags map[string]*string `json:"tags,omitempty"`
}

Patch - Describes a DNS resolver for PATCH operation.

func (Patch) MarshalJSON

func (p Patch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Patch.

type Properties

type Properties struct {
	// REQUIRED; The reference to the virtual network. This cannot be changed after creation.
	VirtualNetwork *SubResource `json:"virtualNetwork,omitempty"`

	// READ-ONLY; The current status of the DNS resolver. This is a read-only property and any attempt to set this value will
	// be ignored.
	DNSResolverState *DNSResolverState `json:"dnsResolverState,omitempty" azure:"ro"`

	// READ-ONLY; The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this
	// value will be ignored.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid property of the DNS resolver resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

Properties - Represents the properties of a DNS resolver.

type ProvisioningState

type ProvisioningState string

ProvisioningState - The current provisioning state of the resource.

const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr

ToPtr returns a *ProvisioningState pointing to the current value.

type ProxyResource

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type SubResource

type SubResource struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`
}

SubResource - Reference to another ARM resource.

type SubResourceListResult

type SubResourceListResult struct {
	// Enumeration of the sub-resources.
	Value []*SubResource `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SubResourceListResult - The response to an enumeration operation on sub-resources.

func (SubResourceListResult) MarshalJSON

func (s SubResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubResourceListResult.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TargetDNSServer

type TargetDNSServer struct {
	// DNS server IP address.
	IPAddress *string `json:"ipAddress,omitempty"`

	// DNS server port.
	Port *int32 `json:"port,omitempty"`
}

TargetDNSServer - Describes a server to forward the DNS queries to.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type VirtualNetworkDNSForwardingRuleset

type VirtualNetworkDNSForwardingRuleset struct {
	// DNS Forwarding Ruleset Resource ID.
	ID *string `json:"id,omitempty"`

	// Properties of the virtual network link sub-resource reference.
	Properties *VirtualNetworkLinkSubResourceProperties `json:"properties,omitempty"`
}

VirtualNetworkDNSForwardingRuleset - Reference to DNS forwarding ruleset and associated virtual network link.

type VirtualNetworkDNSForwardingRulesetListResult

type VirtualNetworkDNSForwardingRulesetListResult struct {
	// Enumeration of the Virtual Network DNS Forwarding Ruleset.
	Value []*VirtualNetworkDNSForwardingRuleset `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

VirtualNetworkDNSForwardingRulesetListResult - The response to an enumeration operation on Virtual Network DNS Forwarding Ruleset.

func (VirtualNetworkDNSForwardingRulesetListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkDNSForwardingRulesetListResult.

type VirtualNetworkLink struct {
	// Properties of the virtual network link.
	Properties *VirtualNetworkLinkProperties `json:"properties,omitempty"`

	// READ-ONLY; ETag of the virtual network link.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetworkLink - Describes a virtual network link.

type VirtualNetworkLinkListResult

type VirtualNetworkLinkListResult struct {
	// Enumeration of the virtual network links.
	Value []*VirtualNetworkLink `json:"value,omitempty"`

	// READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

VirtualNetworkLinkListResult - The response to an enumeration operation on virtual network links.

func (VirtualNetworkLinkListResult) MarshalJSON

func (v VirtualNetworkLinkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkLinkListResult.

type VirtualNetworkLinkPatch

type VirtualNetworkLinkPatch struct {
	// Updatable properties of the virtual network link.
	Properties *VirtualNetworkLinkPatchProperties `json:"properties,omitempty"`
}

VirtualNetworkLinkPatch - Describes a virtual network link for PATCH operation.

func (VirtualNetworkLinkPatch) MarshalJSON

func (v VirtualNetworkLinkPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkLinkPatch.

type VirtualNetworkLinkPatchProperties

type VirtualNetworkLinkPatchProperties struct {
	// Metadata attached to the virtual network link.
	Metadata map[string]*string `json:"metadata,omitempty"`
}

VirtualNetworkLinkPatchProperties - Represents the updatable properties of the virtual network link.

func (VirtualNetworkLinkPatchProperties) MarshalJSON

func (v VirtualNetworkLinkPatchProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkLinkPatchProperties.

type VirtualNetworkLinkProperties

type VirtualNetworkLinkProperties struct {
	// Metadata attached to the virtual network link.
	Metadata map[string]*string `json:"metadata,omitempty"`

	// The reference to the virtual network. This cannot be changed after creation.
	VirtualNetwork *SubResource `json:"virtualNetwork,omitempty"`

	// READ-ONLY; The current provisioning state of the virtual network link. This is a read-only property and any attempt to
	// set this value will be ignored.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualNetworkLinkProperties - Represents the properties of a virtual network link.

func (VirtualNetworkLinkProperties) MarshalJSON

func (v VirtualNetworkLinkProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkLinkProperties.

type VirtualNetworkLinkSubResourceProperties

type VirtualNetworkLinkSubResourceProperties struct {
	// The reference to the virtual network link.
	VirtualNetworkLink *SubResource `json:"virtualNetworkLink,omitempty"`
}

VirtualNetworkLinkSubResourceProperties - The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network.

type VirtualNetworkLinksClient

type VirtualNetworkLinksClient struct {
	// contains filtered or unexported fields
}

VirtualNetworkLinksClient contains the methods for the VirtualNetworkLinks group. Don't use this type directly, use NewVirtualNetworkLinksClient() instead.

func NewVirtualNetworkLinksClient

func NewVirtualNetworkLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworkLinksClient

NewVirtualNetworkLinksClient creates a new instance of VirtualNetworkLinksClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworkLinksClient) BeginCreateOrUpdate

func (client *VirtualNetworkLinksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, virtualNetworkLinkName string, parameters VirtualNetworkLink, options *VirtualNetworkLinksClientBeginCreateOrUpdateOptions) (VirtualNetworkLinksClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a virtual network link to a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. virtualNetworkLinkName - The name of the virtual network link. parameters - Parameters supplied to the CreateOrUpdate operation. options - VirtualNetworkLinksClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkLinksClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/VirtualNetworkLink_Put.json

Output:

func (*VirtualNetworkLinksClient) BeginDelete

func (client *VirtualNetworkLinksClient) BeginDelete(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, virtualNetworkLinkName string, options *VirtualNetworkLinksClientBeginDeleteOptions) (VirtualNetworkLinksClientDeletePollerResponse, error)

BeginDelete - Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. virtualNetworkLinkName - The name of the virtual network link. options - VirtualNetworkLinksClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkLinksClient.BeginDelete method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/VirtualNetworkLink_Delete.json

Output:

func (*VirtualNetworkLinksClient) BeginUpdate

func (client *VirtualNetworkLinksClient) BeginUpdate(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, virtualNetworkLinkName string, parameters VirtualNetworkLinkPatch, options *VirtualNetworkLinksClientBeginUpdateOptions) (VirtualNetworkLinksClientUpdatePollerResponse, error)

BeginUpdate - Updates a virtual network link to a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. virtualNetworkLinkName - The name of the virtual network link. parameters - Parameters supplied to the Update operation. options - VirtualNetworkLinksClientBeginUpdateOptions contains the optional parameters for the VirtualNetworkLinksClient.BeginUpdate method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/VirtualNetworkLink_Patch.json

Output:

func (*VirtualNetworkLinksClient) Get

func (client *VirtualNetworkLinksClient) Get(ctx context.Context, resourceGroupName string, dnsForwardingRulesetName string, virtualNetworkLinkName string, options *VirtualNetworkLinksClientGetOptions) (VirtualNetworkLinksClientGetResponse, error)

Get - Gets properties of a virtual network link to a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. virtualNetworkLinkName - The name of the virtual network link. options - VirtualNetworkLinksClientGetOptions contains the optional parameters for the VirtualNetworkLinksClient.Get method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/VirtualNetworkLink_Get.json

Output:

func (*VirtualNetworkLinksClient) List

func (client *VirtualNetworkLinksClient) List(resourceGroupName string, dnsForwardingRulesetName string, options *VirtualNetworkLinksClientListOptions) *VirtualNetworkLinksClientListPager

List - Lists virtual network links to a DNS forwarding ruleset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. dnsForwardingRulesetName - The name of the DNS forwarding ruleset. options - VirtualNetworkLinksClientListOptions contains the optional parameters for the VirtualNetworkLinksClient.List method.

Example

x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/VirtualNetworkLink_List.json

Output:

type VirtualNetworkLinksClientBeginCreateOrUpdateOptions

type VirtualNetworkLinksClientBeginCreateOrUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
	// Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.
	IfNoneMatch *string
}

VirtualNetworkLinksClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkLinksClient.BeginCreateOrUpdate method.

type VirtualNetworkLinksClientBeginDeleteOptions

type VirtualNetworkLinksClientBeginDeleteOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

VirtualNetworkLinksClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkLinksClient.BeginDelete method.

type VirtualNetworkLinksClientBeginUpdateOptions

type VirtualNetworkLinksClientBeginUpdateOptions struct {
	// ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent
	// accidentally overwriting any concurrent changes.
	IfMatch *string
}

VirtualNetworkLinksClientBeginUpdateOptions contains the optional parameters for the VirtualNetworkLinksClient.BeginUpdate method.

type VirtualNetworkLinksClientCreateOrUpdatePoller

type VirtualNetworkLinksClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkLinksClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkLinksClientCreateOrUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkLinksClientCreateOrUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkLinksClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworkLinksClientCreateOrUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkLinksClientCreateOrUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkLinksClientCreateOrUpdatePollerResponse

type VirtualNetworkLinksClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkLinksClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworkLinksClient.CreateOrUpdate.

func (VirtualNetworkLinksClientCreateOrUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkLinksClientCreateOrUpdatePollerResponse) Resume

Resume rehydrates a VirtualNetworkLinksClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkLinksClientCreateOrUpdateResponse

type VirtualNetworkLinksClientCreateOrUpdateResponse struct {
	VirtualNetworkLinksClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientCreateOrUpdateResponse contains the response from method VirtualNetworkLinksClient.CreateOrUpdate.

type VirtualNetworkLinksClientCreateOrUpdateResult

type VirtualNetworkLinksClientCreateOrUpdateResult struct {
	VirtualNetworkLink
}

VirtualNetworkLinksClientCreateOrUpdateResult contains the result from method VirtualNetworkLinksClient.CreateOrUpdate.

type VirtualNetworkLinksClientDeletePoller

type VirtualNetworkLinksClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkLinksClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkLinksClientDeletePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkLinksClientDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkLinksClientDeleteResponse will be returned.

func (*VirtualNetworkLinksClientDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkLinksClientDeletePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkLinksClientDeletePollerResponse

type VirtualNetworkLinksClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkLinksClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientDeletePollerResponse contains the response from method VirtualNetworkLinksClient.Delete.

func (VirtualNetworkLinksClientDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkLinksClientDeletePollerResponse) Resume

Resume rehydrates a VirtualNetworkLinksClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworkLinksClientDeleteResponse

type VirtualNetworkLinksClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientDeleteResponse contains the response from method VirtualNetworkLinksClient.Delete.

type VirtualNetworkLinksClientGetOptions

type VirtualNetworkLinksClientGetOptions struct {
}

VirtualNetworkLinksClientGetOptions contains the optional parameters for the VirtualNetworkLinksClient.Get method.

type VirtualNetworkLinksClientGetResponse

type VirtualNetworkLinksClientGetResponse struct {
	VirtualNetworkLinksClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientGetResponse contains the response from method VirtualNetworkLinksClient.Get.

type VirtualNetworkLinksClientGetResult

type VirtualNetworkLinksClientGetResult struct {
	VirtualNetworkLink
}

VirtualNetworkLinksClientGetResult contains the result from method VirtualNetworkLinksClient.Get.

type VirtualNetworkLinksClientListOptions

type VirtualNetworkLinksClientListOptions struct {
	// The maximum number of results to return. If not specified, returns up to 100 results.
	Top *int32
}

VirtualNetworkLinksClientListOptions contains the optional parameters for the VirtualNetworkLinksClient.List method.

type VirtualNetworkLinksClientListPager

type VirtualNetworkLinksClientListPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkLinksClientListPager provides operations for iterating over paged responses.

func (*VirtualNetworkLinksClientListPager) Err

Err returns the last error encountered while paging.

func (*VirtualNetworkLinksClientListPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkLinksClientListPager) PageResponse

PageResponse returns the current VirtualNetworkLinksClientListResponse page.

type VirtualNetworkLinksClientListResponse

type VirtualNetworkLinksClientListResponse struct {
	VirtualNetworkLinksClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientListResponse contains the response from method VirtualNetworkLinksClient.List.

type VirtualNetworkLinksClientListResult

type VirtualNetworkLinksClientListResult struct {
	VirtualNetworkLinkListResult
}

VirtualNetworkLinksClientListResult contains the result from method VirtualNetworkLinksClient.List.

type VirtualNetworkLinksClientUpdatePoller

type VirtualNetworkLinksClientUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkLinksClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkLinksClientUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkLinksClientUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkLinksClientUpdateResponse will be returned.

func (*VirtualNetworkLinksClientUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkLinksClientUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkLinksClientUpdatePollerResponse

type VirtualNetworkLinksClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkLinksClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientUpdatePollerResponse contains the response from method VirtualNetworkLinksClient.Update.

func (VirtualNetworkLinksClientUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkLinksClientUpdatePollerResponse) Resume

Resume rehydrates a VirtualNetworkLinksClientUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkLinksClientUpdateResponse

type VirtualNetworkLinksClientUpdateResponse struct {
	VirtualNetworkLinksClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkLinksClientUpdateResponse contains the response from method VirtualNetworkLinksClient.Update.

type VirtualNetworkLinksClientUpdateResult

type VirtualNetworkLinksClientUpdateResult struct {
	VirtualNetworkLink
}

VirtualNetworkLinksClientUpdateResult contains the result from method VirtualNetworkLinksClient.Update.

Jump to

Keyboard shortcuts

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