domains

package
v0.20240612.1122027 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-12-01/domains Documentation

The domains SDK allows for interaction with the Azure Resource Manager Service web (API Version 2023-12-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-12-01/domains"

Client Initialization

client := domains.NewDomainsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DomainsClient.CheckAvailability

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

payload := domains.NameIdentifier{
	// ...
}


read, err := client.CheckAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.CreateOrUpdate

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

payload := domains.Domain{
	// ...
}


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

Example Usage: DomainsClient.CreateOrUpdateOwnershipIdentifier

ctx := context.TODO()
id := domains.NewDomainOwnershipIdentifierID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "domainOwnershipIdentifierValue")

payload := domains.DomainOwnershipIdentifier{
	// ...
}


read, err := client.CreateOrUpdateOwnershipIdentifier(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.Delete

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

read, err := client.Delete(ctx, id, domains.DefaultDeleteOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.DeleteOwnershipIdentifier

ctx := context.TODO()
id := domains.NewDomainOwnershipIdentifierID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "domainOwnershipIdentifierValue")

read, err := client.DeleteOwnershipIdentifier(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.Get

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

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.GetControlCenterSsoRequest

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

read, err := client.GetControlCenterSsoRequest(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.GetOwnershipIdentifier

ctx := context.TODO()
id := domains.NewDomainOwnershipIdentifierID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "domainOwnershipIdentifierValue")

read, err := client.GetOwnershipIdentifier(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.List

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

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

Example Usage: DomainsClient.ListByResourceGroup

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

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

Example Usage: DomainsClient.ListOwnershipIdentifiers

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

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

Example Usage: DomainsClient.ListRecommendations

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

payload := domains.DomainRecommendationSearchParameters{
	// ...
}


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

Example Usage: DomainsClient.Renew

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

read, err := client.Renew(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.TransferOut

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

read, err := client.TransferOut(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.Update

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

payload := domains.DomainPatchResource{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DomainsClient.UpdateOwnershipIdentifier

ctx := context.TODO()
id := domains.NewDomainOwnershipIdentifierID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "domainOwnershipIdentifierValue")

payload := domains.DomainOwnershipIdentifier{
	// ...
}


read, err := client.UpdateOwnershipIdentifier(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAzureResourceType 

func PossibleValuesForAzureResourceType() []string

func PossibleValuesForCustomHostNameDnsRecordType 

func PossibleValuesForCustomHostNameDnsRecordType() []string

func PossibleValuesForDnsType 

func PossibleValuesForDnsType() []string

func PossibleValuesForDomainStatus 

func PossibleValuesForDomainStatus() []string

func PossibleValuesForDomainType 

func PossibleValuesForDomainType() []string

func PossibleValuesForHostNameType 

func PossibleValuesForHostNameType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForResourceNotRenewableReason 

func PossibleValuesForResourceNotRenewableReason() []string

func ValidateDomainID 

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

ValidateDomainID checks that 'input' can be parsed as a Domain ID

func ValidateDomainOwnershipIdentifierID 

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

ValidateDomainOwnershipIdentifierID checks that 'input' can be parsed as a Domain Ownership Identifier ID

Types

type Address 

type Address struct {
	Address1   string  `json:"address1"`
	Address2   *string `json:"address2,omitempty"`
	City       string  `json:"city"`
	Country    string  `json:"country"`
	PostalCode string  `json:"postalCode"`
	State      string  `json:"state"`
}

type AzureResourceType 

type AzureResourceType string
const (
	AzureResourceTypeTrafficManager AzureResourceType = "TrafficManager"
	AzureResourceTypeWebsite        AzureResourceType = "Website"
)

func (*AzureResourceType) UnmarshalJSON 

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

type CheckAvailabilityOperationResponse 

type CheckAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainAvailabilityCheckResult
}

type Contact 

type Contact struct {
	AddressMailing *Address `json:"addressMailing,omitempty"`
	Email          string   `json:"email"`
	Fax            *string  `json:"fax,omitempty"`
	JobTitle       *string  `json:"jobTitle,omitempty"`
	NameFirst      string   `json:"nameFirst"`
	NameLast       string   `json:"nameLast"`
	NameMiddle     *string  `json:"nameMiddle,omitempty"`
	Organization   *string  `json:"organization,omitempty"`
	Phone          string   `json:"phone"`
}

type CreateOrUpdateOperationResponse 

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

type CreateOrUpdateOwnershipIdentifierOperationResponse 

type CreateOrUpdateOwnershipIdentifierOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainOwnershipIdentifier
}

type CustomHostNameDnsRecordType 

type CustomHostNameDnsRecordType string
const (
	CustomHostNameDnsRecordTypeA     CustomHostNameDnsRecordType = "A"
	CustomHostNameDnsRecordTypeCName CustomHostNameDnsRecordType = "CName"
)

func (*CustomHostNameDnsRecordType) UnmarshalJSON 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	ForceHardDeleteDomain *bool
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type DeleteOwnershipIdentifierOperationResponse 

type DeleteOwnershipIdentifierOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DnsType 

type DnsType string
const (
	DnsTypeAzureDns                  DnsType = "AzureDns"
	DnsTypeDefaultDomainRegistrarDns DnsType = "DefaultDomainRegistrarDns"
)

func (*DnsType) UnmarshalJSON 

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

type Domain 

type Domain struct {
	Id         *string            `json:"id,omitempty"`
	Kind       *string            `json:"kind,omitempty"`
	Location   string             `json:"location"`
	Name       *string            `json:"name,omitempty"`
	Properties *DomainProperties  `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type DomainAvailabilityCheckResult 

type DomainAvailabilityCheckResult struct {
	Available  *bool       `json:"available,omitempty"`
	DomainType *DomainType `json:"domainType,omitempty"`
	Name       *string     `json:"name,omitempty"`
}

type DomainControlCenterSsoRequest 

type DomainControlCenterSsoRequest struct {
	PostParameterKey   *string `json:"postParameterKey,omitempty"`
	PostParameterValue *string `json:"postParameterValue,omitempty"`
	Url                *string `json:"url,omitempty"`
}

type DomainId 

type DomainId struct {
	SubscriptionId    string
	ResourceGroupName string
	DomainName        string
}

DomainId is a struct representing the Resource ID for a Domain

func NewDomainID 

func NewDomainID(subscriptionId string, resourceGroupName string, domainName string) DomainId

NewDomainID returns a new DomainId struct

func ParseDomainID 

func ParseDomainID(input string) (*DomainId, error)

ParseDomainID parses 'input' into a DomainId

func ParseDomainIDInsensitively 

func ParseDomainIDInsensitively(input string) (*DomainId, error)

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

func (*DomainId) FromParseResult 

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

func (DomainId) ID 

func (id DomainId) ID() string

ID returns the formatted Domain ID

func (DomainId) Segments 

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

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

func (DomainId) String 

func (id DomainId) String() string

String returns a human-readable description of this Domain ID

type DomainOperationPredicate 

type DomainOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (DomainOperationPredicate) Matches 

func (p DomainOperationPredicate) Matches(input Domain) bool

type DomainOwnershipIdentifier 

type DomainOwnershipIdentifier struct {
	Id         *string                              `json:"id,omitempty"`
	Kind       *string                              `json:"kind,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *DomainOwnershipIdentifierProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type DomainOwnershipIdentifierId 

type DomainOwnershipIdentifierId struct {
	SubscriptionId                string
	ResourceGroupName             string
	DomainName                    string
	DomainOwnershipIdentifierName string
}

DomainOwnershipIdentifierId is a struct representing the Resource ID for a Domain Ownership Identifier

func NewDomainOwnershipIdentifierID 

func NewDomainOwnershipIdentifierID(subscriptionId string, resourceGroupName string, domainName string, domainOwnershipIdentifierName string) DomainOwnershipIdentifierId

NewDomainOwnershipIdentifierID returns a new DomainOwnershipIdentifierId struct

func ParseDomainOwnershipIdentifierID 

func ParseDomainOwnershipIdentifierID(input string) (*DomainOwnershipIdentifierId, error)

ParseDomainOwnershipIdentifierID parses 'input' into a DomainOwnershipIdentifierId

func ParseDomainOwnershipIdentifierIDInsensitively 

func ParseDomainOwnershipIdentifierIDInsensitively(input string) (*DomainOwnershipIdentifierId, error)

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

func (*DomainOwnershipIdentifierId) FromParseResult 

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

func (DomainOwnershipIdentifierId) ID 

func (id DomainOwnershipIdentifierId) ID() string

ID returns the formatted Domain Ownership Identifier ID

func (DomainOwnershipIdentifierId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Domain Ownership Identifier ID

func (DomainOwnershipIdentifierId) String 

func (id DomainOwnershipIdentifierId) String() string

String returns a human-readable description of this Domain Ownership Identifier ID

type DomainOwnershipIdentifierOperationPredicate 

type DomainOwnershipIdentifierOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (DomainOwnershipIdentifierOperationPredicate) Matches 

func (p DomainOwnershipIdentifierOperationPredicate) Matches(input DomainOwnershipIdentifier) bool

type DomainOwnershipIdentifierProperties 

type DomainOwnershipIdentifierProperties struct {
	OwnershipId *string `json:"ownershipId,omitempty"`
}

type DomainPatchResource 

type DomainPatchResource struct {
	Id         *string                        `json:"id,omitempty"`
	Kind       *string                        `json:"kind,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *DomainPatchResourceProperties `json:"properties,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type DomainPatchResourceProperties 

type DomainPatchResourceProperties struct {
	AuthCode                    *string                       `json:"authCode,omitempty"`
	AutoRenew                   *bool                         `json:"autoRenew,omitempty"`
	Consent                     DomainPurchaseConsent         `json:"consent"`
	ContactAdmin                Contact                       `json:"contactAdmin"`
	ContactBilling              Contact                       `json:"contactBilling"`
	ContactRegistrant           Contact                       `json:"contactRegistrant"`
	ContactTech                 Contact                       `json:"contactTech"`
	CreatedTime                 *string                       `json:"createdTime,omitempty"`
	DnsType                     *DnsType                      `json:"dnsType,omitempty"`
	DnsZoneId                   *string                       `json:"dnsZoneId,omitempty"`
	DomainNotRenewableReasons   *[]ResourceNotRenewableReason `json:"domainNotRenewableReasons,omitempty"`
	ExpirationTime              *string                       `json:"expirationTime,omitempty"`
	LastRenewedTime             *string                       `json:"lastRenewedTime,omitempty"`
	ManagedHostNames            *[]HostName                   `json:"managedHostNames,omitempty"`
	NameServers                 *[]string                     `json:"nameServers,omitempty"`
	Privacy                     *bool                         `json:"privacy,omitempty"`
	ProvisioningState           *ProvisioningState            `json:"provisioningState,omitempty"`
	ReadyForDnsRecordManagement *bool                         `json:"readyForDnsRecordManagement,omitempty"`
	RegistrationStatus          *DomainStatus                 `json:"registrationStatus,omitempty"`
	TargetDnsType               *DnsType                      `json:"targetDnsType,omitempty"`
}

func (*DomainPatchResourceProperties) GetCreatedTimeAsTime 

func (o *DomainPatchResourceProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*DomainPatchResourceProperties) GetExpirationTimeAsTime 

func (o *DomainPatchResourceProperties) GetExpirationTimeAsTime() (*time.Time, error)

func (*DomainPatchResourceProperties) GetLastRenewedTimeAsTime 

func (o *DomainPatchResourceProperties) GetLastRenewedTimeAsTime() (*time.Time, error)

func (*DomainPatchResourceProperties) SetCreatedTimeAsTime 

func (o *DomainPatchResourceProperties) SetCreatedTimeAsTime(input time.Time)

func (*DomainPatchResourceProperties) SetExpirationTimeAsTime 

func (o *DomainPatchResourceProperties) SetExpirationTimeAsTime(input time.Time)

func (*DomainPatchResourceProperties) SetLastRenewedTimeAsTime 

func (o *DomainPatchResourceProperties) SetLastRenewedTimeAsTime(input time.Time)

type DomainProperties 

type DomainProperties struct {
	AuthCode                    *string                       `json:"authCode,omitempty"`
	AutoRenew                   *bool                         `json:"autoRenew,omitempty"`
	Consent                     DomainPurchaseConsent         `json:"consent"`
	ContactAdmin                Contact                       `json:"contactAdmin"`
	ContactBilling              Contact                       `json:"contactBilling"`
	ContactRegistrant           Contact                       `json:"contactRegistrant"`
	ContactTech                 Contact                       `json:"contactTech"`
	CreatedTime                 *string                       `json:"createdTime,omitempty"`
	DnsType                     *DnsType                      `json:"dnsType,omitempty"`
	DnsZoneId                   *string                       `json:"dnsZoneId,omitempty"`
	DomainNotRenewableReasons   *[]ResourceNotRenewableReason `json:"domainNotRenewableReasons,omitempty"`
	ExpirationTime              *string                       `json:"expirationTime,omitempty"`
	LastRenewedTime             *string                       `json:"lastRenewedTime,omitempty"`
	ManagedHostNames            *[]HostName                   `json:"managedHostNames,omitempty"`
	NameServers                 *[]string                     `json:"nameServers,omitempty"`
	Privacy                     *bool                         `json:"privacy,omitempty"`
	ProvisioningState           *ProvisioningState            `json:"provisioningState,omitempty"`
	ReadyForDnsRecordManagement *bool                         `json:"readyForDnsRecordManagement,omitempty"`
	RegistrationStatus          *DomainStatus                 `json:"registrationStatus,omitempty"`
	TargetDnsType               *DnsType                      `json:"targetDnsType,omitempty"`
}

func (*DomainProperties) GetCreatedTimeAsTime 

func (o *DomainProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*DomainProperties) GetExpirationTimeAsTime 

func (o *DomainProperties) GetExpirationTimeAsTime() (*time.Time, error)

func (*DomainProperties) GetLastRenewedTimeAsTime 

func (o *DomainProperties) GetLastRenewedTimeAsTime() (*time.Time, error)

func (*DomainProperties) SetCreatedTimeAsTime 

func (o *DomainProperties) SetCreatedTimeAsTime(input time.Time)

func (*DomainProperties) SetExpirationTimeAsTime 

func (o *DomainProperties) SetExpirationTimeAsTime(input time.Time)

func (*DomainProperties) SetLastRenewedTimeAsTime 

func (o *DomainProperties) SetLastRenewedTimeAsTime(input time.Time)

type DomainPurchaseConsent 

type DomainPurchaseConsent struct {
	AgreedAt      *string   `json:"agreedAt,omitempty"`
	AgreedBy      *string   `json:"agreedBy,omitempty"`
	AgreementKeys *[]string `json:"agreementKeys,omitempty"`
}

func (*DomainPurchaseConsent) GetAgreedAtAsTime 

func (o *DomainPurchaseConsent) GetAgreedAtAsTime() (*time.Time, error)

func (*DomainPurchaseConsent) SetAgreedAtAsTime 

func (o *DomainPurchaseConsent) SetAgreedAtAsTime(input time.Time)

type DomainRecommendationSearchParameters 

type DomainRecommendationSearchParameters struct {
	Keywords                 *string `json:"keywords,omitempty"`
	MaxDomainRecommendations *int64  `json:"maxDomainRecommendations,omitempty"`
}

type DomainStatus 

type DomainStatus string
const (
	DomainStatusActive              DomainStatus = "Active"
	DomainStatusAwaiting            DomainStatus = "Awaiting"
	DomainStatusCancelled           DomainStatus = "Cancelled"
	DomainStatusConfiscated         DomainStatus = "Confiscated"
	DomainStatusDisabled            DomainStatus = "Disabled"
	DomainStatusExcluded            DomainStatus = "Excluded"
	DomainStatusExpired             DomainStatus = "Expired"
	DomainStatusFailed              DomainStatus = "Failed"
	DomainStatusHeld                DomainStatus = "Held"
	DomainStatusJsonConverterFailed DomainStatus = "JsonConverterFailed"
	DomainStatusLocked              DomainStatus = "Locked"
	DomainStatusParked              DomainStatus = "Parked"
	DomainStatusPending             DomainStatus = "Pending"
	DomainStatusReserved            DomainStatus = "Reserved"
	DomainStatusReverted            DomainStatus = "Reverted"
	DomainStatusSuspended           DomainStatus = "Suspended"
	DomainStatusTransferred         DomainStatus = "Transferred"
	DomainStatusUnknown             DomainStatus = "Unknown"
	DomainStatusUnlocked            DomainStatus = "Unlocked"
	DomainStatusUnparked            DomainStatus = "Unparked"
	DomainStatusUpdated             DomainStatus = "Updated"
)

func (*DomainStatus) UnmarshalJSON 

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

type DomainType 

type DomainType string
const (
	DomainTypeRegular     DomainType = "Regular"
	DomainTypeSoftDeleted DomainType = "SoftDeleted"
)

func (*DomainType) UnmarshalJSON 

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

type DomainsClient 

type DomainsClient struct {
	Client *resourcemanager.Client
}

func NewDomainsClientWithBaseURI 

func NewDomainsClientWithBaseURI(sdkApi sdkEnv.Api) (*DomainsClient, error)

func (DomainsClient) CheckAvailability 

func (c DomainsClient) CheckAvailability(ctx context.Context, id commonids.SubscriptionId, input NameIdentifier) (result CheckAvailabilityOperationResponse, err error)

CheckAvailability ...

func (DomainsClient) CreateOrUpdate 

func (c DomainsClient) CreateOrUpdate(ctx context.Context, id DomainId, input Domain) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DomainsClient) CreateOrUpdateOwnershipIdentifier 

func (c DomainsClient) CreateOrUpdateOwnershipIdentifier(ctx context.Context, id DomainOwnershipIdentifierId, input DomainOwnershipIdentifier) (result CreateOrUpdateOwnershipIdentifierOperationResponse, err error)

CreateOrUpdateOwnershipIdentifier ...

func (DomainsClient) CreateOrUpdateThenPoll 

func (c DomainsClient) CreateOrUpdateThenPoll(ctx context.Context, id DomainId, input Domain) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DomainsClient) Delete 

func (c DomainsClient) Delete(ctx context.Context, id DomainId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (DomainsClient) DeleteOwnershipIdentifier 

func (c DomainsClient) DeleteOwnershipIdentifier(ctx context.Context, id DomainOwnershipIdentifierId) (result DeleteOwnershipIdentifierOperationResponse, err error)

DeleteOwnershipIdentifier ...

func (DomainsClient) Get 

func (c DomainsClient) Get(ctx context.Context, id DomainId) (result GetOperationResponse, err error)

Get ...

func (DomainsClient) GetControlCenterSsoRequest 

func (c DomainsClient) GetControlCenterSsoRequest(ctx context.Context, id commonids.SubscriptionId) (result GetControlCenterSsoRequestOperationResponse, err error)

GetControlCenterSsoRequest ...

func (DomainsClient) GetOwnershipIdentifier 

func (c DomainsClient) GetOwnershipIdentifier(ctx context.Context, id DomainOwnershipIdentifierId) (result GetOwnershipIdentifierOperationResponse, err error)

GetOwnershipIdentifier ...

func (DomainsClient) List 

func (c DomainsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (DomainsClient) ListByResourceGroup 

func (c DomainsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (DomainsClient) ListByResourceGroupComplete 

func (c DomainsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (DomainsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c DomainsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate DomainOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainsClient) ListComplete 

func (c DomainsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DomainsClient) ListCompleteMatchingPredicate 

func (c DomainsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DomainOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainsClient) ListOwnershipIdentifiers 

func (c DomainsClient) ListOwnershipIdentifiers(ctx context.Context, id DomainId) (result ListOwnershipIdentifiersOperationResponse, err error)

ListOwnershipIdentifiers ...

func (DomainsClient) ListOwnershipIdentifiersComplete 

func (c DomainsClient) ListOwnershipIdentifiersComplete(ctx context.Context, id DomainId) (ListOwnershipIdentifiersCompleteResult, error)

ListOwnershipIdentifiersComplete retrieves all the results into a single object

func (DomainsClient) ListOwnershipIdentifiersCompleteMatchingPredicate 

func (c DomainsClient) ListOwnershipIdentifiersCompleteMatchingPredicate(ctx context.Context, id DomainId, predicate DomainOwnershipIdentifierOperationPredicate) (result ListOwnershipIdentifiersCompleteResult, err error)

ListOwnershipIdentifiersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainsClient) ListRecommendations 

func (c DomainsClient) ListRecommendations(ctx context.Context, id commonids.SubscriptionId, input DomainRecommendationSearchParameters) (result ListRecommendationsOperationResponse, err error)

ListRecommendations ...

func (DomainsClient) ListRecommendationsComplete 

func (c DomainsClient) ListRecommendationsComplete(ctx context.Context, id commonids.SubscriptionId, input DomainRecommendationSearchParameters) (ListRecommendationsCompleteResult, error)

ListRecommendationsComplete retrieves all the results into a single object

func (DomainsClient) ListRecommendationsCompleteMatchingPredicate 

func (c DomainsClient) ListRecommendationsCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, input DomainRecommendationSearchParameters, predicate NameIdentifierOperationPredicate) (result ListRecommendationsCompleteResult, err error)

ListRecommendationsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainsClient) Renew 

func (c DomainsClient) Renew(ctx context.Context, id DomainId) (result RenewOperationResponse, err error)

Renew ...

func (DomainsClient) TransferOut 

func (c DomainsClient) TransferOut(ctx context.Context, id DomainId) (result TransferOutOperationResponse, err error)

TransferOut ...

func (DomainsClient) Update 

func (c DomainsClient) Update(ctx context.Context, id DomainId, input DomainPatchResource) (result UpdateOperationResponse, err error)

Update ...

func (DomainsClient) UpdateOwnershipIdentifier 

func (c DomainsClient) UpdateOwnershipIdentifier(ctx context.Context, id DomainOwnershipIdentifierId, input DomainOwnershipIdentifier) (result UpdateOwnershipIdentifierOperationResponse, err error)

UpdateOwnershipIdentifier ...

type GetControlCenterSsoRequestOperationResponse 

type GetControlCenterSsoRequestOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainControlCenterSsoRequest
}

type GetOperationResponse 

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

type GetOwnershipIdentifierOperationResponse 

type GetOwnershipIdentifierOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainOwnershipIdentifier
}

type HostName 

type HostName struct {
	AzureResourceName           *string                      `json:"azureResourceName,omitempty"`
	AzureResourceType           *AzureResourceType           `json:"azureResourceType,omitempty"`
	CustomHostNameDnsRecordType *CustomHostNameDnsRecordType `json:"customHostNameDnsRecordType,omitempty"`
	HostNameType                *HostNameType                `json:"hostNameType,omitempty"`
	Name                        *string                      `json:"name,omitempty"`
	SiteNames                   *[]string                    `json:"siteNames,omitempty"`
}

type HostNameType 

type HostNameType string
const (
	HostNameTypeManaged  HostNameType = "Managed"
	HostNameTypeVerified HostNameType = "Verified"
)

func (*HostNameType) UnmarshalJSON 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

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

type ListOwnershipIdentifiersCompleteResult 

type ListOwnershipIdentifiersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DomainOwnershipIdentifier
}

type ListOwnershipIdentifiersOperationResponse 

type ListOwnershipIdentifiersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DomainOwnershipIdentifier
}

type ListRecommendationsCompleteResult 

type ListRecommendationsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NameIdentifier
}

type ListRecommendationsOperationResponse 

type ListRecommendationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NameIdentifier
}

