armhdinsight

package module
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2022 License: MIT Imports: 15 Imported by: 7

README

Azure HDInsight Module for Go

PkgGoDev

The armhdinsight module provides operations for working with Azure HDInsight.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure HDInsight module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure HDInsight. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure HDInsight modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armhdinsight.NewApplicationsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armhdinsight.NewApplicationsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the HDInsight label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AaddsResourceDetails 

type AaddsResourceDetails struct {
	// The Azure active directory domain service name.
	DomainName *string `json:"domainName,omitempty"`

	// This indicates whether initial sync complete or not.
	InitialSyncComplete *bool `json:"initialSyncComplete,omitempty"`

	// This indicates whether enable ldaps or not.
	LdapsEnabled *bool `json:"ldapsEnabled,omitempty"`

	// The base 64 format string of public ldap certificate.
	LdapsPublicCertificateInBase64 *string `json:"ldapsPublicCertificateInBase64,omitempty"`

	// The resource id of azure active directory domain service.
	ResourceID *string `json:"resourceId,omitempty"`

	// The subnet resource id.
	SubnetID *string `json:"subnetId,omitempty"`

	// The tenant id of azure active directory domain service .
	TenantID *string `json:"tenantId,omitempty"`
}

AaddsResourceDetails - The Azure active directory domain service resource details.

type Application 

type Application struct {
	// The ETag for the application
	Etag *string `json:"etag,omitempty"`

	// The properties of the application.
	Properties *ApplicationProperties `json:"properties,omitempty"`

	// The tags for the application.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Application - The HDInsight cluster application

func (Application) MarshalJSON 

func (a Application) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Application.

type ApplicationGetEndpoint 

type ApplicationGetEndpoint struct {
	// The destination port to connect to.
	DestinationPort *int32 `json:"destinationPort,omitempty"`

	// The location of the endpoint.
	Location *string `json:"location,omitempty"`

	// The private ip address of the endpoint.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The public port to connect to.
	PublicPort *int32 `json:"publicPort,omitempty"`
}

ApplicationGetEndpoint - Gets the application SSH endpoint

type ApplicationGetHTTPSEndpoint 

type ApplicationGetHTTPSEndpoint struct {
	// The list of access modes for the application.
	AccessModes []*string `json:"accessModes,omitempty"`

	// The destination port to connect to.
	DestinationPort *int32 `json:"destinationPort,omitempty"`

	// The value indicates whether to disable GatewayAuth.
	DisableGatewayAuth *bool `json:"disableGatewayAuth,omitempty"`

	// The private ip address of the endpoint.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The subdomain suffix of the application.
	SubDomainSuffix *string `json:"subDomainSuffix,omitempty"`

	// READ-ONLY; The location of the endpoint.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; The public port to connect to.
	PublicPort *int32 `json:"publicPort,omitempty" azure:"ro"`
}

ApplicationGetHTTPSEndpoint - Gets the application HTTP endpoints.

func (ApplicationGetHTTPSEndpoint) MarshalJSON 

func (a ApplicationGetHTTPSEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGetHTTPSEndpoint.

type ApplicationListResult 

type ApplicationListResult struct {
	// The list of HDInsight applications installed on HDInsight cluster.
	Value []*Application `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ApplicationListResult - Result of the request to list cluster Applications. It contains a list of operations and a URL link to get the next set of results.

func (ApplicationListResult) MarshalJSON 

func (a ApplicationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationListResult.

type ApplicationProperties 

type ApplicationProperties struct {
	// The application type.
	ApplicationType *string `json:"applicationType,omitempty"`

	// The list of roles in the cluster.
	ComputeProfile *ComputeProfile `json:"computeProfile,omitempty"`

	// The list of errors.
	Errors []*Errors `json:"errors,omitempty"`

	// The list of application HTTPS endpoints.
	HTTPSEndpoints []*ApplicationGetHTTPSEndpoint `json:"httpsEndpoints,omitempty"`

	// The list of install script actions.
	InstallScriptActions []*RuntimeScriptAction `json:"installScriptActions,omitempty"`

	// The private link configurations.
	PrivateLinkConfigurations []*PrivateLinkConfiguration `json:"privateLinkConfigurations,omitempty"`

	// The list of application SSH endpoints.
	SSHEndpoints []*ApplicationGetEndpoint `json:"sshEndpoints,omitempty"`

	// The list of uninstall script actions.
	UninstallScriptActions []*RuntimeScriptAction `json:"uninstallScriptActions,omitempty"`

	// READ-ONLY; The application state.
	ApplicationState *string `json:"applicationState,omitempty" azure:"ro"`

	// READ-ONLY; The application create date time.
	CreatedDate *string `json:"createdDate,omitempty" azure:"ro"`

	// READ-ONLY; The marketplace identifier.
	MarketplaceIdentifier *string `json:"marketplaceIdentifier,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the application.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationProperties - The HDInsight cluster application GET response.

func (ApplicationProperties) MarshalJSON 

func (a ApplicationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationProperties.

type ApplicationsClient 

type ApplicationsClient struct {
	// contains filtered or unexported fields
}

ApplicationsClient contains the methods for the Applications group. Don't use this type directly, use NewApplicationsClient() instead.

func NewApplicationsClient 

func NewApplicationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationsClient, error)

NewApplicationsClient creates a new instance of ApplicationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ApplicationsClient) BeginCreate 

func (client *ApplicationsClient) BeginCreate(ctx context.Context, resourceGroupName string, clusterName string, applicationName string, parameters Application, options *ApplicationsClientBeginCreateOptions) (*armruntime.Poller[ApplicationsClientCreateResponse], error)

BeginCreate - Creates applications for the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. applicationName - The constant value for the application name. parameters - The application create request. options - ApplicationsClientBeginCreateOptions contains the optional parameters for the ApplicationsClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/CreateApplication.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewApplicationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<application-name>",
		armhdinsight.Application{
			Properties: &armhdinsight.ApplicationProperties{
				ApplicationType: to.Ptr("<application-type>"),
				ComputeProfile: &armhdinsight.ComputeProfile{
					Roles: []*armhdinsight.Role{
						{
							Name: to.Ptr("<name>"),
							HardwareProfile: &armhdinsight.HardwareProfile{
								VMSize: to.Ptr("<vmsize>"),
							},
							TargetInstanceCount: to.Ptr[int32](1),
						}},
				},
				Errors: []*armhdinsight.Errors{},
				HTTPSEndpoints: []*armhdinsight.ApplicationGetHTTPSEndpoint{
					{
						AccessModes: []*string{
							to.Ptr("WebPage")},
						DestinationPort: to.Ptr[int32](20000),
						SubDomainSuffix: to.Ptr("<sub-domain-suffix>"),
					}},
				InstallScriptActions: []*armhdinsight.RuntimeScriptAction{
					{
						Name:       to.Ptr("<name>"),
						Parameters: to.Ptr("<parameters>"),
						Roles: []*string{
							to.Ptr("edgenode")},
						URI: to.Ptr("<uri>"),
					}},
				UninstallScriptActions: []*armhdinsight.RuntimeScriptAction{},
			},
		},
		&armhdinsight.ApplicationsClientBeginCreateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ApplicationsClient) BeginDelete 

func (client *ApplicationsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, applicationName string, options *ApplicationsClientBeginDeleteOptions) (*armruntime.Poller[ApplicationsClientDeleteResponse], error)

BeginDelete - Deletes the specified application on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. applicationName - The constant value for the application name. options - ApplicationsClientBeginDeleteOptions contains the optional parameters for the ApplicationsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DeleteApplication.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewApplicationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<application-name>",
		&armhdinsight.ApplicationsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ApplicationsClient) Get 

func (client *ApplicationsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, applicationName string, options *ApplicationsClientGetOptions) (ApplicationsClientGetResponse, error)

Get - Gets properties of the specified application. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. applicationName - The constant value for the application name. options - ApplicationsClientGetOptions contains the optional parameters for the ApplicationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationInProgress.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewApplicationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<application-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ApplicationsClient) GetAzureAsyncOperationStatus 

func (client *ApplicationsClient) GetAzureAsyncOperationStatus(ctx context.Context, resourceGroupName string, clusterName string, applicationName string, operationID string, options *ApplicationsClientGetAzureAsyncOperationStatusOptions) (ApplicationsClientGetAzureAsyncOperationStatusResponse, error)

GetAzureAsyncOperationStatus - Gets the async operation status. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. applicationName - The constant value for the application name. operationID - The long running operation id. options - ApplicationsClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the ApplicationsClient.GetAzureAsyncOperationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationCreationAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewApplicationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetAzureAsyncOperationStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<application-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ApplicationsClient) NewListByClusterPager added in v0.4.0 

func (client *ApplicationsClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *ApplicationsClientListByClusterOptions) *runtime.Pager[ApplicationsClientListByClusterResponse]

