domains

package
v0.20240320.1000025 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/domains Documentation

The domains SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2022-06-15).

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/eventgrid/2022-06-15/domains"

Client Initialization

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

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.Delete

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

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

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.ListByResourceGroup

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

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

Example Usage: DomainsClient.ListBySubscription

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

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

Example Usage: DomainsClient.ListSharedAccessKeys

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

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

Example Usage: DomainsClient.RegenerateKey

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

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


read, err := client.RegenerateKey(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.Update

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

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


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataResidencyBoundary 

func PossibleValuesForDataResidencyBoundary() []string

func PossibleValuesForDomainProvisioningState 

func PossibleValuesForDomainProvisioningState() []string

func PossibleValuesForIPActionType 

func PossibleValuesForIPActionType() []string

func PossibleValuesForInputSchema 

func PossibleValuesForInputSchema() []string

func PossibleValuesForInputSchemaMappingType 

func PossibleValuesForInputSchemaMappingType() []string

func PossibleValuesForPersistedConnectionStatus 

func PossibleValuesForPersistedConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForResourceProvisioningState 

func PossibleValuesForResourceProvisioningState() []string

func ValidateDomainID 

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

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

Types

type ConnectionState 

type ConnectionState struct {
	ActionsRequired *string                    `json:"actionsRequired,omitempty"`
	Description     *string                    `json:"description,omitempty"`
	Status          *PersistedConnectionStatus `json:"status,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DataResidencyBoundary 

type DataResidencyBoundary string
const (
	DataResidencyBoundaryWithinGeopair DataResidencyBoundary = "WithinGeopair"
	DataResidencyBoundaryWithinRegion  DataResidencyBoundary = "WithinRegion"
)

func (*DataResidencyBoundary) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type Domain 

type Domain struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *DomainProperties                  `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,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
	Location *string
	Name     *string
	Type     *string
}

func (DomainOperationPredicate) Matches 

func (p DomainOperationPredicate) Matches(input Domain) bool

type DomainProperties 

type DomainProperties struct {
	AutoCreateTopicWithFirstSubscription *bool                        `json:"autoCreateTopicWithFirstSubscription,omitempty"`
	AutoDeleteTopicWithLastSubscription  *bool                        `json:"autoDeleteTopicWithLastSubscription,omitempty"`
	DataResidencyBoundary                *DataResidencyBoundary       `json:"dataResidencyBoundary,omitempty"`
	DisableLocalAuth                     *bool                        `json:"disableLocalAuth,omitempty"`
	Endpoint                             *string                      `json:"endpoint,omitempty"`
	InboundIPRules                       *[]InboundIPRule             `json:"inboundIpRules,omitempty"`
	InputSchema                          *InputSchema                 `json:"inputSchema,omitempty"`
	InputSchemaMapping                   InputSchemaMapping           `json:"inputSchemaMapping"`
	MetricResourceId                     *string                      `json:"metricResourceId,omitempty"`
	PrivateEndpointConnections           *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                    *DomainProvisioningState     `json:"provisioningState,omitempty"`
	PublicNetworkAccess                  *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
}

func (*DomainProperties) UnmarshalJSON 

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

type DomainProvisioningState 

type DomainProvisioningState string
const (
	DomainProvisioningStateCanceled  DomainProvisioningState = "Canceled"
	DomainProvisioningStateCreating  DomainProvisioningState = "Creating"
	DomainProvisioningStateDeleting  DomainProvisioningState = "Deleting"
	DomainProvisioningStateFailed    DomainProvisioningState = "Failed"
	DomainProvisioningStateSucceeded DomainProvisioningState = "Succeeded"
	DomainProvisioningStateUpdating  DomainProvisioningState = "Updating"
)

func (*DomainProvisioningState) UnmarshalJSON 

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

type DomainRegenerateKeyRequest 

type DomainRegenerateKeyRequest struct {
	KeyName string `json:"keyName"`
}

type DomainSharedAccessKeys 

type DomainSharedAccessKeys struct {
	Key1 *string `json:"key1,omitempty"`
	Key2 *string `json:"key2,omitempty"`
}

type DomainUpdateParameterProperties 

type DomainUpdateParameterProperties struct {
	AutoCreateTopicWithFirstSubscription *bool                  `json:"autoCreateTopicWithFirstSubscription,omitempty"`
	AutoDeleteTopicWithLastSubscription  *bool                  `json:"autoDeleteTopicWithLastSubscription,omitempty"`
	DataResidencyBoundary                *DataResidencyBoundary `json:"dataResidencyBoundary,omitempty"`
	DisableLocalAuth                     *bool                  `json:"disableLocalAuth,omitempty"`
	InboundIPRules                       *[]InboundIPRule       `json:"inboundIpRules,omitempty"`
	PublicNetworkAccess                  *PublicNetworkAccess   `json:"publicNetworkAccess,omitempty"`
}

type DomainUpdateParameters 

type DomainUpdateParameters struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *DomainUpdateParameterProperties   `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type DomainsClient 

type DomainsClient struct {
	Client *resourcemanager.Client
}

func NewDomainsClientWithBaseURI 

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

func (DomainsClient) CreateOrUpdate 

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

CreateOrUpdate ...

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) (result DeleteOperationResponse, err error)

Delete ...

func (DomainsClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (DomainsClient) Get 

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

Get ...

func (DomainsClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (DomainsClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (DomainsClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainsClient) ListBySubscription 

func (c DomainsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (DomainsClient) ListBySubscriptionComplete 

func (c DomainsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (DomainsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c DomainsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate DomainOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainsClient) ListSharedAccessKeys 

func (c DomainsClient) ListSharedAccessKeys(ctx context.Context, id DomainId) (result ListSharedAccessKeysOperationResponse, err error)

ListSharedAccessKeys ...

func (DomainsClient) RegenerateKey 

func (c DomainsClient) RegenerateKey(ctx context.Context, id DomainId, input DomainRegenerateKeyRequest) (result RegenerateKeyOperationResponse, err error)

RegenerateKey ...

func (DomainsClient) Update 

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

Update ...

func (DomainsClient) UpdateThenPoll 

func (c DomainsClient) UpdateThenPoll(ctx context.Context, id DomainId, input DomainUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse 

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

type IPActionType 

type IPActionType string
const (
	IPActionTypeAllow IPActionType = "Allow"
)

func (*IPActionType) UnmarshalJSON 

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

type InboundIPRule 

type InboundIPRule struct {
	Action *IPActionType `json:"action,omitempty"`
	IPMask *string       `json:"ipMask,omitempty"`
}

type InputSchema 

type InputSchema string
const (
	InputSchemaCloudEventSchemaVOneZero InputSchema = "CloudEventSchemaV1_0"
	InputSchemaCustomEventSchema        InputSchema = "CustomEventSchema"
	InputSchemaEventGridSchema          InputSchema = "EventGridSchema"
)

func (*InputSchema) UnmarshalJSON 

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

type InputSchemaMapping 

type InputSchemaMapping interface {
}

type InputSchemaMappingType 

type InputSchemaMappingType string
const (
	InputSchemaMappingTypeJson InputSchemaMappingType = "Json"
)

func (*InputSchemaMappingType) UnmarshalJSON 

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

type JsonField 

type JsonField struct {
	SourceField *string `json:"sourceField,omitempty"`
}

type JsonFieldWithDefault 

type JsonFieldWithDefault struct {
	DefaultValue *string `json:"defaultValue,omitempty"`
	SourceField  *string `json:"sourceField,omitempty"`
}

type JsonInputSchemaMapping 

type JsonInputSchemaMapping struct {
	Properties *JsonInputSchemaMappingProperties `json:"properties,omitempty"`
}

func (JsonInputSchemaMapping) MarshalJSON 

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

type JsonInputSchemaMappingProperties 

type JsonInputSchemaMappingProperties struct {
	DataVersion *JsonFieldWithDefault `json:"dataVersion,omitempty"`
	EventTime   *JsonField            `json:"eventTime,omitempty"`
	EventType   *JsonFieldWithDefault `json:"eventType,omitempty"`
	Id          *JsonField            `json:"id,omitempty"`
	Subject     *JsonFieldWithDefault `json:"subject,omitempty"`
	Topic       *JsonField            `json:"topic,omitempty"`
}

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders 

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

func (ListByResourceGroupOperationOptions) ToOData 

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

func (ListByResourceGroupOperationOptions) ToQuery 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders 

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

func (ListBySubscriptionOperationOptions) ToOData 

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

func (ListBySubscriptionOperationOptions) ToQuery 

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

type ListBySubscriptionOperationResponse 

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

type ListSharedAccessKeysOperationResponse 

type ListSharedAccessKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainSharedAccessKeys
}

type PersistedConnectionStatus 

type PersistedConnectionStatus string
const (
	PersistedConnectionStatusApproved     PersistedConnectionStatus = "Approved"
	PersistedConnectionStatusDisconnected PersistedConnectionStatus = "Disconnected"
	PersistedConnectionStatusPending      PersistedConnectionStatus = "Pending"
	PersistedConnectionStatusRejected     PersistedConnectionStatus = "Rejected"
)

func (*PersistedConnectionStatus) UnmarshalJSON 

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

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                  `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint           `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *ConnectionState           `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *ResourceProvisioningState `json:"provisioningState,omitempty"`
}

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON 

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

type RawInputSchemaMappingImpl 

type RawInputSchemaMappingImpl struct {
	Type   string
	Values map[string]interface{}
}

RawInputSchemaMappingImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RegenerateKeyOperationResponse 

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainSharedAccessKeys
}

type ResourceProvisioningState 

type ResourceProvisioningState string
const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating  ResourceProvisioningState = "Updating"
)

func (*ResourceProvisioningState) UnmarshalJSON 

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

type UpdateOperationResponse 

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

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.