managednetwork

package
v0.20231019.1094042 Latest Latest
Warning

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

Go to latest
Published: Oct 19, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2023-04-01-preview/managednetwork Documentation

The managednetwork SDK allows for interaction with the Azure Resource Manager Service machinelearningservices (API Version 2023-04-01-preview).

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-sdk/resource-manager/machinelearningservices/2023-04-01-preview/managednetwork"

Client Initialization

client := managednetwork.NewManagedNetworkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedNetworkClient.ProvisionsProvisionManagedNetwork

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

payload := managednetwork.ManagedNetworkProvisionOptions{
	// ...
}


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

Example Usage: ManagedNetworkClient.SettingsRuleCreateOrUpdate

ctx := context.TODO()
id := managednetwork.NewOutboundRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "outboundRuleValue")

payload := managednetwork.OutboundRuleBasicResource{
	// ...
}


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

Example Usage: ManagedNetworkClient.SettingsRuleDelete

ctx := context.TODO()
id := managednetwork.NewOutboundRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "outboundRuleValue")

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

Example Usage: ManagedNetworkClient.SettingsRuleGet

ctx := context.TODO()
id := managednetwork.NewOutboundRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "outboundRuleValue")

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

Example Usage: ManagedNetworkClient.SettingsRuleList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForManagedNetworkStatus

func PossibleValuesForManagedNetworkStatus() []string

func PossibleValuesForRuleCategory

func PossibleValuesForRuleCategory() []string

func PossibleValuesForRuleStatus

func PossibleValuesForRuleStatus() []string

func PossibleValuesForRuleType

func PossibleValuesForRuleType() []string

func ValidateOutboundRuleID

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

ValidateOutboundRuleID checks that 'input' can be parsed as a Outbound Rule ID

func ValidateWorkspaceID

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type FqdnOutboundRule

type FqdnOutboundRule struct {
	Destination *string `json:"destination,omitempty"`

	// Fields inherited from OutboundRule
	Category *RuleCategory `json:"category,omitempty"`
	Status   *RuleStatus   `json:"status,omitempty"`
}

func (FqdnOutboundRule) MarshalJSON

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

type ManagedNetworkClient

type ManagedNetworkClient struct {
	Client *resourcemanager.Client
}

func NewManagedNetworkClientWithBaseURI

func NewManagedNetworkClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedNetworkClient, error)

func (ManagedNetworkClient) ProvisionsProvisionManagedNetwork

ProvisionsProvisionManagedNetwork ...

func (ManagedNetworkClient) ProvisionsProvisionManagedNetworkThenPoll

func (c ManagedNetworkClient) ProvisionsProvisionManagedNetworkThenPoll(ctx context.Context, id WorkspaceId, input ManagedNetworkProvisionOptions) error

ProvisionsProvisionManagedNetworkThenPoll performs ProvisionsProvisionManagedNetwork then polls until it's completed

func (ManagedNetworkClient) SettingsRuleCreateOrUpdate

SettingsRuleCreateOrUpdate ...

func (ManagedNetworkClient) SettingsRuleCreateOrUpdateThenPoll

func (c ManagedNetworkClient) SettingsRuleCreateOrUpdateThenPoll(ctx context.Context, id OutboundRuleId, input OutboundRuleBasicResource) error

SettingsRuleCreateOrUpdateThenPoll performs SettingsRuleCreateOrUpdate then polls until it's completed

func (ManagedNetworkClient) SettingsRuleDelete

SettingsRuleDelete ...

func (ManagedNetworkClient) SettingsRuleDeleteThenPoll

func (c ManagedNetworkClient) SettingsRuleDeleteThenPoll(ctx context.Context, id OutboundRuleId) error

SettingsRuleDeleteThenPoll performs SettingsRuleDelete then polls until it's completed

func (ManagedNetworkClient) SettingsRuleGet

SettingsRuleGet ...

func (ManagedNetworkClient) SettingsRuleList

func (c ManagedNetworkClient) SettingsRuleList(ctx context.Context, id WorkspaceId) (result SettingsRuleListOperationResponse, err error)

SettingsRuleList ...

func (ManagedNetworkClient) SettingsRuleListComplete

SettingsRuleListComplete retrieves all the results into a single object

func (ManagedNetworkClient) SettingsRuleListCompleteMatchingPredicate

func (c ManagedNetworkClient) SettingsRuleListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate OutboundRuleBasicResourceOperationPredicate) (result SettingsRuleListCompleteResult, err error)

SettingsRuleListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ManagedNetworkProvisionOptions

type ManagedNetworkProvisionOptions struct {
	IncludeSpark *bool `json:"includeSpark,omitempty"`
}

type ManagedNetworkProvisionStatus