NewListByClusterPager - Lists all of the applications for the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ApplicationsClientListByClusterOptions contains the optional parameters for the ApplicationsClient.ListByCluster method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetAllApplications.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewApplicationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListByClusterPager("<resource-group-name>",
		"<cluster-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ApplicationsClientBeginCreateOptions added in v0.2.0 

type ApplicationsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ApplicationsClientBeginCreateOptions contains the optional parameters for the ApplicationsClient.BeginCreate method.

type ApplicationsClientBeginDeleteOptions added in v0.2.0 

type ApplicationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ApplicationsClientBeginDeleteOptions contains the optional parameters for the ApplicationsClient.BeginDelete method.

type ApplicationsClientCreateResponse added in v0.2.0 

type ApplicationsClientCreateResponse struct {
	Application
}

ApplicationsClientCreateResponse contains the response from method ApplicationsClient.Create.

type ApplicationsClientDeleteResponse added in v0.2.0 

type ApplicationsClientDeleteResponse struct {
}

ApplicationsClientDeleteResponse contains the response from method ApplicationsClient.Delete.

type ApplicationsClientGetAzureAsyncOperationStatusOptions added in v0.2.0 

type ApplicationsClientGetAzureAsyncOperationStatusOptions struct {
}

ApplicationsClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the ApplicationsClient.GetAzureAsyncOperationStatus method.

type ApplicationsClientGetAzureAsyncOperationStatusResponse added in v0.2.0 

type ApplicationsClientGetAzureAsyncOperationStatusResponse struct {
	AsyncOperationResult
}

ApplicationsClientGetAzureAsyncOperationStatusResponse contains the response from method ApplicationsClient.GetAzureAsyncOperationStatus.

type ApplicationsClientGetOptions added in v0.2.0 

type ApplicationsClientGetOptions struct {
}

ApplicationsClientGetOptions contains the optional parameters for the ApplicationsClient.Get method.

type ApplicationsClientGetResponse added in v0.2.0 

type ApplicationsClientGetResponse struct {
	Application
}

ApplicationsClientGetResponse contains the response from method ApplicationsClient.Get.

type ApplicationsClientListByClusterOptions added in v0.2.0 

type ApplicationsClientListByClusterOptions struct {
}

ApplicationsClientListByClusterOptions contains the optional parameters for the ApplicationsClient.ListByCluster method.

type ApplicationsClientListByClusterResponse added in v0.2.0 

type ApplicationsClientListByClusterResponse struct {
	ApplicationListResult
}

ApplicationsClientListByClusterResponse contains the response from method ApplicationsClient.ListByCluster.

type AsyncOperationResult 

type AsyncOperationResult struct {
	// The operation error information.
	Error *Errors `json:"error,omitempty"`

	// The async operation state.
	Status *AsyncOperationState `json:"status,omitempty"`
}

AsyncOperationResult - The azure async operation response.

type AsyncOperationState 

type AsyncOperationState string

AsyncOperationState - The async operation state. 

const (
	AsyncOperationStateFailed     AsyncOperationState = "Failed"
	AsyncOperationStateInProgress AsyncOperationState = "InProgress"
	AsyncOperationStateSucceeded  AsyncOperationState = "Succeeded"
)

func PossibleAsyncOperationStateValues 

func PossibleAsyncOperationStateValues() []AsyncOperationState

PossibleAsyncOperationStateValues returns the possible values for the AsyncOperationState const type.

type Autoscale 

type Autoscale struct {
	// Parameters for load-based autoscale
	Capacity *AutoscaleCapacity `json:"capacity,omitempty"`

	// Parameters for schedule-based autoscale
	Recurrence *AutoscaleRecurrence `json:"recurrence,omitempty"`
}

Autoscale - The autoscale request parameters

type AutoscaleCapacity 

type AutoscaleCapacity struct {
	// The maximum instance count of the cluster
	MaxInstanceCount *int32 `json:"maxInstanceCount,omitempty"`

	// The minimum instance count of the cluster
	MinInstanceCount *int32 `json:"minInstanceCount,omitempty"`
}

AutoscaleCapacity - The load-based autoscale request parameters

type AutoscaleConfigurationUpdateParameter 

type AutoscaleConfigurationUpdateParameter struct {
	// The autoscale configuration.
	Autoscale *Autoscale `json:"autoscale,omitempty"`
}

AutoscaleConfigurationUpdateParameter - The autoscale configuration update parameter.

type AutoscaleRecurrence 

type AutoscaleRecurrence struct {
	// Array of schedule-based autoscale rules
	Schedule []*AutoscaleSchedule `json:"schedule,omitempty"`

	// The time zone for the autoscale schedule times
	TimeZone *string `json:"timeZone,omitempty"`
}

AutoscaleRecurrence - Schedule-based autoscale request parameters

func (AutoscaleRecurrence) MarshalJSON 

func (a AutoscaleRecurrence) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AutoscaleRecurrence.

type AutoscaleSchedule 

type AutoscaleSchedule struct {
	// Days of the week for a schedule-based autoscale rule
	Days []*DaysOfWeek `json:"days,omitempty"`

	// Time and capacity for a schedule-based autoscale rule
	TimeAndCapacity *AutoscaleTimeAndCapacity `json:"timeAndCapacity,omitempty"`
}

AutoscaleSchedule - Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity

func (AutoscaleSchedule) MarshalJSON 

func (a AutoscaleSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AutoscaleSchedule.

type AutoscaleTimeAndCapacity 

type AutoscaleTimeAndCapacity struct {
	// The maximum instance count of the cluster
	MaxInstanceCount *int32 `json:"maxInstanceCount,omitempty"`

	// The minimum instance count of the cluster
	MinInstanceCount *int32 `json:"minInstanceCount,omitempty"`

	// 24-hour time in the form xx:xx
	Time *string `json:"time,omitempty"`
}

AutoscaleTimeAndCapacity - Time and capacity request parameters

type AzureMonitorRequest 

type AzureMonitorRequest struct {
	// The Log Analytics workspace key.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// The selected configurations.
	SelectedConfigurations *AzureMonitorSelectedConfigurations `json:"selectedConfigurations,omitempty"`

	// The Log Analytics workspace ID.
	WorkspaceID *string `json:"workspaceId,omitempty"`
}

AzureMonitorRequest - The azure monitor parameters.

type AzureMonitorResponse 

type AzureMonitorResponse struct {
	// The status of the monitor on the HDInsight cluster.
	ClusterMonitoringEnabled *bool `json:"clusterMonitoringEnabled,omitempty"`

	// The selected configurations.
	SelectedConfigurations *AzureMonitorSelectedConfigurations `json:"selectedConfigurations,omitempty"`

	// The workspace ID of the monitor on the HDInsight cluster.
	WorkspaceID *string `json:"workspaceId,omitempty"`
}

AzureMonitorResponse - The azure monitor status response.

type AzureMonitorSelectedConfigurations 

type AzureMonitorSelectedConfigurations struct {
	// The configuration version.
	ConfigurationVersion *string `json:"configurationVersion,omitempty"`

	// The global configurations of selected configurations.
	GlobalConfigurations map[string]*string `json:"globalConfigurations,omitempty"`

	// The table list.
	TableList []*AzureMonitorTableConfiguration `json:"tableList,omitempty"`
}

AzureMonitorSelectedConfigurations - The selected configurations for azure monitor.

func (AzureMonitorSelectedConfigurations) MarshalJSON 

func (a AzureMonitorSelectedConfigurations) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureMonitorSelectedConfigurations.

type AzureMonitorTableConfiguration 

type AzureMonitorTableConfiguration struct {
	// The name.
	Name *string `json:"name,omitempty"`
}

AzureMonitorTableConfiguration - The table configuration for the Log Analytics integration.

type BillingMeters 

type BillingMeters struct {
	// The HDInsight meter guid.
	Meter *string `json:"meter,omitempty"`

	// The virtual machine sizes.
	MeterParameter *string `json:"meterParameter,omitempty"`

	// The unit of meter, VMHours or CoreHours.
	Unit *string `json:"unit,omitempty"`
}

BillingMeters - The billing meters.

type BillingResources 

type BillingResources struct {
	// The billing meter information.
	BillingMeters []*BillingMeters `json:"billingMeters,omitempty"`

	// The managed disk billing information.
	DiskBillingMeters []*DiskBillingMeters `json:"diskBillingMeters,omitempty"`

	// The region or location.
	Region *string `json:"region,omitempty"`
}

BillingResources - The billing resources.

func (BillingResources) MarshalJSON 

func (b BillingResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BillingResources.

type BillingResponseListResult 

type BillingResponseListResult struct {
	// The billing and managed disk billing resources for a region.
	BillingResources []*BillingResources `json:"billingResources,omitempty"`

	// The virtual machine filtering mode. Effectively this can enabling or disabling the virtual machine sizes in a particular
	// set.
	VMSizeFilters []*VMSizeCompatibilityFilterV2 `json:"vmSizeFilters,omitempty"`

	// The virtual machine sizes to include or exclude.
	VMSizes []*string `json:"vmSizes,omitempty"`

	// The vm sizes which enable encryption at host.
	VMSizesWithEncryptionAtHost []*string `json:"vmSizesWithEncryptionAtHost,omitempty"`

	// READ-ONLY; The vm size properties.
	VMSizeProperties []*VMSizeProperty `json:"vmSizeProperties,omitempty" azure:"ro"`
}

BillingResponseListResult - The response for the operation to get regional billingSpecs for a subscription.

func (BillingResponseListResult) MarshalJSON 

func (b BillingResponseListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BillingResponseListResult.

type CapabilitiesResult 

type CapabilitiesResult struct {
	// The capability features.
	Features []*string `json:"features,omitempty"`

	// The virtual machine size compatibility features.
	Regions map[string]*RegionsCapability `json:"regions,omitempty"`

	// The version capability.
	Versions map[string]*VersionsCapability `json:"versions,omitempty"`

	// READ-ONLY; The quota capability.
	Quota *QuotaCapability `json:"quota,omitempty" azure:"ro"`
}

CapabilitiesResult - The Get Capabilities operation response.

func (CapabilitiesResult) MarshalJSON 

func (c CapabilitiesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CapabilitiesResult.

type ClientGroupInfo 

type ClientGroupInfo struct {
	// The AAD security group id.
	GroupID *string `json:"groupId,omitempty"`

	// The AAD security group name.
	GroupName *string `json:"groupName,omitempty"`
}

ClientGroupInfo - The information of AAD security group.

type Cluster 

type Cluster struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// The ETag for the resource
	Etag *string `json:"etag,omitempty"`

	// The identity of the cluster, if configured.
	Identity *ClusterIdentity `json:"identity,omitempty"`

	// The properties of the cluster.
	Properties *ClusterGetProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// The availability zones.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Cluster - The HDInsight cluster.

func (Cluster) MarshalJSON 

func (c Cluster) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Cluster.

type ClusterConfigurations 

type ClusterConfigurations struct {
	// The configuration object for the specified configuration for the specified cluster.
	Configurations map[string]map[string]*string `json:"configurations,omitempty"`
}

ClusterConfigurations - The configuration object for the specified cluster.

func (ClusterConfigurations) MarshalJSON 

func (c ClusterConfigurations) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterConfigurations.

type ClusterCreateParametersExtended 

type ClusterCreateParametersExtended struct {
	// The identity of the cluster, if configured.
	Identity *ClusterIdentity `json:"identity,omitempty"`

	// The location of the cluster.
	Location *string `json:"location,omitempty"`

	// The cluster create parameters.
	Properties *ClusterCreateProperties `json:"properties,omitempty"`

	// The resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// The availability zones.
	Zones []*string `json:"zones,omitempty"`
}

ClusterCreateParametersExtended - The CreateCluster request parameters.

func (ClusterCreateParametersExtended) MarshalJSON 

func (c ClusterCreateParametersExtended) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterCreateParametersExtended.

type ClusterCreateProperties 

type ClusterCreateProperties struct {
	// The cluster definition.
	ClusterDefinition *ClusterDefinition `json:"clusterDefinition,omitempty"`

	// The version of the cluster.
	ClusterVersion *string `json:"clusterVersion,omitempty"`

	// The compute isolation properties.
	ComputeIsolationProperties *ComputeIsolationProperties `json:"computeIsolationProperties,omitempty"`

	// The compute profile.
	ComputeProfile *ComputeProfile `json:"computeProfile,omitempty"`

	// The disk encryption properties.
	DiskEncryptionProperties *DiskEncryptionProperties `json:"diskEncryptionProperties,omitempty"`

	// The encryption-in-transit properties.
	EncryptionInTransitProperties *EncryptionInTransitProperties `json:"encryptionInTransitProperties,omitempty"`

	// The cluster kafka rest proxy configuration.
	KafkaRestProperties *KafkaRestProperties `json:"kafkaRestProperties,omitempty"`

	// The minimal supported tls version.
	MinSupportedTLSVersion *string `json:"minSupportedTlsVersion,omitempty"`

	// The network properties.
	NetworkProperties *NetworkProperties `json:"networkProperties,omitempty"`

	// The type of operating system.
	OSType *OSType `json:"osType,omitempty"`

	// The private link configurations.
	PrivateLinkConfigurations []*PrivateLinkConfiguration `json:"privateLinkConfigurations,omitempty"`

	// The security profile.
	SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`

	// The storage profile.
	StorageProfile *StorageProfile `json:"storageProfile,omitempty"`

	// The cluster tier.
	Tier *Tier `json:"tier,omitempty"`
}

ClusterCreateProperties - The cluster create parameters.

func (ClusterCreateProperties) MarshalJSON 

func (c ClusterCreateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterCreateProperties.

type ClusterCreateRequestValidationParameters 

type ClusterCreateRequestValidationParameters struct {
	// This indicates whether fetch Aadds resource or not.
	FetchAaddsResource *bool `json:"fetchAaddsResource,omitempty"`

	// The identity of the cluster, if configured.
	Identity *ClusterIdentity `json:"identity,omitempty"`

	// The location of the cluster.
	Location *string `json:"location,omitempty"`

	// The cluster name.
	Name *string `json:"name,omitempty"`

	// The cluster create parameters.
	Properties *ClusterCreateProperties `json:"properties,omitempty"`

	// The resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// The tenant id.
	TenantID *string `json:"tenantId,omitempty"`

	// The resource type.
	Type *string `json:"type,omitempty"`

	// The availability zones.
	Zones []*string `json:"zones,omitempty"`
}

ClusterCreateRequestValidationParameters - The cluster create request specification.

func (ClusterCreateRequestValidationParameters) MarshalJSON 

func (c ClusterCreateRequestValidationParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterCreateRequestValidationParameters.

type ClusterCreateValidationResult 

type ClusterCreateValidationResult struct {
	// The Azure active directory domain service resource details.
	AaddsResourcesDetails []*AaddsResourceDetails `json:"aaddsResourcesDetails,omitempty"`

	// The estimated creation duration.
	EstimatedCreationDuration *string `json:"estimatedCreationDuration,omitempty"`

	// The validation errors.
	ValidationErrors []*ValidationErrorInfo `json:"validationErrors,omitempty"`

	// The validation warnings.
	ValidationWarnings []*ValidationErrorInfo `json:"validationWarnings,omitempty"`
}

ClusterCreateValidationResult - The response of cluster create request validation.

func (ClusterCreateValidationResult) MarshalJSON 

func (c ClusterCreateValidationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterCreateValidationResult.

type ClusterDefinition 

type ClusterDefinition struct {
	// The link to the blueprint.
	Blueprint *string `json:"blueprint,omitempty"`

	// The versions of different services in the cluster.
	ComponentVersion map[string]*string `json:"componentVersion,omitempty"`

	// The cluster configurations.
	Configurations interface{} `json:"configurations,omitempty"`

	// The type of cluster.
	Kind *string `json:"kind,omitempty"`
}

ClusterDefinition - The cluster definition.

func (ClusterDefinition) MarshalJSON 

func (c ClusterDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterDefinition.

type ClusterDiskEncryptionParameters 

type ClusterDiskEncryptionParameters struct {
	// Key name that is used for enabling disk encryption.
	KeyName *string `json:"keyName,omitempty"`

	// Specific key version that is used for enabling disk encryption.
	KeyVersion *string `json:"keyVersion,omitempty"`

	// Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net
	VaultURI *string `json:"vaultUri,omitempty"`
}

ClusterDiskEncryptionParameters - The Disk Encryption Cluster request parameters.

type ClusterGetProperties 

type ClusterGetProperties struct {
	// REQUIRED; The cluster definition.
	ClusterDefinition *ClusterDefinition `json:"clusterDefinition,omitempty"`

	// The hdp version of the cluster.
	ClusterHdpVersion *string `json:"clusterHdpVersion,omitempty"`

	// The cluster id.
	ClusterID *string `json:"clusterId,omitempty"`

	// The state of the cluster.
	ClusterState *string `json:"clusterState,omitempty"`

	// The version of the cluster.
	ClusterVersion *string `json:"clusterVersion,omitempty"`

	// The compute isolation properties.
	ComputeIsolationProperties *ComputeIsolationProperties `json:"computeIsolationProperties,omitempty"`

	// The compute profile.
	ComputeProfile *ComputeProfile `json:"computeProfile,omitempty"`

	// The list of connectivity endpoints.
	ConnectivityEndpoints []*ConnectivityEndpoint `json:"connectivityEndpoints,omitempty"`

	// The date on which the cluster was created.
	CreatedDate *string `json:"createdDate,omitempty"`

	// The disk encryption properties.
	DiskEncryptionProperties *DiskEncryptionProperties `json:"diskEncryptionProperties,omitempty"`

	// The encryption-in-transit properties.
	EncryptionInTransitProperties *EncryptionInTransitProperties `json:"encryptionInTransitProperties,omitempty"`

	// The list of errors.
	Errors []*Errors `json:"errors,omitempty"`

	// The excluded services config.
	ExcludedServicesConfig *ExcludedServicesConfig `json:"excludedServicesConfig,omitempty"`

	// The cluster kafka rest proxy configuration.
	KafkaRestProperties *KafkaRestProperties `json:"kafkaRestProperties,omitempty"`

	// The minimal supported tls version.
	MinSupportedTLSVersion *string `json:"minSupportedTlsVersion,omitempty"`

	// The network properties.
	NetworkProperties *NetworkProperties `json:"networkProperties,omitempty"`

	// The type of operating system.
	OSType *OSType `json:"osType,omitempty"`

	// The private link configurations.
	PrivateLinkConfigurations []*PrivateLinkConfiguration `json:"privateLinkConfigurations,omitempty"`

	// The provisioning state, which only appears in the response.
	ProvisioningState *HDInsightClusterProvisioningState `json:"provisioningState,omitempty"`

	// The quota information.
	QuotaInfo *QuotaInfo `json:"quotaInfo,omitempty"`

	// The security profile.
	SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`

	// The storage profile.
	StorageProfile *StorageProfile `json:"storageProfile,omitempty"`

	// The cluster tier.
	Tier *Tier `json:"tier,omitempty"`

	// READ-ONLY; The list of private endpoint connections.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`
}

ClusterGetProperties - The properties of cluster.

func (ClusterGetProperties) MarshalJSON 

func (c ClusterGetProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterGetProperties.

type ClusterIdentity 

type ClusterIdentity struct {
	// The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created
	// identity and a set of user assigned identities.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource
	// ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal id of cluster identity. This property will only be provided for a system assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant id associated with the cluster. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ClusterIdentity - Identity for the cluster.

func (ClusterIdentity) MarshalJSON 

func (c ClusterIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterIdentity.

type ClusterListPersistedScriptActionsResult 

type ClusterListPersistedScriptActionsResult struct {
	// The list of Persisted Script Actions.
	Value []*RuntimeScriptAction `json:"value,omitempty"`

	// READ-ONLY; The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ClusterListPersistedScriptActionsResult - The ListPersistedScriptActions operation response.

func (ClusterListPersistedScriptActionsResult) MarshalJSON 

func (c ClusterListPersistedScriptActionsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterListPersistedScriptActionsResult.

type ClusterListResult 

type ClusterListResult struct {
	// The list of Clusters.
	Value []*Cluster `json:"value,omitempty"`

	// READ-ONLY; The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ClusterListResult - The List Cluster operation response.

func (ClusterListResult) MarshalJSON 

func (c ClusterListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterListResult.

type ClusterMonitoringRequest 

type ClusterMonitoringRequest struct {
	// The cluster monitor workspace key.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// The cluster monitor workspace ID.
	WorkspaceID *string `json:"workspaceId,omitempty"`
}

ClusterMonitoringRequest - The cluster monitor parameters.

type ClusterMonitoringResponse 

type ClusterMonitoringResponse struct {
	// The status of the monitor on the HDInsight cluster.
	ClusterMonitoringEnabled *bool `json:"clusterMonitoringEnabled,omitempty"`

	// The workspace ID of the monitor on the HDInsight cluster.
	WorkspaceID *string `json:"workspaceId,omitempty"`
}

ClusterMonitoringResponse - The cluster monitoring status response.

type ClusterPatchParameters 

type ClusterPatchParameters struct {
	// The resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

ClusterPatchParameters - The PatchCluster request parameters

func (ClusterPatchParameters) MarshalJSON 

func (c ClusterPatchParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterPatchParameters.

type ClusterResizeParameters 

type ClusterResizeParameters struct {
	// The target instance count for the operation.
	TargetInstanceCount *int32 `json:"targetInstanceCount,omitempty"`
}

ClusterResizeParameters - The Resize Cluster request parameters.

type ClustersClient 

type ClustersClient struct {
	// contains filtered or unexported fields
}

ClustersClient contains the methods for the Clusters group. Don't use this type directly, use NewClustersClient() instead.

func NewClustersClient 

func NewClustersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClustersClient, error)

NewClustersClient creates a new instance of ClustersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ClustersClient) BeginCreate 

func (client *ClustersClient) BeginCreate(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterCreateParametersExtended, options *ClustersClientBeginCreateOptions) (*armruntime.Poller[ClustersClientCreateResponse], error)

BeginCreate - Creates a new HDInsight cluster with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The cluster create request. options - ClustersClientBeginCreateOptions contains the optional parameters for the ClustersClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/CreateHDInsightClusterWithAutoscaleConfig.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.ClusterCreateParametersExtended{
			Properties: &armhdinsight.ClusterCreateProperties{
				ClusterDefinition: &armhdinsight.ClusterDefinition{
					ComponentVersion: map[string]*string{
						"Hadoop": to.Ptr("2.7"),
					},
					Configurations: map[string]interface{}{
						"gateway": map[string]interface{}{
							"restAuthCredential.isEnabled": true,
							"restAuthCredential.password":  "**********",
							"restAuthCredential.username":  "admin",
						},
					},
					Kind: to.Ptr("<kind>"),
				},
				ClusterVersion: to.Ptr("<cluster-version>"),
				ComputeProfile: &armhdinsight.ComputeProfile{
					Roles: []*armhdinsight.Role{
						{
							Name: to.Ptr("<name>"),
							AutoscaleConfiguration: &armhdinsight.Autoscale{
								Recurrence: &armhdinsight.AutoscaleRecurrence{
									Schedule: []*armhdinsight.AutoscaleSchedule{
										{
											Days: []*armhdinsight.DaysOfWeek{
												to.Ptr(armhdinsight.DaysOfWeekMonday),
												to.Ptr(armhdinsight.DaysOfWeekTuesday),
												to.Ptr(armhdinsight.DaysOfWeekWednesday),
												to.Ptr(armhdinsight.DaysOfWeekThursday),
												to.Ptr(armhdinsight.DaysOfWeekFriday)},
											TimeAndCapacity: &armhdinsight.AutoscaleTimeAndCapacity{
												MaxInstanceCount: to.Ptr[int32](3),
												MinInstanceCount: to.Ptr[int32](3),
												Time:             to.Ptr("<time>"),
											},
										},
										{
											Days: []*armhdinsight.DaysOfWeek{
												to.Ptr(armhdinsight.DaysOfWeekMonday),
												to.Ptr(armhdinsight.DaysOfWeekTuesday),
												to.Ptr(armhdinsight.DaysOfWeekWednesday),
												to.Ptr(armhdinsight.DaysOfWeekThursday),
												to.Ptr(armhdinsight.DaysOfWeekFriday)},
											TimeAndCapacity: &armhdinsight.AutoscaleTimeAndCapacity{
												MaxInstanceCount: to.Ptr[int32](6),
												MinInstanceCount: to.Ptr[int32](6),
												Time:             to.Ptr("<time>"),
											},
										},
										{
											Days: []*armhdinsight.DaysOfWeek{
												to.Ptr(armhdinsight.DaysOfWeekSaturday),
												to.Ptr(armhdinsight.DaysOfWeekSunday)},
											TimeAndCapacity: &armhdinsight.AutoscaleTimeAndCapacity{
												MaxInstanceCount: to.Ptr[int32](2),
												MinInstanceCount: to.Ptr[int32](2),
												Time:             to.Ptr("<time>"),
											},
										},
										{
											Days: []*armhdinsight.DaysOfWeek{
												to.Ptr(armhdinsight.DaysOfWeekSaturday),
												to.Ptr(armhdinsight.DaysOfWeekSunday)},
											TimeAndCapacity: &armhdinsight.AutoscaleTimeAndCapacity{
												MaxInstanceCount: to.Ptr[int32](4),
												MinInstanceCount: to.Ptr[int32](4),
												Time:             to.Ptr("<time>"),
											},
										}},
									TimeZone: to.Ptr("<time-zone>"),
								},
							},
							HardwareProfile: &armhdinsight.HardwareProfile{
								VMSize: to.Ptr("<vmsize>"),
							},
							OSProfile: &armhdinsight.OsProfile{
								LinuxOperatingSystemProfile: &armhdinsight.LinuxOperatingSystemProfile{
									Password: to.Ptr("<password>"),
									Username: to.Ptr("<username>"),
								},
							},
							ScriptActions:       []*armhdinsight.ScriptAction{},
							TargetInstanceCount: to.Ptr[int32](4),
						}},
				},
				OSType: to.Ptr(armhdinsight.OSTypeLinux),
				StorageProfile: &armhdinsight.StorageProfile{
					Storageaccounts: []*armhdinsight.StorageAccount{
						{
							Name:      to.Ptr("<name>"),
							Container: to.Ptr("<container>"),
							IsDefault: to.Ptr(true),
							Key:       to.Ptr("<key>"),
						}},
				},
				Tier: to.Ptr(armhdinsight.TierStandard),
			},
		},
		&armhdinsight.ClustersClientBeginCreateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ClustersClient) BeginDelete 

func (client *ClustersClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientBeginDeleteOptions) (*armruntime.Poller[ClustersClientDeleteResponse], error)

BeginDelete - Deletes the specified HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ClustersClientBeginDeleteOptions contains the optional parameters for the ClustersClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DeleteLinuxHadoopCluster.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		&armhdinsight.ClustersClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) BeginExecuteScriptActions 

func (client *ClustersClient) BeginExecuteScriptActions(ctx context.Context, resourceGroupName string, clusterName string, parameters ExecuteScriptActionParameters, options *ClustersClientBeginExecuteScriptActionsOptions) (*armruntime.Poller[ClustersClientExecuteScriptActionsResponse], error)

BeginExecuteScriptActions - Executes script actions on the specified HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The parameters for executing script actions. options - ClustersClientBeginExecuteScriptActionsOptions contains the optional parameters for the ClustersClient.BeginExecuteScriptActions method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/PostExecuteScriptAction.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginExecuteScriptActions(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.ExecuteScriptActionParameters{
			PersistOnSuccess: to.Ptr(false),
			ScriptActions: []*armhdinsight.RuntimeScriptAction{
				{
					Name:       to.Ptr("<name>"),
					Parameters: to.Ptr("<parameters>"),
					Roles: []*string{
						to.Ptr("headnode"),
						to.Ptr("workernode")},
					URI: to.Ptr("<uri>"),
				}},
		},
		&armhdinsight.ClustersClientBeginExecuteScriptActionsOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) BeginResize 

func (client *ClustersClient) BeginResize(ctx context.Context, resourceGroupName string, clusterName string, roleName RoleName, parameters ClusterResizeParameters, options *ClustersClientBeginResizeOptions) (*armruntime.Poller[ClustersClientResizeResponse], error)

BeginResize - Resizes the specified HDInsight cluster to the specified size. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. roleName - The constant value for the roleName parameters - The parameters for the resize operation. options - ClustersClientBeginResizeOptions contains the optional parameters for the ClustersClient.BeginResize method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/ResizeLinuxHadoopCluster.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginResize(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.RoleNameWorkernode,
		armhdinsight.ClusterResizeParameters{
			TargetInstanceCount: to.Ptr[int32](10),
		},
		&armhdinsight.ClustersClientBeginResizeOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) BeginRotateDiskEncryptionKey 

func (client *ClustersClient) BeginRotateDiskEncryptionKey(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterDiskEncryptionParameters, options *ClustersClientBeginRotateDiskEncryptionKeyOptions) (*armruntime.Poller[ClustersClientRotateDiskEncryptionKeyResponse], error)

BeginRotateDiskEncryptionKey - Rotate disk encryption key of the specified HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The parameters for the disk encryption operation. options - ClustersClientBeginRotateDiskEncryptionKeyOptions contains the optional parameters for the ClustersClient.BeginRotateDiskEncryptionKey method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginRotateDiskEncryptionKey(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.ClusterDiskEncryptionParameters{
			KeyName:    to.Ptr("<key-name>"),
			KeyVersion: to.Ptr("<key-version>"),
			VaultURI:   to.Ptr("<vault-uri>"),
		},
		&armhdinsight.ClustersClientBeginRotateDiskEncryptionKeyOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) BeginUpdateAutoScaleConfiguration 

func (client *ClustersClient) BeginUpdateAutoScaleConfiguration(ctx context.Context, resourceGroupName string, clusterName string, roleName RoleName, parameters AutoscaleConfigurationUpdateParameter, options *ClustersClientBeginUpdateAutoScaleConfigurationOptions) (*armruntime.Poller[ClustersClientUpdateAutoScaleConfigurationResponse], error)

BeginUpdateAutoScaleConfiguration - Updates the Autoscale Configuration for HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. roleName - The constant value for the roleName parameters - The parameters for the update autoscale configuration operation. options - ClustersClientBeginUpdateAutoScaleConfigurationOptions contains the optional parameters for the ClustersClient.BeginUpdateAutoScaleConfiguration method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DisableClusterAutoScale.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdateAutoScaleConfiguration(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.RoleNameWorkernode,
		armhdinsight.AutoscaleConfigurationUpdateParameter{},
		&armhdinsight.ClustersClientBeginUpdateAutoScaleConfigurationOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) BeginUpdateGatewaySettings 

func (client *ClustersClient) BeginUpdateGatewaySettings(ctx context.Context, resourceGroupName string, clusterName string, parameters UpdateGatewaySettingsParameters, options *ClustersClientBeginUpdateGatewaySettingsOptions) (*armruntime.Poller[ClustersClientUpdateGatewaySettingsResponse], error)

BeginUpdateGatewaySettings - Configures the gateway settings on the specified cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The cluster configurations. options - ClustersClientBeginUpdateGatewaySettingsOptions contains the optional parameters for the ClustersClient.BeginUpdateGatewaySettings method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdateGatewaySettings(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.UpdateGatewaySettingsParameters{
			IsCredentialEnabled: to.Ptr(true),
			Password:            to.Ptr("<password>"),
			UserName:            to.Ptr("<user-name>"),
		},
		&armhdinsight.ClustersClientBeginUpdateGatewaySettingsOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) BeginUpdateIdentityCertificate 

func (client *ClustersClient) BeginUpdateIdentityCertificate(ctx context.Context, resourceGroupName string, clusterName string, parameters UpdateClusterIdentityCertificateParameters, options *ClustersClientBeginUpdateIdentityCertificateOptions) (*armruntime.Poller[ClustersClientUpdateIdentityCertificateResponse], error)

BeginUpdateIdentityCertificate - Updates the cluster identity certificate. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The cluster configurations. options - ClustersClientBeginUpdateIdentityCertificateOptions contains the optional parameters for the ClustersClient.BeginUpdateIdentityCertificate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Clusters_UpdateClusterIdentityCertificate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdateIdentityCertificate(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.UpdateClusterIdentityCertificateParameters{
			ApplicationID:       to.Ptr("<application-id>"),
			Certificate:         to.Ptr("<certificate>"),
			CertificatePassword: to.Ptr("<certificate-password>"),
		},
		&armhdinsight.ClustersClientBeginUpdateIdentityCertificateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ClustersClient) Get 

func (client *ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientGetOptions) (ClustersClientGetResponse, error)

Get - Gets the specified cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ClustersClientGetOptions contains the optional parameters for the ClustersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopCluster.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ClustersClient) GetAzureAsyncOperationStatus 

func (client *ClustersClient) GetAzureAsyncOperationStatus(ctx context.Context, resourceGroupName string, clusterName string, operationID string, options *ClustersClientGetAzureAsyncOperationStatusOptions) (ClustersClientGetAzureAsyncOperationStatusResponse, error)

GetAzureAsyncOperationStatus - The the async operation status. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. operationID - The long running operation id. options - ClustersClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the ClustersClient.GetAzureAsyncOperationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetClusterCreatingAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetAzureAsyncOperationStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ClustersClient) GetGatewaySettings 

func (client *ClustersClient) GetGatewaySettings(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientGetGatewaySettingsOptions) (ClustersClientGetGatewaySettingsResponse, error)

GetGatewaySettings - Gets the gateway settings for the specified cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ClustersClientGetGatewaySettingsOptions contains the optional parameters for the ClustersClient.GetGatewaySettings method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Clusters_GetGatewaySettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetGatewaySettings(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ClustersClient) NewListByResourceGroupPager added in v0.4.0 

func (client *ClustersClient) NewListByResourceGroupPager(resourceGroupName string, options *ClustersClientListByResourceGroupOptions) *runtime.Pager[ClustersClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists the HDInsight clusters in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ClustersClientListByResourceGroupOptions contains the optional parameters for the ClustersClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopAllClustersInResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListByResourceGroupPager("<resource-group-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ClustersClient) NewListPager added in v0.4.0 

func (client *ClustersClient) NewListPager(options *ClustersClientListOptions) *runtime.Pager[ClustersClientListResponse]

NewListPager - Lists all the HDInsight clusters under the subscription. If the operation fails it returns an *azcore.ResponseError type. options - ClustersClientListOptions contains the optional parameters for the ClustersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopAllClusters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ClustersClient) Update 

func (client *ClustersClient) Update(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterPatchParameters, options *ClustersClientUpdateOptions) (ClustersClientUpdateResponse, error)

Update - Patch HDInsight cluster with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The cluster patch request. options - ClustersClientUpdateOptions contains the optional parameters for the ClustersClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/PatchLinuxHadoopCluster.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewClustersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.ClusterPatchParameters{
			Tags: map[string]*string{
				"key1": to.Ptr("val1"),
				"key2": to.Ptr("val2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type ClustersClientBeginCreateOptions added in v0.2.0 

type ClustersClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginCreateOptions contains the optional parameters for the ClustersClient.BeginCreate method.

type ClustersClientBeginDeleteOptions added in v0.2.0 

type ClustersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginDeleteOptions contains the optional parameters for the ClustersClient.BeginDelete method.

type ClustersClientBeginExecuteScriptActionsOptions added in v0.2.0 

type ClustersClientBeginExecuteScriptActionsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginExecuteScriptActionsOptions contains the optional parameters for the ClustersClient.BeginExecuteScriptActions method.

type ClustersClientBeginResizeOptions added in v0.2.0 

type ClustersClientBeginResizeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginResizeOptions contains the optional parameters for the ClustersClient.BeginResize method.

type ClustersClientBeginRotateDiskEncryptionKeyOptions added in v0.2.0 

type ClustersClientBeginRotateDiskEncryptionKeyOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginRotateDiskEncryptionKeyOptions contains the optional parameters for the ClustersClient.BeginRotateDiskEncryptionKey method.

type ClustersClientBeginUpdateAutoScaleConfigurationOptions added in v0.2.0 

type ClustersClientBeginUpdateAutoScaleConfigurationOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginUpdateAutoScaleConfigurationOptions contains the optional parameters for the ClustersClient.BeginUpdateAutoScaleConfiguration method.

type ClustersClientBeginUpdateGatewaySettingsOptions added in v0.2.0 

type ClustersClientBeginUpdateGatewaySettingsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginUpdateGatewaySettingsOptions contains the optional parameters for the ClustersClient.BeginUpdateGatewaySettings method.

type ClustersClientBeginUpdateIdentityCertificateOptions added in v0.2.0 

type ClustersClientBeginUpdateIdentityCertificateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClustersClientBeginUpdateIdentityCertificateOptions contains the optional parameters for the ClustersClient.BeginUpdateIdentityCertificate method.

type ClustersClientCreateResponse added in v0.2.0 

type ClustersClientCreateResponse struct {
	Cluster
}

ClustersClientCreateResponse contains the response from method ClustersClient.Create.

type ClustersClientDeleteResponse added in v0.2.0 

type ClustersClientDeleteResponse struct {
}

ClustersClientDeleteResponse contains the response from method ClustersClient.Delete.

type ClustersClientExecuteScriptActionsResponse added in v0.2.0 

type ClustersClientExecuteScriptActionsResponse struct {
}

ClustersClientExecuteScriptActionsResponse contains the response from method ClustersClient.ExecuteScriptActions.

type ClustersClientGetAzureAsyncOperationStatusOptions added in v0.2.0 

type ClustersClientGetAzureAsyncOperationStatusOptions struct {
}

ClustersClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the ClustersClient.GetAzureAsyncOperationStatus method.

type ClustersClientGetAzureAsyncOperationStatusResponse added in v0.2.0 

type ClustersClientGetAzureAsyncOperationStatusResponse struct {
	AsyncOperationResult
}

ClustersClientGetAzureAsyncOperationStatusResponse contains the response from method ClustersClient.GetAzureAsyncOperationStatus.

type ClustersClientGetGatewaySettingsOptions added in v0.2.0 

type ClustersClientGetGatewaySettingsOptions struct {
}

ClustersClientGetGatewaySettingsOptions contains the optional parameters for the ClustersClient.GetGatewaySettings method.

type ClustersClientGetGatewaySettingsResponse added in v0.2.0 

type ClustersClientGetGatewaySettingsResponse struct {
	GatewaySettings
}

ClustersClientGetGatewaySettingsResponse contains the response from method ClustersClient.GetGatewaySettings.

type ClustersClientGetOptions added in v0.2.0 

type ClustersClientGetOptions struct {
}

ClustersClientGetOptions contains the optional parameters for the ClustersClient.Get method.

type ClustersClientGetResponse added in v0.2.0 

type ClustersClientGetResponse struct {
	Cluster
}

ClustersClientGetResponse contains the response from method ClustersClient.Get.

type ClustersClientListByResourceGroupOptions added in v0.2.0 

type ClustersClientListByResourceGroupOptions struct {
}

ClustersClientListByResourceGroupOptions contains the optional parameters for the ClustersClient.ListByResourceGroup method.

type ClustersClientListByResourceGroupResponse added in v0.2.0 

type ClustersClientListByResourceGroupResponse struct {
	ClusterListResult
}

ClustersClientListByResourceGroupResponse contains the response from method ClustersClient.ListByResourceGroup.

type ClustersClientListOptions added in v0.2.0 

type ClustersClientListOptions struct {
}

ClustersClientListOptions contains the optional parameters for the ClustersClient.List method.

type ClustersClientListResponse added in v0.2.0 

type ClustersClientListResponse struct {
	ClusterListResult
}

ClustersClientListResponse contains the response from method ClustersClient.List.

type ClustersClientResizeResponse added in v0.2.0 

type ClustersClientResizeResponse struct {
}

ClustersClientResizeResponse contains the response from method ClustersClient.Resize.

type ClustersClientRotateDiskEncryptionKeyResponse added in v0.2.0 

type ClustersClientRotateDiskEncryptionKeyResponse struct {
}

ClustersClientRotateDiskEncryptionKeyResponse contains the response from method ClustersClient.RotateDiskEncryptionKey.

type ClustersClientUpdateAutoScaleConfigurationResponse added in v0.2.0 

type ClustersClientUpdateAutoScaleConfigurationResponse struct {
}

ClustersClientUpdateAutoScaleConfigurationResponse contains the response from method ClustersClient.UpdateAutoScaleConfiguration.

type ClustersClientUpdateGatewaySettingsResponse added in v0.2.0 

type ClustersClientUpdateGatewaySettingsResponse struct {
}

ClustersClientUpdateGatewaySettingsResponse contains the response from method ClustersClient.UpdateGatewaySettings.

type ClustersClientUpdateIdentityCertificateResponse added in v0.2.0 

type ClustersClientUpdateIdentityCertificateResponse struct {
}

ClustersClientUpdateIdentityCertificateResponse contains the response from method ClustersClient.UpdateIdentityCertificate.

type ClustersClientUpdateOptions added in v0.2.0 

type ClustersClientUpdateOptions struct {
}

ClustersClientUpdateOptions contains the optional parameters for the ClustersClient.Update method.

type ClustersClientUpdateResponse added in v0.2.0 

type ClustersClientUpdateResponse struct {
	Cluster
}

ClustersClientUpdateResponse contains the response from method ClustersClient.Update.

type ComputeIsolationProperties 

type ComputeIsolationProperties struct {
	// The flag indicates whether enable compute isolation or not.
	EnableComputeIsolation *bool `json:"enableComputeIsolation,omitempty"`

	// The host sku.
	HostSKU *string `json:"hostSku,omitempty"`
}

ComputeIsolationProperties - The compute isolation properties.

type ComputeProfile 

type ComputeProfile struct {
	// The list of roles in the cluster.
	Roles []*Role `json:"roles,omitempty"`
}

ComputeProfile - Describes the compute profile.

func (ComputeProfile) MarshalJSON 

func (c ComputeProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeProfile.

type ConfigurationsClient 

type ConfigurationsClient struct {
	// contains filtered or unexported fields
}

ConfigurationsClient contains the methods for the Configurations group. Don't use this type directly, use NewConfigurationsClient() instead.

func NewConfigurationsClient 

func NewConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConfigurationsClient, error)

NewConfigurationsClient creates a new instance of ConfigurationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ConfigurationsClient) BeginUpdate 

func (client *ConfigurationsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, configurationName string, parameters map[string]*string, options *ConfigurationsClientBeginUpdateOptions) (*armruntime.Poller[ConfigurationsClientUpdateResponse], error)

BeginUpdate - Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. configurationName - The name of the cluster configuration. parameters - The cluster configurations. options - ConfigurationsClientBeginUpdateOptions contains the optional parameters for the ConfigurationsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/ChangeHttpConnectivityDisable.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewConfigurationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<configuration-name>",
		map[string]*string{
			"restAuthCredential.isEnabled": to.Ptr("false"),
		},
		&armhdinsight.ConfigurationsClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ConfigurationsClient) Get 

func (client *ConfigurationsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, configurationName string, options *ConfigurationsClientGetOptions) (ConfigurationsClientGetResponse, error)

Get - The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. configurationName - The name of the cluster configuration. options - ConfigurationsClientGetOptions contains the optional parameters for the ConfigurationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Configurations_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewConfigurationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<configuration-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConfigurationsClient) List 

func (client *ConfigurationsClient) List(ctx context.Context, resourceGroupName string, clusterName string, options *ConfigurationsClientListOptions) (ConfigurationsClientListResponse, error)

List - Gets all configuration information for an HDI cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ConfigurationsClientListOptions contains the optional parameters for the ConfigurationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Configurations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewConfigurationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type ConfigurationsClientBeginUpdateOptions added in v0.2.0 

type ConfigurationsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationsClientBeginUpdateOptions contains the optional parameters for the ConfigurationsClient.BeginUpdate method.

type ConfigurationsClientGetOptions added in v0.2.0 

type ConfigurationsClientGetOptions struct {
}

ConfigurationsClientGetOptions contains the optional parameters for the ConfigurationsClient.Get method.

type ConfigurationsClientGetResponse added in v0.2.0 

type ConfigurationsClientGetResponse struct {
	// The configuration object for the specified configuration for the specified cluster.
	Value map[string]*string
}

ConfigurationsClientGetResponse contains the response from method ConfigurationsClient.Get.

type ConfigurationsClientListOptions added in v0.2.0 

type ConfigurationsClientListOptions struct {
}

ConfigurationsClientListOptions contains the optional parameters for the ConfigurationsClient.List method.

type ConfigurationsClientListResponse added in v0.2.0 

type ConfigurationsClientListResponse struct {
	ClusterConfigurations
}

ConfigurationsClientListResponse contains the response from method ConfigurationsClient.List.

type ConfigurationsClientUpdateResponse added in v0.2.0 

type ConfigurationsClientUpdateResponse struct {
}

ConfigurationsClientUpdateResponse contains the response from method ConfigurationsClient.Update.

type ConnectivityEndpoint 

type ConnectivityEndpoint struct {
	// The location of the endpoint.
	Location *string `json:"location,omitempty"`

	// The name of the endpoint.
	Name *string `json:"name,omitempty"`

	// The port to connect to.
	Port *int32 `json:"port,omitempty"`

	// The private ip address of the endpoint.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The protocol of the endpoint.
	Protocol *string `json:"protocol,omitempty"`
}

ConnectivityEndpoint - The connectivity properties

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type DataDisksGroups 

type DataDisksGroups struct {
	// The number of disks per node.
	DisksPerNode *int32 `json:"disksPerNode,omitempty"`

	// READ-ONLY; ReadOnly. The DiskSize in GB. Do not set this value.
	DiskSizeGB *int32 `json:"diskSizeGB,omitempty" azure:"ro"`

	// READ-ONLY; ReadOnly. The storage account type. Do not set this value.
	StorageAccountType *string `json:"storageAccountType,omitempty" azure:"ro"`
}

DataDisksGroups - The data disks groups for the role.

type DaysOfWeek 

type DaysOfWeek string
const (
	DaysOfWeekFriday    DaysOfWeek = "Friday"
	DaysOfWeekMonday    DaysOfWeek = "Monday"
	DaysOfWeekSaturday  DaysOfWeek = "Saturday"
	DaysOfWeekSunday    DaysOfWeek = "Sunday"
	DaysOfWeekThursday  DaysOfWeek = "Thursday"
	DaysOfWeekTuesday   DaysOfWeek = "Tuesday"
	DaysOfWeekWednesday DaysOfWeek = "Wednesday"
)

func PossibleDaysOfWeekValues 

func PossibleDaysOfWeekValues() []DaysOfWeek

PossibleDaysOfWeekValues returns the possible values for the DaysOfWeek const type.

type Dimension 

type Dimension struct {
	// The display name of the dimension.
	DisplayName *string `json:"displayName,omitempty"`

	// The display name of the dimension.
	InternalName *string `json:"internalName,omitempty"`

	// The name of the dimension.
	Name *string `json:"name,omitempty"`

	// The flag indicates whether the metric will be exported for shoebox or not.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

Dimension - The definition of Dimension.

type DirectoryType 

type DirectoryType string

DirectoryType - The directory type. 

const (
	DirectoryTypeActiveDirectory DirectoryType = "ActiveDirectory"
)

func PossibleDirectoryTypeValues 

func PossibleDirectoryTypeValues() []DirectoryType

PossibleDirectoryTypeValues returns the possible values for the DirectoryType const type.

type DiskBillingMeters 

type DiskBillingMeters struct {
	// The managed disk meter guid.
	DiskRpMeter *string `json:"diskRpMeter,omitempty"`

	// The managed disk billing sku, P30 or S30.
	SKU *string `json:"sku,omitempty"`

	// The managed disk billing tier, Standard or Premium.
	Tier *Tier `json:"tier,omitempty"`
}

DiskBillingMeters - The disk billing meters.

type DiskEncryptionProperties 

type DiskEncryptionProperties struct {
	// Algorithm identifier for encryption, default RSA-OAEP.
	EncryptionAlgorithm *JSONWebKeyEncryptionAlgorithm `json:"encryptionAlgorithm,omitempty"`

	// Indicates whether or not resource disk encryption is enabled.
	EncryptionAtHost *bool `json:"encryptionAtHost,omitempty"`

	// Key name that is used for enabling disk encryption.
	KeyName *string `json:"keyName,omitempty"`

	// Specific key version that is used for enabling disk encryption.
	KeyVersion *string `json:"keyVersion,omitempty"`

	// Resource ID of Managed Identity that is used to access the key vault.
	MsiResourceID *string `json:"msiResourceId,omitempty"`

	// Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net
	VaultURI *string `json:"vaultUri,omitempty"`
}

DiskEncryptionProperties - The disk encryption properties

type EncryptionInTransitProperties 

type EncryptionInTransitProperties struct {
	// Indicates whether or not inter cluster node communication is encrypted in transit.
	IsEncryptionInTransitEnabled *bool `json:"isEncryptionInTransitEnabled,omitempty"`
}

EncryptionInTransitProperties - The encryption-in-transit properties.

type ErrorResponse 

type ErrorResponse struct {
	// Error code
	Code *string `json:"code,omitempty"`

	// Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse - Describes the format of Error response.

type Errors 

type Errors struct {
	// The error code.
	Code *string `json:"code,omitempty"`

	// The error message.
	Message *string `json:"message,omitempty"`
}

Errors - The error message associated with the cluster creation.

type ExcludedServicesConfig 

type ExcludedServicesConfig struct {
	// The config id of excluded services.
	ExcludedServicesConfigID *string `json:"excludedServicesConfigId,omitempty"`

	// The list of excluded services.
	ExcludedServicesList *string `json:"excludedServicesList,omitempty"`
}

ExcludedServicesConfig - The configuration that services will be excluded when creating cluster.

type ExecuteScriptActionParameters 

type ExecuteScriptActionParameters struct {
	// REQUIRED; Gets or sets if the scripts needs to be persisted.
	PersistOnSuccess *bool `json:"persistOnSuccess,omitempty"`

	// The list of run time script actions.
	ScriptActions []*RuntimeScriptAction `json:"scriptActions,omitempty"`
}

ExecuteScriptActionParameters - The parameters for the script actions to execute on a running cluster.

func (ExecuteScriptActionParameters) MarshalJSON 

func (e ExecuteScriptActionParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExecuteScriptActionParameters.

type Extension 

type Extension struct {
	// The certificate for the cluster monitoring extensions.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// The workspace ID for the cluster monitoring extension.
	WorkspaceID *string `json:"workspaceId,omitempty"`
}

Extension - Cluster monitoring extensions.

type ExtensionsClient 

type ExtensionsClient struct {
	// contains filtered or unexported fields
}

ExtensionsClient contains the methods for the Extensions group. Don't use this type directly, use NewExtensionsClient() instead.

func NewExtensionsClient 

func NewExtensionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExtensionsClient, error)

NewExtensionsClient creates a new instance of ExtensionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExtensionsClient) BeginCreate 

func (client *ExtensionsClient) BeginCreate(ctx context.Context, resourceGroupName string, clusterName string, extensionName string, parameters Extension, options *ExtensionsClientBeginCreateOptions) (*armruntime.Poller[ExtensionsClientCreateResponse], error)

BeginCreate - Creates an HDInsight cluster extension. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. extensionName - The name of the cluster extension. parameters - The cluster extensions create request. options - ExtensionsClientBeginCreateOptions contains the optional parameters for the ExtensionsClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/CreateExtension.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<extension-name>",
		armhdinsight.Extension{
			PrimaryKey:  to.Ptr("<primary-key>"),
			WorkspaceID: to.Ptr("<workspace-id>"),
		},
		&armhdinsight.ExtensionsClientBeginCreateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ExtensionsClient) BeginDelete 

func (client *ExtensionsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, extensionName string, options *ExtensionsClientBeginDeleteOptions) (*armruntime.Poller[ExtensionsClientDeleteResponse], error)

BeginDelete - Deletes the specified extension for HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. extensionName - The name of the cluster extension. options - ExtensionsClientBeginDeleteOptions contains the optional parameters for the ExtensionsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DeleteExtension.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<extension-name>",
		&armhdinsight.ExtensionsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ExtensionsClient) BeginDisableAzureMonitor 

func (client *ExtensionsClient) BeginDisableAzureMonitor(ctx context.Context, resourceGroupName string, clusterName string, options *ExtensionsClientBeginDisableAzureMonitorOptions) (*armruntime.Poller[ExtensionsClientDisableAzureMonitorResponse], error)

BeginDisableAzureMonitor - Disables the Azure Monitor on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ExtensionsClientBeginDisableAzureMonitorOptions contains the optional parameters for the ExtensionsClient.BeginDisableAzureMonitor method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DisableLinuxClusterAzureMonitor.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDisableAzureMonitor(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		&armhdinsight.ExtensionsClientBeginDisableAzureMonitorOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ExtensionsClient) BeginDisableMonitoring 

func (client *ExtensionsClient) BeginDisableMonitoring(ctx context.Context, resourceGroupName string, clusterName string, options *ExtensionsClientBeginDisableMonitoringOptions) (*armruntime.Poller[ExtensionsClientDisableMonitoringResponse], error)

BeginDisableMonitoring - Disables the Operations Management Suite (OMS) on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ExtensionsClientBeginDisableMonitoringOptions contains the optional parameters for the ExtensionsClient.BeginDisableMonitoring method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DisableLinuxClusterMonitoring.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDisableMonitoring(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		&armhdinsight.ExtensionsClientBeginDisableMonitoringOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ExtensionsClient) BeginEnableAzureMonitor 

func (client *ExtensionsClient) BeginEnableAzureMonitor(ctx context.Context, resourceGroupName string, clusterName string, parameters AzureMonitorRequest, options *ExtensionsClientBeginEnableAzureMonitorOptions) (*armruntime.Poller[ExtensionsClientEnableAzureMonitorResponse], error)

BeginEnableAzureMonitor - Enables the Azure Monitor on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The Log Analytics workspace parameters. options - ExtensionsClientBeginEnableAzureMonitorOptions contains the optional parameters for the ExtensionsClient.BeginEnableAzureMonitor method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/EnableLinuxClusterAzureMonitor.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginEnableAzureMonitor(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.AzureMonitorRequest{
			PrimaryKey:  to.Ptr("<primary-key>"),
			WorkspaceID: to.Ptr("<workspace-id>"),
		},
		&armhdinsight.ExtensionsClientBeginEnableAzureMonitorOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ExtensionsClient) BeginEnableMonitoring 

func (client *ExtensionsClient) BeginEnableMonitoring(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterMonitoringRequest, options *ExtensionsClientBeginEnableMonitoringOptions) (*armruntime.Poller[ExtensionsClientEnableMonitoringResponse], error)

BeginEnableMonitoring - Enables the Operations Management Suite (OMS) on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. parameters - The Operations Management Suite (OMS) workspace parameters. options - ExtensionsClientBeginEnableMonitoringOptions contains the optional parameters for the ExtensionsClient.BeginEnableMonitoring method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/EnableLinuxClusterMonitoring.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginEnableMonitoring(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		armhdinsight.ClusterMonitoringRequest{
			PrimaryKey:  to.Ptr("<primary-key>"),
			WorkspaceID: to.Ptr("<workspace-id>"),
		},
		&armhdinsight.ExtensionsClientBeginEnableMonitoringOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ExtensionsClient) Get 

func (client *ExtensionsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, extensionName string, options *ExtensionsClientGetOptions) (ExtensionsClientGetResponse, error)

Get - Gets the extension properties for the specified HDInsight cluster extension. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. extensionName - The name of the cluster extension. options - ExtensionsClientGetOptions contains the optional parameters for the ExtensionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetExtension.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<extension-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ExtensionsClient) GetAzureAsyncOperationStatus 

func (client *ExtensionsClient) GetAzureAsyncOperationStatus(ctx context.Context, resourceGroupName string, clusterName string, extensionName string, operationID string, options *ExtensionsClientGetAzureAsyncOperationStatusOptions) (ExtensionsClientGetAzureAsyncOperationStatusResponse, error)

GetAzureAsyncOperationStatus - Gets the async operation status. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. extensionName - The name of the cluster extension. operationID - The long running operation id. options - ExtensionsClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the ExtensionsClient.GetAzureAsyncOperationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetExtensionCreationAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetAzureAsyncOperationStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<extension-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ExtensionsClient) GetAzureMonitorStatus 

func (client *ExtensionsClient) GetAzureMonitorStatus(ctx context.Context, resourceGroupName string, clusterName string, options *ExtensionsClientGetAzureMonitorStatusOptions) (ExtensionsClientGetAzureMonitorStatusResponse, error)

GetAzureMonitorStatus - Gets the status of Azure Monitor on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ExtensionsClientGetAzureMonitorStatusOptions contains the optional parameters for the ExtensionsClient.GetAzureMonitorStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxClusterAzureMonitorStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetAzureMonitorStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ExtensionsClient) GetMonitoringStatus 

func (client *ExtensionsClient) GetMonitoringStatus(ctx context.Context, resourceGroupName string, clusterName string, options *ExtensionsClientGetMonitoringStatusOptions) (ExtensionsClientGetMonitoringStatusResponse, error)

GetMonitoringStatus - Gets the status of Operations Management Suite (OMS) on the HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ExtensionsClientGetMonitoringStatusOptions contains the optional parameters for the ExtensionsClient.GetMonitoringStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxClusterMonitoringStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewExtensionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetMonitoringStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type ExtensionsClientBeginCreateOptions added in v0.2.0 

type ExtensionsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExtensionsClientBeginCreateOptions contains the optional parameters for the ExtensionsClient.BeginCreate method.

type ExtensionsClientBeginDeleteOptions added in v0.2.0 

type ExtensionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExtensionsClientBeginDeleteOptions contains the optional parameters for the ExtensionsClient.BeginDelete method.

type ExtensionsClientBeginDisableAzureMonitorOptions added in v0.2.0 

type ExtensionsClientBeginDisableAzureMonitorOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExtensionsClientBeginDisableAzureMonitorOptions contains the optional parameters for the ExtensionsClient.BeginDisableAzureMonitor method.

type ExtensionsClientBeginDisableMonitoringOptions added in v0.2.0 

type ExtensionsClientBeginDisableMonitoringOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExtensionsClientBeginDisableMonitoringOptions contains the optional parameters for the ExtensionsClient.BeginDisableMonitoring method.

type ExtensionsClientBeginEnableAzureMonitorOptions added in v0.2.0 

type ExtensionsClientBeginEnableAzureMonitorOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExtensionsClientBeginEnableAzureMonitorOptions contains the optional parameters for the ExtensionsClient.BeginEnableAzureMonitor method.

type ExtensionsClientBeginEnableMonitoringOptions added in v0.2.0 

type ExtensionsClientBeginEnableMonitoringOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExtensionsClientBeginEnableMonitoringOptions contains the optional parameters for the ExtensionsClient.BeginEnableMonitoring method.

type ExtensionsClientCreateResponse added in v0.2.0 

type ExtensionsClientCreateResponse struct {
}

ExtensionsClientCreateResponse contains the response from method ExtensionsClient.Create.

type ExtensionsClientDeleteResponse added in v0.2.0 

type ExtensionsClientDeleteResponse struct {
}

ExtensionsClientDeleteResponse contains the response from method ExtensionsClient.Delete.

type ExtensionsClientDisableAzureMonitorResponse added in v0.2.0 

type ExtensionsClientDisableAzureMonitorResponse struct {
}

ExtensionsClientDisableAzureMonitorResponse contains the response from method ExtensionsClient.DisableAzureMonitor.

type ExtensionsClientDisableMonitoringResponse added in v0.2.0 

type ExtensionsClientDisableMonitoringResponse struct {
}

ExtensionsClientDisableMonitoringResponse contains the response from method ExtensionsClient.DisableMonitoring.

type ExtensionsClientEnableAzureMonitorResponse added in v0.2.0 

type ExtensionsClientEnableAzureMonitorResponse struct {
}

ExtensionsClientEnableAzureMonitorResponse contains the response from method ExtensionsClient.EnableAzureMonitor.

type ExtensionsClientEnableMonitoringResponse added in v0.2.0 

type ExtensionsClientEnableMonitoringResponse struct {
}

ExtensionsClientEnableMonitoringResponse contains the response from method ExtensionsClient.EnableMonitoring.

type ExtensionsClientGetAzureAsyncOperationStatusOptions added in v0.2.0 

type ExtensionsClientGetAzureAsyncOperationStatusOptions struct {
}

ExtensionsClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the ExtensionsClient.GetAzureAsyncOperationStatus method.

type ExtensionsClientGetAzureAsyncOperationStatusResponse added in v0.2.0 

type ExtensionsClientGetAzureAsyncOperationStatusResponse struct {
	AsyncOperationResult
}

ExtensionsClientGetAzureAsyncOperationStatusResponse contains the response from method ExtensionsClient.GetAzureAsyncOperationStatus.

type ExtensionsClientGetAzureMonitorStatusOptions added in v0.2.0 

type ExtensionsClientGetAzureMonitorStatusOptions struct {
}

ExtensionsClientGetAzureMonitorStatusOptions contains the optional parameters for the ExtensionsClient.GetAzureMonitorStatus method.

type ExtensionsClientGetAzureMonitorStatusResponse added in v0.2.0 

type ExtensionsClientGetAzureMonitorStatusResponse struct {
	AzureMonitorResponse
}

ExtensionsClientGetAzureMonitorStatusResponse contains the response from method ExtensionsClient.GetAzureMonitorStatus.

type ExtensionsClientGetMonitoringStatusOptions added in v0.2.0 

type ExtensionsClientGetMonitoringStatusOptions struct {
}

ExtensionsClientGetMonitoringStatusOptions contains the optional parameters for the ExtensionsClient.GetMonitoringStatus method.

type ExtensionsClientGetMonitoringStatusResponse added in v0.2.0 

type ExtensionsClientGetMonitoringStatusResponse struct {
	ClusterMonitoringResponse
}

ExtensionsClientGetMonitoringStatusResponse contains the response from method ExtensionsClient.GetMonitoringStatus.

type ExtensionsClientGetOptions added in v0.2.0 

type ExtensionsClientGetOptions struct {
}

ExtensionsClientGetOptions contains the optional parameters for the ExtensionsClient.Get method.

type ExtensionsClientGetResponse added in v0.2.0 

type ExtensionsClientGetResponse struct {
	ClusterMonitoringResponse
}

ExtensionsClientGetResponse contains the response from method ExtensionsClient.Get.

type FilterMode 

type FilterMode string

FilterMode - The filtering mode. Effectively this can enabling or disabling the VM sizes in a particular set. 

const (
	FilterModeDefault   FilterMode = "Default"
	FilterModeExclude   FilterMode = "Exclude"
	FilterModeInclude   FilterMode = "Include"
	FilterModeRecommend FilterMode = "Recommend"
)

func PossibleFilterModeValues 

func PossibleFilterModeValues() []FilterMode

PossibleFilterModeValues returns the possible values for the FilterMode const type.

type GatewaySettings 

type GatewaySettings struct {
	// READ-ONLY; Indicates whether or not the gateway settings based authorization is enabled.
	IsCredentialEnabled *string `json:"restAuthCredential.isEnabled,omitempty" azure:"ro"`

	// READ-ONLY; The gateway settings user password.
	Password *string `json:"restAuthCredential.password,omitempty" azure:"ro"`

	// READ-ONLY; The gateway settings user name.
	UserName *string `json:"restAuthCredential.username,omitempty" azure:"ro"`
}

GatewaySettings - Gateway settings.

type HDInsightClusterProvisioningState 

type HDInsightClusterProvisioningState string

HDInsightClusterProvisioningState - The provisioning state, which only appears in the response. 

const (
	HDInsightClusterProvisioningStateCanceled   HDInsightClusterProvisioningState = "Canceled"
	HDInsightClusterProvisioningStateDeleting   HDInsightClusterProvisioningState = "Deleting"
	HDInsightClusterProvisioningStateFailed     HDInsightClusterProvisioningState = "Failed"
	HDInsightClusterProvisioningStateInProgress HDInsightClusterProvisioningState = "InProgress"
	HDInsightClusterProvisioningStateSucceeded  HDInsightClusterProvisioningState = "Succeeded"
)

func PossibleHDInsightClusterProvisioningStateValues 

func PossibleHDInsightClusterProvisioningStateValues() []HDInsightClusterProvisioningState

PossibleHDInsightClusterProvisioningStateValues returns the possible values for the HDInsightClusterProvisioningState const type.

type HardwareProfile 

type HardwareProfile struct {
	// The size of the VM
	VMSize *string `json:"vmSize,omitempty"`
}

HardwareProfile - The hardware profile.

type HostInfo 

type HostInfo struct {
	// The effective disk encryption key URL used by the host
	EffectiveDiskEncryptionKeyURL *string `json:"effectiveDiskEncryptionKeyUrl,omitempty"`

	// The Fully Qualified Domain Name of host
	Fqdn *string `json:"fqdn,omitempty"`

	// The host name
	Name *string `json:"name,omitempty"`
}

HostInfo - The cluster host information.

type IPConfiguration 

type IPConfiguration struct {
	// REQUIRED; The name of private link IP configuration.
	Name *string `json:"name,omitempty"`

	// The private link ip configuration properties.
	Properties *IPConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; The private link IP configuration id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The type of the private link IP configuration.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IPConfiguration - The ip configurations for the private link service.

type IPConfigurationProperties 

type IPConfigurationProperties struct {
	// Indicates whether this IP configuration is primary for the corresponding NIC.
	Primary *bool `json:"primary,omitempty"`

	// The IP address.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The method that private IP address is allocated.
	PrivateIPAllocationMethod *PrivateIPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The subnet resource id.
	Subnet *ResourceID `json:"subnet,omitempty"`

	// READ-ONLY; The private link configuration provisioning state, which only appears in the response.
	ProvisioningState *PrivateLinkConfigurationProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IPConfigurationProperties - The private link ip configuration properties.

type JSONWebKeyEncryptionAlgorithm 

type JSONWebKeyEncryptionAlgorithm string

JSONWebKeyEncryptionAlgorithm - Algorithm identifier for encryption, default RSA-OAEP. 

const (
	JSONWebKeyEncryptionAlgorithmRSA15      JSONWebKeyEncryptionAlgorithm = "RSA1_5"
	JSONWebKeyEncryptionAlgorithmRSAOAEP    JSONWebKeyEncryptionAlgorithm = "RSA-OAEP"
	JSONWebKeyEncryptionAlgorithmRSAOAEP256 JSONWebKeyEncryptionAlgorithm = "RSA-OAEP-256"
)

func PossibleJSONWebKeyEncryptionAlgorithmValues 

func PossibleJSONWebKeyEncryptionAlgorithmValues() []JSONWebKeyEncryptionAlgorithm

PossibleJSONWebKeyEncryptionAlgorithmValues returns the possible values for the JSONWebKeyEncryptionAlgorithm const type.

type KafkaRestProperties 

type KafkaRestProperties struct {
	// The information of AAD security group.
	ClientGroupInfo *ClientGroupInfo `json:"clientGroupInfo,omitempty"`

	// The configurations that need to be overriden.
	ConfigurationOverride map[string]*string `json:"configurationOverride,omitempty"`
}

KafkaRestProperties - The kafka rest proxy configuration which contains AAD security group information.

func (KafkaRestProperties) MarshalJSON 

func (k KafkaRestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KafkaRestProperties.

type LinuxOperatingSystemProfile 

type LinuxOperatingSystemProfile struct {
	// The password.
	Password *string `json:"password,omitempty"`

	// The SSH profile.
	SSHProfile *SSHProfile `json:"sshProfile,omitempty"`

	// The username.
	Username *string `json:"username,omitempty"`
}

LinuxOperatingSystemProfile - The ssh username, password, and ssh public key.

type LocalizedName 

type LocalizedName struct {
	// The localized name of the used resource.
	LocalizedValue *string `json:"localizedValue,omitempty"`

	// The name of the used resource.
	Value *string `json:"value,omitempty"`
}

LocalizedName - The details about the localizable name of a type of usage.

type LocationsClient 

type LocationsClient struct {
	// contains filtered or unexported fields
}

LocationsClient contains the methods for the Locations group. Don't use this type directly, use NewLocationsClient() instead.

func NewLocationsClient 

func NewLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LocationsClient, error)

NewLocationsClient creates a new instance of LocationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LocationsClient) CheckNameAvailability 

func (client *LocationsClient) CheckNameAvailability(ctx context.Context, location string, parameters NameAvailabilityCheckRequestParameters, options *LocationsClientCheckNameAvailabilityOptions) (LocationsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Check the cluster name is available or not. If the operation fails it returns an *azcore.ResponseError type. location - The Azure location (region) for which to make the request. options - LocationsClientCheckNameAvailabilityOptions contains the optional parameters for the LocationsClient.CheckNameAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Locations_CheckClusterNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.CheckNameAvailability(ctx,
		"<location>",
		armhdinsight.NameAvailabilityCheckRequestParameters{
			Name: to.Ptr("<name>"),
			Type: to.Ptr("<type>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) GetAzureAsyncOperationStatus 

func (client *LocationsClient) GetAzureAsyncOperationStatus(ctx context.Context, location string, operationID string, options *LocationsClientGetAzureAsyncOperationStatusOptions) (LocationsClientGetAzureAsyncOperationStatusResponse, error)

GetAzureAsyncOperationStatus - Get the async operation status. If the operation fails it returns an *azcore.ResponseError type. location - The Azure location (region) for which to make the request. operationID - The long running operation id. options - LocationsClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the LocationsClient.GetAzureAsyncOperationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Locations_GetAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetAzureAsyncOperationStatus(ctx,
		"<location>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) GetCapabilities 

func (client *LocationsClient) GetCapabilities(ctx context.Context, location string, options *LocationsClientGetCapabilitiesOptions) (LocationsClientGetCapabilitiesResponse, error)

GetCapabilities - Gets the capabilities for the specified location. If the operation fails it returns an *azcore.ResponseError type. location - The Azure location (region) for which to make the request. options - LocationsClientGetCapabilitiesOptions contains the optional parameters for the LocationsClient.GetCapabilities method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetHDInsightCapabilities.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetCapabilities(ctx,
		"<location>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) ListBillingSpecs 

func (client *LocationsClient) ListBillingSpecs(ctx context.Context, location string, options *LocationsClientListBillingSpecsOptions) (LocationsClientListBillingSpecsResponse, error)

ListBillingSpecs - Lists the billingSpecs for the specified subscription and location. If the operation fails it returns an *azcore.ResponseError type. location - The Azure location (region) for which to make the request. options - LocationsClientListBillingSpecsOptions contains the optional parameters for the LocationsClient.ListBillingSpecs method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Locations_ListBillingSpecs.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListBillingSpecs(ctx,
		"<location>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) ListUsages 

func (client *LocationsClient) ListUsages(ctx context.Context, location string, options *LocationsClientListUsagesOptions) (LocationsClientListUsagesResponse, error)

ListUsages - Lists the usages for the specified location. If the operation fails it returns an *azcore.ResponseError type. location - The Azure location (region) for which to make the request. options - LocationsClientListUsagesOptions contains the optional parameters for the LocationsClient.ListUsages method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetHDInsightUsages.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListUsages(ctx,
		"<location>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) ValidateClusterCreateRequest 

func (client *LocationsClient) ValidateClusterCreateRequest(ctx context.Context, location string, parameters ClusterCreateRequestValidationParameters, options *LocationsClientValidateClusterCreateRequestOptions) (LocationsClientValidateClusterCreateRequestResponse, error)

ValidateClusterCreateRequest - Validate the cluster create request spec is valid or not. If the operation fails it returns an *azcore.ResponseError type. location - The Azure location (region) for which to make the request. options - LocationsClientValidateClusterCreateRequestOptions contains the optional parameters for the LocationsClient.ValidateClusterCreateRequest method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/HDI_Locations_ValidateClusterCreateRequest.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ValidateClusterCreateRequest(ctx,
		"<location>",
		armhdinsight.ClusterCreateRequestValidationParameters{
			Location: to.Ptr("<location>"),
			Properties: &armhdinsight.ClusterCreateProperties{
				ClusterDefinition: &armhdinsight.ClusterDefinition{
					ComponentVersion: map[string]*string{
						"Spark": to.Ptr("2.4"),
					},
					Configurations: map[string]interface{}{
						"gateway": map[string]interface{}{
							"restAuthCredential.isEnabled": true,
							"restAuthCredential.password":  "**********",
							"restAuthCredential.username":  "admin",
						},
					},
					Kind: to.Ptr("<kind>"),
				},
				ClusterVersion: to.Ptr("<cluster-version>"),
				ComputeProfile: &armhdinsight.ComputeProfile{
					Roles: []*armhdinsight.Role{
						{
							Name: to.Ptr("<name>"),
							HardwareProfile: &armhdinsight.HardwareProfile{
								VMSize: to.Ptr("<vmsize>"),
							},
							MinInstanceCount: to.Ptr[int32](1),
							OSProfile: &armhdinsight.OsProfile{
								LinuxOperatingSystemProfile: &armhdinsight.LinuxOperatingSystemProfile{
									Password: to.Ptr("<password>"),
									Username: to.Ptr("<username>"),
								},
							},
							ScriptActions:       []*armhdinsight.ScriptAction{},
							TargetInstanceCount: to.Ptr[int32](2),
						},
						{
							Name: to.Ptr("<name>"),
							HardwareProfile: &armhdinsight.HardwareProfile{
								VMSize: to.Ptr("<vmsize>"),
							},
							OSProfile: &armhdinsight.OsProfile{
								LinuxOperatingSystemProfile: &armhdinsight.LinuxOperatingSystemProfile{
									Password: to.Ptr("<password>"),
									Username: to.Ptr("<username>"),
								},
							},
							ScriptActions:       []*armhdinsight.ScriptAction{},
							TargetInstanceCount: to.Ptr[int32](4),
						},
						{
							Name: to.Ptr("<name>"),
							HardwareProfile: &armhdinsight.HardwareProfile{
								VMSize: to.Ptr("<vmsize>"),
							},
							MinInstanceCount: to.Ptr[int32](1),
							OSProfile: &armhdinsight.OsProfile{
								LinuxOperatingSystemProfile: &armhdinsight.LinuxOperatingSystemProfile{
									Password: to.Ptr("<password>"),
									Username: to.Ptr("<username>"),
								},
							},
							ScriptActions:       []*armhdinsight.ScriptAction{},
							TargetInstanceCount: to.Ptr[int32](3),
						}},
				},
				MinSupportedTLSVersion: to.Ptr("<min-supported-tlsversion>"),
				OSType:                 to.Ptr(armhdinsight.OSTypeLinux),
				StorageProfile: &armhdinsight.StorageProfile{
					Storageaccounts: []*armhdinsight.StorageAccount{
						{
							Name:       to.Ptr("<name>"),
							Container:  to.Ptr("<container>"),
							IsDefault:  to.Ptr(true),
							Key:        to.Ptr("<key>"),
							ResourceID: to.Ptr("<resource-id>"),
						}},
				},
				Tier: to.Ptr(armhdinsight.TierStandard),
			},
			Tags:               map[string]*string{},
			Name:               to.Ptr("<name>"),
			Type:               to.Ptr("<type>"),
			FetchAaddsResource: to.Ptr(false),
			TenantID:           to.Ptr("<tenant-id>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type LocationsClientCheckNameAvailabilityOptions added in v0.2.0 

type LocationsClientCheckNameAvailabilityOptions struct {
}

LocationsClientCheckNameAvailabilityOptions contains the optional parameters for the LocationsClient.CheckNameAvailability method.

type LocationsClientCheckNameAvailabilityResponse added in v0.2.0 

type LocationsClientCheckNameAvailabilityResponse struct {
	NameAvailabilityCheckResult
}

LocationsClientCheckNameAvailabilityResponse contains the response from method LocationsClient.CheckNameAvailability.

type LocationsClientGetAzureAsyncOperationStatusOptions added in v0.2.0 

type LocationsClientGetAzureAsyncOperationStatusOptions struct {
}

LocationsClientGetAzureAsyncOperationStatusOptions contains the optional parameters for the LocationsClient.GetAzureAsyncOperationStatus method.

type LocationsClientGetAzureAsyncOperationStatusResponse added in v0.2.0 

type LocationsClientGetAzureAsyncOperationStatusResponse struct {
	AsyncOperationResult
}

LocationsClientGetAzureAsyncOperationStatusResponse contains the response from method LocationsClient.GetAzureAsyncOperationStatus.

type LocationsClientGetCapabilitiesOptions added in v0.2.0 

type LocationsClientGetCapabilitiesOptions struct {
}

LocationsClientGetCapabilitiesOptions contains the optional parameters for the LocationsClient.GetCapabilities method.

type LocationsClientGetCapabilitiesResponse added in v0.2.0 

type LocationsClientGetCapabilitiesResponse struct {
	CapabilitiesResult
}

LocationsClientGetCapabilitiesResponse contains the response from method LocationsClient.GetCapabilities.

type LocationsClientListBillingSpecsOptions added in v0.2.0 

type LocationsClientListBillingSpecsOptions struct {
}

LocationsClientListBillingSpecsOptions contains the optional parameters for the LocationsClient.ListBillingSpecs method.

type LocationsClientListBillingSpecsResponse added in v0.2.0 

type LocationsClientListBillingSpecsResponse struct {
	BillingResponseListResult
}

LocationsClientListBillingSpecsResponse contains the response from method LocationsClient.ListBillingSpecs.

type LocationsClientListUsagesOptions added in v0.2.0 

type LocationsClientListUsagesOptions struct {
}

LocationsClientListUsagesOptions contains the optional parameters for the LocationsClient.ListUsages method.

type LocationsClientListUsagesResponse added in v0.2.0 

type LocationsClientListUsagesResponse struct {
	UsagesListResult
}

LocationsClientListUsagesResponse contains the response from method LocationsClient.ListUsages.

type LocationsClientValidateClusterCreateRequestOptions added in v0.2.0 

type LocationsClientValidateClusterCreateRequestOptions struct {
}

LocationsClientValidateClusterCreateRequestOptions contains the optional parameters for the LocationsClient.ValidateClusterCreateRequest method.

type LocationsClientValidateClusterCreateRequestResponse added in v0.2.0 

type LocationsClientValidateClusterCreateRequestResponse struct {
	ClusterCreateValidationResult
}

LocationsClientValidateClusterCreateRequestResponse contains the response from method LocationsClient.ValidateClusterCreateRequest.

type MetricSpecifications 

type MetricSpecifications struct {
	// The aggregation type of the metric specification.
	AggregationType *string `json:"aggregationType,omitempty"`

	// The category of the metric.
	Category *string `json:"category,omitempty"`

	// The override name of delegate metric.
	DelegateMetricNameOverride *string `json:"delegateMetricNameOverride,omitempty"`

	// The dimensions of the metric specification.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

	// The display description of the metric specification.
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// The display name of the metric specification.
	DisplayName *string `json:"displayName,omitempty"`

	// The flag indicates whether enable regional mdm account or not.
	EnableRegionalMdmAccount *bool `json:"enableRegionalMdmAccount,omitempty"`

	// The flag indicates whether filling gap with zero.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// The flag indicates whether the metric is internal or not.
	IsInternal *bool `json:"isInternal,omitempty"`

	// The metric filter pattern.
	MetricFilterPattern *string `json:"metricFilterPattern,omitempty"`

	// The name of the metric specification.
	Name *string `json:"name,omitempty"`

	// The override name of resource id dimension name.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`

	// The source mdm account.
	SourceMdmAccount *string `json:"sourceMdmAccount,omitempty"`

	// The source mdm namespace.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty"`

	// The supported aggregation types of the metric specification.
	SupportedAggregationTypes []*string `json:"supportedAggregationTypes,omitempty"`

	// The supported time grain types of the metric specification.
	SupportedTimeGrainTypes []*string `json:"supportedTimeGrainTypes,omitempty"`

	// The unit of the metric specification.
	Unit *string `json:"unit,omitempty"`
}

MetricSpecifications - The details of metric specifications.

func (MetricSpecifications) MarshalJSON 

func (m MetricSpecifications) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecifications.

type NameAvailabilityCheckRequestParameters 

type NameAvailabilityCheckRequestParameters struct {
	// The resource name.
	Name *string `json:"name,omitempty"`

	// The resource type
	Type *string `json:"type,omitempty"`
}

NameAvailabilityCheckRequestParameters - The request spec of checking name availability.

type NameAvailabilityCheckResult 

type NameAvailabilityCheckResult struct {
	// This indicates whether the name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`

	// READ-ONLY; The related message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The reason of the result.
	Reason *string `json:"reason,omitempty" azure:"ro"`
}

NameAvailabilityCheckResult - The response spec of checking name availability.

type NetworkProperties 

type NetworkProperties struct {
	// Indicates whether or not private link is enabled.
	PrivateLink *PrivateLink `json:"privateLink,omitempty"`

	// The direction for the resource provider connection.
	ResourceProviderConnection *ResourceProviderConnection `json:"resourceProviderConnection,omitempty"`
}

NetworkProperties - The network properties.

type OSType 

type OSType string

OSType - The type of operating system. 

const (
	OSTypeLinux   OSType = "Linux"
	OSTypeWindows OSType = "Windows"
)

func PossibleOSTypeValues 

func PossibleOSTypeValues() []OSType

PossibleOSTypeValues returns the possible values for the OSType const type.

type Operation 

type Operation struct {
	// The display of operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// The operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`

	// The operation properties.
	Properties *OperationProperties `json:"properties,omitempty"`
}

Operation - The HDInsight REST API operation.

type OperationDisplay 

type OperationDisplay struct {
	// Localized friendly description for the operation
	Description *string `json:"description,omitempty"`

	// The operation type: read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// The service provider: Microsoft.HDInsight
	Provider *string `json:"provider,omitempty"`

	// The resource on which the operation is performed: Cluster, Applications, etc.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - The object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	// The URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of HDInsight operations supported by the HDInsight resource provider.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - Result of the request to list HDInsight operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationProperties 

type OperationProperties struct {
	// The specification of the service.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - The details of operation.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.4.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available HDInsight REST API operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OsProfile 

type OsProfile struct {
	// The Linux OS profile.
	LinuxOperatingSystemProfile *LinuxOperatingSystemProfile `json:"linuxOperatingSystemProfile,omitempty"`
}

OsProfile - The Linux operation systems profile.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// The private endpoint id.
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint - The private endpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// REQUIRED; The private endpoint connection properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The private endpoint connection.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// The list of private endpoint connections.
	Value []*PrivateEndpointConnection `json:"value,omitempty"`

	// READ-ONLY; The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PrivateEndpointConnectionListResult - The list private endpoint connections response.

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; The private link service connection state.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// READ-ONLY; The link identifier.
	LinkIdentifier *string `json:"linkIdentifier,omitempty" azure:"ro"`

	// READ-ONLY; The private endpoint of the private endpoint connection
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state, which only appears in the response.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - The private endpoint connection properties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The provisioning state, which only appears in the response. 

const (
	PrivateEndpointConnectionProvisioningStateCanceled   PrivateEndpointConnectionProvisioningState = "Canceled"
	PrivateEndpointConnectionProvisioningStateDeleting   PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed     PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateInProgress PrivateEndpointConnectionProvisioningState = "InProgress"
	PrivateEndpointConnectionProvisioningStateSucceeded  PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUpdating   PrivateEndpointConnectionProvisioningState = "Updating"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions) (*armruntime.Poller[PrivateEndpointConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Approve or reject a private endpoint connection manually. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. privateEndpointConnectionName - The name of the private endpoint connection. parameters - The private endpoint connection create or update request. options - PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/ApprovePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<private-endpoint-connection-name>",
		armhdinsight.PrivateEndpointConnection{
			Properties: &armhdinsight.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armhdinsight.PrivateLinkServiceConnectionState{
					Description:     to.Ptr("<description>"),
					ActionsRequired: to.Ptr("<actions-required>"),
					Status:          to.Ptr(armhdinsight.PrivateLinkServiceConnectionStatusApproved),
				},
			},
		},
		&armhdinsight.PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*armruntime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Deletes the specific private endpoint connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. privateEndpointConnectionName - The name of the private endpoint connection. options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DeletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<private-endpoint-connection-name>",
		&armhdinsight.PrivateEndpointConnectionsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specific private endpoint connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. privateEndpointConnectionName - The name of the private endpoint connection. options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) NewListByClusterPager added in v0.4.0 

func (client *PrivateEndpointConnectionsClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *PrivateEndpointConnectionsClientListByClusterOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByClusterResponse]

NewListByClusterPager - Lists the private endpoint connections for a HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - PrivateEndpointConnectionsClientListByClusterOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByCluster method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetAllPrivateEndpointConnectionsInCluster.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListByClusterPager("<resource-group-name>",
		"<cluster-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByClusterOptions added in v0.2.0 

type PrivateEndpointConnectionsClientListByClusterOptions struct {
}

PrivateEndpointConnectionsClientListByClusterOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByCluster method.

type PrivateEndpointConnectionsClientListByClusterResponse added in v0.2.0 

type PrivateEndpointConnectionsClientListByClusterResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByClusterResponse contains the response from method PrivateEndpointConnectionsClient.ListByCluster.

type PrivateIPAllocationMethod 

type PrivateIPAllocationMethod string

PrivateIPAllocationMethod - The method that private IP address is allocated. 

const (
	PrivateIPAllocationMethodDynamic PrivateIPAllocationMethod = "dynamic"
	PrivateIPAllocationMethodStatic  PrivateIPAllocationMethod = "static"
)

func PossiblePrivateIPAllocationMethodValues 

func PossiblePrivateIPAllocationMethodValues() []PrivateIPAllocationMethod

PossiblePrivateIPAllocationMethodValues returns the possible values for the PrivateIPAllocationMethod const type. 

type PrivateLink string

PrivateLink - Indicates whether or not private link is enabled. 

const (
	PrivateLinkDisabled PrivateLink = "Disabled"
	PrivateLinkEnabled  PrivateLink = "Enabled"
)

func PossiblePrivateLinkValues 

func PossiblePrivateLinkValues() []PrivateLink

PossiblePrivateLinkValues returns the possible values for the PrivateLink const type.

type PrivateLinkConfiguration 

type PrivateLinkConfiguration struct {
	// REQUIRED; The name of private link configuration.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The private link configuration properties.
	Properties *PrivateLinkConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; The private link configuration id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The type of the private link configuration.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkConfiguration - The private link configuration.

type PrivateLinkConfigurationProperties 

type PrivateLinkConfigurationProperties struct {
	// REQUIRED; The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode',
	// 'gateway', 'edgenode'.
	GroupID *string `json:"groupId,omitempty"`

	// REQUIRED; The IP configurations for the private link service.
	IPConfigurations []*IPConfiguration `json:"ipConfigurations,omitempty"`

	// READ-ONLY; The private link configuration provisioning state, which only appears in the response.
	ProvisioningState *PrivateLinkConfigurationProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateLinkConfigurationProperties - The private link configuration properties.

func (PrivateLinkConfigurationProperties) MarshalJSON 

func (p PrivateLinkConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkConfigurationProperties.

type PrivateLinkConfigurationProvisioningState 

type PrivateLinkConfigurationProvisioningState string

PrivateLinkConfigurationProvisioningState - The private link configuration provisioning state, which only appears in the response. 

const (
	PrivateLinkConfigurationProvisioningStateCanceled   PrivateLinkConfigurationProvisioningState = "Canceled"
	PrivateLinkConfigurationProvisioningStateDeleting   PrivateLinkConfigurationProvisioningState = "Deleting"
	PrivateLinkConfigurationProvisioningStateFailed     PrivateLinkConfigurationProvisioningState = "Failed"
	PrivateLinkConfigurationProvisioningStateInProgress PrivateLinkConfigurationProvisioningState = "InProgress"
	PrivateLinkConfigurationProvisioningStateSucceeded  PrivateLinkConfigurationProvisioningState = "Succeeded"
)

func PossiblePrivateLinkConfigurationProvisioningStateValues 

func PossiblePrivateLinkConfigurationProvisioningStateValues() []PrivateLinkConfigurationProvisioningState

PossiblePrivateLinkConfigurationProvisioningStateValues returns the possible values for the PrivateLinkConfigurationProvisioningState const type.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get 

func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, clusterName string, privateLinkResourceName string, options *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)

Get - Gets the specific private link resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. privateLinkResourceName - The name of the private link resource. options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetPrivateLinkResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<private-link-resource-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateLinkResourcesClient) ListByCluster 

func (client *PrivateLinkResourcesClient) ListByCluster(ctx context.Context, resourceGroupName string, clusterName string, options *PrivateLinkResourcesClientListByClusterOptions) (PrivateLinkResourcesClientListByClusterResponse, error)

ListByCluster - Lists the private link resources in a HDInsight cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - PrivateLinkResourcesClientListByClusterOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByCluster method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetAllPrivateLinkResourcesInCluster.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListByCluster(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type PrivateLinkResourcesClientGetOptions added in v0.2.0 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse added in v0.2.0 

type PrivateLinkResourcesClientGetResponse struct {
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListByClusterOptions added in v0.2.0 

type PrivateLinkResourcesClientListByClusterOptions struct {
}

PrivateLinkResourcesClientListByClusterOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByCluster method.

type PrivateLinkResourcesClientListByClusterResponse added in v0.2.0 

type PrivateLinkResourcesClientListByClusterResponse struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListByClusterResponse contains the response from method PrivateLinkResourcesClient.ListByCluster.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// REQUIRED; The concrete private link service connection.
	Status *PrivateLinkServiceConnectionStatus `json:"status,omitempty"`

	// Whether there is further actions.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The optional description of the status.
	Description *string `json:"description,omitempty"`
}

PrivateLinkServiceConnectionState - The private link service connection state.

type PrivateLinkServiceConnectionStatus 

type PrivateLinkServiceConnectionStatus string

PrivateLinkServiceConnectionStatus - The concrete private link service connection. 

const (
	PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusPending  PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected"
	PrivateLinkServiceConnectionStatusRemoved  PrivateLinkServiceConnectionStatus = "Removed"
)

func PossiblePrivateLinkServiceConnectionStatusValues 

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

PossiblePrivateLinkServiceConnectionStatusValues returns the possible values for the PrivateLinkServiceConnectionStatus const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type QuotaCapability 

type QuotaCapability struct {
	// The number of cores used in the subscription.
	CoresUsed *int64 `json:"coresUsed,omitempty"`

	// The number of cores that the subscription allowed.
	MaxCoresAllowed *int64 `json:"maxCoresAllowed,omitempty"`

	// The list of region quota capabilities.
	RegionalQuotas []*RegionalQuotaCapability `json:"regionalQuotas,omitempty"`
}

QuotaCapability - The regional quota capability.

func (QuotaCapability) MarshalJSON 

func (q QuotaCapability) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaCapability.

type QuotaInfo 

type QuotaInfo struct {
	// The cores used by the cluster.
	CoresUsed *int32 `json:"coresUsed,omitempty"`
}

QuotaInfo - The quota properties for the cluster.

type RegionalQuotaCapability 

type RegionalQuotaCapability struct {
	// The number of cores available in the region.
	CoresAvailable *int64 `json:"coresAvailable,omitempty"`

	// The number of cores used in the region.
	CoresUsed *int64 `json:"coresUsed,omitempty"`

	// The region name.
	RegionName *string `json:"regionName,omitempty"`
}

RegionalQuotaCapability - The regional quota capacity.

type RegionsCapability 

type RegionsCapability struct {
	// The list of region capabilities.
	Available []*string `json:"available,omitempty"`
}

RegionsCapability - The regions capability.

func (RegionsCapability) MarshalJSON 

func (r RegionsCapability) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegionsCapability.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ResourceID 

type ResourceID struct {
	// The azure resource id.
	ID *string `json:"id,omitempty"`
}

ResourceID - The azure resource id.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. 

const (
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

type ResourceProviderConnection 

type ResourceProviderConnection string

ResourceProviderConnection - The direction for the resource provider connection. 

const (
	ResourceProviderConnectionInbound  ResourceProviderConnection = "Inbound"
	ResourceProviderConnectionOutbound ResourceProviderConnection = "Outbound"
)

func PossibleResourceProviderConnectionValues 

func PossibleResourceProviderConnectionValues() []ResourceProviderConnection

PossibleResourceProviderConnectionValues returns the possible values for the ResourceProviderConnection const type.

type Role 

type Role struct {
	// The autoscale configurations.
	AutoscaleConfiguration *Autoscale `json:"autoscale,omitempty"`

	// The data disks groups for the role.
	DataDisksGroups []*DataDisksGroups `json:"dataDisksGroups,omitempty"`

	// Indicates whether encrypt the data disks.
	EncryptDataDisks *bool `json:"encryptDataDisks,omitempty"`

	// The hardware profile.
	HardwareProfile *HardwareProfile `json:"hardwareProfile,omitempty"`

	// The minimum instance count of the cluster.
	MinInstanceCount *int32 `json:"minInstanceCount,omitempty"`

	// The name of the role.
	Name *string `json:"name,omitempty"`

	// The operating system profile.
	OSProfile *OsProfile `json:"osProfile,omitempty"`

	// The list of script actions on the role.
	ScriptActions []*ScriptAction `json:"scriptActions,omitempty"`

	// The instance count of the cluster.
	TargetInstanceCount *int32 `json:"targetInstanceCount,omitempty"`

	// The name of the virtual machine group.
	VMGroupName *string `json:"VMGroupName,omitempty"`

	// The virtual network profile.
	VirtualNetworkProfile *VirtualNetworkProfile `json:"virtualNetworkProfile,omitempty"`
}

Role - Describes a role on the cluster.

func (Role) MarshalJSON 

func (r Role) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Role.

type RoleName 

type RoleName string
const (
	RoleNameWorkernode RoleName = "workernode"
)

func PossibleRoleNameValues 

func PossibleRoleNameValues() []RoleName

PossibleRoleNameValues returns the possible values for the RoleName const type.

type RuntimeScriptAction 

type RuntimeScriptAction struct {
	// REQUIRED; The name of the script action.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The list of roles where script will be executed.
	Roles []*string `json:"roles,omitempty"`

	// REQUIRED; The URI to the script.
	URI *string `json:"uri,omitempty"`

	// The parameters for the script
	Parameters *string `json:"parameters,omitempty"`

	// READ-ONLY; The application name of the script action, if any.
	ApplicationName *string `json:"applicationName,omitempty" azure:"ro"`
}

RuntimeScriptAction - Describes a script action on a running cluster.

func (RuntimeScriptAction) MarshalJSON 

func (r RuntimeScriptAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RuntimeScriptAction.

type RuntimeScriptActionDetail 

type RuntimeScriptActionDetail struct {
	// REQUIRED; The name of the script action.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The list of roles where script will be executed.
	Roles []*string `json:"roles,omitempty"`

	// REQUIRED; The URI to the script.
	URI *string `json:"uri,omitempty"`

	// The parameters for the script
	Parameters *string `json:"parameters,omitempty"`

	// READ-ONLY; The application name of the script action, if any.
	ApplicationName *string `json:"applicationName,omitempty" azure:"ro"`

	// READ-ONLY; The script action execution debug information.
	DebugInformation *string `json:"debugInformation,omitempty" azure:"ro"`

	// READ-ONLY; The end time of script action execution.
	EndTime *string `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; The summary of script action execution result.
	ExecutionSummary []*ScriptActionExecutionSummary `json:"executionSummary,omitempty" azure:"ro"`

	// READ-ONLY; The reason why the script action was executed.
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; The execution id of the script action.
	ScriptExecutionID *int64 `json:"scriptExecutionId,omitempty" azure:"ro"`

	// READ-ONLY; The start time of script action execution.
	StartTime *string `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; The current execution status of the script action.
	Status *string `json:"status,omitempty" azure:"ro"`
}

RuntimeScriptActionDetail - The execution details of a script action.

func (RuntimeScriptActionDetail) MarshalJSON 

func (r RuntimeScriptActionDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RuntimeScriptActionDetail.

type SSHProfile 

type SSHProfile struct {
	// The list of SSH public keys.
	PublicKeys []*SSHPublicKey `json:"publicKeys,omitempty"`
}

SSHProfile - The list of SSH public keys.

func (SSHProfile) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SSHProfile.

type SSHPublicKey 

type SSHPublicKey struct {
	// The certificate for SSH.
	CertificateData *string `json:"certificateData,omitempty"`
}

SSHPublicKey - The SSH public key for the cluster nodes.

type ScriptAction 

type ScriptAction struct {
	// REQUIRED; The name of the script action.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The parameters for the script provided.
	Parameters *string `json:"parameters,omitempty"`

	// REQUIRED; The URI to the script.
	URI *string `json:"uri,omitempty"`
}

ScriptAction - Describes a script action on role on the cluster.

type ScriptActionExecutionHistoryList 

type ScriptActionExecutionHistoryList struct {
	// READ-ONLY; The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of persisted script action details for the cluster.
	Value []*RuntimeScriptActionDetail `json:"value,omitempty" azure:"ro"`
}

ScriptActionExecutionHistoryList - The list script execution history response.

func (ScriptActionExecutionHistoryList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScriptActionExecutionHistoryList.

type ScriptActionExecutionSummary 

type ScriptActionExecutionSummary struct {
	// READ-ONLY; The instance count for a given script action execution status.
	InstanceCount *int32 `json:"instanceCount,omitempty" azure:"ro"`

	// READ-ONLY; The status of script action execution.
	Status *string `json:"status,omitempty" azure:"ro"`
}

ScriptActionExecutionSummary - The execution summary of a script action.

type ScriptActionPersistedGetResponseSpec 

type ScriptActionPersistedGetResponseSpec struct {
	// The application name for the script action.
	ApplicationName *string `json:"applicationName,omitempty"`

	// The name of script action.
	Name *string `json:"name,omitempty"`

	// The parameters for the script provided.
	Parameters *string `json:"parameters,omitempty"`

	// The list of roles where script will be executed.
	Roles []*string `json:"roles,omitempty"`

	// The URI to the script.
	URI *string `json:"uri,omitempty"`
}

ScriptActionPersistedGetResponseSpec - The persisted script action for cluster.

func (ScriptActionPersistedGetResponseSpec) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScriptActionPersistedGetResponseSpec.

type ScriptActionsClient 

type ScriptActionsClient struct {
	// contains filtered or unexported fields
}

ScriptActionsClient contains the methods for the ScriptActions group. Don't use this type directly, use NewScriptActionsClient() instead.

func NewScriptActionsClient 

func NewScriptActionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ScriptActionsClient, error)

NewScriptActionsClient creates a new instance of ScriptActionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ScriptActionsClient) Delete 

func (client *ScriptActionsClient) Delete(ctx context.Context, resourceGroupName string, clusterName string, scriptName string, options *ScriptActionsClientDeleteOptions) (ScriptActionsClientDeleteResponse, error)

Delete - Deletes a specified persisted script action of the cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. scriptName - The name of the script. options - ScriptActionsClientDeleteOptions contains the optional parameters for the ScriptActionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/DeleteScriptAction.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewScriptActionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<script-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
}

Output:

func (*ScriptActionsClient) GetExecutionAsyncOperationStatus 

func (client *ScriptActionsClient) GetExecutionAsyncOperationStatus(ctx context.Context, resourceGroupName string, clusterName string, operationID string, options *ScriptActionsClientGetExecutionAsyncOperationStatusOptions) (ScriptActionsClientGetExecutionAsyncOperationStatusResponse, error)

GetExecutionAsyncOperationStatus - Gets the async operation status of execution operation. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. operationID - The long running operation id. options - ScriptActionsClientGetExecutionAsyncOperationStatusOptions contains the optional parameters for the ScriptActionsClient.GetExecutionAsyncOperationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetScriptExecutionAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewScriptActionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetExecutionAsyncOperationStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ScriptActionsClient) GetExecutionDetail 

func (client *ScriptActionsClient) GetExecutionDetail(ctx context.Context, resourceGroupName string, clusterName string, scriptExecutionID string, options *ScriptActionsClientGetExecutionDetailOptions) (ScriptActionsClientGetExecutionDetailResponse, error)

GetExecutionDetail - Gets the script execution detail for the given script execution ID. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. scriptExecutionID - The script execution Id options - ScriptActionsClientGetExecutionDetailOptions contains the optional parameters for the ScriptActionsClient.GetExecutionDetail method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetScriptActionById.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewScriptActionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetExecutionDetail(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<script-execution-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ScriptActionsClient) NewListByClusterPager added in v0.4.0 

func (client *ScriptActionsClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *ScriptActionsClientListByClusterOptions) *runtime.Pager[ScriptActionsClientListByClusterResponse]

NewListByClusterPager - Lists all the persisted script actions for the specified cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ScriptActionsClientListByClusterOptions contains the optional parameters for the ScriptActionsClient.ListByCluster method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopScriptAction.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewScriptActionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListByClusterPager("<resource-group-name>",
		"<cluster-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ScriptActionsClientDeleteOptions added in v0.2.0 

type ScriptActionsClientDeleteOptions struct {
}

ScriptActionsClientDeleteOptions contains the optional parameters for the ScriptActionsClient.Delete method.

type ScriptActionsClientDeleteResponse added in v0.2.0 

type ScriptActionsClientDeleteResponse struct {
}

ScriptActionsClientDeleteResponse contains the response from method ScriptActionsClient.Delete.

type ScriptActionsClientGetExecutionAsyncOperationStatusOptions added in v0.2.0 

type ScriptActionsClientGetExecutionAsyncOperationStatusOptions struct {
}

ScriptActionsClientGetExecutionAsyncOperationStatusOptions contains the optional parameters for the ScriptActionsClient.GetExecutionAsyncOperationStatus method.

type ScriptActionsClientGetExecutionAsyncOperationStatusResponse added in v0.2.0 

type ScriptActionsClientGetExecutionAsyncOperationStatusResponse struct {
	AsyncOperationResult
}

ScriptActionsClientGetExecutionAsyncOperationStatusResponse contains the response from method ScriptActionsClient.GetExecutionAsyncOperationStatus.

type ScriptActionsClientGetExecutionDetailOptions added in v0.2.0 

type ScriptActionsClientGetExecutionDetailOptions struct {
}

ScriptActionsClientGetExecutionDetailOptions contains the optional parameters for the ScriptActionsClient.GetExecutionDetail method.

type ScriptActionsClientGetExecutionDetailResponse added in v0.2.0 

type ScriptActionsClientGetExecutionDetailResponse struct {
	RuntimeScriptActionDetail
}

ScriptActionsClientGetExecutionDetailResponse contains the response from method ScriptActionsClient.GetExecutionDetail.

type ScriptActionsClientListByClusterOptions added in v0.2.0 

type ScriptActionsClientListByClusterOptions struct {
}

ScriptActionsClientListByClusterOptions contains the optional parameters for the ScriptActionsClient.ListByCluster method.

type ScriptActionsClientListByClusterResponse added in v0.2.0 

type ScriptActionsClientListByClusterResponse struct {
	ScriptActionsList
}

ScriptActionsClientListByClusterResponse contains the response from method ScriptActionsClient.ListByCluster.

type ScriptActionsList 

type ScriptActionsList struct {
	// The list of persisted script action details for the cluster.
	Value []*RuntimeScriptActionDetail `json:"value,omitempty"`

	// READ-ONLY; The link (url) to the next page of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ScriptActionsList - The persisted script action for the cluster.

func (ScriptActionsList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScriptActionsList.

type ScriptExecutionHistoryClient 

type ScriptExecutionHistoryClient struct {
	// contains filtered or unexported fields
}

ScriptExecutionHistoryClient contains the methods for the ScriptExecutionHistory group. Don't use this type directly, use NewScriptExecutionHistoryClient() instead.

func NewScriptExecutionHistoryClient 

func NewScriptExecutionHistoryClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ScriptExecutionHistoryClient, error)

NewScriptExecutionHistoryClient creates a new instance of ScriptExecutionHistoryClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ScriptExecutionHistoryClient) NewListByClusterPager added in v0.4.0 

func (client *ScriptExecutionHistoryClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *ScriptExecutionHistoryClientListByClusterOptions) *runtime.Pager[ScriptExecutionHistoryClientListByClusterResponse]

NewListByClusterPager - Lists all scripts' execution history for the specified cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - ScriptExecutionHistoryClientListByClusterOptions contains the optional parameters for the ScriptExecutionHistoryClient.ListByCluster method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetScriptExecutionHistory.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewScriptExecutionHistoryClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListByClusterPager("<resource-group-name>",
		"<cluster-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ScriptExecutionHistoryClient) Promote 

func (client *ScriptExecutionHistoryClient) Promote(ctx context.Context, resourceGroupName string, clusterName string, scriptExecutionID string, options *ScriptExecutionHistoryClientPromoteOptions) (ScriptExecutionHistoryClientPromoteResponse, error)

Promote - Promotes the specified ad-hoc script execution to a persisted script. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. scriptExecutionID - The script execution Id options - ScriptExecutionHistoryClientPromoteOptions contains the optional parameters for the ScriptExecutionHistoryClient.Promote method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/PromoteLinuxHadoopScriptAction.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewScriptExecutionHistoryClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	_, err = client.Promote(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<script-execution-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
}

Output:

type ScriptExecutionHistoryClientListByClusterOptions added in v0.2.0 

type ScriptExecutionHistoryClientListByClusterOptions struct {
}

ScriptExecutionHistoryClientListByClusterOptions contains the optional parameters for the ScriptExecutionHistoryClient.ListByCluster method.

type ScriptExecutionHistoryClientListByClusterResponse added in v0.2.0 

type ScriptExecutionHistoryClientListByClusterResponse struct {
	ScriptActionExecutionHistoryList
}

ScriptExecutionHistoryClientListByClusterResponse contains the response from method ScriptExecutionHistoryClient.ListByCluster.

type ScriptExecutionHistoryClientPromoteOptions added in v0.2.0 

type ScriptExecutionHistoryClientPromoteOptions struct {
}

ScriptExecutionHistoryClientPromoteOptions contains the optional parameters for the ScriptExecutionHistoryClient.Promote method.

type ScriptExecutionHistoryClientPromoteResponse added in v0.2.0 

type ScriptExecutionHistoryClientPromoteResponse struct {
}

ScriptExecutionHistoryClientPromoteResponse contains the response from method ScriptExecutionHistoryClient.Promote.

type SecurityProfile 

type SecurityProfile struct {
	// The resource ID of the user's Azure Active Directory Domain Service.
	AaddsResourceID *string `json:"aaddsResourceId,omitempty"`

	// Optional. The Distinguished Names for cluster user groups
	ClusterUsersGroupDNs []*string `json:"clusterUsersGroupDNs,omitempty"`

	// The directory type.
	DirectoryType *DirectoryType `json:"directoryType,omitempty"`

	// The organization's active directory domain.
	Domain *string `json:"domain,omitempty"`

	// The domain admin password.
	DomainUserPassword *string `json:"domainUserPassword,omitempty"`

	// The domain user account that will have admin privileges on the cluster.
	DomainUsername *string `json:"domainUsername,omitempty"`

	// The LDAPS protocol URLs to communicate with the Active Directory.
	LdapsUrls []*string `json:"ldapsUrls,omitempty"`

	// User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS.
	MsiResourceID *string `json:"msiResourceId,omitempty"`

	// The organizational unit within the Active Directory to place the cluster and service accounts.
	OrganizationalUnitDN *string `json:"organizationalUnitDN,omitempty"`
}

SecurityProfile - The security profile which contains Ssh public key for the HDInsight cluster.

func (SecurityProfile) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecurityProfile.

type ServiceSpecification 

type ServiceSpecification struct {
	// The metric specifications.
	MetricSpecifications []*MetricSpecifications `json:"metricSpecifications,omitempty"`
}

ServiceSpecification - The specification of the service.

func (ServiceSpecification) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

type StorageAccount 

type StorageAccount struct {
	// The container in the storage account, only to be specified for WASB storage accounts.
	Container *string `json:"container,omitempty"`

	// The filesystem, only to be specified for Azure Data Lake Storage Gen 2.
	FileSystem *string `json:"fileSystem,omitempty"`

	// The file share name.
	Fileshare *string `json:"fileshare,omitempty"`

	// Whether or not the storage account is the default storage account.
	IsDefault *bool `json:"isDefault,omitempty"`

	// The storage account access key.
	Key *string `json:"key,omitempty"`

	// The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage
	// Gen 2.
	MsiResourceID *string `json:"msiResourceId,omitempty"`

	// The name of the storage account.
	Name *string `json:"name,omitempty"`

	// The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2.
	ResourceID *string `json:"resourceId,omitempty"`

	// The shared access signature key.
	Saskey *string `json:"saskey,omitempty"`
}

StorageAccount - The storage Account.

type StorageProfile 

type StorageProfile struct {
	// The list of storage accounts in the cluster.
	Storageaccounts []*StorageAccount `json:"storageaccounts,omitempty"`
}

StorageProfile - The storage profile.

func (StorageProfile) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StorageProfile.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type Tier 

type Tier string

Tier - The cluster tier. 

const (
	TierPremium  Tier = "Premium"
	TierStandard Tier = "Standard"
)

func PossibleTierValues 

func PossibleTierValues() []Tier

PossibleTierValues returns the possible values for the Tier const type.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type UpdateClusterIdentityCertificateParameters 

type UpdateClusterIdentityCertificateParameters struct {
	// The application id.
	ApplicationID *string `json:"applicationId,omitempty"`

	// The certificate in base64 encoded format.
	Certificate *string `json:"certificate,omitempty"`

	// The password of the certificate.
	CertificatePassword *string `json:"certificatePassword,omitempty"`
}

UpdateClusterIdentityCertificateParameters - The update cluster identity certificate request parameters.

type UpdateGatewaySettingsParameters 

type UpdateGatewaySettingsParameters struct {
	// Indicates whether or not the gateway settings based authorization is enabled.
	IsCredentialEnabled *bool `json:"restAuthCredential.isEnabled,omitempty"`

	// The gateway settings user password.
	Password *string `json:"restAuthCredential.password,omitempty"`

	// The gateway settings user name.
	UserName *string `json:"restAuthCredential.username,omitempty"`
}

UpdateGatewaySettingsParameters - The update gateway settings request parameters.

type Usage 

type Usage struct {
	// The current usage.
	CurrentValue *int64 `json:"currentValue,omitempty"`

	// The maximum allowed usage.
	Limit *int64 `json:"limit,omitempty"`

	// The type of measurement for usage.
	Unit *string `json:"unit,omitempty"`

	// READ-ONLY; The details about the localizable name of the used resource.
	Name *LocalizedName `json:"name,omitempty" azure:"ro"`
}

Usage - The details about the usage of a particular limited resource.

type UsagesListResult 

type UsagesListResult struct {
	// The list of usages.
	Value []*Usage `json:"value,omitempty"`
}

UsagesListResult - The response for the operation to get regional usages for a subscription.

func (UsagesListResult) MarshalJSON 

func (u UsagesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsagesListResult.

type UserAssignedIdentity 

type UserAssignedIdentity struct {
	// The tenant id of user assigned identity.
	TenantID *string `json:"tenantId,omitempty"`

	// READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedIdentity - The User Assigned Identity

type VMSizeCompatibilityFilterV2 

type VMSizeCompatibilityFilterV2 struct {
	// The list of cluster flavors under the effect of the filter.
	ClusterFlavors []*string `json:"clusterFlavors,omitempty"`

	// The list of cluster versions affected in Major.Minor format.
	ClusterVersions []*string `json:"clusterVersions,omitempty"`

	// Whether support compute isolation. 'true' means only for ComputeIsolationEnabled, 'false' means only for regular cluster.
	ComputeIsolationSupported *string `json:"computeIsolationSupported,omitempty"`

	// Whether apply for ESP cluster. 'true' means only for ESP, 'false' means only for non-ESP, null or empty string or others
	// mean for both.
	EspApplied *string `json:"espApplied,omitempty"`

	// The filtering mode. Effectively this can enabling or disabling the VM sizes in a particular set.
	FilterMode *FilterMode `json:"filterMode,omitempty"`

	// The list of node types affected by the filter.
	NodeTypes []*string `json:"nodeTypes,omitempty"`

	// The OSType affected, Windows or Linux.
	OSType []*OSType `json:"osType,omitempty"`

	// The list of regions under the effect of the filter.
	Regions []*string `json:"regions,omitempty"`

	// The list of virtual machine sizes to include or exclude.
	VMSizes []*string `json:"vmSizes,omitempty"`
}

VMSizeCompatibilityFilterV2 - This class represent a single filter object that defines a multidimensional set. The dimensions of this set are Regions, ClusterFlavors, NodeTypes and ClusterVersions. The constraint should be defined based on the following: FilterMode (Exclude vs Include), VMSizes (the vm sizes in affect of exclusion/inclusion) and the ordering of the Filters. Later filters override previous settings if conflicted.

func (VMSizeCompatibilityFilterV2) MarshalJSON 

func (v VMSizeCompatibilityFilterV2) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VMSizeCompatibilityFilterV2.

type VMSizeProperty 

type VMSizeProperty struct {
	// The number of cores that the vm size has.
	Cores *int32 `json:"cores,omitempty"`

	// The data disk storage tier of the vm size.
	DataDiskStorageTier *string `json:"dataDiskStorageTier,omitempty"`

	// The label of the vm size.
	Label *string `json:"label,omitempty"`

	// The max data disk count of the vm size.
	MaxDataDiskCount *int64 `json:"maxDataDiskCount,omitempty"`

	// The memory whose unit is MB of the vm size.
	MemoryInMb *int64 `json:"memoryInMb,omitempty"`

	// The vm size name.
	Name *string `json:"name,omitempty"`

	// This indicates this vm size is supported by virtual machines or not
	SupportedByVirtualMachines *bool `json:"supportedByVirtualMachines,omitempty"`

	// The indicates this vm size is supported by web worker roles or not
	SupportedByWebWorkerRoles *bool `json:"supportedByWebWorkerRoles,omitempty"`

	// The virtual machine resource disk size whose unit is MB of the vm size.
	VirtualMachineResourceDiskSizeInMb *int64 `json:"virtualMachineResourceDiskSizeInMb,omitempty"`

	// The web worker resource disk size whose unit is MB of the vm size.
	WebWorkerResourceDiskSizeInMb *int64 `json:"webWorkerResourceDiskSizeInMb,omitempty"`
}

VMSizeProperty - The vm size property

type ValidationErrorInfo 

type ValidationErrorInfo struct {
	// The error code.
	Code *string `json:"code,omitempty"`

	// The error resource.
	ErrorResource *string `json:"errorResource,omitempty"`

	// The error message.
	Message *string `json:"message,omitempty"`

	// The message arguments
	MessageArguments []*string `json:"messageArguments,omitempty"`
}

ValidationErrorInfo - The validation error information.

func (ValidationErrorInfo) MarshalJSON 

func (v ValidationErrorInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidationErrorInfo.

type VersionSpec 

type VersionSpec struct {
	// The component version property.
	ComponentVersions map[string]*string `json:"componentVersions,omitempty"`

	// The display name
	DisplayName *string `json:"displayName,omitempty"`

	// The friendly name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Whether or not the version is the default version.
	IsDefault *bool `json:"isDefault,omitempty"`
}

VersionSpec - The version properties.

func (VersionSpec) MarshalJSON 

func (v VersionSpec) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VersionSpec.

type VersionsCapability 

type VersionsCapability struct {
	// The list of version capabilities.
	Available []*VersionSpec `json:"available,omitempty"`
}

VersionsCapability - The version capability.

func (VersionsCapability) MarshalJSON 

func (v VersionsCapability) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VersionsCapability.

type VirtualMachinesClient 

type VirtualMachinesClient struct {
	// contains filtered or unexported fields
}

VirtualMachinesClient contains the methods for the VirtualMachines group. Don't use this type directly, use NewVirtualMachinesClient() instead.

func NewVirtualMachinesClient 

func NewVirtualMachinesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VirtualMachinesClient, error)

NewVirtualMachinesClient creates a new instance of VirtualMachinesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualMachinesClient) BeginRestartHosts 

func (client *VirtualMachinesClient) BeginRestartHosts(ctx context.Context, resourceGroupName string, clusterName string, hosts []*string, options *VirtualMachinesClientBeginRestartHostsOptions) (*armruntime.Poller[VirtualMachinesClientRestartHostsResponse], error)

BeginRestartHosts - Restarts the specified HDInsight cluster hosts. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. hosts - The list of hosts to restart options - VirtualMachinesClientBeginRestartHostsOptions contains the optional parameters for the VirtualMachinesClient.BeginRestartHosts method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/RestartVirtualMachinesOperation.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewVirtualMachinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginRestartHosts(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		[]*string{
			to.Ptr("gateway1"),
			to.Ptr("gateway3")},
		&armhdinsight.VirtualMachinesClientBeginRestartHostsOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*VirtualMachinesClient) GetAsyncOperationStatus 

func (client *VirtualMachinesClient) GetAsyncOperationStatus(ctx context.Context, resourceGroupName string, clusterName string, operationID string, options *VirtualMachinesClientGetAsyncOperationStatusOptions) (VirtualMachinesClientGetAsyncOperationStatusResponse, error)

GetAsyncOperationStatus - Gets the async operation status. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. operationID - The long running operation id. options - VirtualMachinesClientGetAsyncOperationStatusOptions contains the optional parameters for the VirtualMachinesClient.GetAsyncOperationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetRestartHostsAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewVirtualMachinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetAsyncOperationStatus(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*VirtualMachinesClient) ListHosts 

func (client *VirtualMachinesClient) ListHosts(ctx context.Context, resourceGroupName string, clusterName string, options *VirtualMachinesClientListHostsOptions) (VirtualMachinesClientListHostsResponse, error)

ListHosts - Lists the HDInsight clusters hosts If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. clusterName - The name of the cluster. options - VirtualMachinesClientListHostsOptions contains the optional parameters for the VirtualMachinesClient.ListHosts method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetClusterVirtualMachines.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armhdinsight.NewVirtualMachinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListHosts(ctx,
		"<resource-group-name>",
		"<cluster-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type VirtualMachinesClientBeginRestartHostsOptions added in v0.2.0 

type VirtualMachinesClientBeginRestartHostsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualMachinesClientBeginRestartHostsOptions contains the optional parameters for the VirtualMachinesClient.BeginRestartHosts method.

type VirtualMachinesClientGetAsyncOperationStatusOptions added in v0.2.0 

type VirtualMachinesClientGetAsyncOperationStatusOptions struct {
}

VirtualMachinesClientGetAsyncOperationStatusOptions contains the optional parameters for the VirtualMachinesClient.GetAsyncOperationStatus method.

type VirtualMachinesClientGetAsyncOperationStatusResponse added in v0.2.0 

type VirtualMachinesClientGetAsyncOperationStatusResponse struct {
	AsyncOperationResult
}

VirtualMachinesClientGetAsyncOperationStatusResponse contains the response from method VirtualMachinesClient.GetAsyncOperationStatus.

type VirtualMachinesClientListHostsOptions added in v0.2.0 

type VirtualMachinesClientListHostsOptions struct {
}

VirtualMachinesClientListHostsOptions contains the optional parameters for the VirtualMachinesClient.ListHosts method.

type VirtualMachinesClientListHostsResponse added in v0.2.0 

type VirtualMachinesClientListHostsResponse struct {
	// Result of the request to list cluster hosts
	HostInfoArray []*HostInfo
}

VirtualMachinesClientListHostsResponse contains the response from method VirtualMachinesClient.ListHosts.

type VirtualMachinesClientRestartHostsResponse added in v0.2.0 

type VirtualMachinesClientRestartHostsResponse struct {
}

VirtualMachinesClientRestartHostsResponse contains the response from method VirtualMachinesClient.RestartHosts.

type VirtualNetworkProfile 

type VirtualNetworkProfile struct {
	// The ID of the virtual network.
	ID *string `json:"id,omitempty"`

	// The name of the subnet.
	Subnet *string `json:"subnet,omitempty"`
}

VirtualNetworkProfile - The virtual network properties.

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.