deploymentsettings

package
v0.20240327.1161949 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-08-01-preview/deploymentsettings Documentation

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

Client Initialization

client := deploymentsettings.NewDeploymentSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeploymentSettingsClient.CreateOrUpdate

ctx := context.TODO()
id := deploymentsettings.NewDeploymentSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "deploymentSettingValue")

payload := deploymentsettings.DeploymentSetting{
	// ...
}


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

Example Usage: DeploymentSettingsClient.Delete

ctx := context.TODO()
id := deploymentsettings.NewDeploymentSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "deploymentSettingValue")

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

Example Usage: DeploymentSettingsClient.Get

ctx := context.TODO()
id := deploymentsettings.NewDeploymentSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue", "deploymentSettingValue")

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: DeploymentSettingsClient.ListByClusters

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

// alternatively `client.ListByClusters(ctx, id)` can be used to do batched pagination
items, err := client.ListByClustersComplete(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 PossibleValuesForDeploymentMode

func PossibleValuesForDeploymentMode() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateClusterID

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

func ValidateDeploymentSettingID

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

ValidateDeploymentSettingID checks that 'input' can be parsed as a Deployment Setting ID

Types

type AdapterPropertyOverrides

type AdapterPropertyOverrides struct {
	JumboPacket             *string `json:"jumboPacket,omitempty"`
	NetworkDirect           *string `json:"networkDirect,omitempty"`
	NetworkDirectTechnology *string `json:"networkDirectTechnology,omitempty"`
}

type Cluster

type Cluster struct {
	AzureServiceEndpoint *string `json:"azureServiceEndpoint,omitempty"`
	CloudAccountName     *string `json:"cloudAccountName,omitempty"`
	Name                 *string `json:"name,omitempty"`
	WitnessPath          *string `json:"witnessPath,omitempty"`
	WitnessType          *string `json:"witnessType,omitempty"`
}

type ClusterId

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult

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

func (ClusterId) ID

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments

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

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

func (ClusterId) String

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type DeploymentConfiguration

type DeploymentConfiguration struct {
	ScaleUnits []ScaleUnits `json:"scaleUnits"`
	Version    *string      `json:"version,omitempty"`
}

type DeploymentData

type DeploymentData struct {
	AdouPath              *string                  `json:"adouPath,omitempty"`
	Cluster               *Cluster                 `json:"cluster,omitempty"`
	DomainFqdn            *string                  `json:"domainFqdn,omitempty"`
	HostNetwork           *HostNetwork             `json:"hostNetwork,omitempty"`
	InfrastructureNetwork *[]InfrastructureNetwork `json:"infrastructureNetwork,omitempty"`
	NamingPrefix          *string                  `json:"namingPrefix,omitempty"`
	Observability         *Observability           `json:"observability,omitempty"`
	OptionalServices      *OptionalServices        `json:"optionalServices,omitempty"`
	PhysicalNodes         *[]PhysicalNodes         `json:"physicalNodes,omitempty"`
	SecretsLocation       *string                  `json:"secretsLocation,omitempty"`
	SecuritySettings      *SecuritySettings        `json:"securitySettings,omitempty"`
	Storage               *Storage                 `json:"storage,omitempty"`
}

type DeploymentMode

type DeploymentMode string
const (
	DeploymentModeDeploy   DeploymentMode = "Deploy"
	DeploymentModeValidate DeploymentMode = "Validate"
)

func (*DeploymentMode) UnmarshalJSON

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

type DeploymentSetting

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

type DeploymentSettingId

type DeploymentSettingId struct {
	SubscriptionId        string
	ResourceGroupName     string
	ClusterName           string
	DeploymentSettingName string
}

DeploymentSettingId is a struct representing the Resource ID for a Deployment Setting

func NewDeploymentSettingID

func NewDeploymentSettingID(subscriptionId string, resourceGroupName string, clusterName string, deploymentSettingName string) DeploymentSettingId

NewDeploymentSettingID returns a new DeploymentSettingId struct

func ParseDeploymentSettingID

func ParseDeploymentSettingID(input string) (*DeploymentSettingId, error)

ParseDeploymentSettingID parses 'input' into a DeploymentSettingId

func ParseDeploymentSettingIDInsensitively

func ParseDeploymentSettingIDInsensitively(input string) (*DeploymentSettingId, error)

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

func (*DeploymentSettingId) FromParseResult

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

func (DeploymentSettingId) ID

func (id DeploymentSettingId) ID() string

ID returns the formatted Deployment Setting ID

func (DeploymentSettingId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Deployment Setting ID

func (DeploymentSettingId) String

func (id DeploymentSettingId) String() string

String returns a human-readable description of this Deployment Setting ID

type DeploymentSettingOperationPredicate

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

func (DeploymentSettingOperationPredicate) Matches

type DeploymentSettingsClient

type DeploymentSettingsClient struct {
	Client *resourcemanager.Client
}

func NewDeploymentSettingsClientWithBaseURI

func NewDeploymentSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*DeploymentSettingsClient, error)

func (DeploymentSettingsClient) CreateOrUpdate

CreateOrUpdate ...

func (DeploymentSettingsClient) CreateOrUpdateThenPoll

func (c DeploymentSettingsClient) CreateOrUpdateThenPoll(ctx context.Context, id DeploymentSettingId, input DeploymentSetting) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DeploymentSettingsClient) Delete

