topleveldomains

README

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

The topleveldomains SDK allows for interaction with the Azure Resource Manager Service web (API Version 2023-01-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-01-01/topleveldomains"

Client Initialization

client := topleveldomains.NewTopLevelDomainsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TopLevelDomainsClient.Get

ctx := context.TODO()
id := topleveldomains.NewTopLevelDomainID("12345678-1234-9876-4563-123456789012", "topLevelDomainValue")

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: TopLevelDomainsClient.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: TopLevelDomainsClient.ListAgreements

ctx := context.TODO()
id := topleveldomains.NewTopLevelDomainID("12345678-1234-9876-4563-123456789012", "topLevelDomainValue")

payload := topleveldomains.TopLevelDomainAgreementOption{
	// ...
}


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

Documentation

Index

• func ValidateTopLevelDomainID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListAgreementsCompleteResult
• type ListAgreementsOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type TldLegalAgreement
• type TldLegalAgreementOperationPredicate
  • func (p TldLegalAgreementOperationPredicate) Matches(input TldLegalAgreement) bool
• type TopLevelDomain
• type TopLevelDomainAgreementOption
• type TopLevelDomainId
  • func NewTopLevelDomainID(subscriptionId string, topLevelDomainName string) TopLevelDomainId
  • func ParseTopLevelDomainID(input string) (*TopLevelDomainId, error)
  • func ParseTopLevelDomainIDInsensitively(input string) (*TopLevelDomainId, error)
  • func (id *TopLevelDomainId) FromParseResult(input resourceids.ParseResult) error
  • func (id TopLevelDomainId) ID() string
  • func (id TopLevelDomainId) Segments() []resourceids.Segment
  • func (id TopLevelDomainId) String() string
• type TopLevelDomainOperationPredicate
  • func (p TopLevelDomainOperationPredicate) Matches(input TopLevelDomain) bool
• type TopLevelDomainProperties
• type TopLevelDomainsClient
  • func NewTopLevelDomainsClientWithBaseURI(sdkApi sdkEnv.Api) (*TopLevelDomainsClient, error)
  • func (c TopLevelDomainsClient) Get(ctx context.Context, id TopLevelDomainId) (result GetOperationResponse, err error)
  • func (c TopLevelDomainsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c TopLevelDomainsClient) ListAgreements(ctx context.Context, id TopLevelDomainId, input TopLevelDomainAgreementOption) (result ListAgreementsOperationResponse, err error)
  • func (c TopLevelDomainsClient) ListAgreementsComplete(ctx context.Context, id TopLevelDomainId, input TopLevelDomainAgreementOption) (ListAgreementsCompleteResult, error)
  • func (c TopLevelDomainsClient) ListAgreementsCompleteMatchingPredicate(ctx context.Context, id TopLevelDomainId, input TopLevelDomainAgreementOption, ...) (result ListAgreementsCompleteResult, err error)
  • func (c TopLevelDomainsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c TopLevelDomainsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)

Functions

func ValidateTopLevelDomainID

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

ValidateTopLevelDomainID checks that 'input' can be parsed as a Top Level Domain ID

Types

type GetOperationResponse

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

type ListAgreementsCompleteResult

type ListAgreementsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TldLegalAgreement
}

type ListAgreementsOperationResponse

type ListAgreementsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TldLegalAgreement
}

type ListCompleteResult

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

type ListOperationResponse

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

type TldLegalAgreement

type TldLegalAgreement struct {
	AgreementKey string  `json:"agreementKey"`
	Content      string  `json:"content"`
	Title        string  `json:"title"`
	Url          *string `json:"url,omitempty"`
}

type TldLegalAgreementOperationPredicate

type TldLegalAgreementOperationPredicate struct {
	AgreementKey *string
	Content      *string
	Title        *string
	Url          *string
}

func (TldLegalAgreementOperationPredicate) Matches

func (p TldLegalAgreementOperationPredicate) Matches(input TldLegalAgreement) bool

type TopLevelDomain

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

type TopLevelDomainAgreementOption

type TopLevelDomainAgreementOption struct {
	ForTransfer    *bool `json:"forTransfer,omitempty"`
	IncludePrivacy *bool `json:"includePrivacy,omitempty"`
}

type TopLevelDomainId

type TopLevelDomainId struct {
	SubscriptionId     string
	TopLevelDomainName string
}

TopLevelDomainId is a struct representing the Resource ID for a Top Level Domain

func NewTopLevelDomainID

func NewTopLevelDomainID(subscriptionId string, topLevelDomainName string) TopLevelDomainId

NewTopLevelDomainID returns a new TopLevelDomainId struct

func ParseTopLevelDomainID

func ParseTopLevelDomainID(input string) (*TopLevelDomainId, error)

ParseTopLevelDomainID parses 'input' into a TopLevelDomainId

func ParseTopLevelDomainIDInsensitively

func ParseTopLevelDomainIDInsensitively(input string) (*TopLevelDomainId, error)

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

func (*TopLevelDomainId) FromParseResult

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

func (TopLevelDomainId) ID

func (id TopLevelDomainId) ID() string

ID returns the formatted Top Level Domain ID

func (TopLevelDomainId) Segments

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

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

func (TopLevelDomainId) String

func (id TopLevelDomainId) String() string

String returns a human-readable description of this Top Level Domain ID

type TopLevelDomainOperationPredicate

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

func (TopLevelDomainOperationPredicate) Matches

func (p TopLevelDomainOperationPredicate) Matches(input TopLevelDomain) bool

type TopLevelDomainProperties

type TopLevelDomainProperties struct {
	Privacy *bool `json:"privacy,omitempty"`
}

type TopLevelDomainsClient

type TopLevelDomainsClient struct {
	Client *resourcemanager.Client
}

func NewTopLevelDomainsClientWithBaseURI

func NewTopLevelDomainsClientWithBaseURI(sdkApi sdkEnv.Api) (*TopLevelDomainsClient, error)

func (TopLevelDomainsClient) Get

func (c TopLevelDomainsClient) Get(ctx context.Context, id TopLevelDomainId) (result GetOperationResponse, err error)

Get ...

func (TopLevelDomainsClient) List

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

List ...

func (TopLevelDomainsClient) ListAgreements

func (c TopLevelDomainsClient) ListAgreements(ctx context.Context, id TopLevelDomainId, input TopLevelDomainAgreementOption) (result ListAgreementsOperationResponse, err error)

ListAgreements ...

func (TopLevelDomainsClient) ListAgreementsComplete

func (c TopLevelDomainsClient) ListAgreementsComplete(ctx context.Context, id TopLevelDomainId, input TopLevelDomainAgreementOption) (ListAgreementsCompleteResult, error)

ListAgreementsComplete retrieves all the results into a single object

func (TopLevelDomainsClient) ListAgreementsCompleteMatchingPredicate

func (c TopLevelDomainsClient) ListAgreementsCompleteMatchingPredicate(ctx context.Context, id TopLevelDomainId, input TopLevelDomainAgreementOption, predicate TldLegalAgreementOperationPredicate) (result ListAgreementsCompleteResult, err error)

ListAgreementsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TopLevelDomainsClient) ListComplete

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

ListComplete retrieves all the results into a single object

func (TopLevelDomainsClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate