compute

package
v50.2.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Jan 23, 2021 License: Apache-2.0 Imports: 10 Imported by: 246

Documentation

Overview

Package compute implements the Azure ARM Compute service API version 2017-08-01-preview.

These APIs allow end users to operate on Azure Machine Learning Compute resources. They support the following operations:<ul><li>Create or update a cluster</li><li>Get a cluster</li><li>Patch a cluster</li><li>Delete a cluster</li><li>Get keys for a cluster</li><li>Check if updates are available for system services in a cluster</li><li>Update system services in a cluster</li><li>Get all clusters in a resource group</li><li>Get all clusters in a subscription</li></ul>

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Compute
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AcsClusterProperties

type AcsClusterProperties struct {
	// ClusterFqdn - READ-ONLY; The FQDN of the cluster.
	ClusterFqdn *string `json:"clusterFqdn,omitempty"`
	// OrchestratorType - Type of orchestrator. It cannot be changed once the cluster is created. Possible values include: 'Kubernetes', 'None'
	OrchestratorType OrchestratorType `json:"orchestratorType,omitempty"`
	// OrchestratorProperties - Orchestrator specific properties
	OrchestratorProperties *KubernetesClusterProperties `json:"orchestratorProperties,omitempty"`
	// SystemServices - The system services deployed to the cluster
	SystemServices *[]SystemService `json:"systemServices,omitempty"`
	// MasterCount - The number of master nodes in the container service.
	MasterCount *int32 `json:"masterCount,omitempty"`
	// AgentCount - The number of agent nodes in the Container Service. This can be changed to scale the cluster.
	AgentCount *int32 `json:"agentCount,omitempty"`
	// AgentVMSize - The Azure VM size of the agent VM nodes. This cannot be changed once the cluster is created. This list is non exhaustive; refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes for the possible VM sizes. Possible values include: 'StandardA0', 'StandardA1', 'StandardA2', 'StandardA3', 'StandardA4', 'StandardA5', 'StandardA6', 'StandardA7', 'StandardA8', 'StandardA9', 'StandardA10', 'StandardA11', 'StandardD1', 'StandardD2', 'StandardD3', 'StandardD4', 'StandardD11', 'StandardD12', 'StandardD13', 'StandardD14', 'StandardD1V2', 'StandardD2V2', 'StandardD3V2', 'StandardD4V2', 'StandardD5V2', 'StandardD11V2', 'StandardD12V2', 'StandardD13V2', 'StandardD14V2', 'StandardG1', 'StandardG2', 'StandardG3', 'StandardG4', 'StandardG5', 'StandardDS1', 'StandardDS2', 'StandardDS3', 'StandardDS4', 'StandardDS11', 'StandardDS12', 'StandardDS13', 'StandardDS14', 'StandardGS1', 'StandardGS2', 'StandardGS3', 'StandardGS4', 'StandardGS5'
	AgentVMSize AgentVMSizeTypes `json:"agentVmSize,omitempty"`
}

AcsClusterProperties information about the container service backing the cluster

func (AcsClusterProperties) MarshalJSON

func (acp AcsClusterProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AcsClusterProperties.

type AgentVMSizeTypes

type AgentVMSizeTypes string

AgentVMSizeTypes enumerates the values for agent vm size types.

const (
	// StandardA0 ...
	StandardA0 AgentVMSizeTypes = "Standard_A0"
	// StandardA1 ...
	StandardA1 AgentVMSizeTypes = "Standard_A1"
	// StandardA10 ...
	StandardA10 AgentVMSizeTypes = "Standard_A10"
	// StandardA11 ...
	StandardA11 AgentVMSizeTypes = "Standard_A11"
	// StandardA2 ...
	StandardA2 AgentVMSizeTypes = "Standard_A2"
	// StandardA3 ...
	StandardA3 AgentVMSizeTypes = "Standard_A3"
	// StandardA4 ...
	StandardA4 AgentVMSizeTypes = "Standard_A4"
	// StandardA5 ...
	StandardA5 AgentVMSizeTypes = "Standard_A5"
	// StandardA6 ...
	StandardA6 AgentVMSizeTypes = "Standard_A6"
	// StandardA7 ...
	StandardA7 AgentVMSizeTypes = "Standard_A7"
	// StandardA8 ...
	StandardA8 AgentVMSizeTypes = "Standard_A8"
	// StandardA9 ...
	StandardA9 AgentVMSizeTypes = "Standard_A9"
	// StandardD1 ...
	StandardD1 AgentVMSizeTypes = "Standard_D1"
	// StandardD11 ...
	StandardD11 AgentVMSizeTypes = "Standard_D11"
	// StandardD11V2 ...
	StandardD11V2 AgentVMSizeTypes = "Standard_D11_v2"
	// StandardD12 ...
	StandardD12 AgentVMSizeTypes = "Standard_D12"
	// StandardD12V2 ...
	StandardD12V2 AgentVMSizeTypes = "Standard_D12_v2"
	// StandardD13 ...
	StandardD13 AgentVMSizeTypes = "Standard_D13"
	// StandardD13V2 ...
	StandardD13V2 AgentVMSizeTypes = "Standard_D13_v2"
	// StandardD14 ...
	StandardD14 AgentVMSizeTypes = "Standard_D14"
	// StandardD14V2 ...
	StandardD14V2 AgentVMSizeTypes = "Standard_D14_v2"
	// StandardD1V2 ...
	StandardD1V2 AgentVMSizeTypes = "Standard_D1_v2"
	// StandardD2 ...
	StandardD2 AgentVMSizeTypes = "Standard_D2"
	// StandardD2V2 ...
	StandardD2V2 AgentVMSizeTypes = "Standard_D2_v2"
	// StandardD3 ...
	StandardD3 AgentVMSizeTypes = "Standard_D3"
	// StandardD3V2 ...
	StandardD3V2 AgentVMSizeTypes = "Standard_D3_v2"
	// StandardD4 ...
	StandardD4 AgentVMSizeTypes = "Standard_D4"
	// StandardD4V2 ...
	StandardD4V2 AgentVMSizeTypes = "Standard_D4_v2"
	// StandardD5V2 ...
	StandardD5V2 AgentVMSizeTypes = "Standard_D5_v2"
	// StandardDS1 ...
	StandardDS1 AgentVMSizeTypes = "Standard_DS1"
	// StandardDS11 ...
	StandardDS11 AgentVMSizeTypes = "Standard_DS11"
	// StandardDS12 ...
	StandardDS12 AgentVMSizeTypes = "Standard_DS12"
	// StandardDS13 ...
	StandardDS13 AgentVMSizeTypes = "Standard_DS13"
	// StandardDS14 ...
	StandardDS14 AgentVMSizeTypes = "Standard_DS14"
	// StandardDS2 ...
	StandardDS2 AgentVMSizeTypes = "Standard_DS2"
	// StandardDS3 ...
	StandardDS3 AgentVMSizeTypes = "Standard_DS3"
	// StandardDS4 ...
	StandardDS4 AgentVMSizeTypes = "Standard_DS4"
	// StandardG1 ...
	StandardG1 AgentVMSizeTypes = "Standard_G1"
	// StandardG2 ...
	StandardG2 AgentVMSizeTypes = "Standard_G2"
	// StandardG3 ...
	StandardG3 AgentVMSizeTypes = "Standard_G3"
	// StandardG4 ...
	StandardG4 AgentVMSizeTypes = "Standard_G4"
	// StandardG5 ...
	StandardG5 AgentVMSizeTypes = "Standard_G5"
	// StandardGS1 ...
	StandardGS1 AgentVMSizeTypes = "Standard_GS1"
	// StandardGS2 ...
	StandardGS2 AgentVMSizeTypes = "Standard_GS2"
	// StandardGS3 ...
	StandardGS3 AgentVMSizeTypes = "Standard_GS3"
	// StandardGS4 ...
	StandardGS4 AgentVMSizeTypes = "Standard_GS4"
	// StandardGS5 ...
	StandardGS5 AgentVMSizeTypes = "Standard_GS5"
)

func PossibleAgentVMSizeTypesValues

func PossibleAgentVMSizeTypesValues() []AgentVMSizeTypes

PossibleAgentVMSizeTypesValues returns an array of possible values for the AgentVMSizeTypes const type.

type AppInsightsCredentials

type AppInsightsCredentials struct {
	// AppID - The AppInsights application ID.
	AppID *string `json:"appId,omitempty"`
	// InstrumentationKey - The AppInsights instrumentation key. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API.
	InstrumentationKey *string `json:"instrumentationKey,omitempty"`
}

AppInsightsCredentials appInsights credentials.

type AppInsightsProperties

type AppInsightsProperties struct {
	// ResourceID - ARM resource ID of the App Insights.
	ResourceID *string `json:"resourceId,omitempty"`
}

AppInsightsProperties properties of App Insights.

type AutoScaleConfiguration

type AutoScaleConfiguration struct {
	// Status - If auto-scale is enabled for all services. Each service can turn it off individually. Possible values include: 'Enabled', 'Disabled'
	Status Status `json:"status,omitempty"`
	// MinReplicas - The minimum number of replicas for each service.
	MinReplicas *int32 `json:"minReplicas,omitempty"`
	// MaxReplicas - The maximum number of replicas for each service.
	MaxReplicas *int32 `json:"maxReplicas,omitempty"`
	// TargetUtilization - The target utilization.
	TargetUtilization *float64 `json:"targetUtilization,omitempty"`
	// RefreshPeriodInSeconds - Refresh period in seconds.
	RefreshPeriodInSeconds *int32 `json:"refreshPeriodInSeconds,omitempty"`
}

AutoScaleConfiguration autoScale configuration properties.

type AvailableOperations

type AvailableOperations struct {
	autorest.Response `json:"-"`
	// Value - An array of available operations.
	Value *[]ResourceOperation `json:"value,omitempty"`
}

AvailableOperations available operation list.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Compute.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CheckSystemServicesUpdatesAvailableResponse

type CheckSystemServicesUpdatesAvailableResponse struct {
	autorest.Response `json:"-"`
	// UpdatesAvailable - READ-ONLY; Yes if updates are available for the system services, No if not. Possible values include: 'Yes', 'No'
	UpdatesAvailable UpdatesAvailable `json:"updatesAvailable,omitempty"`
}

CheckSystemServicesUpdatesAvailableResponse information about updates available for system services in a cluster.

type ClusterType

type ClusterType string

ClusterType enumerates the values for cluster type.

const (
	// ACS ...
	ACS ClusterType = "ACS"
	// Local ...
	Local ClusterType = "Local"
)

func PossibleClusterTypeValues

func PossibleClusterTypeValues() []ClusterType

PossibleClusterTypeValues returns an array of possible values for the ClusterType const type.

type ContainerRegistryCredentials

type ContainerRegistryCredentials struct {
	// LoginServer - READ-ONLY; The ACR login server name. User name is the first part of the FQDN.
	LoginServer *string `json:"loginServer,omitempty"`
	// Password - READ-ONLY; The ACR primary password.
	Password *string `json:"password,omitempty"`
	// Password2 - READ-ONLY; The ACR secondary password.
	Password2 *string `json:"password2,omitempty"`
	// Username - READ-ONLY; The ACR login username.
	Username *string `json:"username,omitempty"`
}

ContainerRegistryCredentials information about the Azure Container Registry which contains the images deployed to the cluster.

type ContainerRegistryProperties

type ContainerRegistryProperties struct {
	// ResourceID - ARM resource ID of the Azure Container Registry used to store Docker images for web services in the cluster. If not provided one will be created. This cannot be changed once the cluster is created.
	ResourceID *string `json:"resourceId,omitempty"`
}

ContainerRegistryProperties properties of Azure Container Registry.

type ContainerServiceCredentials

type ContainerServiceCredentials struct {
	// AcsKubeConfig - READ-ONLY; The ACS kube config file.
	AcsKubeConfig *string `json:"acsKubeConfig,omitempty"`
	// ServicePrincipalConfiguration - READ-ONLY; Service principal configuration used by Kubernetes.
	ServicePrincipalConfiguration *ServicePrincipalProperties `json:"servicePrincipalConfiguration,omitempty"`
	// ImagePullSecretName - READ-ONLY; The ACR image pull secret name which was created in Kubernetes.
	ImagePullSecretName *string `json:"imagePullSecretName,omitempty"`
}

ContainerServiceCredentials information about the Azure Container Registry which contains the images deployed to the cluster.

type ErrorDetail

type ErrorDetail struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message.
	Message *string `json:"message,omitempty"`
}

ErrorDetail error detail information.

type ErrorResponse

type ErrorResponse struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message.
	Message *string `json:"message,omitempty"`
	// Details - An array of error detail objects.
	Details *[]ErrorDetail `json:"details,omitempty"`
}

ErrorResponse error response information.

type ErrorResponseWrapper

type ErrorResponseWrapper struct {
	// Error - The error response.
	Error *ErrorResponse `json:"error,omitempty"`
}

ErrorResponseWrapper wrapper for error response to follow ARM guidelines.

type GlobalServiceConfiguration

type GlobalServiceConfiguration struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// Etag - The configuration ETag for updates.
	Etag *string `json:"etag,omitempty"`
	// Ssl - The SSL configuration properties
	Ssl *SslConfiguration `json:"ssl,omitempty"`
	// ServiceAuth - Optional global authorization keys for all user services deployed in cluster. These are used if the service does not have auth keys.
	ServiceAuth *ServiceAuthConfiguration `json:"serviceAuth,omitempty"`
	// AutoScale - The auto-scale configuration
	AutoScale *AutoScaleConfiguration `json:"autoScale,omitempty"`
}

GlobalServiceConfiguration global configuration for services in the cluster.

func (GlobalServiceConfiguration) MarshalJSON

func (gsc GlobalServiceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GlobalServiceConfiguration.

func (*GlobalServiceConfiguration) UnmarshalJSON

func (gsc *GlobalServiceConfiguration) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GlobalServiceConfiguration struct.

type KubernetesClusterProperties

type KubernetesClusterProperties struct {
	// ServicePrincipal - The Azure Service Principal used by Kubernetes
	ServicePrincipal *ServicePrincipalProperties `json:"servicePrincipal,omitempty"`
}

KubernetesClusterProperties kubernetes cluster specific properties

type MachineLearningComputeClient

type MachineLearningComputeClient struct {
	BaseClient
}

MachineLearningComputeClient is the these APIs allow end users to operate on Azure Machine Learning Compute resources. They support the following operations:<ul><li>Create or update a cluster</li><li>Get a cluster</li><li>Patch a cluster</li><li>Delete a cluster</li><li>Get keys for a cluster</li><li>Check if updates are available for system services in a cluster</li><li>Update system services in a cluster</li><li>Get all clusters in a resource group</li><li>Get all clusters in a subscription</li></ul>

func NewMachineLearningComputeClient

func NewMachineLearningComputeClient(subscriptionID string) MachineLearningComputeClient

NewMachineLearningComputeClient creates an instance of the MachineLearningComputeClient client.

func NewMachineLearningComputeClientWithBaseURI

func NewMachineLearningComputeClientWithBaseURI(baseURI string, subscriptionID string) MachineLearningComputeClient

NewMachineLearningComputeClientWithBaseURI creates an instance of the MachineLearningComputeClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (MachineLearningComputeClient) ListAvailableOperations

func (client MachineLearningComputeClient) ListAvailableOperations(ctx context.Context) (result AvailableOperations, err error)

ListAvailableOperations gets all available operations.

func (MachineLearningComputeClient) ListAvailableOperationsPreparer

func (client MachineLearningComputeClient) ListAvailableOperationsPreparer(ctx context.Context) (*http.Request, error)

ListAvailableOperationsPreparer prepares the ListAvailableOperations request.

func (MachineLearningComputeClient) ListAvailableOperationsResponder

func (client MachineLearningComputeClient) ListAvailableOperationsResponder(resp *http.Response) (result AvailableOperations, err error)

ListAvailableOperationsResponder handles the response to the ListAvailableOperations request. The method always closes the http.Response Body.

func (MachineLearningComputeClient) ListAvailableOperationsSender

func (client MachineLearningComputeClient) ListAvailableOperationsSender(req *http.Request) (*http.Response, error)

ListAvailableOperationsSender sends the ListAvailableOperations request. The method will close the http.Response Body if it receives an error.

type OperationStatus

type OperationStatus string

OperationStatus enumerates the values for operation status.

const (
	// Canceled ...
	Canceled OperationStatus = "Canceled"
	// Creating ...
	Creating OperationStatus = "Creating"
	// Deleting ...
	Deleting OperationStatus = "Deleting"
	// Failed ...
	Failed OperationStatus = "Failed"
	// Succeeded ...
	Succeeded OperationStatus = "Succeeded"
	// Unknown ...
	Unknown OperationStatus = "Unknown"
	// Updating ...
	Updating OperationStatus = "Updating"
)

func PossibleOperationStatusValues

func PossibleOperationStatusValues() []OperationStatus

PossibleOperationStatusValues returns an array of possible values for the OperationStatus const type.

type OperationalizationCluster

type OperationalizationCluster struct {
	autorest.Response `json:"-"`
	// OperationalizationClusterProperties - Properties of an operationalization cluster.
	*OperationalizationClusterProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty"`
	// Location - Specifies the location of the resource.
	Location *string `json:"location,omitempty"`
	// Type - READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty"`
	// Tags - Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags"`
}

OperationalizationCluster instance of an Azure ML Operationalization Cluster resource.

func (OperationalizationCluster) MarshalJSON

func (oc OperationalizationCluster) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationalizationCluster.

func (*OperationalizationCluster) UnmarshalJSON

func (oc *OperationalizationCluster) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OperationalizationCluster struct.

type OperationalizationClusterCredentials

type OperationalizationClusterCredentials struct {
	autorest.Response `json:"-"`
	// StorageAccount - Credentials for the Storage Account.
	StorageAccount *StorageAccountCredentials `json:"storageAccount,omitempty"`
	// ContainerRegistry - Credentials for Azure Container Registry.
	ContainerRegistry *ContainerRegistryCredentials `json:"containerRegistry,omitempty"`
	// ContainerService - Credentials for Azure Container Service.
	ContainerService *ContainerServiceCredentials `json:"containerService,omitempty"`
	// AppInsights - Credentials for Azure AppInsights.
	AppInsights *AppInsightsCredentials `json:"appInsights,omitempty"`
	// ServiceAuthConfiguration - Global authorization keys for all user services deployed in cluster. These are used if the service does not have auth keys.
	ServiceAuthConfiguration *ServiceAuthConfiguration `json:"serviceAuthConfiguration,omitempty"`
	// SslConfiguration - The SSL configuration for the services.
	SslConfiguration *SslConfiguration `json:"sslConfiguration,omitempty"`
}

OperationalizationClusterCredentials credentials to resources in the cluster.

type OperationalizationClusterProperties

type OperationalizationClusterProperties struct {
	// Description - The description of the cluster.
	Description *string `json:"description,omitempty"`
	// CreatedOn - READ-ONLY; The date and time when the cluster was created.
	CreatedOn *date.Time `json:"createdOn,omitempty"`
	// ModifiedOn - READ-ONLY; The date and time when the cluster was last modified.
	ModifiedOn *date.Time `json:"modifiedOn,omitempty"`
	// ProvisioningState - READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. Possible values include: 'Unknown', 'Updating', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
	ProvisioningState OperationStatus `json:"provisioningState,omitempty"`
	// ProvisioningErrors - READ-ONLY; List of provisioning errors reported by the resource provider.
	ProvisioningErrors *[]ErrorResponseWrapper `json:"provisioningErrors,omitempty"`
	// ClusterType - The cluster type. Possible values include: 'ACS', 'Local'
	ClusterType ClusterType `json:"clusterType,omitempty"`
	// StorageAccount - Storage Account properties.
	StorageAccount *StorageAccountProperties `json:"storageAccount,omitempty"`
	// ContainerRegistry - Container Registry properties.
	ContainerRegistry *ContainerRegistryProperties `json:"containerRegistry,omitempty"`
	// ContainerService - Parameters for the Azure Container Service cluster.
	ContainerService *AcsClusterProperties `json:"containerService,omitempty"`
	// AppInsights - AppInsights configuration.
	AppInsights *AppInsightsProperties `json:"appInsights,omitempty"`
	// GlobalServiceConfiguration - Contains global configuration for the web services in the cluster.
	GlobalServiceConfiguration *GlobalServiceConfiguration `json:"globalServiceConfiguration,omitempty"`
}

OperationalizationClusterProperties properties of an operationalization cluster

func (OperationalizationClusterProperties) MarshalJSON

func (ocp OperationalizationClusterProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationalizationClusterProperties.

type OperationalizationClusterUpdateParameters

type OperationalizationClusterUpdateParameters struct {
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.
	Tags map[string]*string `json:"tags"`
}

OperationalizationClusterUpdateParameters parameters for PATCH operation on an operationalization cluster

func (OperationalizationClusterUpdateParameters) MarshalJSON

func (ocup OperationalizationClusterUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationalizationClusterUpdateParameters.

type OperationalizationClustersClient

type OperationalizationClustersClient struct {
	BaseClient
}

OperationalizationClustersClient is the these APIs allow end users to operate on Azure Machine Learning Compute resources. They support the following operations:<ul><li>Create or update a cluster</li><li>Get a cluster</li><li>Patch a cluster</li><li>Delete a cluster</li><li>Get keys for a cluster</li><li>Check if updates are available for system services in a cluster</li><li>Update system services in a cluster</li><li>Get all clusters in a resource group</li><li>Get all clusters in a subscription</li></ul>

func NewOperationalizationClustersClient

func NewOperationalizationClustersClient(subscriptionID string) OperationalizationClustersClient

NewOperationalizationClustersClient creates an instance of the OperationalizationClustersClient client.

func NewOperationalizationClustersClientWithBaseURI

func NewOperationalizationClustersClientWithBaseURI(baseURI string, subscriptionID string) OperationalizationClustersClient

NewOperationalizationClustersClientWithBaseURI creates an instance of the OperationalizationClustersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationalizationClustersClient) CheckSystemServicesUpdatesAvailable

func (client OperationalizationClustersClient) CheckSystemServicesUpdatesAvailable(ctx context.Context, resourceGroupName string, clusterName string) (result CheckSystemServicesUpdatesAvailableResponse, err error)

CheckSystemServicesUpdatesAvailable checks if updates are available for system services in the cluster. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster.

func (OperationalizationClustersClient) CheckSystemServicesUpdatesAvailablePreparer

func (client OperationalizationClustersClient) CheckSystemServicesUpdatesAvailablePreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

CheckSystemServicesUpdatesAvailablePreparer prepares the CheckSystemServicesUpdatesAvailable request.

func (OperationalizationClustersClient) CheckSystemServicesUpdatesAvailableResponder

func (client OperationalizationClustersClient) CheckSystemServicesUpdatesAvailableResponder(resp *http.Response) (result CheckSystemServicesUpdatesAvailableResponse, err error)

CheckSystemServicesUpdatesAvailableResponder handles the response to the CheckSystemServicesUpdatesAvailable request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) CheckSystemServicesUpdatesAvailableSender

func (client OperationalizationClustersClient) CheckSystemServicesUpdatesAvailableSender(req *http.Request) (*http.Response, error)

CheckSystemServicesUpdatesAvailableSender sends the CheckSystemServicesUpdatesAvailable request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) CreateOrUpdate

func (client OperationalizationClustersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, parameters OperationalizationCluster) (result OperationalizationClustersCreateOrUpdateFuture, err error)

CreateOrUpdate create or update an operationalization cluster. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster. parameters - parameters supplied to create or update an Operationalization cluster.

func (OperationalizationClustersClient) CreateOrUpdatePreparer

func (client OperationalizationClustersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters OperationalizationCluster) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (OperationalizationClustersClient) CreateOrUpdateResponder

func (client OperationalizationClustersClient) CreateOrUpdateResponder(resp *http.Response) (result OperationalizationCluster, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) CreateOrUpdateSender

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) Delete

func (client OperationalizationClustersClient) Delete(ctx context.Context, resourceGroupName string, clusterName string, deleteAll *bool) (result OperationalizationClustersDeleteFuture, err error)

Delete deletes the specified cluster. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster. deleteAll - if true, deletes all resources associated with this cluster.

func (OperationalizationClustersClient) DeletePreparer

func (client OperationalizationClustersClient) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string, deleteAll *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (OperationalizationClustersClient) DeleteResponder

func (client OperationalizationClustersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) DeleteSender

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) Get

func (client OperationalizationClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result OperationalizationCluster, err error)

Get gets the operationalization cluster resource view. Note that the credentials are not returned by this call. Call ListKeys to get them. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster.