type ManagedNetworkProvisionStatus struct {
	SparkReady *bool                 `json:"sparkReady,omitempty"`
	Status     *ManagedNetworkStatus `json:"status,omitempty"`
}

type ManagedNetworkStatus

type ManagedNetworkStatus string
const (
	ManagedNetworkStatusActive   ManagedNetworkStatus = "Active"
	ManagedNetworkStatusInactive ManagedNetworkStatus = "Inactive"
)

func (*ManagedNetworkStatus) UnmarshalJSON

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

type OutboundRule

type OutboundRule interface {
}

type OutboundRuleBasicResource

type OutboundRuleBasicResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties OutboundRule           `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (*OutboundRuleBasicResource) UnmarshalJSON

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

type OutboundRuleBasicResourceOperationPredicate

type OutboundRuleBasicResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (OutboundRuleBasicResourceOperationPredicate) Matches

type OutboundRuleId

type OutboundRuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	OutboundRuleName  string
}

OutboundRuleId is a struct representing the Resource ID for a Outbound Rule

func NewOutboundRuleID

func NewOutboundRuleID(subscriptionId string, resourceGroupName string, workspaceName string, outboundRuleName string) OutboundRuleId

NewOutboundRuleID returns a new OutboundRuleId struct

func ParseOutboundRuleID

func ParseOutboundRuleID(input string) (*OutboundRuleId, error)

ParseOutboundRuleID parses 'input' into a OutboundRuleId

func ParseOutboundRuleIDInsensitively

func ParseOutboundRuleIDInsensitively(input string) (*OutboundRuleId, error)

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

func (OutboundRuleId) ID

func (id OutboundRuleId) ID() string

ID returns the formatted Outbound Rule ID

func (OutboundRuleId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Outbound Rule ID

func (OutboundRuleId) String

func (id OutboundRuleId) String() string

String returns a human-readable description of this Outbound Rule ID

type PrivateEndpointDestination

type PrivateEndpointDestination struct {
	ServiceResourceId *string     `json:"serviceResourceId,omitempty"`
	SparkEnabled      *bool       `json:"sparkEnabled,omitempty"`
	SparkStatus       *RuleStatus `json:"sparkStatus,omitempty"`
	SubresourceTarget *string     `json:"subresourceTarget,omitempty"`
}

type PrivateEndpointOutboundRule

type PrivateEndpointOutboundRule struct {
	Destination *PrivateEndpointDestination `json:"destination,omitempty"`

	// Fields inherited from OutboundRule
	Category *RuleCategory `json:"category,omitempty"`
	Status   *RuleStatus   `json:"status,omitempty"`
}

func (PrivateEndpointOutboundRule) MarshalJSON

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

type ProvisionsProvisionManagedNetworkOperationResponse

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

type RawOutboundRuleImpl added in v0.20230807.1063129

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

RawOutboundRuleImpl 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 RuleCategory

type RuleCategory string
const (
	RuleCategoryRecommended RuleCategory = "Recommended"
	RuleCategoryRequired    RuleCategory = "Required"
	RuleCategoryUserDefined RuleCategory = "UserDefined"
)

func (*RuleCategory) UnmarshalJSON

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

type RuleStatus

type RuleStatus string
const (
	RuleStatusActive   RuleStatus = "Active"
	RuleStatusInactive RuleStatus = "Inactive"
)

func (*RuleStatus) UnmarshalJSON

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

type RuleType

type RuleType string
const (
	RuleTypeFQDN            RuleType = "FQDN"
	RuleTypePrivateEndpoint RuleType = "PrivateEndpoint"
	RuleTypeServiceTag      RuleType = "ServiceTag"
)

func (*RuleType) UnmarshalJSON

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

type ServiceTagDestination

type ServiceTagDestination struct {
	PortRanges *string `json:"portRanges,omitempty"`
	Protocol   *string `json:"protocol,omitempty"`
	ServiceTag *string `json:"serviceTag,omitempty"`
}

type ServiceTagOutboundRule

type ServiceTagOutboundRule struct {
	Destination *ServiceTagDestination `json:"destination,omitempty"`

	// Fields inherited from OutboundRule
	Category *RuleCategory `json:"category,omitempty"`
	Status   *RuleStatus   `json:"status,omitempty"`
}

func (ServiceTagOutboundRule) MarshalJSON

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

type SettingsRuleCreateOrUpdateOperationResponse

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

type SettingsRuleDeleteOperationResponse

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

type SettingsRuleGetOperationResponse

type SettingsRuleGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OutboundRuleBasicResource
}

type SettingsRuleListCompleteResult

type SettingsRuleListCompleteResult struct {
	Items []OutboundRuleBasicResource
}

type SettingsRuleListOperationResponse

type SettingsRuleListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]OutboundRuleBasicResource
}

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

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

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

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL