dns

package
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package dns implements the Azure ARM Dns service API version 2015-05-04-preview.

Client for managing DNS zones and record.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Dns
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type ARecord 

type ARecord struct {
	// Ipv4Address - Gets or sets the IPv4 address of this A record in string notation.
	Ipv4Address *string `json:"ipv4Address,omitempty"`
}

ARecord an A record.

type AaaaRecord 

type AaaaRecord struct {
	// Ipv6Address - Gets or sets the IPv6 address of this AAAA record in string notation.
	Ipv6Address *string `json:"ipv6Address,omitempty"`
}

AaaaRecord an AAAA record.

type AzureEntityResource 

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON 

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Dns.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CnameRecord 

type CnameRecord struct {
	// Cname - Gets or sets the canonical name for this record without a terminating dot.
	Cname *string `json:"cname,omitempty"`
}

CnameRecord a CNAME record.

type MxRecord 

type MxRecord struct {
	// Preference - Gets or sets the preference metric for this record.
	Preference *int32 `json:"preference,omitempty"`
	// Exchange - Gets or sets the domain name of the mail host, without a terminating dot.
	Exchange *string `json:"exchange,omitempty"`
}

MxRecord an MX record.

type NsRecord 

type NsRecord struct {
	// Nsdname - Gets or sets the name server name for this record, without a terminating dot.
	Nsdname *string `json:"nsdname,omitempty"`
}

NsRecord an NS record.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type PtrRecord 

type PtrRecord struct {
	// Ptrdname - Gets or sets the PTR target domain name for this record without a terminating dot.
	Ptrdname *string `json:"ptrdname,omitempty"`
}

PtrRecord a PTR record.

type RecordSet 

type RecordSet struct {
	autorest.Response `json:"-"`
	// Etag - Gets or sets the ETag of the RecordSet.
	Etag *string `json:"etag,omitempty"`
	// Properties - Gets or sets the properties of the RecordSet.
	Properties *RecordSetProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

RecordSet describes a DNS RecordSet (a set of DNS records with the same name and type).

func (RecordSet) MarshalJSON 

func (rs RecordSet) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RecordSet.

type RecordSetListResult 

type RecordSetListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets or sets information about the RecordSets in the response.
	Value *[]RecordSet `json:"value,omitempty"`
	// NextLink - Gets or sets the continuation token for the next page.
	NextLink *string `json:"nextLink,omitempty"`
}

RecordSetListResult the response to a RecordSet List operation.

func (RecordSetListResult) IsEmpty 