func (OperationalizationClustersClient) GetPreparer

func (client OperationalizationClustersClient) GetPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OperationalizationClustersClient) GetResponder

func (client OperationalizationClustersClient) GetResponder(resp *http.Response) (result OperationalizationCluster, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) GetSender

func (client OperationalizationClustersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) ListByResourceGroup

func (client OperationalizationClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, skiptoken string) (result PaginatedOperationalizationClustersListPage, err error)

ListByResourceGroup gets the clusters in the specified resource group. Parameters: resourceGroupName - name of the resource group in which the cluster is located. skiptoken - continuation token for pagination.

func (OperationalizationClustersClient) ListByResourceGroupComplete

func (client OperationalizationClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, skiptoken string) (result PaginatedOperationalizationClustersListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationalizationClustersClient) ListByResourceGroupPreparer

func (client OperationalizationClustersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, skiptoken string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (OperationalizationClustersClient) ListByResourceGroupResponder

func (client OperationalizationClustersClient) ListByResourceGroupResponder(resp *http.Response) (result PaginatedOperationalizationClustersList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) ListByResourceGroupSender

func (client OperationalizationClustersClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) ListBySubscriptionID

func (client OperationalizationClustersClient) ListBySubscriptionID(ctx context.Context, skiptoken string) (result PaginatedOperationalizationClustersListPage, err error)

ListBySubscriptionID gets the operationalization clusters in the specified subscription. Parameters: skiptoken - continuation token for pagination.

func (OperationalizationClustersClient) ListBySubscriptionIDComplete

func (client OperationalizationClustersClient) ListBySubscriptionIDComplete(ctx context.Context, skiptoken string) (result PaginatedOperationalizationClustersListIterator, err error)

ListBySubscriptionIDComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationalizationClustersClient) ListBySubscriptionIDPreparer

func (client OperationalizationClustersClient) ListBySubscriptionIDPreparer(ctx context.Context, skiptoken string) (*http.Request, error)

ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.

func (OperationalizationClustersClient) ListBySubscriptionIDResponder

func (client OperationalizationClustersClient) ListBySubscriptionIDResponder(resp *http.Response) (result PaginatedOperationalizationClustersList, err error)

ListBySubscriptionIDResponder handles the response to the ListBySubscriptionID request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) ListBySubscriptionIDSender

func (client OperationalizationClustersClient) ListBySubscriptionIDSender(req *http.Request) (*http.Response, error)

ListBySubscriptionIDSender sends the ListBySubscriptionID request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) ListKeys

func (client OperationalizationClustersClient) ListKeys(ctx context.Context, resourceGroupName string, clusterName string) (result OperationalizationClusterCredentials, err error)

ListKeys gets the credentials for the specified cluster such as Storage, ACR and ACS credentials. This is a long running operation because it fetches keys from dependencies. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster.

func (OperationalizationClustersClient) ListKeysPreparer

func (client OperationalizationClustersClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (OperationalizationClustersClient) ListKeysResponder

func (client OperationalizationClustersClient) ListKeysResponder(resp *http.Response) (result OperationalizationClusterCredentials, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) ListKeysSender

func (client OperationalizationClustersClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) Update

func (client OperationalizationClustersClient) Update(ctx context.Context, resourceGroupName string, clusterName string, parameters OperationalizationClusterUpdateParameters) (result OperationalizationCluster, err error)

Update the PATCH operation can be used to update only the tags for a cluster. Use PUT operation to update other properties. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster. parameters - the parameters supplied to patch the cluster.

func (OperationalizationClustersClient) UpdatePreparer

func (client OperationalizationClustersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters OperationalizationClusterUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (OperationalizationClustersClient) UpdateResponder

func (client OperationalizationClustersClient) UpdateResponder(resp *http.Response) (result OperationalizationCluster, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) UpdateSender

func (client OperationalizationClustersClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

func (OperationalizationClustersClient) UpdateSystemServices

func (client OperationalizationClustersClient) UpdateSystemServices(ctx context.Context, resourceGroupName string, clusterName string) (result OperationalizationClustersUpdateSystemServicesFuture, err error)

UpdateSystemServices updates system services in a cluster. Parameters: resourceGroupName - name of the resource group in which the cluster is located. clusterName - the name of the cluster.

func (OperationalizationClustersClient) UpdateSystemServicesPreparer

func (client OperationalizationClustersClient) UpdateSystemServicesPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

UpdateSystemServicesPreparer prepares the UpdateSystemServices request.

func (OperationalizationClustersClient) UpdateSystemServicesResponder

func (client OperationalizationClustersClient) UpdateSystemServicesResponder(resp *http.Response) (result UpdateSystemServicesResponse, err error)

UpdateSystemServicesResponder handles the response to the UpdateSystemServices request. The method always closes the http.Response Body.

func (OperationalizationClustersClient) UpdateSystemServicesSender

func (client OperationalizationClustersClient) UpdateSystemServicesSender(req *http.Request) (future OperationalizationClustersUpdateSystemServicesFuture, err error)

UpdateSystemServicesSender sends the UpdateSystemServices request. The method will close the http.Response Body if it receives an error.

type OperationalizationClustersCreateOrUpdateFuture

type OperationalizationClustersCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(OperationalizationClustersClient) (OperationalizationCluster, error)
}

OperationalizationClustersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type OperationalizationClustersDeleteFuture

type OperationalizationClustersDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(OperationalizationClustersClient) (autorest.Response, error)
}

OperationalizationClustersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type OperationalizationClustersUpdateSystemServicesFuture

type OperationalizationClustersUpdateSystemServicesFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(OperationalizationClustersClient) (UpdateSystemServicesResponse, error)
}

OperationalizationClustersUpdateSystemServicesFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type OrchestratorType

type OrchestratorType string

OrchestratorType enumerates the values for orchestrator type.

const (
	// Kubernetes ...
	Kubernetes OrchestratorType = "Kubernetes"
	// None ...
	None OrchestratorType = "None"
)

func PossibleOrchestratorTypeValues

func PossibleOrchestratorTypeValues() []OrchestratorType

PossibleOrchestratorTypeValues returns an array of possible values for the OrchestratorType const type.

type PaginatedOperationalizationClustersList

type PaginatedOperationalizationClustersList struct {
	autorest.Response `json:"-"`
	// Value - An array of cluster objects.
	Value *[]OperationalizationCluster `json:"value,omitempty"`
	// NextLink - A continuation link (absolute URI) to the next page of results in the list.
	NextLink *string `json:"nextLink,omitempty"`
}

PaginatedOperationalizationClustersList paginated list of operationalization clusters.

func (PaginatedOperationalizationClustersList) IsEmpty

IsEmpty returns true if the ListResult contains no values.

type PaginatedOperationalizationClustersListIterator

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

PaginatedOperationalizationClustersListIterator provides access to a complete listing of OperationalizationCluster values.

func NewPaginatedOperationalizationClustersListIterator

func NewPaginatedOperationalizationClustersListIterator(page PaginatedOperationalizationClustersListPage) PaginatedOperationalizationClustersListIterator

Creates a new instance of the PaginatedOperationalizationClustersListIterator type.

func (*PaginatedOperationalizationClustersListIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PaginatedOperationalizationClustersListIterator) NextWithContext

func (iter *PaginatedOperationalizationClustersListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PaginatedOperationalizationClustersListIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (PaginatedOperationalizationClustersListIterator) Response

Response returns the raw server response from the last page request.

func (PaginatedOperationalizationClustersListIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PaginatedOperationalizationClustersListPage

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

PaginatedOperationalizationClustersListPage contains a page of OperationalizationCluster values.

func NewPaginatedOperationalizationClustersListPage

Creates a new instance of the PaginatedOperationalizationClustersListPage type.

func (*PaginatedOperationalizationClustersListPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PaginatedOperationalizationClustersListPage) NextWithContext

func (page *PaginatedOperationalizationClustersListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PaginatedOperationalizationClustersListPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PaginatedOperationalizationClustersListPage) Response

Response returns the raw server response from the last page request.

func (PaginatedOperationalizationClustersListPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type Resource

type Resource struct {
	// ID - READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty"`
	// Location - Specifies the location of the resource.
	Location *string `json:"location,omitempty"`
	// Type - READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty"`
	// Tags - Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags"`
}

Resource azure resource

func (Resource) MarshalJSON

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

MarshalJSON is the custom marshaler for Resource.

type ResourceOperation

type ResourceOperation struct {
	// Name - Name of this operation.
	Name *string `json:"name,omitempty"`
	// Display - Display of the operation.
	Display *ResourceOperationDisplay `json:"display,omitempty"`
	// Origin - The operation origin.
	Origin *string `json:"origin,omitempty"`
}

ResourceOperation resource operation.

type ResourceOperationDisplay

type ResourceOperationDisplay struct {
	// Provider - The resource provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - The resource name.
	Resource *string `json:"resource,omitempty"`
	// Operation - The operation.
	Operation *string `json:"operation,omitempty"`
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
}

ResourceOperationDisplay display of the operation.

type ServiceAuthConfiguration

type ServiceAuthConfiguration struct {
	// PrimaryAuthKeyHash - The primary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API.
	PrimaryAuthKeyHash *string `json:"primaryAuthKeyHash,omitempty"`
	// SecondaryAuthKeyHash - The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API.
	SecondaryAuthKeyHash *string `json:"secondaryAuthKeyHash,omitempty"`
}

ServiceAuthConfiguration global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own.

type ServicePrincipalProperties

type ServicePrincipalProperties struct {
	// ClientID - The service principal client ID
	ClientID *string `json:"clientId,omitempty"`
	// Secret - The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys.
	Secret *string `json:"secret,omitempty"`
}

ServicePrincipalProperties the Azure service principal used by Kubernetes for configuring load balancers

type SslConfiguration

type SslConfiguration struct {
	// Status - SSL status. Allowed values are Enabled and Disabled. Possible values include: 'Enabled', 'Disabled'
	Status Status `json:"status,omitempty"`
	// Cert - The SSL cert data in PEM format.
	Cert *string `json:"cert,omitempty"`
	// Key - The SSL key data in PEM format. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API.
	Key *string `json:"key,omitempty"`
	// Cname - The CName of the certificate.
	Cname *string `json:"cname,omitempty"`
}

SslConfiguration SSL configuration. If configured data-plane calls to user services will be exposed over SSL only.

type Status

type Status string

Status enumerates the values for status.

const (
	// Disabled ...
	Disabled Status = "Disabled"
	// Enabled ...
	Enabled Status = "Enabled"
)

func PossibleStatusValues

func PossibleStatusValues() []Status

PossibleStatusValues returns an array of possible values for the Status const type.

type StorageAccountCredentials

type StorageAccountCredentials struct {
	// ResourceID - READ-ONLY; The ARM resource ID of the storage account.
	ResourceID *string `json:"resourceId,omitempty"`
	// PrimaryKey - READ-ONLY; The primary key of the storage account.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - READ-ONLY; The secondary key of the storage account.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

StorageAccountCredentials access information for the storage account.

type StorageAccountProperties

type StorageAccountProperties struct {
	// ResourceID - ARM resource ID of the Azure Storage Account to store CLI specific files. If not provided one will be created. This cannot be changed once the cluster is created.
	ResourceID *string `json:"resourceId,omitempty"`
}

StorageAccountProperties properties of Storage Account.

type SystemService

type SystemService struct {
	// SystemServiceType - The system service type. Possible values include: 'SystemServiceTypeNone', 'SystemServiceTypeScoringFrontEnd', 'SystemServiceTypeBatchFrontEnd'
	SystemServiceType SystemServiceType `json:"systemServiceType,omitempty"`
	// PublicIPAddress - READ-ONLY; The public IP address of the system service
	PublicIPAddress *string `json:"publicIpAddress,omitempty"`
	// Version - READ-ONLY; The state of the system service
	Version *string `json:"version,omitempty"`
}

SystemService information about a system service deployed in the cluster

func (SystemService) MarshalJSON

func (ss SystemService) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SystemService.

type SystemServiceType

type SystemServiceType string

SystemServiceType enumerates the values for system service type.

const (
	// SystemServiceTypeBatchFrontEnd ...
	SystemServiceTypeBatchFrontEnd SystemServiceType = "BatchFrontEnd"
	// SystemServiceTypeNone ...
	SystemServiceTypeNone SystemServiceType = "None"
	// SystemServiceTypeScoringFrontEnd ...
	SystemServiceTypeScoringFrontEnd SystemServiceType = "ScoringFrontEnd"
)

func PossibleSystemServiceTypeValues

func PossibleSystemServiceTypeValues() []SystemServiceType

PossibleSystemServiceTypeValues returns an array of possible values for the SystemServiceType const type.

type UpdateSystemServicesResponse

type UpdateSystemServicesResponse struct {
	autorest.Response `json:"-"`
	// UpdateStatus - READ-ONLY; Update status. Possible values include: 'Unknown', 'Updating', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
	UpdateStatus OperationStatus `json:"updateStatus,omitempty"`
	// UpdateStartedOn - READ-ONLY; The date and time when the last system services update was started.
	UpdateStartedOn *date.Time `json:"updateStartedOn,omitempty"`
	// UpdateCompletedOn - READ-ONLY; The date and time when the last system services update completed.
	UpdateCompletedOn *date.Time `json:"updateCompletedOn,omitempty"`
}

UpdateSystemServicesResponse response of the update system services API

type UpdatesAvailable

type UpdatesAvailable string

UpdatesAvailable enumerates the values for updates available.

const (
	// No ...
	No UpdatesAvailable = "No"
	// Yes ...
	Yes UpdatesAvailable = "Yes"
)

func PossibleUpdatesAvailableValues

func PossibleUpdatesAvailableValues() []UpdatesAvailable

PossibleUpdatesAvailableValues returns an array of possible values for the UpdatesAvailable const type.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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