Delete ...

func (DeploymentSettingsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (DeploymentSettingsClient) Get

Get ...

func (DeploymentSettingsClient) ListByClusters

ListByClusters ...

func (DeploymentSettingsClient) ListByClustersComplete

ListByClustersComplete retrieves all the results into a single object

func (DeploymentSettingsClient) ListByClustersCompleteMatchingPredicate

func (c DeploymentSettingsClient) ListByClustersCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate DeploymentSettingOperationPredicate) (result ListByClustersCompleteResult, err error)

ListByClustersCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DeploymentSettingsProperties

type DeploymentSettingsProperties struct {
	ArcNodeResourceIds      []string                `json:"arcNodeResourceIds"`
	DeploymentConfiguration DeploymentConfiguration `json:"deploymentConfiguration"`
	DeploymentMode          DeploymentMode          `json:"deploymentMode"`
	ProvisioningState       *ProvisioningState      `json:"provisioningState,omitempty"`
	ReportedProperties      *ReportedProperties     `json:"reportedProperties,omitempty"`
}

type DeploymentStatus

type DeploymentStatus struct {
	Status *string `json:"status,omitempty"`
	Steps  *[]Step `json:"steps,omitempty"`
}

type GetOperationResponse

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

type HostNetwork

type HostNetwork struct {
	EnableStorageAutoIP           *bool              `json:"enableStorageAutoIp,omitempty"`
	Intents                       *[]Intents         `json:"intents,omitempty"`
	StorageConnectivitySwitchless *bool              `json:"storageConnectivitySwitchless,omitempty"`
	StorageNetworks               *[]StorageNetworks `json:"storageNetworks,omitempty"`
}

type IPPools

type IPPools struct {
	EndingAddress   *string `json:"endingAddress,omitempty"`
	StartingAddress *string `json:"startingAddress,omitempty"`
}

type InfrastructureNetwork

type InfrastructureNetwork struct {
	DnsServers *[]string  `json:"dnsServers,omitempty"`
	Gateway    *string    `json:"gateway,omitempty"`
	IPPools    *[]IPPools `json:"ipPools,omitempty"`
	SubnetMask *string    `json:"subnetMask,omitempty"`
	UseDhcp    *bool      `json:"useDhcp,omitempty"`
}

type Intents

type Intents struct {
	Adapter                             *[]string                            `json:"adapter,omitempty"`
	AdapterPropertyOverrides            *AdapterPropertyOverrides            `json:"adapterPropertyOverrides,omitempty"`
	Name                                *string                              `json:"name,omitempty"`
	OverrideAdapterProperty             *bool                                `json:"overrideAdapterProperty,omitempty"`
	OverrideQosPolicy                   *bool                                `json:"overrideQosPolicy,omitempty"`
	OverrideVirtualSwitchConfiguration  *bool                                `json:"overrideVirtualSwitchConfiguration,omitempty"`
	QosPolicyOverrides                  *QosPolicyOverrides                  `json:"qosPolicyOverrides,omitempty"`
	TrafficType                         *[]string                            `json:"trafficType,omitempty"`
	VirtualSwitchConfigurationOverrides *VirtualSwitchConfigurationOverrides `json:"virtualSwitchConfigurationOverrides,omitempty"`
}

