nodetype

package
v0.20240522.1080424 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicefabricmanagedcluster/2021-05-01/nodetype Documentation

The nodetype SDK allows for interaction with the Azure Resource Manager Service servicefabricmanagedcluster (API Version 2021-05-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-sdk/resource-manager/servicefabricmanagedcluster/2021-05-01/nodetype"

Client Initialization

client := nodetype.NewNodeTypeClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NodeTypeClient.CreateOrUpdate

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

payload := nodetype.NodeType{
	// ...
}


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

Example Usage: NodeTypeClient.Delete

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

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

Example Usage: NodeTypeClient.DeleteNode

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

payload := nodetype.NodeTypeActionParameters{
	// ...
}


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

Example Usage: NodeTypeClient.Get

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

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: NodeTypeClient.ListByManagedClusters

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

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

Example Usage: NodeTypeClient.Reimage

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

payload := nodetype.NodeTypeActionParameters{
	// ...
}


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

Example Usage: NodeTypeClient.Restart

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

payload := nodetype.NodeTypeActionParameters{
	// ...
}


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

Example Usage: NodeTypeClient.Update

ctx := context.TODO()
id := nodetype.NewNodeTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "nodeTypeValue")

payload := nodetype.NodeTypeUpdateParameters{
	// ...
}


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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDiskType 

func PossibleValuesForDiskType() []string

func PossibleValuesForManagedResourceProvisioningState 

func PossibleValuesForManagedResourceProvisioningState() []string

func ValidateManagedClusterID 

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

ValidateManagedClusterID checks that 'input' can be parsed as a Managed Cluster ID

func ValidateNodeTypeID 

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

ValidateNodeTypeID checks that 'input' can be parsed as a Node Type ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteNodeOperationResponse 

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

type DeleteOperationResponse 

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

type DiskType 

type DiskType string
const (
	DiskTypePremiumLRS     DiskType = "Premium_LRS"
	DiskTypeStandardLRS    DiskType = "Standard_LRS"
	DiskTypeStandardSSDLRS DiskType = "StandardSSD_LRS"
)

func (*DiskType) UnmarshalJSON added in v0.20240126.1105227 

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

type EndpointRangeDescription 

type EndpointRangeDescription struct {
	EndPort   int64 `json:"endPort"`
	StartPort int64 `json:"startPort"`
}

type GetOperationResponse 

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

type ListByManagedClustersCompleteResult 

type ListByManagedClustersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NodeType
}

type ListByManagedClustersOperationResponse 

type ListByManagedClustersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NodeType
}

type ManagedClusterId 

type ManagedClusterId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ManagedClusterName string
}

ManagedClusterId is a struct representing the Resource ID for a Managed Cluster

func NewManagedClusterID 

func NewManagedClusterID(subscriptionId string, resourceGroupName string, managedClusterName string) ManagedClusterId

NewManagedClusterID returns a new ManagedClusterId struct

func ParseManagedClusterID 

func ParseManagedClusterID(input string) (*ManagedClusterId, error)

ParseManagedClusterID parses 'input' into a ManagedClusterId

func ParseManagedClusterIDInsensitively 

func ParseManagedClusterIDInsensitively(input string) (*ManagedClusterId, error)

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

func (*ManagedClusterId) FromParseResult 

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

func (ManagedClusterId) ID 

func (id ManagedClusterId) ID() string

ID returns the formatted Managed Cluster ID