type NameIdentifier 

type NameIdentifier struct {
	Name *string `json:"name,omitempty"`
}

type NameIdentifierOperationPredicate 

type NameIdentifierOperationPredicate struct {
	Name *string
}

func (NameIdentifierOperationPredicate) Matches 

func (p NameIdentifierOperationPredicate) Matches(input NameIdentifier) bool

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateDeleting   ProvisioningState = "Deleting"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RenewOperationResponse 

type RenewOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ResourceNotRenewableReason 

type ResourceNotRenewableReason string
const (
	ResourceNotRenewableReasonExpirationNotInRenewalTimeRange          ResourceNotRenewableReason = "ExpirationNotInRenewalTimeRange"
	ResourceNotRenewableReasonRegistrationStatusNotSupportedForRenewal ResourceNotRenewableReason = "RegistrationStatusNotSupportedForRenewal"
	ResourceNotRenewableReasonSubscriptionNotActive                    ResourceNotRenewableReason = "SubscriptionNotActive"
)

func (*ResourceNotRenewableReason) UnmarshalJSON 

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

type TransferOutOperationResponse 

type TransferOutOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Domain
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Domain
}

type UpdateOwnershipIdentifierOperationResponse 

type UpdateOwnershipIdentifierOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainOwnershipIdentifier
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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