func (rslr RecordSetListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RecordSetListResultIterator 

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

RecordSetListResultIterator provides access to a complete listing of RecordSet values.

func NewRecordSetListResultIterator 

func NewRecordSetListResultIterator(page RecordSetListResultPage) RecordSetListResultIterator

Creates a new instance of the RecordSetListResultIterator type.

func (*RecordSetListResultIterator) Next 

func (iter *RecordSetListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RecordSetListResultIterator) NextWithContext 

func (iter *RecordSetListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (RecordSetListResultIterator) NotDone 

func (iter RecordSetListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (RecordSetListResultIterator) Response 

func (iter RecordSetListResultIterator) Response() RecordSetListResult

Response returns the raw server response from the last page request.

func (RecordSetListResultIterator) Value 

func (iter RecordSetListResultIterator) Value() RecordSet

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type RecordSetListResultPage 

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

RecordSetListResultPage contains a page of RecordSet values.

func NewRecordSetListResultPage 

func NewRecordSetListResultPage(cur RecordSetListResult, getNextPage func(context.Context, RecordSetListResult) (RecordSetListResult, error)) RecordSetListResultPage

Creates a new instance of the RecordSetListResultPage type.

func (*RecordSetListResultPage) Next 

func (page *RecordSetListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RecordSetListResultPage) NextWithContext 

func (page *RecordSetListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (RecordSetListResultPage) NotDone 

func (page RecordSetListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (RecordSetListResultPage) Response 

func (page RecordSetListResultPage) Response() RecordSetListResult

Response returns the raw server response from the last page request.

func (RecordSetListResultPage) Values 

func (page RecordSetListResultPage) Values() []RecordSet

Values returns the slice of values for the current page or nil if there are no values.

type RecordSetProperties 

type RecordSetProperties struct {
	// TTL - Gets or sets the TTL of the records in the RecordSet.
	TTL *int64 `json:"TTL,omitempty"`
	// ARecords - Gets or sets the list of A records in the RecordSet.
	ARecords *[]ARecord `json:"ARecords,omitempty"`
	// AAAARecords - Gets or sets the list of AAAA records in the RecordSet.
	AAAARecords *[]AaaaRecord `json:"AAAARecords,omitempty"`
	// MXRecords - Gets or sets the list of MX records in the RecordSet.
	MXRecords *[]MxRecord `json:"MXRecords,omitempty"`
	// NSRecords - Gets or sets the list of NS records in the RecordSet.
	NSRecords *[]NsRecord `json:"NSRecords,omitempty"`
	// PTRRecords - Gets or sets the list of PTR records in the RecordSet.
	PTRRecords *[]PtrRecord `json:"PTRRecords,omitempty"`
	// SRVRecords - Gets or sets the list of SRV records in the RecordSet.
	SRVRecords *[]SrvRecord `json:"SRVRecords,omitempty"`
	// TXTRecords - Gets or sets the list of TXT records in the RecordSet.
	TXTRecords *[]TxtRecord `json:"TXTRecords,omitempty"`
	// CNAMERecord - Gets or sets the CNAME record in the RecordSet.
	CNAMERecord *CnameRecord `json:"CNAMERecord,omitempty"`
	// SOARecord - Gets or sets the SOA record in the RecordSet.
	SOARecord *SoaRecord `json:"SOARecord,omitempty"`
}

RecordSetProperties represents the properties of the records in the RecordSet.

type RecordSetsClient 

type RecordSetsClient struct {
	BaseClient
}

RecordSetsClient is the client for managing DNS zones and record.

func NewRecordSetsClient 

func NewRecordSetsClient(subscriptionID string) RecordSetsClient

NewRecordSetsClient creates an instance of the RecordSetsClient client.

func NewRecordSetsClientWithBaseURI 

func NewRecordSetsClientWithBaseURI(baseURI string, subscriptionID string) RecordSetsClient

NewRecordSetsClientWithBaseURI creates an instance of the RecordSetsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (RecordSetsClient) CreateOrUpdate 

func (client RecordSetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, relativeRecordSetName string, parameters RecordSet, ifMatch string, ifNoneMatch string) (result RecordSet, err error)

CreateOrUpdate creates a RecordSet within a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone without a terminating dot. recordType - the type of DNS record. relativeRecordSetName - the name of the RecordSet, relative to the name of the zone. parameters - parameters supplied to the CreateOrUpdate operation. ifMatch - the etag of RecordSet. ifNoneMatch - defines the If-None-Match condition. Set to '*' to force Create-If-Not-Exist. Other values will be ignored.

func (RecordSetsClient) CreateOrUpdatePreparer 

func (client RecordSetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, relativeRecordSetName string, parameters RecordSet, ifMatch string, ifNoneMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RecordSetsClient) CreateOrUpdateResponder 

func (client RecordSetsClient) CreateOrUpdateResponder(resp *http.Response) (result RecordSet, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (RecordSetsClient) CreateOrUpdateSender 

func (client RecordSetsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (RecordSetsClient) Delete 

func (client RecordSetsClient) Delete(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, relativeRecordSetName string, ifMatch string) (result autorest.Response, err error)

Delete removes a RecordSet from a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone without a terminating dot. recordType - the type of DNS record. relativeRecordSetName - the name of the RecordSet, relative to the name of the zone. ifMatch - defines the If-Match condition. The delete operation will be performed only if the ETag of the zone on the server matches this value.

func (RecordSetsClient) DeletePreparer 

func (client RecordSetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, relativeRecordSetName string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RecordSetsClient) DeleteResponder 

func (client RecordSetsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (RecordSetsClient) DeleteSender 

func (client RecordSetsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (RecordSetsClient) Get 

func (client RecordSetsClient) Get(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, relativeRecordSetName string) (result RecordSet, err error)

Get gets a RecordSet. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone without a terminating dot. recordType - the type of DNS record. relativeRecordSetName - the name of the RecordSet, relative to the name of the zone.

func (RecordSetsClient) GetPreparer 

func (client RecordSetsClient) GetPreparer(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, relativeRecordSetName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RecordSetsClient) GetResponder 

func (client RecordSetsClient) GetResponder(resp *http.Response) (result RecordSet, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (RecordSetsClient) GetSender 

func (client RecordSetsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (RecordSetsClient) List 

func (client RecordSetsClient) List(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, top string, filter string) (result RecordSetListResultPage, err error)

List lists the RecordSets of a specified type in a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone from which to enumerate RecordsSets. recordType - the type of record sets to enumerate. top - query parameters. If null is passed returns the default number of zones. filter - the filter to apply on the operation.

func (RecordSetsClient) ListAll 

func (client RecordSetsClient) ListAll(ctx context.Context, resourceGroupName string, zoneName string, top string, filter string) (result RecordSetListResultPage, err error)

ListAll lists all RecordSets in a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone from which to enumerate RecordSets. top - query parameters. If null is passed returns the default number of zones. filter - the filter to apply on the operation.

func (RecordSetsClient) ListAllComplete 

func (client RecordSetsClient) ListAllComplete(ctx context.Context, resourceGroupName string, zoneName string, top string, filter string) (result RecordSetListResultIterator, err error)

ListAllComplete enumerates all values, automatically crossing page boundaries as required.

func (RecordSetsClient) ListAllPreparer 

func (client RecordSetsClient) ListAllPreparer(ctx context.Context, resourceGroupName string, zoneName string, top string, filter string) (*http.Request, error)

ListAllPreparer prepares the ListAll request.

func (RecordSetsClient) ListAllResponder 

func (client RecordSetsClient) ListAllResponder(resp *http.Response) (result RecordSetListResult, err error)

ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.

func (RecordSetsClient) ListAllSender 

func (client RecordSetsClient) ListAllSender(req *http.Request) (*http.Response, error)

ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.

func (RecordSetsClient) ListComplete 

func (client RecordSetsClient) ListComplete(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, top string, filter string) (result RecordSetListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (RecordSetsClient) ListPreparer 

func (client RecordSetsClient) ListPreparer(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, top string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (RecordSetsClient) ListResponder 

func (client RecordSetsClient) ListResponder(resp *http.Response) (result RecordSetListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RecordSetsClient) ListSender 

func (client RecordSetsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type RecordType 

type RecordType string

RecordType enumerates the values for record type. 

const (
	// A ...
	A RecordType = "A"
	// AAAA ...
	AAAA RecordType = "AAAA"
	// CNAME ...
	CNAME RecordType = "CNAME"
	// MX ...
	MX RecordType = "MX"
	// NS ...
	NS RecordType = "NS"
	// PTR ...
	PTR RecordType = "PTR"
	// SOA ...
	SOA RecordType = "SOA"
	// SRV ...
	SRV RecordType = "SRV"
	// TXT ...
	TXT RecordType = "TXT"
)

func PossibleRecordTypeValues 

func PossibleRecordTypeValues() []RecordType

PossibleRecordTypeValues returns an array of possible values for the RecordType const type.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type SoaRecord 

type SoaRecord struct {
	// Host - Gets or sets the domain name of the authoritative name server, without a terminating dot.
	Host *string `json:"host,omitempty"`
	// Email - Gets or sets the email for this record.
	Email *string `json:"email,omitempty"`
	// SerialNumber - Gets or sets the serial number for this record.
	SerialNumber *int64 `json:"serialNumber,omitempty"`
	// RefreshTime - Gets or sets the refresh value for this record.
	RefreshTime *int64 `json:"refreshTime,omitempty"`
	// RetryTime - Gets or sets the retry time for this record.
	RetryTime *int64 `json:"retryTime,omitempty"`
	// ExpireTime - Gets or sets the expire time for this record.
	ExpireTime *int64 `json:"expireTime,omitempty"`
	// MinimumTTL - Gets or sets the minimum TTL value for this record.
	MinimumTTL *int64 `json:"minimumTTL,omitempty"`
}

SoaRecord an SOA record.

type SrvRecord 

type SrvRecord struct {
	// Priority - Gets or sets the priority metric for this record.
	Priority *int32 `json:"priority,omitempty"`
	// Weight - Gets or sets the weight metric for this record.
	Weight *int32 `json:"weight,omitempty"`
	// Port - Gets or sets the port of the service for this record.
	Port *int32 `json:"port,omitempty"`
	// Target - Gets or sets the domain name of the target for this record, without a terminating dot.
	Target *string `json:"target,omitempty"`
}

SrvRecord an SRV record.

type SubResource 

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

SubResource ...

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (TrackedResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for TrackedResource.

type TxtRecord 

type TxtRecord struct {
	// Value - Gets or sets the text value of this record.
	Value *[]string `json:"value,omitempty"`
}

TxtRecord a TXT record.

type Zone 

type Zone struct {
	autorest.Response `json:"-"`
	// Etag - Gets or sets the ETag of the zone that is being updated, as received from a Get operation.
	Etag *string `json:"etag,omitempty"`
	// Properties - Gets or sets the properties of the zone.
	Properties *ZoneProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Zone describes a DNS zone.

func (Zone) MarshalJSON 

func (z Zone) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Zone.

type ZoneListResult 

type ZoneListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets or sets information about the zones in the response.
	Value *[]Zone `json:"value,omitempty"`
	// NextLink - Gets or sets the continuation token for the next page.
	NextLink *string `json:"nextLink,omitempty"`
}

ZoneListResult the response to a Zone List or ListAll operation.

func (ZoneListResult) IsEmpty 

func (zlr ZoneListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ZoneListResultIterator 

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

ZoneListResultIterator provides access to a complete listing of Zone values.

func NewZoneListResultIterator 

func NewZoneListResultIterator(page ZoneListResultPage) ZoneListResultIterator

Creates a new instance of the ZoneListResultIterator type.

func (*ZoneListResultIterator) Next 

func (iter *ZoneListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ZoneListResultIterator) NextWithContext 

func (iter *ZoneListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ZoneListResultIterator) NotDone 

func (iter ZoneListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ZoneListResultIterator) Response 

func (iter ZoneListResultIterator) Response() ZoneListResult

Response returns the raw server response from the last page request.

func (ZoneListResultIterator) Value 

func (iter ZoneListResultIterator) Value() Zone

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ZoneListResultPage 

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

ZoneListResultPage contains a page of Zone values.

func NewZoneListResultPage 

func NewZoneListResultPage(cur ZoneListResult, getNextPage func(context.Context, ZoneListResult) (ZoneListResult, error)) ZoneListResultPage

Creates a new instance of the ZoneListResultPage type.

func (*ZoneListResultPage) Next 

func (page *ZoneListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ZoneListResultPage) NextWithContext 

func (page *ZoneListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ZoneListResultPage) NotDone 

func (page ZoneListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ZoneListResultPage) Response 

func (page ZoneListResultPage) Response() ZoneListResult

Response returns the raw server response from the last page request.

func (ZoneListResultPage) Values 

func (page ZoneListResultPage) Values() []Zone

Values returns the slice of values for the current page or nil if there are no values.

type ZoneProperties 

type ZoneProperties struct {
	// MaxNumberOfRecordSets - Gets or sets the maximum number of record sets that can be created in this zone.
	MaxNumberOfRecordSets *int64 `json:"maxNumberOfRecordSets,omitempty"`
	// NumberOfRecordSets - Gets or sets the current number of record sets in this zone.
	NumberOfRecordSets *int64 `json:"numberOfRecordSets,omitempty"`
}

ZoneProperties represents the properties of the zone.

type ZonesClient 

type ZonesClient struct {
	BaseClient
}

ZonesClient is the client for managing DNS zones and record.

func NewZonesClient 

func NewZonesClient(subscriptionID string) ZonesClient

NewZonesClient creates an instance of the ZonesClient client.

func NewZonesClientWithBaseURI 

func NewZonesClientWithBaseURI(baseURI string, subscriptionID string) ZonesClient

NewZonesClientWithBaseURI creates an instance of the ZonesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ZonesClient) CreateOrUpdate 

func (client ZonesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, zoneName string, parameters Zone, ifMatch string, ifNoneMatch string) (result Zone, err error)

CreateOrUpdate creates a DNS zone within a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone without a terminating dot. parameters - parameters supplied to the CreateOrUpdate operation. ifMatch - the etag of Zone. ifNoneMatch - defines the If-None-Match condition. Set to '*' to force Create-If-Not-Exist. Other values will be ignored.

func (ZonesClient) CreateOrUpdatePreparer 

func (client ZonesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, zoneName string, parameters Zone, ifMatch string, ifNoneMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ZonesClient) CreateOrUpdateResponder 

func (client ZonesClient) CreateOrUpdateResponder(resp *http.Response) (result Zone, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ZonesClient) CreateOrUpdateSender 

func (client ZonesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ZonesClient) Delete 

func (client ZonesClient) Delete(ctx context.Context, resourceGroupName string, zoneName string, ifMatch string) (result autorest.Response, err error)

Delete removes a DNS zone from a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone without a terminating dot. ifMatch - defines the If-Match condition. The delete operation will be performed only if the ETag of the zone on the server matches this value.

func (ZonesClient) DeletePreparer 

func (client ZonesClient) DeletePreparer(ctx context.Context, resourceGroupName string, zoneName string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ZonesClient) DeleteResponder 

func (client ZonesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ZonesClient) DeleteSender 

func (client ZonesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ZonesClient) Get 

func (client ZonesClient) Get(ctx context.Context, resourceGroupName string, zoneName string) (result Zone, err error)

Get gets a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the zone without a terminating dot.

func (ZonesClient) GetPreparer 

func (client ZonesClient) GetPreparer(ctx context.Context, resourceGroupName string, zoneName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ZonesClient) GetResponder 

func (client ZonesClient) GetResponder(resp *http.Response) (result Zone, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ZonesClient) GetSender 

func (client ZonesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ZonesClient) ListZonesInResourceGroup 

func (client ZonesClient) ListZonesInResourceGroup(ctx context.Context, resourceGroupName string, top string, filter string) (result ZoneListResultPage, err error)

ListZonesInResourceGroup lists the DNS zones within a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. top - query parameters. If null is passed returns the default number of zones. filter - the filter to apply on the operation.

func (ZonesClient) ListZonesInResourceGroupComplete 

func (client ZonesClient) ListZonesInResourceGroupComplete(ctx context.Context, resourceGroupName string, top string, filter string) (result ZoneListResultIterator, err error)

ListZonesInResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ZonesClient) ListZonesInResourceGroupPreparer 

func (client ZonesClient) ListZonesInResourceGroupPreparer(ctx context.Context, resourceGroupName string, top string, filter string) (*http.Request, error)

ListZonesInResourceGroupPreparer prepares the ListZonesInResourceGroup request.

func (ZonesClient) ListZonesInResourceGroupResponder 

func (client ZonesClient) ListZonesInResourceGroupResponder(resp *http.Response) (result ZoneListResult, err error)

ListZonesInResourceGroupResponder handles the response to the ListZonesInResourceGroup request. The method always closes the http.Response Body.

func (ZonesClient) ListZonesInResourceGroupSender 

func (client ZonesClient) ListZonesInResourceGroupSender(req *http.Request) (*http.Response, error)

ListZonesInResourceGroupSender sends the ListZonesInResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ZonesClient) ListZonesInSubscription 

func (client ZonesClient) ListZonesInSubscription(ctx context.Context, top string, filter string) (result ZoneListResultPage, err error)

ListZonesInSubscription lists the DNS zones within a resource group. Parameters: top - query parameters. If null is passed returns the default number of zones. filter - the filter to apply on the operation.

func (ZonesClient) ListZonesInSubscriptionComplete 

func (client ZonesClient) ListZonesInSubscriptionComplete(ctx context.Context, top string, filter string) (result ZoneListResultIterator, err error)

ListZonesInSubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (ZonesClient) ListZonesInSubscriptionPreparer 

func (client ZonesClient) ListZonesInSubscriptionPreparer(ctx context.Context, top string, filter string) (*http.Request, error)

ListZonesInSubscriptionPreparer prepares the ListZonesInSubscription request.

func (ZonesClient) ListZonesInSubscriptionResponder 

func (client ZonesClient) ListZonesInSubscriptionResponder(resp *http.Response) (result ZoneListResult, err error)

ListZonesInSubscriptionResponder handles the response to the ListZonesInSubscription request. The method always closes the http.Response Body.

func (ZonesClient) ListZonesInSubscriptionSender 

func (client ZonesClient) ListZonesInSubscriptionSender(req *http.Request) (*http.Response, error)

ListZonesInSubscriptionSender sends the ListZonesInSubscription request. The method will close the http.Response Body if it receives an error.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.