func (ManagedClusterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Cluster ID

func (ManagedClusterId) String 

func (id ManagedClusterId) String() string

String returns a human-readable description of this Managed Cluster ID

type ManagedResourceProvisioningState 

type ManagedResourceProvisioningState string
const (
	ManagedResourceProvisioningStateCanceled  ManagedResourceProvisioningState = "Canceled"
	ManagedResourceProvisioningStateCreated   ManagedResourceProvisioningState = "Created"
	ManagedResourceProvisioningStateCreating  ManagedResourceProvisioningState = "Creating"
	ManagedResourceProvisioningStateDeleted   ManagedResourceProvisioningState = "Deleted"
	ManagedResourceProvisioningStateDeleting  ManagedResourceProvisioningState = "Deleting"
	ManagedResourceProvisioningStateFailed    ManagedResourceProvisioningState = "Failed"
	ManagedResourceProvisioningStateNone      ManagedResourceProvisioningState = "None"
	ManagedResourceProvisioningStateOther     ManagedResourceProvisioningState = "Other"
	ManagedResourceProvisioningStateSucceeded ManagedResourceProvisioningState = "Succeeded"
	ManagedResourceProvisioningStateUpdating  ManagedResourceProvisioningState = "Updating"
)

func (*ManagedResourceProvisioningState) UnmarshalJSON added in v0.20240126.1105227 

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

type NodeType 

type NodeType struct {
	Id         *string             `json:"id,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Properties *NodeTypeProperties `json:"properties,omitempty"`
	SystemData *SystemData         `json:"systemData,omitempty"`
	Tags       *map[string]string  `json:"tags,omitempty"`
	Type       *string             `json:"type,omitempty"`
}

type NodeTypeActionParameters 

type NodeTypeActionParameters struct {
	Force *bool    `json:"force,omitempty"`
	Nodes []string `json:"nodes"`
}

type NodeTypeClient 

type NodeTypeClient struct {
	Client *resourcemanager.Client
}

func NewNodeTypeClientWithBaseURI 

func NewNodeTypeClientWithBaseURI(sdkApi sdkEnv.Api) (*NodeTypeClient, error)

func (NodeTypeClient) CreateOrUpdate 

func (c NodeTypeClient) CreateOrUpdate(ctx context.Context, id NodeTypeId, input NodeType) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NodeTypeClient) CreateOrUpdateThenPoll 

func (c NodeTypeClient) CreateOrUpdateThenPoll(ctx context.Context, id NodeTypeId, input NodeType) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (NodeTypeClient) Delete 

func (c NodeTypeClient) Delete(ctx context.Context, id NodeTypeId) (result DeleteOperationResponse, err error)

Delete ...

func (NodeTypeClient) DeleteNode 

func (c NodeTypeClient) DeleteNode(ctx context.Context, id NodeTypeId, input NodeTypeActionParameters) (result DeleteNodeOperationResponse, err error)

DeleteNode ...

func (NodeTypeClient) DeleteNodeThenPoll 

func (c NodeTypeClient) DeleteNodeThenPoll(ctx context.Context, id NodeTypeId, input NodeTypeActionParameters) error

DeleteNodeThenPoll performs DeleteNode then polls until it's completed

func (NodeTypeClient) DeleteThenPoll 

func (c NodeTypeClient) DeleteThenPoll(ctx context.Context, id NodeTypeId) error

DeleteThenPoll performs Delete then polls until it's completed

func (NodeTypeClient) Get 

func (c NodeTypeClient) Get(ctx context.Context, id NodeTypeId) (result GetOperationResponse, err error)

Get ...

func (NodeTypeClient) ListByManagedClusters 

func (c NodeTypeClient) ListByManagedClusters(ctx context.Context, id ManagedClusterId) (result ListByManagedClustersOperationResponse, err error)

ListByManagedClusters ...

func (NodeTypeClient) ListByManagedClustersComplete 

func (c NodeTypeClient) ListByManagedClustersComplete(ctx context.Context, id ManagedClusterId) (ListByManagedClustersCompleteResult, error)

ListByManagedClustersComplete retrieves all the results into a single object

func (NodeTypeClient) ListByManagedClustersCompleteMatchingPredicate 

func (c NodeTypeClient) ListByManagedClustersCompleteMatchingPredicate(ctx context.Context, id ManagedClusterId, predicate NodeTypeOperationPredicate) (result ListByManagedClustersCompleteResult, err error)

ListByManagedClustersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NodeTypeClient) Reimage 

func (c NodeTypeClient) Reimage(ctx context.Context, id NodeTypeId, input NodeTypeActionParameters) (result ReimageOperationResponse, err error)

Reimage ...

func (NodeTypeClient) ReimageThenPoll 

func (c NodeTypeClient) ReimageThenPoll(ctx context.Context, id NodeTypeId, input NodeTypeActionParameters) error

ReimageThenPoll performs Reimage then polls until it's completed

func (NodeTypeClient) Restart 

func (c NodeTypeClient) Restart(ctx context.Context, id NodeTypeId, input NodeTypeActionParameters) (result RestartOperationResponse, err error)

Restart ...

func (NodeTypeClient) RestartThenPoll 

func (c NodeTypeClient) RestartThenPoll(ctx context.Context, id NodeTypeId, input NodeTypeActionParameters) error

RestartThenPoll performs Restart then polls until it's completed

func (NodeTypeClient) Update 

func (c NodeTypeClient) Update(ctx context.Context, id NodeTypeId, input NodeTypeUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type NodeTypeId 

type NodeTypeId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ManagedClusterName string
	NodeTypeName       string
}

NodeTypeId is a struct representing the Resource ID for a Node Type

func NewNodeTypeID 

func NewNodeTypeID(subscriptionId string, resourceGroupName string, managedClusterName string, nodeTypeName string) NodeTypeId

NewNodeTypeID returns a new NodeTypeId struct

func ParseNodeTypeID 

func ParseNodeTypeID(input string) (*NodeTypeId, error)

ParseNodeTypeID parses 'input' into a NodeTypeId

func ParseNodeTypeIDInsensitively 

func ParseNodeTypeIDInsensitively(input string) (*NodeTypeId, error)

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

func (*NodeTypeId) FromParseResult 

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

func (NodeTypeId) ID 

func (id NodeTypeId) ID() string

ID returns the formatted Node Type ID

func (NodeTypeId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Node Type ID

func (NodeTypeId) String 

func (id NodeTypeId) String() string

String returns a human-readable description of this Node Type ID

type NodeTypeOperationPredicate 

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

func (NodeTypeOperationPredicate) Matches 

func (p NodeTypeOperationPredicate) Matches(input NodeType) bool

type NodeTypeProperties 

type NodeTypeProperties struct {
	ApplicationPorts        *EndpointRangeDescription         `json:"applicationPorts,omitempty"`
	Capacities              *map[string]string                `json:"capacities,omitempty"`
	DataDiskSizeGB          int64                             `json:"dataDiskSizeGB"`
	DataDiskType            *DiskType                         `json:"dataDiskType,omitempty"`
	EphemeralPorts          *EndpointRangeDescription         `json:"ephemeralPorts,omitempty"`
	IsPrimary               bool                              `json:"isPrimary"`
	IsStateless             *bool                             `json:"isStateless,omitempty"`
	MultiplePlacementGroups *bool                             `json:"multiplePlacementGroups,omitempty"`
	PlacementProperties     *map[string]string                `json:"placementProperties,omitempty"`
	ProvisioningState       *ManagedResourceProvisioningState `json:"provisioningState,omitempty"`
	VMExtensions            *[]VMSSExtension                  `json:"vmExtensions,omitempty"`
	VMImageOffer            *string                           `json:"vmImageOffer,omitempty"`
	VMImagePublisher        *string                           `json:"vmImagePublisher,omitempty"`
	VMImageSku              *string                           `json:"vmImageSku,omitempty"`
	VMImageVersion          *string                           `json:"vmImageVersion,omitempty"`
	VMInstanceCount         int64                             `json:"vmInstanceCount"`
	VMManagedIdentity       *identity.UserAssignedList        `json:"vmManagedIdentity,omitempty"`
	VMSecrets               *[]VaultSecretGroup               `json:"vmSecrets,omitempty"`
	VMSize                  *string                           `json:"vmSize,omitempty"`
}

type NodeTypeUpdateParameters 

type NodeTypeUpdateParameters struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type ReimageOperationResponse 

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

type RestartOperationResponse 

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

type SubResource 

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

type SystemData 

type SystemData struct {
	CreatedAt          *string `json:"createdAt,omitempty"`
	CreatedBy          *string `json:"createdBy,omitempty"`
	CreatedByType      *string `json:"createdByType,omitempty"`
	LastModifiedAt     *string `json:"lastModifiedAt,omitempty"`
	LastModifiedBy     *string `json:"lastModifiedBy,omitempty"`
	LastModifiedByType *string `json:"lastModifiedByType,omitempty"`
}

func (*SystemData) GetCreatedAtAsTime 

func (o *SystemData) GetCreatedAtAsTime() (*time.Time, error)

func (*SystemData) GetLastModifiedAtAsTime 

func (o *SystemData) GetLastModifiedAtAsTime() (*time.Time, error)

func (*SystemData) SetCreatedAtAsTime 

func (o *SystemData) SetCreatedAtAsTime(input time.Time)

func (*SystemData) SetLastModifiedAtAsTime 

func (o *SystemData) SetLastModifiedAtAsTime(input time.Time)

type UpdateOperationResponse 

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

type VMSSExtension 

type VMSSExtension struct {
	Name       string                  `json:"name"`
	Properties VMSSExtensionProperties `json:"properties"`
}

type VMSSExtensionProperties 

type VMSSExtensionProperties struct {
	AutoUpgradeMinorVersion  *bool        `json:"autoUpgradeMinorVersion,omitempty"`
	ForceUpdateTag           *string      `json:"forceUpdateTag,omitempty"`
	ProtectedSettings        *interface{} `json:"protectedSettings,omitempty"`
	ProvisionAfterExtensions *[]string    `json:"provisionAfterExtensions,omitempty"`
	ProvisioningState        *string      `json:"provisioningState,omitempty"`
	Publisher                string       `json:"publisher"`
	Settings                 *interface{} `json:"settings,omitempty"`
	Type                     string       `json:"type"`
	TypeHandlerVersion       string       `json:"typeHandlerVersion"`
}

type VaultCertificate 

type VaultCertificate struct {
	CertificateStore string `json:"certificateStore"`
	CertificateUrl   string `json:"certificateUrl"`
}

type VaultSecretGroup 

type VaultSecretGroup struct {
	SourceVault       SubResource        `json:"sourceVault"`
	VaultCertificates []VaultCertificate `json:"vaultCertificates"`
}

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.