type ListByClustersCompleteResult

type ListByClustersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DeploymentSetting
}

type ListByClustersOperationResponse

type ListByClustersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DeploymentSetting
}

type Observability

type Observability struct {
	EpisodicDataUpload  *bool `json:"episodicDataUpload,omitempty"`
	EuLocation          *bool `json:"euLocation,omitempty"`
	StreamingDataClient *bool `json:"streamingDataClient,omitempty"`
}

type OptionalServices

type OptionalServices struct {
	CustomLocation *string `json:"customLocation,omitempty"`
}

type PhysicalNodes

type PhysicalNodes struct {
	IPv4Address *string `json:"ipv4Address,omitempty"`
	Name        *string `json:"name,omitempty"`
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

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

type QosPolicyOverrides

type QosPolicyOverrides struct {
	BandwidthPercentageSMB         *string `json:"bandwidthPercentage_SMB,omitempty"`
	PriorityValue8021ActionCluster *string `json:"priorityValue8021Action_Cluster,omitempty"`
	PriorityValue8021ActionSMB     *string `json:"priorityValue8021Action_SMB,omitempty"`
}

type ReportedProperties

type ReportedProperties struct {
	DeploymentStatus *DeploymentStatus `json:"deploymentStatus,omitempty"`
	ValidationStatus *ValidationStatus `json:"validationStatus,omitempty"`
}

type ScaleUnits

type ScaleUnits struct {
	DeploymentData DeploymentData `json:"deploymentData"`
}

type SecuritySettings

type SecuritySettings struct {
	BitlockerBootVolume           *bool `json:"bitlockerBootVolume,omitempty"`
	BitlockerDataVolumes          *bool `json:"bitlockerDataVolumes,omitempty"`
	CredentialGuardEnforced       *bool `json:"credentialGuardEnforced,omitempty"`
	DriftControlEnforced          *bool `json:"driftControlEnforced,omitempty"`
	DrtmProtection                *bool `json:"drtmProtection,omitempty"`
	HvciProtection                *bool `json:"hvciProtection,omitempty"`
	SideChannelMitigationEnforced *bool `json:"sideChannelMitigationEnforced,omitempty"`
	SmbClusterEncryption          *bool `json:"smbClusterEncryption,omitempty"`
	SmbSigningEnforced            *bool `json:"smbSigningEnforced,omitempty"`
	WdacEnforced                  *bool `json:"wdacEnforced,omitempty"`
}

type Step

type Step struct {
	Description   *string   `json:"description,omitempty"`
	EndTimeUtc    *string   `json:"endTimeUtc,omitempty"`
	Exception     *[]string `json:"exception,omitempty"`
	FullStepIndex *string   `json:"fullStepIndex,omitempty"`
	Name          *string   `json:"name,omitempty"`
	StartTimeUtc  *string   `json:"startTimeUtc,omitempty"`
	Status        *string   `json:"status,omitempty"`
	Steps         *[]Step   `json:"steps,omitempty"`
}

type Storage

type Storage struct {
	ConfigurationMode *string `json:"configurationMode,omitempty"`
}

type StorageNetworks

type StorageNetworks struct {
	Name               *string `json:"name,omitempty"`
	NetworkAdapterName *string `json:"networkAdapterName,omitempty"`
	VlanId             *string `json:"vlanId,omitempty"`
}

type ValidationStatus

type ValidationStatus struct {
	Status *string `json:"status,omitempty"`
	Steps  *[]Step `json:"steps,omitempty"`
}

type VirtualSwitchConfigurationOverrides

type VirtualSwitchConfigurationOverrides struct {
	EnableIov              *string `json:"enableIov,omitempty"`
	LoadBalancingAlgorithm *string `json:"loadBalancingAlgorithm,omitempty"`
}

Jump to

Keyboard shortcuts

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