dns

package
v51.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package dns implements the Azure ARM Dns service API version 2017-09-01.

The DNS Management Client.

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 - The IPv4 address of this A record.
	Ipv4Address *string `json:"ipv4Address,omitempty"`
}

ARecord an A record.

type AaaaRecord 

type AaaaRecord struct {
	// Ipv6Address - The IPv6 address of this AAAA record.
	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.

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 CaaRecord 

type CaaRecord struct {
	// Flags - The flags for this CAA record as an integer between 0 and 255.
	Flags *int32 `json:"flags,omitempty"`
	// Tag - The tag for this CAA record.
	Tag *string `json:"tag,omitempty"`
	// Value - The value for this CAA record.
	Value *string `json:"value,omitempty"`
}

CaaRecord a CAA record.

type CloudError 

type CloudError struct {
	// Error - Cloud error body.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the service.

type CloudErrorBody 

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the service.

type CnameRecord 

type CnameRecord struct {
	// Cname - The canonical name for this CNAME record.
	Cname *string `json:"cname,omitempty"`
}

CnameRecord a CNAME record.

type MxRecord 

type MxRecord struct {
	// Preference - The preference value for this MX record.
	Preference *int32 `json:"preference,omitempty"`
	// Exchange - The domain name of the mail host for this MX record.
	Exchange *string `json:"exchange,omitempty"`
}

MxRecord an MX record.

type NsRecord 

type NsRecord struct {
	// Nsdname - The name server name for this NS record.
	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

type PtrRecord 

type PtrRecord struct {
	// Ptrdname - The PTR target domain name for this PTR record.
	Ptrdname *string `json:"ptrdname,omitempty"`
}

PtrRecord a PTR record.

type RecordSet 

type RecordSet struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The ID of the record set.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the record set.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the record set.
	Type *string `json:"type,omitempty"`
	// Etag - The etag of the record set.
	Etag *string `json:"etag,omitempty"`
	// RecordSetProperties - The properties of the record set.
	*RecordSetProperties `json:"properties,omitempty"`
}

RecordSet describes a DNS record set (a collection 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.

func (*RecordSet) UnmarshalJSON 

func (rs *RecordSet) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RecordSet struct.

type RecordSetListResult 

type RecordSetListResult struct {
	autorest.Response `json:"-"`
	// Value - Information about the record sets in the response.
	Value *[]RecordSet `json:"value,omitempty"`
	// NextLink - READ-ONLY; The continuation token for the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

RecordSetListResult the response to a record set List operation.

func (RecordSetListResult) IsEmpty 

func (rslr RecordSetListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (RecordSetListResult) MarshalJSON 

func (rslr RecordSetListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RecordSetListResult.

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 {
	// Metadata - The metadata attached to the record set.
	Metadata map[string]*string `json:"metadata"`
	// TTL - The TTL (time-to-live) of the records in the record set.
	TTL *int64 `json:"TTL,omitempty"`
	// Fqdn - READ-ONLY; Fully qualified domain name of the record set.
	Fqdn *string `json:"fqdn,omitempty"`
	// ARecords - The list of A records in the record set.
	ARecords *[]ARecord `json:"ARecords,omitempty"`
	// AaaaRecords - The list of AAAA records in the record set.
	AaaaRecords *[]AaaaRecord `json:"AAAARecords,omitempty"`
	// MxRecords - The list of MX records in the record set.
	MxRecords *[]MxRecord `json:"MXRecords,omitempty"`
	// NsRecords - The list of NS records in the record set.
	NsRecords *[]NsRecord `json:"NSRecords,omitempty"`
	// PtrRecords - The list of PTR records in the record set.
	PtrRecords *[]PtrRecord `json:"PTRRecords,omitempty"`
	// SrvRecords - The list of SRV records in the record set.
	SrvRecords *[]SrvRecord `json:"SRVRecords,omitempty"`
	// TxtRecords - The list of TXT records in the record set.
	TxtRecords *[]TxtRecord `json:"TXTRecords,omitempty"`
	// CnameRecord - The CNAME record in the  record set.
	CnameRecord *CnameRecord `json:"CNAMERecord,omitempty"`
	// SoaRecord - The SOA record in the record set.
	SoaRecord *SoaRecord `json:"SOARecord,omitempty"`
	// CaaRecords - The list of CAA records in the record set.
	CaaRecords *[]CaaRecord `json:"caaRecords,omitempty"`
}

RecordSetProperties represents the properties of the records in the record set.

func (RecordSetProperties) MarshalJSON 

func (rsp RecordSetProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RecordSetProperties.

type RecordSetUpdateParameters 

type RecordSetUpdateParameters struct {
	// RecordSet - Specifies information about the record set being updated.
	RecordSet *RecordSet `json:"RecordSet,omitempty"`
}

RecordSetUpdateParameters parameters supplied to update a record set.

type RecordSetsClient 

type RecordSetsClient struct {
	BaseClient
}

RecordSetsClient is the the DNS Management Client.

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, relativeRecordSetName string, recordType RecordType, parameters RecordSet, ifMatch string, ifNoneMatch string) (result RecordSet, err error)

CreateOrUpdate creates or updates a record set within a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS zone (without a terminating dot). relativeRecordSetName - the name of the record set, relative to the name of the zone. recordType - the type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the DNS zone is created). parameters - parameters supplied to the CreateOrUpdate operation. ifMatch - the etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. ifNoneMatch - set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.

func (RecordSetsClient) CreateOrUpdatePreparer 

func (client RecordSetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, zoneName string, relativeRecordSetName string, recordType RecordType, 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, relativeRecordSetName string, recordType RecordType, ifMatch string) (result autorest.Response, err error)

Delete deletes a record set from a DNS zone. This operation cannot be undone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS zone (without a terminating dot). relativeRecordSetName - the name of the record set, relative to the name of the zone. recordType - the type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the DNS zone is deleted). ifMatch - the etag of the record set. Omit this value to always delete the current record set. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.

func (RecordSetsClient) DeletePreparer 

func (client RecordSetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, zoneName string, relativeRecordSetName string, recordType RecordType, 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, relativeRecordSetName string, recordType RecordType) (result RecordSet, err error)

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

func (RecordSetsClient) GetPreparer 

func (client RecordSetsClient) GetPreparer(ctx context.Context, resourceGroupName string, zoneName string, relativeRecordSetName string, recordType RecordType) (*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) ListByDNSZone 

func (client RecordSetsClient) ListByDNSZone(ctx context.Context, resourceGroupName string, zoneName string, top *int32, recordsetnamesuffix string) (result RecordSetListResultPage, err error)

ListByDNSZone lists all record sets in a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS zone (without a terminating dot). top - the maximum number of record sets to return. If not specified, returns up to 100 record sets. recordsetnamesuffix - the suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix>

func (RecordSetsClient) ListByDNSZoneComplete 

func (client RecordSetsClient) ListByDNSZoneComplete(ctx context.Context, resourceGroupName string, zoneName string, top *int32, recordsetnamesuffix string) (result RecordSetListResultIterator, err error)

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

func (RecordSetsClient) ListByDNSZonePreparer 

func (client RecordSetsClient) ListByDNSZonePreparer(ctx context.Context, resourceGroupName string, zoneName string, top *int32, recordsetnamesuffix string) (*http.Request, error)

ListByDNSZonePreparer prepares the ListByDNSZone request.

func (RecordSetsClient) ListByDNSZoneResponder 

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

ListByDNSZoneResponder handles the response to the ListByDNSZone request. The method always closes the http.Response Body.

func (RecordSetsClient) ListByDNSZoneSender 

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

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

func (RecordSetsClient) ListByType 

func (client RecordSetsClient) ListByType(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, top *int32, recordsetnamesuffix string) (result RecordSetListResultPage, err error)

ListByType lists the record sets 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 DNS zone (without a terminating dot). recordType - the type of record sets to enumerate. top - the maximum number of record sets to return. If not specified, returns up to 100 record sets. recordsetnamesuffix - the suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix>

func (RecordSetsClient) ListByTypeComplete 

func (client RecordSetsClient) ListByTypeComplete(ctx context.Context, resourceGroupName string, zoneName string, recordType RecordType, top *int32, recordsetnamesuffix string) (result RecordSetListResultIterator, err error)

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

func (RecordSetsClient) ListByTypePreparer 

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

ListByTypePreparer prepares the ListByType request.

func (RecordSetsClient) ListByTypeResponder 

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

ListByTypeResponder handles the response to the ListByType request. The method always closes the http.Response Body.

func (RecordSetsClient) ListByTypeSender 

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

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

func (RecordSetsClient) Update 

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

Update updates a record set within a DNS zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS zone (without a terminating dot). relativeRecordSetName - the name of the record set, relative to the name of the zone. recordType - the type of DNS record in this record set. parameters - parameters supplied to the Update operation. ifMatch - the etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes.

func (RecordSetsClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (RecordSetsClient) UpdateResponder 

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

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (RecordSetsClient) UpdateSender 

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

UpdateSender sends the Update 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"
	// CAA ...
	CAA RecordType = "CAA"
	// 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

type SoaRecord 

type SoaRecord struct {
	// Host - The domain name of the authoritative name server for this SOA record.
	Host *string `json:"host,omitempty"`
	// Email - The email contact for this SOA record.
	Email *string `json:"email,omitempty"`
	// SerialNumber - The serial number for this SOA record.
	SerialNumber *int64 `json:"serialNumber,omitempty"`
	// RefreshTime - The refresh value for this SOA record.
	RefreshTime *int64 `json:"refreshTime,omitempty"`
	// RetryTime - The retry time for this SOA record.
	RetryTime *int64 `json:"retryTime,omitempty"`
	// ExpireTime - The expire time for this SOA record.
	ExpireTime *int64 `json:"expireTime,omitempty"`
	// MinimumTTL - The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
	MinimumTTL *int64 `json:"minimumTTL,omitempty"`
}

SoaRecord an SOA record.

type SrvRecord 

type SrvRecord struct {
	// Priority - The priority value for this SRV record.
	Priority *int32 `json:"priority,omitempty"`
	// Weight - The weight value for this SRV record.
	Weight *int32 `json:"weight,omitempty"`
	// Port - The port value for this SRV record.
	Port *int32 `json:"port,omitempty"`
	// Target - The target domain name for this SRV record.
	Target *string `json:"target,omitempty"`
}

SrvRecord an SRV record.

type SubResource 

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

SubResource a reference to a another resource

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 - The text value of this TXT record.
	Value *[]string `json:"value,omitempty"`
}

TxtRecord a TXT record.

type Zone 

type Zone struct {
	autorest.Response `json:"-"`
	// Etag - The etag of the zone.
	Etag *string `json:"etag,omitempty"`
	// ZoneProperties - The properties of the zone.
	*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.

func (*Zone) UnmarshalJSON 

func (z *Zone) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Zone struct.

type ZoneListResult 

type ZoneListResult struct {
	autorest.Response `json:"-"`
	// Value - Information about the DNS zones.
	Value *[]Zone `json:"value,omitempty"`
	// NextLink - READ-ONLY; The continuation token for the next page of results.
	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.

func (ZoneListResult) MarshalJSON 

func (zlr ZoneListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ZoneListResult.

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 - READ-ONLY; The maximum number of record sets that can be created in this DNS zone.  This is a read-only property and any attempt to set this value will be ignored.
	MaxNumberOfRecordSets *int64 `json:"maxNumberOfRecordSets,omitempty"`
	// MaxNumberOfRecordsPerRecordSet - READ-ONLY; The maximum number of records per record set that can be created in this DNS zone.  This is a read-only property and any attempt to set this value will be ignored.
	MaxNumberOfRecordsPerRecordSet *int64 `json:"maxNumberOfRecordsPerRecordSet,omitempty"`
	// NumberOfRecordSets - READ-ONLY; The current number of record sets in this DNS zone.  This is a read-only property and any attempt to set this value will be ignored.
	NumberOfRecordSets *int64 `json:"numberOfRecordSets,omitempty"`
	// NameServers - READ-ONLY; The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
	NameServers *[]string `json:"nameServers,omitempty"`
}

ZoneProperties represents the properties of the zone.

type ZonesClient 

type ZonesClient struct {
	BaseClient
}

ZonesClient is the the DNS Management Client.

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 or updates a DNS zone. Does not modify DNS records within the zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS zone (without a terminating dot). parameters - parameters supplied to the CreateOrUpdate operation. ifMatch - the etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. ifNoneMatch - set to '*' to allow a new DNS zone to be created, but to prevent updating an existing zone. 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 ZonesDeleteFuture, err error)

Delete deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS zone (without a terminating dot). ifMatch - the etag of the DNS zone. Omit this value to always delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.

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) (future ZonesDeleteFuture, err 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. Retrieves the zone properties, but not the record sets within the zone. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. zoneName - the name of the DNS 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) List 

func (client ZonesClient) List(ctx context.Context, top *int32) (result ZoneListResultPage, err error)

List lists the DNS zones in all resource groups in a subscription. Parameters: top - the maximum number of DNS zones to return. If not specified, returns up to 100 zones.

func (ZonesClient) ListByResourceGroup 

func (client ZonesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32) (result ZoneListResultPage, err error)

ListByResourceGroup lists the DNS zones within a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. top - the maximum number of record sets to return. If not specified, returns up to 100 record sets.

func (ZonesClient) ListByResourceGroupComplete 

func (client ZonesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32) (result ZoneListResultIterator, err error)

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

func (ZonesClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ZonesClient) ListByResourceGroupResponder 

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

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ZonesClient) ListByResourceGroupSender 

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

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

func (ZonesClient) ListComplete 

func (client ZonesClient) ListComplete(ctx context.Context, top *int32) (result ZoneListResultIterator, err error)

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

func (ZonesClient) ListPreparer 

func (client ZonesClient) ListPreparer(ctx context.Context, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ZonesClient) ListResponder 

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

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

func (ZonesClient) ListSender 

func (client ZonesClient) 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 ZonesDeleteFuture 

type ZonesDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ZonesClient) (autorest.Response, error)
}

ZonesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

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.