armazurestackhci

package module
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Aug 21, 2024 License: MIT Imports: 14 Imported by: 1

README

Azure Stack HCI Module for Go

PkgGoDev

The armazurestackhci module provides operations for working with Azure Stack HCI.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Stack HCI module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/azurestackhci/armazurestackhci/v2

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Stack HCI. 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.

Client Factory

Azure Stack HCI module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armazurestackhci.NewClientFactory(<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,
    },
}
clientFactory, err := armazurestackhci.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewArcSettingsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Stack HCI 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 AccessLevel 

type AccessLevel string

AccessLevel - Remote Support Access Level 

const (
	AccessLevelDiagnostics          AccessLevel = "Diagnostics"
	AccessLevelDiagnosticsAndRepair AccessLevel = "DiagnosticsAndRepair"
)

func PossibleAccessLevelValues 

func PossibleAccessLevelValues() []AccessLevel

PossibleAccessLevelValues returns the possible values for the AccessLevel const type.

type ActionType 

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. 

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ArcExtensionState 

type ArcExtensionState string

ArcExtensionState - Arc extension installation state. 

const (
	// ArcExtensionStateAccepted - Arc extension state is Accepted when extension installation triggered.
	ArcExtensionStateAccepted ArcExtensionState = "Accepted"
	// ArcExtensionStateCanceled - Arc extension state is Canceled.
	ArcExtensionStateCanceled ArcExtensionState = "Canceled"
	// ArcExtensionStateCreating - Arc extension is in Creating State.
	ArcExtensionStateCreating ArcExtensionState = "Creating"
	// ArcExtensionStateDeleted - Arc extension is in Deleted State.
	ArcExtensionStateDeleted ArcExtensionState = "Deleted"
	// ArcExtensionStateDeleting - Arc extension is in Deleting State.
	ArcExtensionStateDeleting ArcExtensionState = "Deleting"
	// ArcExtensionStateFailed - Arc extension state is Failed.
	ArcExtensionStateFailed ArcExtensionState = "Failed"
	// ArcExtensionStateMoving - Arc extension is in Moving State.
	ArcExtensionStateMoving ArcExtensionState = "Moving"
	// ArcExtensionStateNotSpecified - Arc extension state is not specified.
	ArcExtensionStateNotSpecified ArcExtensionState = "NotSpecified"
	// ArcExtensionStateSucceeded - Arc extension state is Succeeded.
	ArcExtensionStateSucceeded ArcExtensionState = "Succeeded"
	// ArcExtensionStateUpdating - Arc extension is in Updating State.
	ArcExtensionStateUpdating ArcExtensionState = "Updating"
)

func PossibleArcExtensionStateValues 

func PossibleArcExtensionStateValues() []ArcExtensionState

PossibleArcExtensionStateValues returns the possible values for the ArcExtensionState const type.

type ArcIdentityResponse 

type ArcIdentityResponse struct {
	// READ-ONLY; ArcIdentity properties.
	Properties *ArcIdentityResponseProperties
}

ArcIdentityResponse - ArcIdentity details.

func (ArcIdentityResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcIdentityResponse.

func (*ArcIdentityResponse) UnmarshalJSON 

func (a *ArcIdentityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcIdentityResponse.

type ArcIdentityResponseProperties 

type ArcIdentityResponseProperties struct {
	ArcApplicationClientID      *string
	ArcApplicationObjectID      *string
	ArcApplicationTenantID      *string
	ArcServicePrincipalObjectID *string
}

func (ArcIdentityResponseProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcIdentityResponseProperties.

func (*ArcIdentityResponseProperties) UnmarshalJSON 

func (a *ArcIdentityResponseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcIdentityResponseProperties.

type ArcSetting 

type ArcSetting struct {
	// ArcSetting properties.
	Properties *ArcSettingProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ArcSetting details.

func (ArcSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcSetting.

func (*ArcSetting) UnmarshalJSON 

func (a *ArcSetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcSetting.

type ArcSettingAggregateState 

type ArcSettingAggregateState string

ArcSettingAggregateState - Aggregate state of Arc agent across the nodes in this HCI cluster. 

const (
	ArcSettingAggregateStateAccepted           ArcSettingAggregateState = "Accepted"
	ArcSettingAggregateStateCanceled           ArcSettingAggregateState = "Canceled"
	ArcSettingAggregateStateConnected          ArcSettingAggregateState = "Connected"
	ArcSettingAggregateStateCreating           ArcSettingAggregateState = "Creating"
	ArcSettingAggregateStateDeleted            ArcSettingAggregateState = "Deleted"
	ArcSettingAggregateStateDeleting           ArcSettingAggregateState = "Deleting"
	ArcSettingAggregateStateDisableInProgress  ArcSettingAggregateState = "DisableInProgress"
	ArcSettingAggregateStateDisconnected       ArcSettingAggregateState = "Disconnected"
	ArcSettingAggregateStateError              ArcSettingAggregateState = "Error"
	ArcSettingAggregateStateFailed             ArcSettingAggregateState = "Failed"
	ArcSettingAggregateStateInProgress         ArcSettingAggregateState = "InProgress"
	ArcSettingAggregateStateMoving             ArcSettingAggregateState = "Moving"
	ArcSettingAggregateStateNotSpecified       ArcSettingAggregateState = "NotSpecified"
	ArcSettingAggregateStatePartiallyConnected ArcSettingAggregateState = "PartiallyConnected"
	ArcSettingAggregateStatePartiallySucceeded ArcSettingAggregateState = "PartiallySucceeded"
	ArcSettingAggregateStateProvisioning       ArcSettingAggregateState = "Provisioning"
	ArcSettingAggregateStateSucceeded          ArcSettingAggregateState = "Succeeded"
	ArcSettingAggregateStateUpdating           ArcSettingAggregateState = "Updating"
)

func PossibleArcSettingAggregateStateValues 

func PossibleArcSettingAggregateStateValues() []ArcSettingAggregateState

PossibleArcSettingAggregateStateValues returns the possible values for the ArcSettingAggregateState const type.

type ArcSettingList 

type ArcSettingList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; List of ArcSetting proxy resources.
	Value []*ArcSetting
}

ArcSettingList - List of ArcSetting proxy resources for the HCI cluster.

func (ArcSettingList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcSettingList.

func (*ArcSettingList) UnmarshalJSON 

func (a *ArcSettingList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcSettingList.

type ArcSettingProperties 

type ArcSettingProperties struct {
	// App id of arc AAD identity.
	ArcApplicationClientID *string

	// Object id of arc AAD identity.
	ArcApplicationObjectID *string

	// Tenant id of arc AAD identity.
	ArcApplicationTenantID *string

	// The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.
	ArcInstanceResourceGroup *string

	// Object id of arc AAD service principal.
	ArcServicePrincipalObjectID *string

	// contains connectivity related configuration for ARC resources
	ConnectivityProperties any

	// READ-ONLY; Aggregate state of Arc agent across the nodes in this HCI cluster.
	AggregateState *ArcSettingAggregateState

	// READ-ONLY; Properties for each of the default extensions category
	DefaultExtensions []*DefaultExtensionDetails

	// READ-ONLY; State of Arc agent in each of the nodes.
	PerNodeDetails []*PerNodeState

	// READ-ONLY; Provisioning state of the ArcSetting proxy resource.
	ProvisioningState *ProvisioningState
}

ArcSettingProperties - ArcSetting properties.

func (ArcSettingProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcSettingProperties.

func (*ArcSettingProperties) UnmarshalJSON 

func (a *ArcSettingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcSettingProperties.

type ArcSettingsClient 

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

ArcSettingsClient contains the methods for the ArcSettings group. Don't use this type directly, use NewArcSettingsClient() instead.

func NewArcSettingsClient 

func NewArcSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ArcSettingsClient, error)

NewArcSettingsClient creates a new instance of ArcSettingsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ArcSettingsClient) BeginCreateIdentity 

func (client *ArcSettingsClient) BeginCreateIdentity(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, options *ArcSettingsClientBeginCreateIdentityOptions) (*runtime.Poller[ArcSettingsClientCreateIdentityResponse], error)

BeginCreateIdentity - Create Aad identity for arc settings. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ArcSettingsClientBeginCreateIdentityOptions contains the optional parameters for the ArcSettingsClient.BeginCreateIdentity method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateArcIdentity.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArcSettingsClient().BeginCreateIdentity(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArcIdentityResponse = armazurestackhci.ArcIdentityResponse{
// 	Properties: &armazurestackhci.ArcIdentityResponseProperties{
// 		ArcApplicationClientID: to.Ptr("7b93bf67-60ac-4909-a987-ac438e69f9ba"),
// 		ArcApplicationObjectID: to.Ptr("400bd05f-395f-45a6-ba75-72601df80107"),
// 		ArcApplicationTenantID: to.Ptr("bdb2c88c-9cfd-4e19-927d-51e875f6912b"),
// 		ArcServicePrincipalObjectID: to.Ptr("00cc4014-482e-4de9-9932-83415cc75f45"),
// 	},
// }

Output:

func (*ArcSettingsClient) BeginDelete 

func (client *ArcSettingsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, options *ArcSettingsClientBeginDeleteOptions) (*runtime.Poller[ArcSettingsClientDeleteResponse], error)

BeginDelete - Delete ArcSetting resource details of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ArcSettingsClientBeginDeleteOptions contains the optional parameters for the ArcSettingsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteArcSetting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArcSettingsClient().BeginDelete(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ArcSettingsClient) BeginInitializeDisableProcess 

func (client *ArcSettingsClient) BeginInitializeDisableProcess(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, options *ArcSettingsClientBeginInitializeDisableProcessOptions) (*runtime.Poller[ArcSettingsClientInitializeDisableProcessResponse], error)

BeginInitializeDisableProcess - Initializes ARC Disable process on the cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ArcSettingsClientBeginInitializeDisableProcessOptions contains the optional parameters for the ArcSettingsClient.BeginInitializeDisableProcess method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/InitializeDisableProcess.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArcSettingsClient().BeginInitializeDisableProcess(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ArcSettingsClient) ConsentAndInstallDefaultExtensions 

func (client *ArcSettingsClient) ConsentAndInstallDefaultExtensions(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, options *ArcSettingsClientConsentAndInstallDefaultExtensionsOptions) (ArcSettingsClientConsentAndInstallDefaultExtensionsResponse, error)

ConsentAndInstallDefaultExtensions - Add consent time for default extensions and initiate extensions installation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ArcSettingsClientConsentAndInstallDefaultExtensionsOptions contains the optional parameters for the ArcSettingsClient.ConsentAndInstallDefaultExtensions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConsentAndInstallDefaultExtensions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArcSettingsClient().ConsentAndInstallDefaultExtensions(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArcSetting = armazurestackhci.ArcSetting{
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ArcSettingProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ArcSettingAggregateStateCreating),
// 		ArcInstanceResourceGroup: to.Ptr("ArcInstance-rg"),
// 		ConnectivityProperties: map[string]any{
// 			"enabled": false,
// 			"serviceConfigurations":[]any{
// 			},
// 		},
// 		DefaultExtensions: []*armazurestackhci.DefaultExtensionDetails{
// 			{
// 				Category: to.Ptr("Telemetry"),
// 				ConsentTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:18:19.123Z"); return t}()),
// 		}},
// 		PerNodeDetails: []*armazurestackhci.PerNodeState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ArcSettingsClient) Create 

func (client *ArcSettingsClient) Create(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, arcSetting ArcSetting, options *ArcSettingsClientCreateOptions) (ArcSettingsClientCreateResponse, error)

Create - Create ArcSetting for HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • arcSetting - Parameters supplied to the Create ArcSetting resource for this HCI cluster.
  • options - ArcSettingsClientCreateOptions contains the optional parameters for the ArcSettingsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutArcSetting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArcSettingsClient().Create(ctx, "test-rg", "myCluster", "default", armazurestackhci.ArcSetting{}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArcSetting = armazurestackhci.ArcSetting{
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ArcSettingProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ArcSettingAggregateStateCreating),
// 		ArcInstanceResourceGroup: to.Ptr("ArcInstance-rg"),
// 		ConnectivityProperties: map[string]any{
// 			"enabled": false,
// 			"serviceConfigurations":[]any{
// 			},
// 		},
// 		DefaultExtensions: []*armazurestackhci.DefaultExtensionDetails{
// 			{
// 				Category: to.Ptr("Telemetry"),
// 				ConsentTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:18:19.123Z"); return t}()),
// 		}},
// 		PerNodeDetails: []*armazurestackhci.PerNodeState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ArcSettingsClient) GeneratePassword 

func (client *ArcSettingsClient) GeneratePassword(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, options *ArcSettingsClientGeneratePasswordOptions) (ArcSettingsClientGeneratePasswordResponse, error)

GeneratePassword - Generate password for arc settings. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ArcSettingsClientGeneratePasswordOptions contains the optional parameters for the ArcSettingsClient.GeneratePassword method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GeneratePassword.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArcSettingsClient().GeneratePassword(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PasswordCredential = armazurestackhci.PasswordCredential{
// 	EndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2121-02-17T10:54:23.626Z"); return t}()),
// 	KeyID: to.Ptr("00000000-2d47-4fb2-8ed2-fed71a5c197b"),
// 	SecretText: to.Ptr("secretText"),
// 	StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-17T10:54:23.626Z"); return t}()),
// }

Output:

func (*ArcSettingsClient) Get 

func (client *ArcSettingsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, options *ArcSettingsClientGetOptions) (ArcSettingsClientGetResponse, error)

Get - Get ArcSetting resource details of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ArcSettingsClientGetOptions contains the optional parameters for the ArcSettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetArcSetting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArcSettingsClient().Get(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArcSetting = armazurestackhci.ArcSetting{
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ArcSettingProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ArcSettingAggregateStatePartiallyConnected),
// 		ArcInstanceResourceGroup: to.Ptr("ArcInstance-rg"),
// 		ConnectivityProperties: map[string]any{
// 			"enabled": false,
// 			"serviceConfigurations":[]any{
// 				map[string]any{
// 					"port": float64(6516),
// 					"serviceName": "WAC",
// 				},
// 			},
// 		},
// 		DefaultExtensions: []*armazurestackhci.DefaultExtensionDetails{
// 			{
// 				Category: to.Ptr("Telemetry"),
// 				ConsentTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:18:19.123Z"); return t}()),
// 			},
// 			{
// 				Category: to.Ptr("Supportability"),
// 		}},
// 		PerNodeDetails: []*armazurestackhci.PerNodeState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateConnected),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateDisconnected),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ArcSettingsClient) NewListByClusterPager 

func (client *ArcSettingsClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *ArcSettingsClientListByClusterOptions) *runtime.Pager[ArcSettingsClientListByClusterResponse]

NewListByClusterPager - Get ArcSetting resources of HCI Cluster.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - ArcSettingsClientListByClusterOptions contains the optional parameters for the ArcSettingsClient.NewListByClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListArcSettingsByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewArcSettingsClient().NewListByClusterPager("test-rg", "myCluster", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ArcSettingList = armazurestackhci.ArcSettingList{
	// 	Value: []*armazurestackhci.ArcSetting{
	// 		{
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Properties: &armazurestackhci.ArcSettingProperties{
	// 				AggregateState: to.Ptr(armazurestackhci.ArcSettingAggregateStatePartiallyConnected),
	// 				ArcInstanceResourceGroup: to.Ptr("ArcInstance-rg"),
	// 				ConnectivityProperties: map[string]any{
	// 					"enabled": false,
	// 					"serviceConfigurations":[]any{
	// 						map[string]any{
	// 							"port": float64(6516),
	// 							"serviceName": "WAC",
	// 						},
	// 					},
	// 				},
	// 				DefaultExtensions: []*armazurestackhci.DefaultExtensionDetails{
	// 					{
	// 						Category: to.Ptr("Telemetry"),
	// 						ConsentTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:18:19.123Z"); return t}()),
	// 					},
	// 					{
	// 						Category: to.Ptr("Supportability"),
	// 				}},
	// 				PerNodeDetails: []*armazurestackhci.PerNodeState{
	// 					{
	// 						Name: to.Ptr("Node-1"),
	// 						ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
	// 						State: to.Ptr(armazurestackhci.NodeArcStateConnected),
	// 					},
	// 					{
	// 						Name: to.Ptr("Node-2"),
	// 						ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"),
	// 						State: to.Ptr(armazurestackhci.NodeArcStateDisconnected),
	// 				}},
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*ArcSettingsClient) Update 

func (client *ArcSettingsClient) Update(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, arcSetting ArcSettingsPatch, options *ArcSettingsClientUpdateOptions) (ArcSettingsClientUpdateResponse, error)

Update - Update ArcSettings for HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • arcSetting - ArcSettings parameters that needs to be updated
  • options - ArcSettingsClientUpdateOptions contains the optional parameters for the ArcSettingsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchArcSetting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArcSettingsClient().Update(ctx, "test-rg", "myCluster", "default", armazurestackhci.ArcSettingsPatch{
	Properties: &armazurestackhci.ArcSettingsPatchProperties{
		ConnectivityProperties: map[string]any{
			"enabled": true,
			"serviceConfigurations": []any{
				map[string]any{
					"port":        float64(6516),
					"serviceName": "WAC",
				},
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArcSetting = armazurestackhci.ArcSetting{
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ArcSettingProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ArcSettingAggregateStateCreating),
// 		ArcInstanceResourceGroup: to.Ptr("ArcInstance-rg"),
// 		ConnectivityProperties: map[string]any{
// 			"enabled": true,
// 			"serviceConfigurations":[]any{
// 				map[string]any{
// 					"port": float64(6516),
// 					"serviceName": "WAC",
// 				},
// 			},
// 		},
// 		DefaultExtensions: []*armazurestackhci.DefaultExtensionDetails{
// 			{
// 				Category: to.Ptr("Telemetry"),
// 				ConsentTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T17:18:19.123Z"); return t}()),
// 			},
// 			{
// 				Category: to.Ptr("Supportability"),
// 		}},
// 		PerNodeDetails: []*armazurestackhci.PerNodeState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				ArcInstance: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2"),
// 				State: to.Ptr(armazurestackhci.NodeArcStateCreating),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

type ArcSettingsClientBeginCreateIdentityOptions 

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

ArcSettingsClientBeginCreateIdentityOptions contains the optional parameters for the ArcSettingsClient.BeginCreateIdentity method.

type ArcSettingsClientBeginDeleteOptions 

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

ArcSettingsClientBeginDeleteOptions contains the optional parameters for the ArcSettingsClient.BeginDelete method.

type ArcSettingsClientBeginInitializeDisableProcessOptions 

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

ArcSettingsClientBeginInitializeDisableProcessOptions contains the optional parameters for the ArcSettingsClient.BeginInitializeDisableProcess method.

type ArcSettingsClientConsentAndInstallDefaultExtensionsOptions 

type ArcSettingsClientConsentAndInstallDefaultExtensionsOptions struct {
}

ArcSettingsClientConsentAndInstallDefaultExtensionsOptions contains the optional parameters for the ArcSettingsClient.ConsentAndInstallDefaultExtensions method.

type ArcSettingsClientConsentAndInstallDefaultExtensionsResponse 

type ArcSettingsClientConsentAndInstallDefaultExtensionsResponse struct {
	// ArcSetting details.
	ArcSetting
}

ArcSettingsClientConsentAndInstallDefaultExtensionsResponse contains the response from method ArcSettingsClient.ConsentAndInstallDefaultExtensions.

type ArcSettingsClientCreateIdentityResponse 

type ArcSettingsClientCreateIdentityResponse struct {
	// ArcIdentity details.
	ArcIdentityResponse
}

ArcSettingsClientCreateIdentityResponse contains the response from method ArcSettingsClient.BeginCreateIdentity.

type ArcSettingsClientCreateOptions 

type ArcSettingsClientCreateOptions struct {
}

ArcSettingsClientCreateOptions contains the optional parameters for the ArcSettingsClient.Create method.

type ArcSettingsClientCreateResponse 

type ArcSettingsClientCreateResponse struct {
	// ArcSetting details.
	ArcSetting
}

ArcSettingsClientCreateResponse contains the response from method ArcSettingsClient.Create.

type ArcSettingsClientDeleteResponse 

type ArcSettingsClientDeleteResponse struct {
}

ArcSettingsClientDeleteResponse contains the response from method ArcSettingsClient.BeginDelete.

type ArcSettingsClientGeneratePasswordOptions 

type ArcSettingsClientGeneratePasswordOptions struct {
}

ArcSettingsClientGeneratePasswordOptions contains the optional parameters for the ArcSettingsClient.GeneratePassword method.

type ArcSettingsClientGeneratePasswordResponse 

type ArcSettingsClientGeneratePasswordResponse struct {
	PasswordCredential
}

ArcSettingsClientGeneratePasswordResponse contains the response from method ArcSettingsClient.GeneratePassword.

type ArcSettingsClientGetOptions 

type ArcSettingsClientGetOptions struct {
}

ArcSettingsClientGetOptions contains the optional parameters for the ArcSettingsClient.Get method.

type ArcSettingsClientGetResponse 

type ArcSettingsClientGetResponse struct {
	// ArcSetting details.
	ArcSetting
}

ArcSettingsClientGetResponse contains the response from method ArcSettingsClient.Get.

type ArcSettingsClientInitializeDisableProcessResponse 

type ArcSettingsClientInitializeDisableProcessResponse struct {
}

ArcSettingsClientInitializeDisableProcessResponse contains the response from method ArcSettingsClient.BeginInitializeDisableProcess.

type ArcSettingsClientListByClusterOptions 

type ArcSettingsClientListByClusterOptions struct {
}

ArcSettingsClientListByClusterOptions contains the optional parameters for the ArcSettingsClient.NewListByClusterPager method.

type ArcSettingsClientListByClusterResponse 

type ArcSettingsClientListByClusterResponse struct {
	// List of ArcSetting proxy resources for the HCI cluster.
	ArcSettingList
}

ArcSettingsClientListByClusterResponse contains the response from method ArcSettingsClient.NewListByClusterPager.

type ArcSettingsClientUpdateOptions 

type ArcSettingsClientUpdateOptions struct {
}

ArcSettingsClientUpdateOptions contains the optional parameters for the ArcSettingsClient.Update method.

type ArcSettingsClientUpdateResponse 

type ArcSettingsClientUpdateResponse struct {
	// ArcSetting details.
	ArcSetting
}

ArcSettingsClientUpdateResponse contains the response from method ArcSettingsClient.Update.

type ArcSettingsPatch 

type ArcSettingsPatch struct {
	// ArcSettings properties.
	Properties *ArcSettingsPatchProperties

	// Resource tags.
	Tags map[string]*string
}

ArcSettingsPatch - ArcSetting details to update.

func (ArcSettingsPatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcSettingsPatch.

func (*ArcSettingsPatch) UnmarshalJSON 

func (a *ArcSettingsPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcSettingsPatch.

type ArcSettingsPatchProperties 

type ArcSettingsPatchProperties struct {
	// contains connectivity related configuration for ARC resources
	ConnectivityProperties any
}

ArcSettingsPatchProperties - ArcSettings properties.

func (ArcSettingsPatchProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArcSettingsPatchProperties.

func (*ArcSettingsPatchProperties) UnmarshalJSON 

func (a *ArcSettingsPatchProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArcSettingsPatchProperties.

type AvailabilityType 

type AvailabilityType string

AvailabilityType - Indicates the way the update content can be downloaded. 

const (
	AvailabilityTypeLocal  AvailabilityType = "Local"
	AvailabilityTypeNotify AvailabilityType = "Notify"
	AvailabilityTypeOnline AvailabilityType = "Online"
)

func PossibleAvailabilityTypeValues 

func PossibleAvailabilityTypeValues() []AvailabilityType

PossibleAvailabilityTypeValues returns the possible values for the AvailabilityType const type.

type ClientFactory 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewArcSettingsClient 

func (c *ClientFactory) NewArcSettingsClient() *ArcSettingsClient

NewArcSettingsClient creates a new instance of ArcSettingsClient.

func (*ClientFactory) NewClustersClient 

func (c *ClientFactory) NewClustersClient() *ClustersClient

NewClustersClient creates a new instance of ClustersClient.

func (*ClientFactory) NewDeploymentSettingsClient 

func (c *ClientFactory) NewDeploymentSettingsClient() *DeploymentSettingsClient

NewDeploymentSettingsClient creates a new instance of DeploymentSettingsClient.

func (*ClientFactory) NewEdgeDevicesClient 

func (c *ClientFactory) NewEdgeDevicesClient() *EdgeDevicesClient

NewEdgeDevicesClient creates a new instance of EdgeDevicesClient.

func (*ClientFactory) NewExtensionsClient 

func (c *ClientFactory) NewExtensionsClient() *ExtensionsClient

NewExtensionsClient creates a new instance of ExtensionsClient.

func (*ClientFactory) NewOffersClient 

func (c *ClientFactory) NewOffersClient() *OffersClient

NewOffersClient creates a new instance of OffersClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPublishersClient 

func (c *ClientFactory) NewPublishersClient() *PublishersClient

NewPublishersClient creates a new instance of PublishersClient.

func (*ClientFactory) NewSKUsClient 

func (c *ClientFactory) NewSKUsClient() *SKUsClient

NewSKUsClient creates a new instance of SKUsClient.

func (*ClientFactory) NewSecuritySettingsClient 

func (c *ClientFactory) NewSecuritySettingsClient() *SecuritySettingsClient

NewSecuritySettingsClient creates a new instance of SecuritySettingsClient.

func (*ClientFactory) NewUpdateRunsClient 

func (c *ClientFactory) NewUpdateRunsClient() *UpdateRunsClient

NewUpdateRunsClient creates a new instance of UpdateRunsClient.

func (*ClientFactory) NewUpdateSummariesClient 

func (c *ClientFactory) NewUpdateSummariesClient() *UpdateSummariesClient

NewUpdateSummariesClient creates a new instance of UpdateSummariesClient.

func (*ClientFactory) NewUpdatesClient 

func (c *ClientFactory) NewUpdatesClient() *UpdatesClient

NewUpdatesClient creates a new instance of UpdatesClient.

type Cluster 

type Cluster struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Identity of Cluster resource
	Identity *ManagedServiceIdentity

	// Cluster properties.
	Properties *ClusterProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Cluster details.

func (Cluster) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Cluster.

func (*Cluster) UnmarshalJSON 

func (c *Cluster) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Cluster.

type ClusterDesiredProperties 

type ClusterDesiredProperties struct {
	// Desired level of diagnostic data emitted by the cluster.
	DiagnosticLevel *DiagnosticLevel

	// Desired state of Windows Server Subscription.
	WindowsServerSubscription *WindowsServerSubscription
}

ClusterDesiredProperties - Desired properties of the cluster.

func (ClusterDesiredProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterDesiredProperties.

func (*ClusterDesiredProperties) UnmarshalJSON 

func (c *ClusterDesiredProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterDesiredProperties.

type ClusterIdentityResponse 

type ClusterIdentityResponse struct {
	// READ-ONLY; Cluster identity properties.
	Properties *ClusterIdentityResponseProperties
}

ClusterIdentityResponse - Cluster Identity details.

func (ClusterIdentityResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterIdentityResponse.

func (*ClusterIdentityResponse) UnmarshalJSON 

func (c *ClusterIdentityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterIdentityResponse.

type ClusterIdentityResponseProperties 

type ClusterIdentityResponseProperties struct {
	AADApplicationObjectID      *string
	AADClientID                 *string
	AADServicePrincipalObjectID *string
	AADTenantID                 *string
}

func (ClusterIdentityResponseProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterIdentityResponseProperties.

func (*ClusterIdentityResponseProperties) UnmarshalJSON 

func (c *ClusterIdentityResponseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterIdentityResponseProperties.

type ClusterList 

type ClusterList struct {
	// List of clusters.
	Value []*Cluster

	// READ-ONLY; Link to the next set of results.
	NextLink *string
}

ClusterList - List of clusters.

func (ClusterList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterList.

func (*ClusterList) UnmarshalJSON 

func (c *ClusterList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterList.

type ClusterNode 

type ClusterNode struct {
	// READ-ONLY; Number of physical cores on the cluster node.
	CoreCount *float32

	// READ-ONLY; Edge Hardware Center Resource Id
	EhcResourceID *string

	// READ-ONLY; Id of the node in the cluster.
	ID *float32

	// READ-ONLY; Most recent licensing timestamp.
	LastLicensingTimestamp *time.Time

	// READ-ONLY; Manufacturer of the cluster node hardware.
	Manufacturer *string

	// READ-ONLY; Total available memory on the cluster node (in GiB).
	MemoryInGiB *float32

	// READ-ONLY; Model name of the cluster node hardware.
	Model *string

	// READ-ONLY; Name of the cluster node.
	Name *string

	// READ-ONLY; Type of the cluster node hardware.
	NodeType *ClusterNodeType

	// READ-ONLY; Display version of the operating system running on the cluster node.
	OSDisplayVersion *string

	// READ-ONLY; Operating system running on the cluster node.
	OSName *string

	// READ-ONLY; Version of the operating system running on the cluster node.
	OSVersion *string

	// READ-ONLY; OEM activation status of the node.
	OemActivation *OemActivation

	// READ-ONLY; Immutable id of the cluster node.
	SerialNumber *string

	// READ-ONLY; State of Windows Server Subscription.
	WindowsServerSubscription *WindowsServerSubscription
}

ClusterNode - Cluster node details.

func (ClusterNode) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterNode.

func (*ClusterNode) UnmarshalJSON 

func (c *ClusterNode) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterNode.

type ClusterNodeType 

type ClusterNodeType string

ClusterNodeType - The node type of all the nodes of the cluster. 

const (
	ClusterNodeTypeFirstParty ClusterNodeType = "FirstParty"
	ClusterNodeTypeThirdParty ClusterNodeType = "ThirdParty"
)

func PossibleClusterNodeTypeValues 

func PossibleClusterNodeTypeValues() []ClusterNodeType

PossibleClusterNodeTypeValues returns the possible values for the ClusterNodeType const type.

type ClusterPatch 

type ClusterPatch struct {
	// Identity of Cluster resource
	Identity *ManagedServiceIdentity

	// Cluster properties.
	Properties *ClusterPatchProperties

	// Resource tags.
	Tags map[string]*string
}

ClusterPatch - Cluster details to update.

func (ClusterPatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterPatch.

func (*ClusterPatch) UnmarshalJSON 

func (c *ClusterPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPatch.

type ClusterPatchProperties 

type ClusterPatchProperties struct {
	// App id of cluster AAD identity.
	AADClientID *string

	// Tenant id of cluster AAD identity.
	AADTenantID *string

	// Endpoint configured for management from the Azure portal
	CloudManagementEndpoint *string

	// Desired properties of the cluster.
	DesiredProperties *ClusterDesiredProperties
}

ClusterPatchProperties - Cluster properties.

func (ClusterPatchProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterPatchProperties.

func (*ClusterPatchProperties) UnmarshalJSON 

func (c *ClusterPatchProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPatchProperties.

type ClusterProperties 

type ClusterProperties struct {
	// Object id of cluster AAD identity.
	AADApplicationObjectID *string

	// App id of cluster AAD identity.
	AADClientID *string

	// Id of cluster identity service principal.
	AADServicePrincipalObjectID *string

	// Tenant id of cluster AAD identity.
	AADTenantID *string

	// Endpoint configured for management from the Azure portal.
	CloudManagementEndpoint *string

	// Desired properties of the cluster.
	DesiredProperties *ClusterDesiredProperties

	// Log Collection properties of the cluster.
	LogCollectionProperties *LogCollectionProperties

	// RemoteSupport properties of the cluster.
	RemoteSupportProperties *RemoteSupportProperties

	// Software Assurance properties of the cluster.
	SoftwareAssuranceProperties *SoftwareAssuranceProperties

	// READ-ONLY; Type of billing applied to the resource.
	BillingModel *string

	// READ-ONLY; Unique, immutable resource id.
	CloudID *string

	// READ-ONLY; Overall connectivity status for the cluster resource.
	ConnectivityStatus *ConnectivityStatus

	// READ-ONLY; Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
	IsolatedVMAttestationConfiguration *IsolatedVMAttestationConfiguration

	// READ-ONLY; Most recent billing meter timestamp.
	LastBillingTimestamp *time.Time

	// READ-ONLY; Most recent cluster sync timestamp.
	LastSyncTimestamp *time.Time

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningState

	// READ-ONLY; First cluster sync timestamp.
	RegistrationTimestamp *time.Time

	// READ-ONLY; Properties reported by cluster agent.
	ReportedProperties *ClusterReportedProperties

	// READ-ONLY; Object id of RP Service Principal
	ResourceProviderObjectID *string

	// READ-ONLY; Region specific DataPath Endpoint of the cluster.
	ServiceEndpoint *string

	// READ-ONLY; Status of the cluster agent.
	Status *Status

	// READ-ONLY; Number of days remaining in the trial period.
	TrialDaysRemaining *float32
}

ClusterProperties - Cluster properties.

func (ClusterProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterProperties.

func (*ClusterProperties) UnmarshalJSON 

func (c *ClusterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterProperties.

type ClusterReportedProperties 

type ClusterReportedProperties struct {
	// Level of diagnostic data emitted by the cluster.
	DiagnosticLevel *DiagnosticLevel

	// READ-ONLY; Unique id generated by the on-prem cluster.
	ClusterID *string

	// READ-ONLY; Name of the on-prem cluster connected to this resource.
	ClusterName *string

	// READ-ONLY; The node type of all the nodes of the cluster.
	ClusterType *ClusterNodeType

	// READ-ONLY; Version of the cluster software.
	ClusterVersion *string

	// READ-ONLY; IMDS attestation status of the cluster.
	ImdsAttestation *ImdsAttestation

	// READ-ONLY; Last time the cluster reported the data.
	LastUpdated *time.Time

	// READ-ONLY; The manufacturer of all the nodes of the cluster.
	Manufacturer *string

	// READ-ONLY; List of nodes reported by the cluster.
	Nodes []*ClusterNode

	// READ-ONLY; OEM activation status of the cluster.
	OemActivation *OemActivation

	// READ-ONLY; Capabilities supported by the cluster.
	SupportedCapabilities []*string
}

ClusterReportedProperties - Properties reported by cluster agent.

func (ClusterReportedProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterReportedProperties.

func (*ClusterReportedProperties) UnmarshalJSON 

func (c *ClusterReportedProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterReportedProperties.

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 ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClustersClient) BeginConfigureRemoteSupport 

func (client *ClustersClient) BeginConfigureRemoteSupport(ctx context.Context, resourceGroupName string, clusterName string, remoteSupportRequest RemoteSupportRequest, options *ClustersClientBeginConfigureRemoteSupportOptions) (*runtime.Poller[ClustersClientConfigureRemoteSupportResponse], error)

BeginConfigureRemoteSupport - Configure RemoteSupport on a cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • remoteSupportRequest - Configure Remote Support Request Payload
  • options - ClustersClientBeginConfigureRemoteSupportOptions contains the optional parameters for the ClustersClient.BeginConfigureRemoteSupport method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ConfigureRemoteSupport.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginConfigureRemoteSupport(ctx, "test-rg", "mycluster", armazurestackhci.RemoteSupportRequest{
	Properties: &armazurestackhci.RemoteSupportRequestProperties{
		AccessLevel:         to.Ptr(armazurestackhci.AccessLevelDiagnostics),
		ExpirationTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t }()),
		RemoteSupportType:   to.Ptr(armazurestackhci.RemoteSupportTypeEnable),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Cluster = armazurestackhci.Cluster{
// 	Name: to.Ptr("myCluster"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armazurestackhci.ClusterProperties{
// 		AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
// 		AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 		BillingModel: to.Ptr("Trial"),
// 		CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
// 		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
// 		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 		},
// 		LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
// 		LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		RemoteSupportProperties: &armazurestackhci.RemoteSupportProperties{
// 			AccessLevel: to.Ptr(armazurestackhci.AccessLevelDiagnostics),
// 			ExpirationTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			RemoteSupportNodeSettings: []*armazurestackhci.RemoteSupportNodeSettings{
// 				{
// 					ArcResourceID: to.Ptr("/subscriptions/<subId>/resourcegroups/<rg>/Microsoft.HybridCompute/machines/arcNode0"),
// 					ConnectionErrorMessage: to.Ptr("test"),
// 					ConnectionStatus: to.Ptr("Connected"),
// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					State: to.Ptr("Active"),
// 					TranscriptLocation: to.Ptr("test"),
// 					UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 				},
// 				{
// 					ArcResourceID: to.Ptr("/subscriptions/<subId>/resourcegroups/<rg>/Microsoft.HybridCompute/machines/arcNode1"),
// 					ConnectionErrorMessage: to.Ptr("test"),
// 					ConnectionStatus: to.Ptr("Connected"),
// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					State: to.Ptr("Active"),
// 					TranscriptLocation: to.Ptr("test"),
// 					UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			}},
// 			RemoteSupportSessionDetails: []*armazurestackhci.PerNodeRemoteSupportSession{
// 				{
// 					AccessLevel: to.Ptr(armazurestackhci.AccessLevelDiagnostics),
// 					Duration: to.Ptr[int64](120),
// 					NodeName: to.Ptr("arcNode0"),
// 					SessionEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					SessionStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			}},
// 			RemoteSupportType: to.Ptr(armazurestackhci.RemoteSupportTypeEnable),
// 		},
// 		ReportedProperties: &armazurestackhci.ClusterReportedProperties{
// 			ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
// 			ClusterName: to.Ptr("cluster1"),
// 			ClusterVersion: to.Ptr("10.0.17777"),
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 			Nodes: []*armazurestackhci.ClusterNode{
// 				{
// 					Name: to.Ptr("Node1"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](1),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					NodeType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q45CZC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 			}},
// 		},
// 		Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
// 		TrialDaysRemaining: to.Ptr[float32](30),
// 	},
// }

Output:

func (*ClustersClient) BeginCreateIdentity 

func (client *ClustersClient) BeginCreateIdentity(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientBeginCreateIdentityOptions) (*runtime.Poller[ClustersClientCreateIdentityResponse], error)

BeginCreateIdentity - Create cluster identity. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - ClustersClientBeginCreateIdentityOptions contains the optional parameters for the ClustersClient.BeginCreateIdentity method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateClusterIdentity.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginCreateIdentity(ctx, "test-rg", "myCluster", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ClusterIdentityResponse = armazurestackhci.ClusterIdentityResponse{
// 	Properties: &armazurestackhci.ClusterIdentityResponseProperties{
// 		AADApplicationObjectID: to.Ptr("00cc4014-482e-4de9-9932-83415cc75f45"),
// 		AADClientID: to.Ptr("7b93bf67-60ac-4909-a987-ac438e69f9ba"),
// 		AADServicePrincipalObjectID: to.Ptr("400bd05f-395f-45a6-ba75-72601df80107"),
// 		AADTenantID: to.Ptr("bdb2c88c-9cfd-4e19-927d-51e875f6912b"),
// 	},
// }

Output:

func (*ClustersClient) BeginDelete 

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

BeginDelete - Delete an HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • 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/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginDelete(ctx, "test-rg", "myCluster", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ClustersClient) BeginExtendSoftwareAssuranceBenefit 

func (client *ClustersClient) BeginExtendSoftwareAssuranceBenefit(ctx context.Context, resourceGroupName string, clusterName string, softwareAssuranceChangeRequest SoftwareAssuranceChangeRequest, options *ClustersClientBeginExtendSoftwareAssuranceBenefitOptions) (*runtime.Poller[ClustersClientExtendSoftwareAssuranceBenefitResponse], error)

BeginExtendSoftwareAssuranceBenefit - Extends Software Assurance Benefit to a cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • softwareAssuranceChangeRequest - Software Assurance Change Request Payload
  • options - ClustersClientBeginExtendSoftwareAssuranceBenefitOptions contains the optional parameters for the ClustersClient.BeginExtendSoftwareAssuranceBenefit method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ExtendSoftwareAssuranceBenefit.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginExtendSoftwareAssuranceBenefit(ctx, "test-rg", "myCluster", armazurestackhci.SoftwareAssuranceChangeRequest{
	Properties: &armazurestackhci.SoftwareAssuranceChangeRequestProperties{
		SoftwareAssuranceIntent: to.Ptr(armazurestackhci.SoftwareAssuranceIntentEnable),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Cluster = armazurestackhci.Cluster{
// 	Name: to.Ptr("myCluster"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armazurestackhci.ClusterProperties{
// 		AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
// 		AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 		BillingModel: to.Ptr("Trial"),
// 		CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
// 		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
// 		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 		},
// 		LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
// 		LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ReportedProperties: &armazurestackhci.ClusterReportedProperties{
// 			ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
// 			ClusterName: to.Ptr("cluster1"),
// 			ClusterVersion: to.Ptr("10.0.17777"),
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 			Nodes: []*armazurestackhci.ClusterNode{
// 				{
// 					Name: to.Ptr("Node1"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](1),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					NodeType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q45CZC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 			}},
// 		},
// 		SoftwareAssuranceProperties: &armazurestackhci.SoftwareAssuranceProperties{
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-08-18T22:01:12.419Z"); return t}()),
// 			SoftwareAssuranceIntent: to.Ptr(armazurestackhci.SoftwareAssuranceIntentEnable),
// 			SoftwareAssuranceStatus: to.Ptr(armazurestackhci.SoftwareAssuranceStatusEnabled),
// 		},
// 		Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
// 		TrialDaysRemaining: to.Ptr[float32](30),
// 	},
// }

Output:

func (*ClustersClient) BeginTriggerLogCollection 

func (client *ClustersClient) BeginTriggerLogCollection(ctx context.Context, resourceGroupName string, clusterName string, logCollectionRequest LogCollectionRequest, options *ClustersClientBeginTriggerLogCollectionOptions) (*runtime.Poller[ClustersClientTriggerLogCollectionResponse], error)

BeginTriggerLogCollection - Trigger Log Collection on a cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • logCollectionRequest - Trigger Log Collection Request Payload
  • options - ClustersClientBeginTriggerLogCollectionOptions contains the optional parameters for the ClustersClient.BeginTriggerLogCollection method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/TriggerLogCollection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginTriggerLogCollection(ctx, "test-rg", "mycluster", armazurestackhci.LogCollectionRequest{
	Properties: &armazurestackhci.LogCollectionRequestProperties{
		FromDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t }()),
		ToDate:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t }()),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Cluster = armazurestackhci.Cluster{
// 	Name: to.Ptr("myCluster"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armazurestackhci.ClusterProperties{
// 		AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
// 		AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 		BillingModel: to.Ptr("Trial"),
// 		CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
// 		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
// 		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 		},
// 		LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
// 		LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		LogCollectionProperties: &armazurestackhci.LogCollectionProperties{
// 			FromDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			LastLogGenerated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			LogCollectionSessionDetails: []*armazurestackhci.LogCollectionSession{
// 				{
// 					CorrelationID: to.Ptr("a76ab33a-1819-4e82-1212-e3e4ec3d1425"),
// 					EndTimeCollected: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:25:19.123Z"); return t}()),
// 					LogCollectionJobType: to.Ptr(armazurestackhci.LogCollectionJobTypeOnDemand),
// 					LogCollectionStatus: to.Ptr(armazurestackhci.LogCollectionStatusSucceeded),
// 					LogEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					LogSize: to.Ptr[int64](1000),
// 					LogStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					TimeCollected: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			}},
// 			ToDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ReportedProperties: &armazurestackhci.ClusterReportedProperties{
// 			ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
// 			ClusterName: to.Ptr("cluster1"),
// 			ClusterVersion: to.Ptr("10.0.17777"),
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 			Nodes: []*armazurestackhci.ClusterNode{
// 				{
// 					Name: to.Ptr("Node1"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](1),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					NodeType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q45CZC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 			}},
// 		},
// 		Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
// 		TrialDaysRemaining: to.Ptr[float32](30),
// 	},
// }

Output:

func (*ClustersClient) BeginUploadCertificate 

func (client *ClustersClient) BeginUploadCertificate(ctx context.Context, resourceGroupName string, clusterName string, uploadCertificateRequest UploadCertificateRequest, options *ClustersClientBeginUploadCertificateOptions) (*runtime.Poller[ClustersClientUploadCertificateResponse], error)

BeginUploadCertificate - Upload certificate. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • uploadCertificateRequest - Upload certificate request.
  • options - ClustersClientBeginUploadCertificateOptions contains the optional parameters for the ClustersClient.BeginUploadCertificate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UploadCertificate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginUploadCertificate(ctx, "test-rg", "myCluster", armazurestackhci.UploadCertificateRequest{
	Properties: &armazurestackhci.RawCertificateData{
		Certificates: []*string{
			to.Ptr("base64cert"),
			to.Ptr("base64cert")},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ClustersClient) Create 

func (client *ClustersClient) Create(ctx context.Context, resourceGroupName string, clusterName string, cluster Cluster, options *ClustersClientCreateOptions) (ClustersClientCreateResponse, error)

Create - Create an HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • cluster - Details of the HCI cluster.
  • options - ClustersClientCreateOptions contains the optional parameters for the ClustersClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClustersClient().Create(ctx, "test-rg", "myCluster", armazurestackhci.Cluster{
	Location: to.Ptr("East US"),
	Identity: &armazurestackhci.ManagedServiceIdentity{
		Type: to.Ptr(armazurestackhci.ManagedServiceIdentityTypeSystemAssigned),
	},
	Properties: &armazurestackhci.ClusterProperties{
		AADClientID:             to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
		AADTenantID:             to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Cluster = armazurestackhci.Cluster{
// 	Name: to.Ptr("myCluster"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armazurestackhci.ManagedServiceIdentity{
// 		Type: to.Ptr(armazurestackhci.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("87a834db-2e45-409e-911b-e16a44562ec3"),
// 		TenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 	},
// 	Properties: &armazurestackhci.ClusterProperties{
// 		AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
// 		AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 		BillingModel: to.Ptr("Trial"),
// 		CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
// 		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
// 		ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusNotYetRegistered),
// 		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionDisabled),
// 		},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		ReportedProperties: &armazurestackhci.ClusterReportedProperties{
// 		},
// 		ServiceEndpoint: to.Ptr("https://azurestackhci.azurefd.net/eastus"),
// 		Status: to.Ptr(armazurestackhci.StatusNotYetRegistered),
// 		TrialDaysRemaining: to.Ptr[float32](30),
// 	},
// }

Output:

func (*ClustersClient) Get 

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

Get - Get HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • 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/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClustersClient().Get(ctx, "test-rg", "myCluster", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Cluster = armazurestackhci.Cluster{
// 	Name: to.Ptr("myCluster"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armazurestackhci.ClusterProperties{
// 		AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
// 		AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 		BillingModel: to.Ptr("Trial"),
// 		CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
// 		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
// 		ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusConnected),
// 		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 		},
// 		IsolatedVMAttestationConfiguration: &armazurestackhci.IsolatedVMAttestationConfiguration{
// 			AttestationResourceID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa"),
// 			AttestationServiceEndpoint: to.Ptr("https://dantestnoauth01.eus.attest.azure.net"),
// 			RelyingPartyServiceEndpoint: to.Ptr("https://azurestackhci.azurefd.net/eastus"),
// 		},
// 		LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
// 		LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		LogCollectionProperties: &armazurestackhci.LogCollectionProperties{
// 			FromDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			LastLogGenerated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			LogCollectionSessionDetails: []*armazurestackhci.LogCollectionSession{
// 				{
// 					CorrelationID: to.Ptr("a76ab33a-1819-4e82-1212-e3e4ec3d1425"),
// 					EndTimeCollected: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:25:19.123Z"); return t}()),
// 					LogCollectionJobType: to.Ptr(armazurestackhci.LogCollectionJobTypeOnDemand),
// 					LogCollectionStatus: to.Ptr(armazurestackhci.LogCollectionStatusSucceeded),
// 					LogEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					LogSize: to.Ptr[int64](1000),
// 					LogStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 					TimeCollected: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 			}},
// 			ToDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ReportedProperties: &armazurestackhci.ClusterReportedProperties{
// 			ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
// 			ClusterName: to.Ptr("cluster1"),
// 			ClusterType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
// 			ClusterVersion: to.Ptr("10.0.17777"),
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 			Manufacturer: to.Ptr("Dell Inc."),
// 			Nodes: []*armazurestackhci.ClusterNode{
// 				{
// 					Name: to.Ptr("Node1"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](1),
// 					LastLicensingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q45CZC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 				},
// 				{
// 					Name: to.Ptr("Node2"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](2),
// 					LastLicensingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q44BSC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 				},
// 				{
// 					Name: to.Ptr("Node3"),
// 					CoreCount: to.Ptr[float32](16),
// 					ID: to.Ptr[float32](3),
// 					LastLicensingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](256),
// 					Model: to.Ptr("EMC AX740"),
// 					OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q44RFC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 			}},
// 			OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
// 		},
// 		Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
// 		TrialDaysRemaining: to.Ptr[float32](30),
// 	},
// }

Output:

func (*ClustersClient) NewListByResourceGroupPager 

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

NewListByResourceGroupPager - List all HCI clusters in a resource group.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ClustersClientListByResourceGroupOptions contains the optional parameters for the ClustersClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListByResourceGroupPager("test-rg", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ClusterList = armazurestackhci.ClusterList{
	// 	Value: []*armazurestackhci.Cluster{
	// 		{
	// 			Name: to.Ptr("myCluster1"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("East US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armazurestackhci.ClusterProperties{
	// 				AADClientID: to.Ptr("515da1c2-379e-49b4-9975-09e3e40c86be"),
	// 				AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
	// 				BillingModel: to.Ptr("Trial"),
	// 				CloudID: to.Ptr("91c2b355-4826-4e96-9164-e3f26dcf1cdd"),
	// 				CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
	// 				ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusNotYetRegistered),
	// 				DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
	// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
	// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 				},
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 				ReportedProperties: &armazurestackhci.ClusterReportedProperties{
	// 				},
	// 				Status: to.Ptr(armazurestackhci.StatusNotYetRegistered),
	// 				TrialDaysRemaining: to.Ptr[float32](29),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("myCluster2"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("East US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armazurestackhci.ClusterProperties{
	// 				AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
	// 				AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
	// 				BillingModel: to.Ptr("Trial"),
	// 				CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
	// 				CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
	// 				ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusPartiallyConnected),
	// 				DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
	// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
	// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 				},
	// 				LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
	// 				LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 				RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
	// 				ReportedProperties: &armazurestackhci.ClusterReportedProperties{
	// 					ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
	// 					ClusterName: to.Ptr("cluster1"),
	// 					ClusterType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
	// 					ClusterVersion: to.Ptr("10.0.17777"),
	// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
	// 					ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
	// 					LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
	// 					Manufacturer: to.Ptr("Dell Inc."),
	// 					Nodes: []*armazurestackhci.ClusterNode{
	// 						{
	// 							Name: to.Ptr("Node1"),
	// 							CoreCount: to.Ptr[float32](8),
	// 							ID: to.Ptr[float32](0),
	// 							Manufacturer: to.Ptr("Dell Inc."),
	// 							MemoryInGiB: to.Ptr[float32](128),
	// 							Model: to.Ptr("EMC AX740"),
	// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
	// 							OSName: to.Ptr("Azure Stack HCI"),
	// 							OSVersion: to.Ptr("10.0.17777.1061"),
	// 							SerialNumber: to.Ptr("Q45CZC3"),
	// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 						},
	// 						{
	// 							Name: to.Ptr("Node2"),
	// 							CoreCount: to.Ptr[float32](8),
	// 							ID: to.Ptr[float32](1),
	// 							Manufacturer: to.Ptr("Dell Inc."),
	// 							MemoryInGiB: to.Ptr[float32](128),
	// 							Model: to.Ptr("EMC AX740"),
	// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
	// 							OSName: to.Ptr("Azure Stack HCI"),
	// 							OSVersion: to.Ptr("10.0.17777.1061"),
	// 							SerialNumber: to.Ptr("Q44BSC3"),
	// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 						},
	// 						{
	// 							Name: to.Ptr("Node3"),
	// 							CoreCount: to.Ptr[float32](16),
	// 							ID: to.Ptr[float32](2),
	// 							Manufacturer: to.Ptr("Dell Inc."),
	// 							MemoryInGiB: to.Ptr[float32](256),
	// 							Model: to.Ptr("EMC AX740"),
	// 							OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
	// 							OSName: to.Ptr("Azure Stack HCI"),
	// 							OSVersion: to.Ptr("10.0.17777.1061"),
	// 							SerialNumber: to.Ptr("Q44RFC3"),
	// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 					}},
	// 					OemActivation: to.Ptr(armazurestackhci.OemActivationDisabled),
	// 				},
	// 				Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
	// 				TrialDaysRemaining: to.Ptr[float32](30),
	// 			},
	// 	}},
	// }
}

Output:

func (*ClustersClient) NewListBySubscriptionPager 

func (client *ClustersClient) NewListBySubscriptionPager(options *ClustersClientListBySubscriptionOptions) *runtime.Pager[ClustersClientListBySubscriptionResponse]

NewListBySubscriptionPager - List all HCI clusters in a subscription.

Generated from API version 2024-04-01

  • options - ClustersClientListBySubscriptionOptions contains the optional parameters for the ClustersClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListClustersBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListBySubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ClusterList = armazurestackhci.ClusterList{
	// 	Value: []*armazurestackhci.Cluster{
	// 		{
	// 			Name: to.Ptr("myCluster1"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg1/providers/Microsoft.AzureStackHCI/clusters/myCluster1"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("East US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armazurestackhci.ClusterProperties{
	// 				AADClientID: to.Ptr("515da1c2-379e-49b4-9975-09e3e40c86be"),
	// 				AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
	// 				BillingModel: to.Ptr("Trial"),
	// 				CloudID: to.Ptr("91c2b355-4826-4e96-9164-e3f26dcf1cdd"),
	// 				CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
	// 				ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusNotYetRegistered),
	// 				DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
	// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
	// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 				},
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 				ReportedProperties: &armazurestackhci.ClusterReportedProperties{
	// 				},
	// 				Status: to.Ptr(armazurestackhci.StatusNotYetRegistered),
	// 				TrialDaysRemaining: to.Ptr[float32](29),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("myCluster2"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg2/providers/Microsoft.AzureStackHCI/clusters/myCluster2"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("West US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armazurestackhci.ClusterProperties{
	// 				AADClientID: to.Ptr("24a6e53d-04e5-44d2-b7cc-1b732a847dfc"),
	// 				AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
	// 				BillingModel: to.Ptr("Trial"),
	// 				CloudID: to.Ptr("a3c0468f-e38e-4dda-ac48-817f620536f0"),
	// 				CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
	// 				ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusConnected),
	// 				DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
	// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
	// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 				},
	// 				LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
	// 				LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 				RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
	// 				ReportedProperties: &armazurestackhci.ClusterReportedProperties{
	// 					ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
	// 					ClusterName: to.Ptr("cluster1"),
	// 					ClusterType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
	// 					ClusterVersion: to.Ptr("10.0.17777"),
	// 					DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
	// 					ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
	// 					LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
	// 					Manufacturer: to.Ptr("Dell Inc."),
	// 					Nodes: []*armazurestackhci.ClusterNode{
	// 						{
	// 							Name: to.Ptr("Node1"),
	// 							CoreCount: to.Ptr[float32](8),
	// 							ID: to.Ptr[float32](0),
	// 							Manufacturer: to.Ptr("Dell Inc."),
	// 							MemoryInGiB: to.Ptr[float32](128),
	// 							Model: to.Ptr("EMC AX740"),
	// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
	// 							OSName: to.Ptr("Azure Stack HCI"),
	// 							OSVersion: to.Ptr("10.0.17777.1061"),
	// 							SerialNumber: to.Ptr("Q45CZC3"),
	// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 						},
	// 						{
	// 							Name: to.Ptr("Node2"),
	// 							CoreCount: to.Ptr[float32](8),
	// 							ID: to.Ptr[float32](1),
	// 							Manufacturer: to.Ptr("Dell Inc."),
	// 							MemoryInGiB: to.Ptr[float32](128),
	// 							Model: to.Ptr("EMC AX740"),
	// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
	// 							OSName: to.Ptr("Azure Stack HCI"),
	// 							OSVersion: to.Ptr("10.0.17777.1061"),
	// 							SerialNumber: to.Ptr("Q44BSC3"),
	// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 						},
	// 						{
	// 							Name: to.Ptr("Node3"),
	// 							CoreCount: to.Ptr[float32](16),
	// 							ID: to.Ptr[float32](2),
	// 							Manufacturer: to.Ptr("Dell Inc."),
	// 							MemoryInGiB: to.Ptr[float32](256),
	// 							Model: to.Ptr("EMC AX740"),
	// 							OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
	// 							OSName: to.Ptr("Azure Stack HCI"),
	// 							OSVersion: to.Ptr("10.0.17777.1061"),
	// 							SerialNumber: to.Ptr("Q44RFC3"),
	// 							WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
	// 					}},
	// 					OemActivation: to.Ptr(armazurestackhci.OemActivationEnabled),
	// 				},
	// 				Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
	// 				TrialDaysRemaining: to.Ptr[float32](30),
	// 			},
	// 	}},
	// }
}

Output:

func (*ClustersClient) Update 

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

Update - Update an HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • cluster - Details of the HCI cluster.
  • options - ClustersClientUpdateOptions contains the optional parameters for the ClustersClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/UpdateCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClustersClient().Update(ctx, "test-rg", "myCluster", armazurestackhci.ClusterPatch{
	Identity: &armazurestackhci.ManagedServiceIdentity{
		Type: to.Ptr(armazurestackhci.ManagedServiceIdentityTypeSystemAssigned),
	},
	Properties: &armazurestackhci.ClusterPatchProperties{
		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
			DiagnosticLevel:           to.Ptr(armazurestackhci.DiagnosticLevelBasic),
			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
		},
	},
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Cluster = armazurestackhci.Cluster{
// 	Name: to.Ptr("myCluster"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Identity: &armazurestackhci.ManagedServiceIdentity{
// 		Type: to.Ptr(armazurestackhci.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("87a834db-2e45-409e-911b-e16a44562ec3"),
// 		TenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 	},
// 	Properties: &armazurestackhci.ClusterProperties{
// 		AADClientID: to.Ptr("515da1c2-379e-49b4-9975-09e3e40c86be"),
// 		AADTenantID: to.Ptr("7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"),
// 		BillingModel: to.Ptr("Trial"),
// 		CloudID: to.Ptr("91c2b355-4826-4e96-9164-e3f26dcf1cdd"),
// 		CloudManagementEndpoint: to.Ptr("https://98294836-31be-4668-aeae-698667faf99b.waconazure.com"),
// 		ConnectivityStatus: to.Ptr(armazurestackhci.ConnectivityStatusConnected),
// 		DesiredProperties: &armazurestackhci.ClusterDesiredProperties{
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 		},
// 		IsolatedVMAttestationConfiguration: &armazurestackhci.IsolatedVMAttestationConfiguration{
// 			AttestationResourceID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa"),
// 			AttestationServiceEndpoint: to.Ptr("https://dantestnoauth01.eus.attest.azure.net"),
// 			RelyingPartyServiceEndpoint: to.Ptr("https://azurestackhci.azurefd.net/eastus"),
// 		},
// 		LastBillingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-12T08:12:55.231Z"); return t}()),
// 		LastSyncTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		RegistrationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T20:44:32.562Z"); return t}()),
// 		ReportedProperties: &armazurestackhci.ClusterReportedProperties{
// 			ClusterID: to.Ptr("a76ac23a-1819-4e82-9410-e3e4ec3d1425"),
// 			ClusterName: to.Ptr("cluster1"),
// 			ClusterType: to.Ptr(armazurestackhci.ClusterNodeTypeThirdParty),
// 			ClusterVersion: to.Ptr("10.0.17777"),
// 			DiagnosticLevel: to.Ptr(armazurestackhci.DiagnosticLevelBasic),
// 			ImdsAttestation: to.Ptr(armazurestackhci.ImdsAttestationDisabled),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 			Manufacturer: to.Ptr("Dell Inc."),
// 			Nodes: []*armazurestackhci.ClusterNode{
// 				{
// 					Name: to.Ptr("Node1"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](1),
// 					LastLicensingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q45CZC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 				},
// 				{
// 					Name: to.Ptr("Node2"),
// 					CoreCount: to.Ptr[float32](8),
// 					ID: to.Ptr[float32](2),
// 					LastLicensingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](128),
// 					Model: to.Ptr("EMC AX740"),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q44BSC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 				},
// 				{
// 					Name: to.Ptr("Node3"),
// 					CoreCount: to.Ptr[float32](16),
// 					ID: to.Ptr[float32](3),
// 					LastLicensingTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-03-11T19:24:42.194Z"); return t}()),
// 					Manufacturer: to.Ptr("Dell Inc."),
// 					MemoryInGiB: to.Ptr[float32](256),
// 					Model: to.Ptr("EMC AX740"),
// 					OSName: to.Ptr("Azure Stack HCI"),
// 					OSVersion: to.Ptr("10.0.17777.1061"),
// 					SerialNumber: to.Ptr("Q44RFC3"),
// 					WindowsServerSubscription: to.Ptr(armazurestackhci.WindowsServerSubscriptionEnabled),
// 			}},
// 		},
// 		Status: to.Ptr(armazurestackhci.StatusConnectedRecently),
// 		TrialDaysRemaining: to.Ptr[float32](30),
// 	},
// }

Output:

type ClustersClientBeginConfigureRemoteSupportOptions 

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

ClustersClientBeginConfigureRemoteSupportOptions contains the optional parameters for the ClustersClient.BeginConfigureRemoteSupport method.

type ClustersClientBeginCreateIdentityOptions 

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

ClustersClientBeginCreateIdentityOptions contains the optional parameters for the ClustersClient.BeginCreateIdentity method.

type ClustersClientBeginDeleteOptions 

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

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

type ClustersClientBeginExtendSoftwareAssuranceBenefitOptions 

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

ClustersClientBeginExtendSoftwareAssuranceBenefitOptions contains the optional parameters for the ClustersClient.BeginExtendSoftwareAssuranceBenefit method.

type ClustersClientBeginTriggerLogCollectionOptions 

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

ClustersClientBeginTriggerLogCollectionOptions contains the optional parameters for the ClustersClient.BeginTriggerLogCollection method.

type ClustersClientBeginUploadCertificateOptions 

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

ClustersClientBeginUploadCertificateOptions contains the optional parameters for the ClustersClient.BeginUploadCertificate method.

type ClustersClientConfigureRemoteSupportResponse 

type ClustersClientConfigureRemoteSupportResponse struct {
	// Cluster details.
	Cluster
}

ClustersClientConfigureRemoteSupportResponse contains the response from method ClustersClient.BeginConfigureRemoteSupport.

type ClustersClientCreateIdentityResponse 

type ClustersClientCreateIdentityResponse struct {
	// Cluster Identity details.
	ClusterIdentityResponse
}

ClustersClientCreateIdentityResponse contains the response from method ClustersClient.BeginCreateIdentity.

type ClustersClientCreateOptions 

type ClustersClientCreateOptions struct {
}

ClustersClientCreateOptions contains the optional parameters for the ClustersClient.Create method.

type ClustersClientCreateResponse 

type ClustersClientCreateResponse struct {
	// Cluster details.
	Cluster
}

ClustersClientCreateResponse contains the response from method ClustersClient.Create.

type ClustersClientDeleteResponse 

type ClustersClientDeleteResponse struct {
}

ClustersClientDeleteResponse contains the response from method ClustersClient.BeginDelete.

type ClustersClientExtendSoftwareAssuranceBenefitResponse 

type ClustersClientExtendSoftwareAssuranceBenefitResponse struct {
	// Cluster details.
	Cluster
}

ClustersClientExtendSoftwareAssuranceBenefitResponse contains the response from method ClustersClient.BeginExtendSoftwareAssuranceBenefit.

type ClustersClientGetOptions 

type ClustersClientGetOptions struct {
}

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

type ClustersClientGetResponse 

type ClustersClientGetResponse struct {
	// Cluster details.
	Cluster
}

ClustersClientGetResponse contains the response from method ClustersClient.Get.

type ClustersClientListByResourceGroupOptions 

type ClustersClientListByResourceGroupOptions struct {
}

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

type ClustersClientListByResourceGroupResponse 

type ClustersClientListByResourceGroupResponse struct {
	// List of clusters.
	ClusterList
}

ClustersClientListByResourceGroupResponse contains the response from method ClustersClient.NewListByResourceGroupPager.

type ClustersClientListBySubscriptionOptions 

type ClustersClientListBySubscriptionOptions struct {
}

ClustersClientListBySubscriptionOptions contains the optional parameters for the ClustersClient.NewListBySubscriptionPager method.

type ClustersClientListBySubscriptionResponse 

type ClustersClientListBySubscriptionResponse struct {
	// List of clusters.
	ClusterList
}

ClustersClientListBySubscriptionResponse contains the response from method ClustersClient.NewListBySubscriptionPager.

type ClustersClientTriggerLogCollectionResponse 

type ClustersClientTriggerLogCollectionResponse struct {
	// Cluster details.
	Cluster
}

ClustersClientTriggerLogCollectionResponse contains the response from method ClustersClient.BeginTriggerLogCollection.

type ClustersClientUpdateOptions 

type ClustersClientUpdateOptions struct {
}

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

type ClustersClientUpdateResponse 

type ClustersClientUpdateResponse struct {
	// Cluster details.
	Cluster
}

ClustersClientUpdateResponse contains the response from method ClustersClient.Update.

type ClustersClientUploadCertificateResponse 

type ClustersClientUploadCertificateResponse struct {
}

ClustersClientUploadCertificateResponse contains the response from method ClustersClient.BeginUploadCertificate.

type ComplianceAssignmentType 

type ComplianceAssignmentType string

ComplianceAssignmentType - Represents the compliance assignment type of a resource. 

const (
	// ComplianceAssignmentTypeApplyAndAutoCorrect - Applied to the machine. If it drifts, the local service inside the machine
	// makes a correction at the next evaluation.
	ComplianceAssignmentTypeApplyAndAutoCorrect ComplianceAssignmentType = "ApplyAndAutoCorrect"
	// ComplianceAssignmentTypeAudit - Report on the state of the machine, but don't make changes.
	ComplianceAssignmentTypeAudit ComplianceAssignmentType = "Audit"
)

func PossibleComplianceAssignmentTypeValues 

func PossibleComplianceAssignmentTypeValues() []ComplianceAssignmentType

PossibleComplianceAssignmentTypeValues returns the possible values for the ComplianceAssignmentType const type.

type ComplianceStatus 

type ComplianceStatus string

ComplianceStatus - Represents the compliance status of a resource. 

const (
	// ComplianceStatusCompliant - The resource is compliant
	ComplianceStatusCompliant ComplianceStatus = "Compliant"
	// ComplianceStatusNonCompliant - The resource is non-compliant
	ComplianceStatusNonCompliant ComplianceStatus = "NonCompliant"
	// ComplianceStatusPending - The resource compliance status is pending
	ComplianceStatusPending ComplianceStatus = "Pending"
)

func PossibleComplianceStatusValues 

func PossibleComplianceStatusValues() []ComplianceStatus

PossibleComplianceStatusValues returns the possible values for the ComplianceStatus const type.

type ConnectivityStatus 

type ConnectivityStatus string

ConnectivityStatus - Overall connectivity status for the cluster resource. 

const (
	ConnectivityStatusConnected            ConnectivityStatus = "Connected"
	ConnectivityStatusDisconnected         ConnectivityStatus = "Disconnected"
	ConnectivityStatusNotConnectedRecently ConnectivityStatus = "NotConnectedRecently"
	ConnectivityStatusNotSpecified         ConnectivityStatus = "NotSpecified"
	ConnectivityStatusNotYetRegistered     ConnectivityStatus = "NotYetRegistered"
	ConnectivityStatusPartiallyConnected   ConnectivityStatus = "PartiallyConnected"
)

func PossibleConnectivityStatusValues 

func PossibleConnectivityStatusValues() []ConnectivityStatus

PossibleConnectivityStatusValues returns the possible values for the ConnectivityStatus const type.

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 DefaultExtensionDetails 

type DefaultExtensionDetails struct {
	// READ-ONLY; Default extension category
	Category *string

	// READ-ONLY; Consent time for extension category
	ConsentTime *time.Time
}

DefaultExtensionDetails - Properties for a particular default extension category.

func (DefaultExtensionDetails) MarshalJSON 

func (d DefaultExtensionDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultExtensionDetails.

func (*DefaultExtensionDetails) UnmarshalJSON 

func (d *DefaultExtensionDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultExtensionDetails.

type DeploymentCluster 

type DeploymentCluster struct {
	// For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the
	// domain for the blob service in this format core.windows.net.
	AzureServiceEndpoint *string

	// Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster.
	CloudAccountName *string

	// The cluster name provided when preparing Active Directory.
	Name *string

	// Specify the fileshare path for the local witness for your Azure Stack HCI cluster.
	WitnessPath *string

	// Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum.
	// A cloud witness uses Azure Blob Storage to read or write a blob file and
	// then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'.
	WitnessType *string
}

DeploymentCluster - AzureStackHCI Cluster deployment properties.

func (DeploymentCluster) MarshalJSON 

func (d DeploymentCluster) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentCluster.

func (*DeploymentCluster) UnmarshalJSON 

func (d *DeploymentCluster) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentCluster.

type DeploymentConfiguration 

type DeploymentConfiguration struct {
	// REQUIRED; Scale units will contains list of deployment data
	ScaleUnits []*ScaleUnits

	// deployment template version
	Version *string
}

DeploymentConfiguration - Deployment Configuration

func (DeploymentConfiguration) MarshalJSON 

func (d DeploymentConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentConfiguration.

func (*DeploymentConfiguration) UnmarshalJSON 

func (d *DeploymentConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentConfiguration.

type DeploymentData 

type DeploymentData struct {
	// The path to the Active Directory Organizational Unit container object prepared for the deployment.
	AdouPath *string

	// Observability config to deploy AzureStackHCI Cluster.
	Cluster *DeploymentCluster

	// FQDN to deploy cluster
	DomainFqdn *string

	// HostNetwork config to deploy AzureStackHCI Cluster.
	HostNetwork *DeploymentSettingHostNetwork

	// InfrastructureNetwork config to deploy AzureStackHCI Cluster.
	InfrastructureNetwork []*InfrastructureNetwork

	// naming prefix to deploy cluster.
	NamingPrefix *string

	// Observability config to deploy AzureStackHCI Cluster.
	Observability *Observability

	// OptionalServices config to deploy AzureStackHCI Cluster.
	OptionalServices *OptionalServices

	// list of physical nodes config to deploy AzureStackHCI Cluster.
	PhysicalNodes []*PhysicalNodes

	// SDN Integration config to deploy AzureStackHCI Cluster.
	SdnIntegration *SdnIntegration

	// secrets used for cloud deployment.
	Secrets []*EceDeploymentSecrets

	// Azure keyvault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead.
	SecretsLocation *string

	// SecuritySettings to deploy AzureStackHCI Cluster.
	SecuritySettings *DeploymentSecuritySettings

	// Storage config to deploy AzureStackHCI Cluster.
	Storage *Storage
}

DeploymentData - The Deployment data of AzureStackHCI Cluster.

func (DeploymentData) MarshalJSON 

func (d DeploymentData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentData.

func (*DeploymentData) UnmarshalJSON 

func (d *DeploymentData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentData.

type DeploymentMode 

type DeploymentMode string

DeploymentMode - The deployment mode of EnterpriseCloudEngine(ECE) action for a cluster. 

const (
	// DeploymentModeDeploy - Deploy ECE action deployment for a cluster.
	DeploymentModeDeploy DeploymentMode = "Deploy"
	// DeploymentModeValidate - Validate ECE action deployment for a cluster.
	DeploymentModeValidate DeploymentMode = "Validate"
)

func PossibleDeploymentModeValues 

func PossibleDeploymentModeValues() []DeploymentMode

PossibleDeploymentModeValues returns the possible values for the DeploymentMode const type.

type DeploymentSecuritySettings 

type DeploymentSecuritySettings struct {
	// When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack
	// HCI cluster. This setting is TPM-hardware dependent.
	BitlockerBootVolume *bool

	// When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster
	// shared volumes.
	BitlockerDataVolumes *bool

	// When set to true, Credential Guard is enabled.
	CredentialGuardEnforced *bool

	// When set to true, the security baseline is re-applied regularly.
	DriftControlEnforced *bool

	// By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent.
	DrtmProtection *bool

	// By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster.
	HvciProtection *bool

	// When set to true, all the side channel mitigations are enabled
	SideChannelMitigationEnforced *bool

	// When set to true, cluster east-west traffic is encrypted.
	SmbClusterEncryption *bool

	// When set to true, the SMB default instance requires sign in for the client and server services.
	SmbSigningEnforced *bool

	// WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster.
	WdacEnforced *bool
}

DeploymentSecuritySettings - The SecuritySettings of AzureStackHCI Cluster.

func (DeploymentSecuritySettings) MarshalJSON 

func (d DeploymentSecuritySettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSecuritySettings.

func (*DeploymentSecuritySettings) UnmarshalJSON 

func (d *DeploymentSecuritySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSecuritySettings.

type DeploymentSetting 

type DeploymentSetting struct {
	// The resource-specific properties for this resource.
	Properties *DeploymentSettingsProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DeploymentSetting - Edge device resource

func (DeploymentSetting) MarshalJSON 

func (d DeploymentSetting) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSetting.

func (*DeploymentSetting) UnmarshalJSON 

func (d *DeploymentSetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSetting.

type DeploymentSettingAdapterPropertyOverrides 

type DeploymentSettingAdapterPropertyOverrides struct {
	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	JumboPacket *string

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	NetworkDirect *string

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	// Expected values are 'iWARP', 'RoCEv2', 'RoCE'
	NetworkDirectTechnology *string
}

DeploymentSettingAdapterPropertyOverrides - The AdapterPropertyOverrides of a cluster.

func (DeploymentSettingAdapterPropertyOverrides) MarshalJSON 

func (d DeploymentSettingAdapterPropertyOverrides) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingAdapterPropertyOverrides.

func (*DeploymentSettingAdapterPropertyOverrides) UnmarshalJSON 

func (d *DeploymentSettingAdapterPropertyOverrides) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingAdapterPropertyOverrides.

type DeploymentSettingHostNetwork 

type DeploymentSettingHostNetwork struct {
	// Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage
	// NICs when Network ATC is not assigning the IPs for storage automatically.
	EnableStorageAutoIP *bool

	// The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own
	// name, traffic type, adapter names, and overrides as recommended by your OEM.
	Intents []*DeploymentSettingIntents

	// Defines how the storage adapters between nodes are connected either switch or switch less..
	StorageConnectivitySwitchless *bool

	// List of StorageNetworks config to deploy AzureStackHCI Cluster.
	StorageNetworks []*DeploymentSettingStorageNetworks
}

DeploymentSettingHostNetwork - The HostNetwork of a cluster.

func (DeploymentSettingHostNetwork) MarshalJSON 

func (d DeploymentSettingHostNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingHostNetwork.

func (*DeploymentSettingHostNetwork) UnmarshalJSON 

func (d *DeploymentSettingHostNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingHostNetwork.

type DeploymentSettingIntents 

type DeploymentSettingIntents struct {
	// Array of network interfaces used for the network intent.
	Adapter []*string

	// Set Adapter PropertyOverrides for cluster.
	AdapterPropertyOverrides *DeploymentSettingAdapterPropertyOverrides

	// Name of the network intent you wish to create.
	Name *string

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	OverrideAdapterProperty *bool

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	OverrideQosPolicy *bool

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	OverrideVirtualSwitchConfiguration *bool

	// Set QoS PolicyOverrides for cluster.
	QosPolicyOverrides *QosPolicyOverrides

	// List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'.
	TrafficType []*string

	// Set virtualSwitch ConfigurationOverrides for cluster.
	VirtualSwitchConfigurationOverrides *DeploymentSettingVirtualSwitchConfigurationOverrides
}

DeploymentSettingIntents - The Intents of a cluster.

func (DeploymentSettingIntents) MarshalJSON 

func (d DeploymentSettingIntents) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingIntents.

func (*DeploymentSettingIntents) UnmarshalJSON 

func (d *DeploymentSettingIntents) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingIntents.

type DeploymentSettingListResult 

type DeploymentSettingListResult struct {
	// REQUIRED; The DeploymentSetting items on this page
	Value []*DeploymentSetting

	// The link to the next page of items
	NextLink *string
}

DeploymentSettingListResult - The response of a DeploymentSetting list operation.

func (DeploymentSettingListResult) MarshalJSON 

func (d DeploymentSettingListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingListResult.

func (*DeploymentSettingListResult) UnmarshalJSON 

func (d *DeploymentSettingListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingListResult.

type DeploymentSettingStorageAdapterIPInfo 

type DeploymentSettingStorageAdapterIPInfo struct {
	// The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster.
	IPv4Address *string

	// storage adapter physical node name.
	PhysicalNode *string

	// The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster.
	SubnetMask *string
}

DeploymentSettingStorageAdapterIPInfo - The StorageAdapter physical nodes of a cluster.

func (DeploymentSettingStorageAdapterIPInfo) MarshalJSON 

func (d DeploymentSettingStorageAdapterIPInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingStorageAdapterIPInfo.

func (*DeploymentSettingStorageAdapterIPInfo) UnmarshalJSON 

func (d *DeploymentSettingStorageAdapterIPInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingStorageAdapterIPInfo.

type DeploymentSettingStorageNetworks 

type DeploymentSettingStorageNetworks struct {
	// Name of the storage network.
	Name *string

	// Name of the storage network adapter.
	NetworkAdapterName *string

	// List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.
	StorageAdapterIPInfo []*DeploymentSettingStorageAdapterIPInfo

	// ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and
	// VM migration traffic.
	VlanID *string
}

DeploymentSettingStorageNetworks - The StorageNetworks of a cluster.

func (DeploymentSettingStorageNetworks) MarshalJSON 

func (d DeploymentSettingStorageNetworks) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingStorageNetworks.

func (*DeploymentSettingStorageNetworks) UnmarshalJSON 

func (d *DeploymentSettingStorageNetworks) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingStorageNetworks.

type DeploymentSettingVirtualSwitchConfigurationOverrides 

type DeploymentSettingVirtualSwitchConfigurationOverrides struct {
	// Enable IoV for Virtual Switch
	EnableIov *string

	// Load Balancing Algorithm for Virtual Switch
	LoadBalancingAlgorithm *string
}

DeploymentSettingVirtualSwitchConfigurationOverrides - The VirtualSwitchConfigurationOverrides of a cluster.

func (DeploymentSettingVirtualSwitchConfigurationOverrides) MarshalJSON 

func (d DeploymentSettingVirtualSwitchConfigurationOverrides) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingVirtualSwitchConfigurationOverrides.

func (*DeploymentSettingVirtualSwitchConfigurationOverrides) UnmarshalJSON 

func (d *DeploymentSettingVirtualSwitchConfigurationOverrides) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingVirtualSwitchConfigurationOverrides.

type DeploymentSettingsClient 

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

DeploymentSettingsClient contains the methods for the DeploymentSettings group. Don't use this type directly, use NewDeploymentSettingsClient() instead.

func NewDeploymentSettingsClient 

func NewDeploymentSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeploymentSettingsClient, error)

NewDeploymentSettingsClient creates a new instance of DeploymentSettingsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeploymentSettingsClient) BeginCreateOrUpdate 

func (client *DeploymentSettingsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, deploymentSettingsName string, resource DeploymentSetting, options *DeploymentSettingsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DeploymentSettingsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a DeploymentSetting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • deploymentSettingsName - Name of Deployment Setting
  • resource - Resource create parameters.
  • options - DeploymentSettingsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentSettingsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutDeploymentSettings.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentSettingsClient().BeginCreateOrUpdate(ctx, "test-rg", "myCluster", "default", armazurestackhci.DeploymentSetting{
	Properties: &armazurestackhci.DeploymentSettingsProperties{
		ArcNodeResourceIDs: []*string{
			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2")},
		DeploymentConfiguration: &armazurestackhci.DeploymentConfiguration{
			ScaleUnits: []*armazurestackhci.ScaleUnits{
				{
					DeploymentData: &armazurestackhci.DeploymentData{
						AdouPath: to.Ptr("OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com"),
						Cluster: &armazurestackhci.DeploymentCluster{
							Name:                 to.Ptr("testHCICluster"),
							AzureServiceEndpoint: to.Ptr("core.windows.net"),
							CloudAccountName:     to.Ptr("myasestoragacct"),
							WitnessPath:          to.Ptr("Cloud"),
							WitnessType:          to.Ptr("Cloud"),
						},
						DomainFqdn: to.Ptr("ASZ1PLab8.nttest.microsoft.com"),
						HostNetwork: &armazurestackhci.DeploymentSettingHostNetwork{
							EnableStorageAutoIP: to.Ptr(false),
							Intents: []*armazurestackhci.DeploymentSettingIntents{
								{
									Name: to.Ptr("Compute_Management"),
									Adapter: []*string{
										to.Ptr("Port2")},
									AdapterPropertyOverrides: &armazurestackhci.DeploymentSettingAdapterPropertyOverrides{
										JumboPacket:             to.Ptr("1514"),
										NetworkDirect:           to.Ptr("Enabled"),
										NetworkDirectTechnology: to.Ptr("iWARP"),
									},
									OverrideAdapterProperty:            to.Ptr(false),
									OverrideQosPolicy:                  to.Ptr(false),
									OverrideVirtualSwitchConfiguration: to.Ptr(false),
									QosPolicyOverrides: &armazurestackhci.QosPolicyOverrides{
										BandwidthPercentageSMB:         to.Ptr("50"),
										PriorityValue8021ActionCluster: to.Ptr("7"),
										PriorityValue8021ActionSMB:     to.Ptr("3"),
									},
									TrafficType: []*string{
										to.Ptr("Compute"),
										to.Ptr("Management")},
									VirtualSwitchConfigurationOverrides: &armazurestackhci.DeploymentSettingVirtualSwitchConfigurationOverrides{
										EnableIov:              to.Ptr("True"),
										LoadBalancingAlgorithm: to.Ptr("HyperVPort"),
									},
								}},
							StorageConnectivitySwitchless: to.Ptr(true),
							StorageNetworks: []*armazurestackhci.DeploymentSettingStorageNetworks{
								{
									Name:               to.Ptr("Storage1Network"),
									NetworkAdapterName: to.Ptr("Port3"),
									StorageAdapterIPInfo: []*armazurestackhci.DeploymentSettingStorageAdapterIPInfo{
										{
											IPv4Address:  to.Ptr("10.57.48.60"),
											PhysicalNode: to.Ptr("string"),
											SubnetMask:   to.Ptr("255.255.248.0"),
										}},
									VlanID: to.Ptr("5"),
								}},
						},
						InfrastructureNetwork: []*armazurestackhci.InfrastructureNetwork{
							{
								DNSServers: []*string{
									to.Ptr("10.57.50.90")},
								Gateway: to.Ptr("255.255.248.0"),
								IPPools: []*armazurestackhci.IPPools{
									{
										EndingAddress:   to.Ptr("10.57.48.66"),
										StartingAddress: to.Ptr("10.57.48.60"),
									}},
								SubnetMask: to.Ptr("255.255.248.0"),
							}},
						NamingPrefix: to.Ptr("ms169"),
						Observability: &armazurestackhci.Observability{
							EpisodicDataUpload:  to.Ptr(true),
							EuLocation:          to.Ptr(false),
							StreamingDataClient: to.Ptr(true),
						},
						OptionalServices: &armazurestackhci.OptionalServices{
							CustomLocation: to.Ptr("customLocationName"),
						},
						PhysicalNodes: []*armazurestackhci.PhysicalNodes{
							{
								Name:        to.Ptr("ms169host"),
								IPv4Address: to.Ptr("10.57.51.224"),
							},
							{
								Name:        to.Ptr("ms154host"),
								IPv4Address: to.Ptr("10.57.53.236"),
							}},
						SdnIntegration: &armazurestackhci.SdnIntegration{
							NetworkController: &armazurestackhci.NetworkController{
								MacAddressPoolStart:          to.Ptr("00-0D-3A-1B-C7-21"),
								MacAddressPoolStop:           to.Ptr("00-0D-3A-1B-C7-29"),
								NetworkVirtualizationEnabled: to.Ptr(true),
							},
						},
						Secrets: []*armazurestackhci.EceDeploymentSecrets{
							{
								EceSecretName:  to.Ptr(armazurestackhci.EceSecrets("BMCAdminUserCred")),
								SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
								SecretName:     to.Ptr("cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
							},
							{
								EceSecretName:  to.Ptr(armazurestackhci.EceSecretsAzureStackLCMUserCredential),
								SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c"),
								SecretName:     to.Ptr("cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
							}},
						SecretsLocation: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123"),
						SecuritySettings: &armazurestackhci.DeploymentSecuritySettings{
							BitlockerBootVolume:           to.Ptr(true),
							BitlockerDataVolumes:          to.Ptr(true),
							CredentialGuardEnforced:       to.Ptr(false),
							DriftControlEnforced:          to.Ptr(true),
							DrtmProtection:                to.Ptr(true),
							HvciProtection:                to.Ptr(true),
							SideChannelMitigationEnforced: to.Ptr(true),
							SmbClusterEncryption:          to.Ptr(false),
							SmbSigningEnforced:            to.Ptr(true),
							WdacEnforced:                  to.Ptr(true),
						},
						Storage: &armazurestackhci.Storage{
							ConfigurationMode: to.Ptr("Express"),
						},
					},
					SbePartnerInfo: &armazurestackhci.SbePartnerInfo{
						CredentialList: []*armazurestackhci.SbeCredentials{
							{
								EceSecretName:  to.Ptr("DownloadConnectorCred"),
								SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
								SecretName:     to.Ptr("cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
							}},
						PartnerProperties: []*armazurestackhci.SbePartnerProperties{
							{
								Name:  to.Ptr("EnableBMCIpV6"),
								Value: to.Ptr("false"),
							},
							{
								Name:  to.Ptr("PhoneHomePort"),
								Value: to.Ptr("1653"),
							},
							{
								Name:  to.Ptr("BMCSecurityState"),
								Value: to.Ptr("HighSecurity"),
							}},
						SbeDeploymentInfo: &armazurestackhci.SbeDeploymentInfo{
							Family:                  to.Ptr("Gen5"),
							Publisher:               to.Ptr("Contoso"),
							SbeManifestCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-25T02:40:33.000Z"); return t }()),
							SbeManifestSource:       to.Ptr("default"),
							Version:                 to.Ptr("4.0.2309.13"),
						},
					},
				}},
			Version: to.Ptr("string"),
		},
		DeploymentMode: to.Ptr(armazurestackhci.DeploymentModeDeploy),
		OperationType:  to.Ptr(armazurestackhci.OperationTypeClusterProvisioning),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentSetting = armazurestackhci.DeploymentSetting{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/deploymentSettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.DeploymentSettingsProperties{
// 		ArcNodeResourceIDs: []*string{
// 			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
// 			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2")},
// 			DeploymentConfiguration: &armazurestackhci.DeploymentConfiguration{
// 				ScaleUnits: []*armazurestackhci.ScaleUnits{
// 					{
// 						DeploymentData: &armazurestackhci.DeploymentData{
// 							AdouPath: to.Ptr("OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com"),
// 							Cluster: &armazurestackhci.DeploymentCluster{
// 								Name: to.Ptr("testHCICluster"),
// 								AzureServiceEndpoint: to.Ptr("core.windows.net"),
// 								CloudAccountName: to.Ptr("myasestoragacct"),
// 								WitnessPath: to.Ptr("Cloud"),
// 								WitnessType: to.Ptr("Cloud"),
// 							},
// 							DomainFqdn: to.Ptr("ASZ1PLab8.nttest.microsoft.com"),
// 							HostNetwork: &armazurestackhci.DeploymentSettingHostNetwork{
// 								EnableStorageAutoIP: to.Ptr(false),
// 								Intents: []*armazurestackhci.DeploymentSettingIntents{
// 									{
// 										Name: to.Ptr("Compute_Management"),
// 										Adapter: []*string{
// 											to.Ptr("Port2")},
// 											AdapterPropertyOverrides: &armazurestackhci.DeploymentSettingAdapterPropertyOverrides{
// 												JumboPacket: to.Ptr("1514"),
// 												NetworkDirect: to.Ptr("Enabled"),
// 												NetworkDirectTechnology: to.Ptr("iWARP"),
// 											},
// 											OverrideAdapterProperty: to.Ptr(false),
// 											OverrideQosPolicy: to.Ptr(false),
// 											OverrideVirtualSwitchConfiguration: to.Ptr(false),
// 											QosPolicyOverrides: &armazurestackhci.QosPolicyOverrides{
// 												BandwidthPercentageSMB: to.Ptr("50"),
// 												PriorityValue8021ActionCluster: to.Ptr("7"),
// 												PriorityValue8021ActionSMB: to.Ptr("3"),
// 											},
// 											TrafficType: []*string{
// 												to.Ptr("Compute"),
// 												to.Ptr("Management")},
// 												VirtualSwitchConfigurationOverrides: &armazurestackhci.DeploymentSettingVirtualSwitchConfigurationOverrides{
// 													EnableIov: to.Ptr("True"),
// 													LoadBalancingAlgorithm: to.Ptr("HyperVPort"),
// 												},
// 										}},
// 										StorageConnectivitySwitchless: to.Ptr(true),
// 										StorageNetworks: []*armazurestackhci.DeploymentSettingStorageNetworks{
// 											{
// 												Name: to.Ptr("Storage1Network"),
// 												NetworkAdapterName: to.Ptr("Port3"),
// 												StorageAdapterIPInfo: []*armazurestackhci.DeploymentSettingStorageAdapterIPInfo{
// 													{
// 														IPv4Address: to.Ptr("10.57.48.60"),
// 														PhysicalNode: to.Ptr("string"),
// 														SubnetMask: to.Ptr("255.255.248.0"),
// 												}},
// 												VlanID: to.Ptr("5"),
// 										}},
// 									},
// 									InfrastructureNetwork: []*armazurestackhci.InfrastructureNetwork{
// 										{
// 											DNSServers: []*string{
// 												to.Ptr("10.57.50.90")},
// 												Gateway: to.Ptr("255.255.248.0"),
// 												IPPools: []*armazurestackhci.IPPools{
// 													{
// 														EndingAddress: to.Ptr("10.57.48.66"),
// 														StartingAddress: to.Ptr("10.57.48.60"),
// 												}},
// 												SubnetMask: to.Ptr("255.255.248.0"),
// 										}},
// 										NamingPrefix: to.Ptr("ms169"),
// 										Observability: &armazurestackhci.Observability{
// 											EpisodicDataUpload: to.Ptr(true),
// 											EuLocation: to.Ptr(false),
// 											StreamingDataClient: to.Ptr(true),
// 										},
// 										OptionalServices: &armazurestackhci.OptionalServices{
// 											CustomLocation: to.Ptr("customLocationName"),
// 										},
// 										PhysicalNodes: []*armazurestackhci.PhysicalNodes{
// 											{
// 												Name: to.Ptr("ms169host"),
// 												IPv4Address: to.Ptr("10.57.51.224"),
// 											},
// 											{
// 												Name: to.Ptr("ms154host"),
// 												IPv4Address: to.Ptr("10.57.53.236"),
// 										}},
// 										SdnIntegration: &armazurestackhci.SdnIntegration{
// 											NetworkController: &armazurestackhci.NetworkController{
// 												MacAddressPoolStart: to.Ptr("00-0D-3A-1B-C7-21"),
// 												MacAddressPoolStop: to.Ptr("00-0D-3A-1B-C7-29"),
// 												NetworkVirtualizationEnabled: to.Ptr(true),
// 											},
// 										},
// 										Secrets: []*armazurestackhci.EceDeploymentSecrets{
// 											{
// 												EceSecretName: to.Ptr(armazurestackhci.EceSecrets("BMCAdminUserCred")),
// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
// 												SecretName: to.Ptr("cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
// 											},
// 											{
// 												EceSecretName: to.Ptr(armazurestackhci.EceSecretsAzureStackLCMUserCredential),
// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c"),
// 												SecretName: to.Ptr("cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
// 										}},
// 										SecretsLocation: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123"),
// 										SecuritySettings: &armazurestackhci.DeploymentSecuritySettings{
// 											BitlockerBootVolume: to.Ptr(true),
// 											BitlockerDataVolumes: to.Ptr(true),
// 											CredentialGuardEnforced: to.Ptr(false),
// 											DriftControlEnforced: to.Ptr(true),
// 											DrtmProtection: to.Ptr(true),
// 											HvciProtection: to.Ptr(true),
// 											SideChannelMitigationEnforced: to.Ptr(true),
// 											SmbClusterEncryption: to.Ptr(false),
// 											SmbSigningEnforced: to.Ptr(true),
// 											WdacEnforced: to.Ptr(true),
// 										},
// 										Storage: &armazurestackhci.Storage{
// 											ConfigurationMode: to.Ptr("Express"),
// 										},
// 									},
// 									SbePartnerInfo: &armazurestackhci.SbePartnerInfo{
// 										CredentialList: []*armazurestackhci.SbeCredentials{
// 											{
// 												EceSecretName: to.Ptr("DownloadConnectorCred"),
// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
// 												SecretName: to.Ptr("cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
// 										}},
// 										PartnerProperties: []*armazurestackhci.SbePartnerProperties{
// 											{
// 												Name: to.Ptr("EnableBMCIpV6"),
// 												Value: to.Ptr("false"),
// 											},
// 											{
// 												Name: to.Ptr("PhoneHomePort"),
// 												Value: to.Ptr("1653"),
// 											},
// 											{
// 												Name: to.Ptr("BMCSecurityState"),
// 												Value: to.Ptr("HighSecurity"),
// 										}},
// 										SbeDeploymentInfo: &armazurestackhci.SbeDeploymentInfo{
// 											Family: to.Ptr("Gen5"),
// 											Publisher: to.Ptr("Contoso"),
// 											SbeManifestCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-25T02:40:33.000Z"); return t}()),
// 											SbeManifestSource: to.Ptr("default"),
// 											Version: to.Ptr("4.0.2309.13"),
// 										},
// 									},
// 							}},
// 							Version: to.Ptr("string"),
// 						},
// 						DeploymentMode: to.Ptr(armazurestackhci.DeploymentModeDeploy),
// 						ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 						ReportedProperties: &armazurestackhci.EceReportedProperties{
// 							DeploymentStatus: &armazurestackhci.EceActionStatus{
// 								Status: to.Ptr("Error"),
// 								Steps: []*armazurestackhci.DeploymentStep{
// 									{
// 										Name: to.Ptr("Cloud Deployment"),
// 										Description: to.Ptr("Deploy Cloud."),
// 										EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 										Exception: []*string{
// 											to.Ptr("exception1"),
// 											to.Ptr("exception2")},
// 											FullStepIndex: to.Ptr("0"),
// 											StartTimeUTC: to.Ptr("2023-06-09T00:08:19"),
// 											Status: to.Ptr("Error"),
// 											Steps: []*armazurestackhci.DeploymentStep{
// 												{
// 													Name: to.Ptr("Before Cloud Deployment"),
// 													EndTimeUTC: to.Ptr("2023-06-09T01:10:10"),
// 													Exception: []*string{
// 														to.Ptr("exception1"),
// 														to.Ptr("exception2")},
// 														FullStepIndex: to.Ptr("0.1"),
// 														StartTimeUTC: to.Ptr("2023-06-09T00:08:23"),
// 														Steps: []*armazurestackhci.DeploymentStep{
// 														},
// 													},
// 													{
// 														Name: to.Ptr("Clean up temporary content"),
// 														EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 														Exception: []*string{
// 															to.Ptr("exception1"),
// 															to.Ptr("exception2")},
// 															FullStepIndex: to.Ptr("0.36"),
// 															StartTimeUTC: to.Ptr("2023-06-09T03:58:37"),
// 															Status: to.Ptr("Error"),
// 															Steps: []*armazurestackhci.DeploymentStep{
// 															},
// 													}},
// 											}},
// 										},
// 										ValidationStatus: &armazurestackhci.EceActionStatus{
// 											Status: to.Ptr("Error"),
// 											Steps: []*armazurestackhci.DeploymentStep{
// 												{
// 													Name: to.Ptr("Cloud Deployment"),
// 													Description: to.Ptr("Deploy Cloud."),
// 													EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 													Exception: []*string{
// 														to.Ptr("exception1"),
// 														to.Ptr("exception2")},
// 														FullStepIndex: to.Ptr("0"),
// 														StartTimeUTC: to.Ptr("2023-06-09T00:08:19"),
// 														Status: to.Ptr("Error"),
// 														Steps: []*armazurestackhci.DeploymentStep{
// 															{
// 																Name: to.Ptr("Before Cloud Deployment"),
// 																Description: to.Ptr("Before Cloud Deployment"),
// 																EndTimeUTC: to.Ptr("2023-06-09T01:10:10"),
// 																Exception: []*string{
// 																	to.Ptr("exception1"),
// 																	to.Ptr("exception2")},
// 																	FullStepIndex: to.Ptr("0.1"),
// 																	StartTimeUTC: to.Ptr("2023-06-09T00:08:23"),
// 																	Steps: []*armazurestackhci.DeploymentStep{
// 																	},
// 																},
// 																{
// 																	Name: to.Ptr("Clean up temporary content"),
// 																	Description: to.Ptr("Clean up temporary content"),
// 																	EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 																	Exception: []*string{
// 																		to.Ptr("exception1"),
// 																		to.Ptr("exception2")},
// 																		FullStepIndex: to.Ptr("0.36"),
// 																		StartTimeUTC: to.Ptr("2023-06-09T03:58:37"),
// 																		Status: to.Ptr("Error"),
// 																		Steps: []*armazurestackhci.DeploymentStep{
// 																		},
// 																}},
// 														}},
// 													},
// 												},
// 											},
// 										}

Output:

func (*DeploymentSettingsClient) BeginDelete 

func (client *DeploymentSettingsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, deploymentSettingsName string, options *DeploymentSettingsClientBeginDeleteOptions) (*runtime.Poller[DeploymentSettingsClientDeleteResponse], error)

BeginDelete - Delete a DeploymentSetting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • deploymentSettingsName - Name of Deployment Setting
  • options - DeploymentSettingsClientBeginDeleteOptions contains the optional parameters for the DeploymentSettingsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteDeploymentSettings.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentSettingsClient().BeginDelete(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*DeploymentSettingsClient) Get 

func (client *DeploymentSettingsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, deploymentSettingsName string, options *DeploymentSettingsClientGetOptions) (DeploymentSettingsClientGetResponse, error)

Get - Get a DeploymentSetting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • deploymentSettingsName - Name of Deployment Setting
  • options - DeploymentSettingsClientGetOptions contains the optional parameters for the DeploymentSettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetDeploymentSettings.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeploymentSettingsClient().Get(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentSetting = armazurestackhci.DeploymentSetting{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/deploymentSettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.DeploymentSettingsProperties{
// 		ArcNodeResourceIDs: []*string{
// 			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
// 			to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2")},
// 			DeploymentConfiguration: &armazurestackhci.DeploymentConfiguration{
// 				ScaleUnits: []*armazurestackhci.ScaleUnits{
// 					{
// 						DeploymentData: &armazurestackhci.DeploymentData{
// 							AdouPath: to.Ptr("OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com"),
// 							Cluster: &armazurestackhci.DeploymentCluster{
// 								Name: to.Ptr("testHCICluster"),
// 								AzureServiceEndpoint: to.Ptr("core.windows.net"),
// 								CloudAccountName: to.Ptr("myasestoragacct"),
// 								WitnessPath: to.Ptr("Cloud"),
// 								WitnessType: to.Ptr("Cloud"),
// 							},
// 							DomainFqdn: to.Ptr("ASZ1PLab8.nttest.microsoft.com"),
// 							HostNetwork: &armazurestackhci.DeploymentSettingHostNetwork{
// 								EnableStorageAutoIP: to.Ptr(false),
// 								Intents: []*armazurestackhci.DeploymentSettingIntents{
// 									{
// 										Name: to.Ptr("Compute_Management"),
// 										Adapter: []*string{
// 											to.Ptr("Port2")},
// 											AdapterPropertyOverrides: &armazurestackhci.DeploymentSettingAdapterPropertyOverrides{
// 												JumboPacket: to.Ptr("1514"),
// 												NetworkDirect: to.Ptr("Enabled"),
// 												NetworkDirectTechnology: to.Ptr("iWARP"),
// 											},
// 											OverrideAdapterProperty: to.Ptr(false),
// 											OverrideQosPolicy: to.Ptr(false),
// 											OverrideVirtualSwitchConfiguration: to.Ptr(false),
// 											QosPolicyOverrides: &armazurestackhci.QosPolicyOverrides{
// 												BandwidthPercentageSMB: to.Ptr("50"),
// 												PriorityValue8021ActionCluster: to.Ptr("7"),
// 												PriorityValue8021ActionSMB: to.Ptr("3"),
// 											},
// 											TrafficType: []*string{
// 												to.Ptr("Compute"),
// 												to.Ptr("Management")},
// 												VirtualSwitchConfigurationOverrides: &armazurestackhci.DeploymentSettingVirtualSwitchConfigurationOverrides{
// 													EnableIov: to.Ptr("True"),
// 													LoadBalancingAlgorithm: to.Ptr("HyperVPort"),
// 												},
// 										}},
// 										StorageConnectivitySwitchless: to.Ptr(true),
// 										StorageNetworks: []*armazurestackhci.DeploymentSettingStorageNetworks{
// 											{
// 												Name: to.Ptr("Storage1Network"),
// 												NetworkAdapterName: to.Ptr("Port3"),
// 												StorageAdapterIPInfo: []*armazurestackhci.DeploymentSettingStorageAdapterIPInfo{
// 													{
// 														IPv4Address: to.Ptr("10.57.48.60"),
// 														PhysicalNode: to.Ptr("string"),
// 														SubnetMask: to.Ptr("255.255.248.0"),
// 												}},
// 												VlanID: to.Ptr("5"),
// 										}},
// 									},
// 									InfrastructureNetwork: []*armazurestackhci.InfrastructureNetwork{
// 										{
// 											DNSServers: []*string{
// 												to.Ptr("10.57.50.90")},
// 												Gateway: to.Ptr("255.255.248.0"),
// 												IPPools: []*armazurestackhci.IPPools{
// 													{
// 														EndingAddress: to.Ptr("10.57.48.66"),
// 														StartingAddress: to.Ptr("10.57.48.60"),
// 												}},
// 												SubnetMask: to.Ptr("255.255.248.0"),
// 										}},
// 										NamingPrefix: to.Ptr("ms169"),
// 										Observability: &armazurestackhci.Observability{
// 											EpisodicDataUpload: to.Ptr(true),
// 											EuLocation: to.Ptr(false),
// 											StreamingDataClient: to.Ptr(true),
// 										},
// 										OptionalServices: &armazurestackhci.OptionalServices{
// 											CustomLocation: to.Ptr("customLocationName"),
// 										},
// 										PhysicalNodes: []*armazurestackhci.PhysicalNodes{
// 											{
// 												Name: to.Ptr("ms169host"),
// 												IPv4Address: to.Ptr("10.57.51.224"),
// 											},
// 											{
// 												Name: to.Ptr("ms154host"),
// 												IPv4Address: to.Ptr("10.57.53.236"),
// 										}},
// 										SdnIntegration: &armazurestackhci.SdnIntegration{
// 											NetworkController: &armazurestackhci.NetworkController{
// 												MacAddressPoolStart: to.Ptr("00-0D-3A-1B-C7-21"),
// 												MacAddressPoolStop: to.Ptr("00-0D-3A-1B-C7-29"),
// 												NetworkVirtualizationEnabled: to.Ptr(true),
// 											},
// 										},
// 										Secrets: []*armazurestackhci.EceDeploymentSecrets{
// 											{
// 												EceSecretName: to.Ptr(armazurestackhci.EceSecrets("BMCAdminUserCred")),
// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
// 												SecretName: to.Ptr("cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
// 											},
// 											{
// 												EceSecretName: to.Ptr(armazurestackhci.EceSecretsAzureStackLCMUserCredential),
// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c"),
// 												SecretName: to.Ptr("cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
// 										}},
// 										SecretsLocation: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123"),
// 										SecuritySettings: &armazurestackhci.DeploymentSecuritySettings{
// 											BitlockerBootVolume: to.Ptr(true),
// 											BitlockerDataVolumes: to.Ptr(true),
// 											CredentialGuardEnforced: to.Ptr(false),
// 											DriftControlEnforced: to.Ptr(true),
// 											DrtmProtection: to.Ptr(true),
// 											HvciProtection: to.Ptr(true),
// 											SideChannelMitigationEnforced: to.Ptr(true),
// 											SmbClusterEncryption: to.Ptr(false),
// 											SmbSigningEnforced: to.Ptr(true),
// 											WdacEnforced: to.Ptr(true),
// 										},
// 										Storage: &armazurestackhci.Storage{
// 											ConfigurationMode: to.Ptr("Express"),
// 										},
// 									},
// 									SbePartnerInfo: &armazurestackhci.SbePartnerInfo{
// 										CredentialList: []*armazurestackhci.SbeCredentials{
// 											{
// 												EceSecretName: to.Ptr("DownloadConnectorCred"),
// 												SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
// 												SecretName: to.Ptr("cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
// 										}},
// 										PartnerProperties: []*armazurestackhci.SbePartnerProperties{
// 											{
// 												Name: to.Ptr("EnableBMCIpV6"),
// 												Value: to.Ptr("false"),
// 											},
// 											{
// 												Name: to.Ptr("PhoneHomePort"),
// 												Value: to.Ptr("1653"),
// 											},
// 											{
// 												Name: to.Ptr("BMCSecurityState"),
// 												Value: to.Ptr("HighSecurity"),
// 										}},
// 										SbeDeploymentInfo: &armazurestackhci.SbeDeploymentInfo{
// 											Family: to.Ptr("Gen5"),
// 											Publisher: to.Ptr("Contoso"),
// 											SbeManifestCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-25T02:40:33.000Z"); return t}()),
// 											SbeManifestSource: to.Ptr("default"),
// 											Version: to.Ptr("4.0.2309.13"),
// 										},
// 									},
// 							}},
// 							Version: to.Ptr("string"),
// 						},
// 						DeploymentMode: to.Ptr(armazurestackhci.DeploymentModeDeploy),
// 						OperationType: to.Ptr(armazurestackhci.OperationTypeClusterProvisioning),
// 						ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 						ReportedProperties: &armazurestackhci.EceReportedProperties{
// 							DeploymentStatus: &armazurestackhci.EceActionStatus{
// 								Status: to.Ptr("Error"),
// 								Steps: []*armazurestackhci.DeploymentStep{
// 									{
// 										Name: to.Ptr("Cloud Deployment"),
// 										Description: to.Ptr("Deploy Cloud."),
// 										EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 										FullStepIndex: to.Ptr("0"),
// 										StartTimeUTC: to.Ptr("2023-06-09T00:08:19"),
// 										Status: to.Ptr("Error"),
// 										Steps: []*armazurestackhci.DeploymentStep{
// 											{
// 												Name: to.Ptr("Before Cloud Deployment"),
// 												Description: to.Ptr("Before Cloud Deployment"),
// 												EndTimeUTC: to.Ptr("2023-06-09T01:10:10"),
// 												FullStepIndex: to.Ptr("0.1"),
// 												StartTimeUTC: to.Ptr("2023-06-09T00:08:23"),
// 											},
// 											{
// 												Name: to.Ptr("Clean up temporary content"),
// 												Description: to.Ptr("Clean up temporary content"),
// 												EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 												Exception: []*string{
// 													to.Ptr("exception1"),
// 													to.Ptr("exception2")},
// 													FullStepIndex: to.Ptr("0.36"),
// 													StartTimeUTC: to.Ptr("2023-06-09T03:58:37"),
// 													Status: to.Ptr("Error"),
// 											}},
// 									}},
// 								},
// 								ValidationStatus: &armazurestackhci.EceActionStatus{
// 									Status: to.Ptr("Error"),
// 									Steps: []*armazurestackhci.DeploymentStep{
// 										{
// 											Name: to.Ptr("Cloud Deployment"),
// 											Description: to.Ptr("Deploy Cloud."),
// 											EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 											FullStepIndex: to.Ptr("0"),
// 											StartTimeUTC: to.Ptr("2023-06-09T00:08:19"),
// 											Status: to.Ptr("Error"),
// 											Steps: []*armazurestackhci.DeploymentStep{
// 												{
// 													Name: to.Ptr("Before Cloud Deployment"),
// 													Description: to.Ptr("Before Cloud Deployment"),
// 													EndTimeUTC: to.Ptr("2023-06-09T01:10:10"),
// 													FullStepIndex: to.Ptr("0.1"),
// 													StartTimeUTC: to.Ptr("2023-06-09T00:08:23"),
// 												},
// 												{
// 													Name: to.Ptr("Clean up temporary content"),
// 													Description: to.Ptr("Clean up temporary content"),
// 													EndTimeUTC: to.Ptr("2023-06-09T04:01:47"),
// 													Exception: []*string{
// 														to.Ptr("exception1"),
// 														to.Ptr("exception2")},
// 														FullStepIndex: to.Ptr("0.36"),
// 														StartTimeUTC: to.Ptr("2023-06-09T03:58:37"),
// 														Status: to.Ptr("Error"),
// 												}},
// 										}},
// 									},
// 								},
// 							},
// 						}

Output:

func (*DeploymentSettingsClient) NewListByClustersPager 

func (client *DeploymentSettingsClient) NewListByClustersPager(resourceGroupName string, clusterName string, options *DeploymentSettingsClientListByClustersOptions) *runtime.Pager[DeploymentSettingsClientListByClustersResponse]

NewListByClustersPager - List DeploymentSetting resources by Clusters

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - DeploymentSettingsClientListByClustersOptions contains the optional parameters for the DeploymentSettingsClient.NewListByClustersPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListDeploymentSettingsByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDeploymentSettingsClient().NewListByClustersPager("test-rg", "myCluster", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DeploymentSettingListResult = armazurestackhci.DeploymentSettingListResult{
	// 	Value: []*armazurestackhci.DeploymentSetting{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/deploymentSettings"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Properties: &armazurestackhci.DeploymentSettingsProperties{
	// 				ArcNodeResourceIDs: []*string{
	// 					to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1"),
	// 					to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2")},
	// 					DeploymentConfiguration: &armazurestackhci.DeploymentConfiguration{
	// 						ScaleUnits: []*armazurestackhci.ScaleUnits{
	// 							{
	// 								DeploymentData: &armazurestackhci.DeploymentData{
	// 									AdouPath: to.Ptr("OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com"),
	// 									Cluster: &armazurestackhci.DeploymentCluster{
	// 										Name: to.Ptr("testHCICluster"),
	// 										AzureServiceEndpoint: to.Ptr("core.windows.net"),
	// 										CloudAccountName: to.Ptr("myasestoragacct"),
	// 										WitnessPath: to.Ptr("Cloud"),
	// 										WitnessType: to.Ptr("Cloud"),
	// 									},
	// 									DomainFqdn: to.Ptr("ASZ1PLab8.nttest.microsoft.com"),
	// 									HostNetwork: &armazurestackhci.DeploymentSettingHostNetwork{
	// 										EnableStorageAutoIP: to.Ptr(false),
	// 										Intents: []*armazurestackhci.DeploymentSettingIntents{
	// 											{
	// 												Name: to.Ptr("Compute_Management"),
	// 												Adapter: []*string{
	// 													to.Ptr("Port2")},
	// 													AdapterPropertyOverrides: &armazurestackhci.DeploymentSettingAdapterPropertyOverrides{
	// 														JumboPacket: to.Ptr("1514"),
	// 														NetworkDirect: to.Ptr("Enabled"),
	// 														NetworkDirectTechnology: to.Ptr("iWARP"),
	// 													},
	// 													OverrideAdapterProperty: to.Ptr(false),
	// 													OverrideQosPolicy: to.Ptr(false),
	// 													OverrideVirtualSwitchConfiguration: to.Ptr(false),
	// 													QosPolicyOverrides: &armazurestackhci.QosPolicyOverrides{
	// 														BandwidthPercentageSMB: to.Ptr("50"),
	// 														PriorityValue8021ActionCluster: to.Ptr("7"),
	// 														PriorityValue8021ActionSMB: to.Ptr("3"),
	// 													},
	// 													TrafficType: []*string{
	// 														to.Ptr("Compute"),
	// 														to.Ptr("Management")},
	// 														VirtualSwitchConfigurationOverrides: &armazurestackhci.DeploymentSettingVirtualSwitchConfigurationOverrides{
	// 															EnableIov: to.Ptr("True"),
	// 															LoadBalancingAlgorithm: to.Ptr("HyperVPort"),
	// 														},
	// 												}},
	// 												StorageConnectivitySwitchless: to.Ptr(true),
	// 												StorageNetworks: []*armazurestackhci.DeploymentSettingStorageNetworks{
	// 													{
	// 														Name: to.Ptr("Storage1Network"),
	// 														NetworkAdapterName: to.Ptr("Port3"),
	// 														StorageAdapterIPInfo: []*armazurestackhci.DeploymentSettingStorageAdapterIPInfo{
	// 															{
	// 																IPv4Address: to.Ptr("10.57.48.60"),
	// 																PhysicalNode: to.Ptr("string"),
	// 																SubnetMask: to.Ptr("255.255.248.0"),
	// 														}},
	// 														VlanID: to.Ptr("5"),
	// 												}},
	// 											},
	// 											InfrastructureNetwork: []*armazurestackhci.InfrastructureNetwork{
	// 												{
	// 													DNSServers: []*string{
	// 														to.Ptr("10.57.50.90")},
	// 														Gateway: to.Ptr("255.255.248.0"),
	// 														IPPools: []*armazurestackhci.IPPools{
	// 															{
	// 																EndingAddress: to.Ptr("10.57.48.66"),
	// 																StartingAddress: to.Ptr("10.57.48.60"),
	// 														}},
	// 														SubnetMask: to.Ptr("255.255.248.0"),
	// 												}},
	// 												NamingPrefix: to.Ptr("ms169"),
	// 												Observability: &armazurestackhci.Observability{
	// 													EpisodicDataUpload: to.Ptr(true),
	// 													EuLocation: to.Ptr(false),
	// 													StreamingDataClient: to.Ptr(true),
	// 												},
	// 												OptionalServices: &armazurestackhci.OptionalServices{
	// 													CustomLocation: to.Ptr("customLocationName"),
	// 												},
	// 												PhysicalNodes: []*armazurestackhci.PhysicalNodes{
	// 													{
	// 														Name: to.Ptr("ms169host"),
	// 														IPv4Address: to.Ptr("10.57.51.224"),
	// 													},
	// 													{
	// 														Name: to.Ptr("ms154host"),
	// 														IPv4Address: to.Ptr("10.57.53.236"),
	// 												}},
	// 												SdnIntegration: &armazurestackhci.SdnIntegration{
	// 													NetworkController: &armazurestackhci.NetworkController{
	// 														MacAddressPoolStart: to.Ptr("00-0D-3A-1B-C7-21"),
	// 														MacAddressPoolStop: to.Ptr("00-0D-3A-1B-C7-29"),
	// 														NetworkVirtualizationEnabled: to.Ptr(true),
	// 													},
	// 												},
	// 												Secrets: []*armazurestackhci.EceDeploymentSecrets{
	// 													{
	// 														EceSecretName: to.Ptr(armazurestackhci.EceSecrets("BMCAdminUserCred")),
	// 														SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
	// 														SecretName: to.Ptr("cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
	// 													},
	// 													{
	// 														EceSecretName: to.Ptr(armazurestackhci.EceSecretsAzureStackLCMUserCredential),
	// 														SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c"),
	// 														SecretName: to.Ptr("cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
	// 												}},
	// 												SecretsLocation: to.Ptr("/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123"),
	// 												SecuritySettings: &armazurestackhci.DeploymentSecuritySettings{
	// 													BitlockerBootVolume: to.Ptr(true),
	// 													BitlockerDataVolumes: to.Ptr(true),
	// 													CredentialGuardEnforced: to.Ptr(false),
	// 													DriftControlEnforced: to.Ptr(true),
	// 													DrtmProtection: to.Ptr(true),
	// 													HvciProtection: to.Ptr(true),
	// 													SideChannelMitigationEnforced: to.Ptr(true),
	// 													SmbClusterEncryption: to.Ptr(false),
	// 													SmbSigningEnforced: to.Ptr(true),
	// 													WdacEnforced: to.Ptr(true),
	// 												},
	// 												Storage: &armazurestackhci.Storage{
	// 													ConfigurationMode: to.Ptr("Express"),
	// 												},
	// 											},
	// 											SbePartnerInfo: &armazurestackhci.SbePartnerInfo{
	// 												CredentialList: []*armazurestackhci.SbeCredentials{
	// 													{
	// 														EceSecretName: to.Ptr("DownloadConnectorCred"),
	// 														SecretLocation: to.Ptr("https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b"),
	// 														SecretName: to.Ptr("cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63"),
	// 												}},
	// 												PartnerProperties: []*armazurestackhci.SbePartnerProperties{
	// 													{
	// 														Name: to.Ptr("EnableBMCIpV6"),
	// 														Value: to.Ptr("false"),
	// 													},
	// 													{
	// 														Name: to.Ptr("PhoneHomePort"),
	// 														Value: to.Ptr("1653"),
	// 													},
	// 													{
	// 														Name: to.Ptr("BMCSecurityState"),
	// 														Value: to.Ptr("HighSecurity"),
	// 												}},
	// 												SbeDeploymentInfo: &armazurestackhci.SbeDeploymentInfo{
	// 													Family: to.Ptr("Gen5"),
	// 													Publisher: to.Ptr("Contoso"),
	// 													SbeManifestCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-25T02:40:33.000Z"); return t}()),
	// 													SbeManifestSource: to.Ptr("default"),
	// 													Version: to.Ptr("4.0.2309.13"),
	// 												},
	// 											},
	// 									}},
	// 									Version: to.Ptr("string"),
	// 								},
	// 								DeploymentMode: to.Ptr(armazurestackhci.DeploymentModeDeploy),
	// 								OperationType: to.Ptr(armazurestackhci.OperationTypeClusterProvisioning),
	// 								ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 							},
	// 					}},
	// 				}
}

Output:

type DeploymentSettingsClientBeginCreateOrUpdateOptions 

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

DeploymentSettingsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentSettingsClient.BeginCreateOrUpdate method.

type DeploymentSettingsClientBeginDeleteOptions 

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

DeploymentSettingsClientBeginDeleteOptions contains the optional parameters for the DeploymentSettingsClient.BeginDelete method.

type DeploymentSettingsClientCreateOrUpdateResponse 

type DeploymentSettingsClientCreateOrUpdateResponse struct {
	// Edge device resource
	DeploymentSetting
}

DeploymentSettingsClientCreateOrUpdateResponse contains the response from method DeploymentSettingsClient.BeginCreateOrUpdate.

type DeploymentSettingsClientDeleteResponse 

type DeploymentSettingsClientDeleteResponse struct {
}

DeploymentSettingsClientDeleteResponse contains the response from method DeploymentSettingsClient.BeginDelete.

type DeploymentSettingsClientGetOptions 

type DeploymentSettingsClientGetOptions struct {
}

DeploymentSettingsClientGetOptions contains the optional parameters for the DeploymentSettingsClient.Get method.

type DeploymentSettingsClientGetResponse 

type DeploymentSettingsClientGetResponse struct {
	// Edge device resource
	DeploymentSetting
}

DeploymentSettingsClientGetResponse contains the response from method DeploymentSettingsClient.Get.

type DeploymentSettingsClientListByClustersOptions 

type DeploymentSettingsClientListByClustersOptions struct {
}

DeploymentSettingsClientListByClustersOptions contains the optional parameters for the DeploymentSettingsClient.NewListByClustersPager method.

type DeploymentSettingsClientListByClustersResponse 

type DeploymentSettingsClientListByClustersResponse struct {
	// The response of a DeploymentSetting list operation.
	DeploymentSettingListResult
}

DeploymentSettingsClientListByClustersResponse contains the response from method DeploymentSettingsClient.NewListByClustersPager.

type DeploymentSettingsProperties 

type DeploymentSettingsProperties struct {
	// REQUIRED; Azure resource ids of Arc machines to be part of cluster.
	ArcNodeResourceIDs []*string

	// REQUIRED; Scale units will contains list of deployment data
	DeploymentConfiguration *DeploymentConfiguration

	// REQUIRED; The deployment mode for cluster deployment.
	DeploymentMode *DeploymentMode

	// The intended operation for a cluster.
	OperationType *OperationType

	// READ-ONLY; DeploymentSetting provisioning state
	ProvisioningState *ProvisioningState

	// READ-ONLY; Deployment Status reported from cluster.
	ReportedProperties *EceReportedProperties
}

DeploymentSettingsProperties - DeploymentSetting properties

func (DeploymentSettingsProperties) MarshalJSON 

func (d DeploymentSettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentSettingsProperties.

func (*DeploymentSettingsProperties) UnmarshalJSON 

func (d *DeploymentSettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettingsProperties.

type DeploymentStep 

type DeploymentStep struct {
	// READ-ONLY; Description of step.
	Description *string

	// READ-ONLY; End time of step.
	EndTimeUTC *string

	// READ-ONLY; List of exceptions in AzureStackHCI Cluster Deployment.
	Exception []*string

	// READ-ONLY; FullStepIndex of step.
	FullStepIndex *string

	// READ-ONLY; Name of step.
	Name *string

	// READ-ONLY; Start time of step.
	StartTimeUTC *string

	// READ-ONLY; Status of step. Allowed values are 'Error', 'Success', 'InProgress'
	Status *string

	// READ-ONLY; List of nested steps of AzureStackHCI Cluster Deployment.
	Steps []*DeploymentStep
}

DeploymentStep - The Step of AzureStackHCI Cluster.

func (DeploymentStep) MarshalJSON 

func (d DeploymentStep) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentStep.

func (*DeploymentStep) UnmarshalJSON 

func (d *DeploymentStep) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentStep.

type DeviceConfiguration 

type DeviceConfiguration struct {
	// Device metadata details.
	DeviceMetadata *string

	// NIC Details of device
	NicDetails []*NicDetail
}

DeviceConfiguration - The device Configuration for edge device.

func (DeviceConfiguration) MarshalJSON 

func (d DeviceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceConfiguration.

func (*DeviceConfiguration) UnmarshalJSON 

func (d *DeviceConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceConfiguration.

type DeviceKind 

type DeviceKind string

DeviceKind - Edge device kind. 

const (
	// DeviceKindHCI - Arc-enabled edge device with HCI OS.
	DeviceKindHCI DeviceKind = "HCI"
)

func PossibleDeviceKindValues 

func PossibleDeviceKindValues() []DeviceKind

PossibleDeviceKindValues returns the possible values for the DeviceKind const type.

type DeviceState 

type DeviceState string

DeviceState - The edge device state. 

const (
	// DeviceStateConnected - The edge device state is in connected state.
	DeviceStateConnected DeviceState = "Connected"
	// DeviceStateDisconnected - The edge device state is in disconnected state.
	DeviceStateDisconnected DeviceState = "Disconnected"
	// DeviceStateDraining - The edge device state is in draining state.
	DeviceStateDraining DeviceState = "Draining"
	// DeviceStateInMaintenance - The edge device state is in maintenance state.
	DeviceStateInMaintenance DeviceState = "InMaintenance"
	// DeviceStateNotSpecified - The edge device state is not specified.
	DeviceStateNotSpecified DeviceState = "NotSpecified"
	// DeviceStateProcessing - The edge device state is in processing state.
	DeviceStateProcessing DeviceState = "Processing"
	// DeviceStateRepairing - The edge device state is in repairing state.
	DeviceStateRepairing DeviceState = "Repairing"
	// DeviceStateResuming - The edge device state is in resuming state.
	DeviceStateResuming DeviceState = "Resuming"
)

func PossibleDeviceStateValues 

func PossibleDeviceStateValues() []DeviceState

PossibleDeviceStateValues returns the possible values for the DeviceState const type.

type DiagnosticLevel 

type DiagnosticLevel string

DiagnosticLevel - Desired level of diagnostic data emitted by the cluster. 

const (
	DiagnosticLevelBasic    DiagnosticLevel = "Basic"
	DiagnosticLevelEnhanced DiagnosticLevel = "Enhanced"
	DiagnosticLevelOff      DiagnosticLevel = "Off"
)

func PossibleDiagnosticLevelValues 

func PossibleDiagnosticLevelValues() []DiagnosticLevel

PossibleDiagnosticLevelValues returns the possible values for the DiagnosticLevel const type.

type EceActionStatus 

type EceActionStatus struct {
	// READ-ONLY; Status of ECE action AzureStackHCI Cluster Deployment.
	Status *string

	// READ-ONLY; List of steps of AzureStackHCI Cluster Deployment.
	Steps []*DeploymentStep
}

EceActionStatus - The ECE action plan deployment status for AzureStackHCI Cluster.

func (EceActionStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EceActionStatus.

func (*EceActionStatus) UnmarshalJSON 

func (e *EceActionStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EceActionStatus.

type EceDeploymentSecrets 

type EceDeploymentSecrets struct {
	// Secret name expected for Enterprise Cloud Engine (ECE) deployment.
	EceSecretName *EceSecrets

	// Secret URI stored in keyvault.
	SecretLocation *string

	// Secret name stored in keyvault.
	SecretName *string
}

EceDeploymentSecrets - Protected parameters list stored in keyvault.

func (EceDeploymentSecrets) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EceDeploymentSecrets.

func (*EceDeploymentSecrets) UnmarshalJSON 

func (e *EceDeploymentSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EceDeploymentSecrets.

type EceReportedProperties 

type EceReportedProperties struct {
	// READ-ONLY; Deployment status of AzureStackHCI Cluster Deployment.
	DeploymentStatus *EceActionStatus

	// READ-ONLY; validation status of AzureStackHCI Cluster Deployment.
	ValidationStatus *EceActionStatus
}

EceReportedProperties - The DeploymentStatus of AzureStackHCI Cluster.

func (EceReportedProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EceReportedProperties.

func (*EceReportedProperties) UnmarshalJSON 

func (e *EceReportedProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EceReportedProperties.

type EceSecrets 

type EceSecrets string

EceSecrets - Secret names allowed for Enterprise Cloud Engine (ECE) deployment. 

const (
	// EceSecretsAzureStackLCMUserCredential - AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster.
	EceSecretsAzureStackLCMUserCredential EceSecrets = "AzureStackLCMUserCredential"
	// EceSecretsDefaultARBApplication - DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI
	// cluster.
	EceSecretsDefaultARBApplication EceSecrets = "DefaultARBApplication"
	// EceSecretsLocalAdminCredential - LocalAdminCredential used for admin operations for AzureStackHCI cluster.
	EceSecretsLocalAdminCredential EceSecrets = "LocalAdminCredential"
	// EceSecretsWitnessStorageKey - WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster.
	EceSecretsWitnessStorageKey EceSecrets = "WitnessStorageKey"
)

func PossibleEceSecretsValues 

func PossibleEceSecretsValues() []EceSecrets

PossibleEceSecretsValues returns the possible values for the EceSecrets const type.

type EdgeDevice 

type EdgeDevice struct {
	// REQUIRED; Device kind to support polymorphic resource.
	Kind *DeviceKind

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EdgeDevice - Edge device resource.

func (*EdgeDevice) GetEdgeDevice 

func (e *EdgeDevice) GetEdgeDevice() *EdgeDevice

GetEdgeDevice implements the EdgeDeviceClassification interface for type EdgeDevice.

func (EdgeDevice) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EdgeDevice.

func (*EdgeDevice) UnmarshalJSON 

func (e *EdgeDevice) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeDevice.

type EdgeDeviceClassification 

type EdgeDeviceClassification interface {
	// GetEdgeDevice returns the EdgeDevice content of the underlying type.
	GetEdgeDevice() *EdgeDevice
}

EdgeDeviceClassification provides polymorphic access to related types. Call the interface's GetEdgeDevice() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EdgeDevice, *HciEdgeDevice

type EdgeDeviceListResult 

type EdgeDeviceListResult struct {
	// REQUIRED; The EdgeDevice items on this page
	Value []EdgeDeviceClassification

	// The link to the next page of items
	NextLink *string
}

EdgeDeviceListResult - The response of a EdgeDevice list operation.

func (EdgeDeviceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EdgeDeviceListResult.

func (*EdgeDeviceListResult) UnmarshalJSON 

func (e *EdgeDeviceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeDeviceListResult.

type EdgeDevicesClient 

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

EdgeDevicesClient contains the methods for the EdgeDevices group. Don't use this type directly, use NewEdgeDevicesClient() instead.

func NewEdgeDevicesClient 

func NewEdgeDevicesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*EdgeDevicesClient, error)

NewEdgeDevicesClient creates a new instance of EdgeDevicesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*EdgeDevicesClient) BeginCreateOrUpdate 

func (client *EdgeDevicesClient) BeginCreateOrUpdate(ctx context.Context, resourceURI string, edgeDeviceName string, resource EdgeDeviceClassification, options *EdgeDevicesClientBeginCreateOrUpdateOptions) (*runtime.Poller[EdgeDevicesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a EdgeDevice If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceURI - The fully qualified Azure Resource manager identifier of the resource.
  • edgeDeviceName - Name of Device
  • resource - Resource create parameters.
  • options - EdgeDevicesClientBeginCreateOrUpdateOptions contains the optional parameters for the EdgeDevicesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/CreateHciEdgeDevice.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEdgeDevicesClient().BeginCreateOrUpdate(ctx, "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", "default", &armazurestackhci.HciEdgeDevice{
	Kind: to.Ptr(armazurestackhci.DeviceKindHCI),
	Properties: &armazurestackhci.HciEdgeDeviceProperties{
		DeviceConfiguration: &armazurestackhci.DeviceConfiguration{
			DeviceMetadata: to.Ptr(""),
			NicDetails: []*armazurestackhci.NicDetail{
				{
					AdapterName:        to.Ptr("ethernet"),
					ComponentID:        to.Ptr("VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} "),
					DefaultGateway:     to.Ptr("10.10.10.1"),
					DefaultIsolationID: to.Ptr("0"),
					DNSServers: []*string{
						to.Ptr("100.10.10.1")},
					DriverVersion:        to.Ptr("10.0.20348.1547 "),
					InterfaceDescription: to.Ptr("NDIS 6.70 "),
					Ip4Address:           to.Ptr("10.10.10.10"),
					SubnetMask:           to.Ptr("255.255.255.0"),
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armazurestackhci.EdgeDevicesClientCreateOrUpdateResponse{
// 	                            EdgeDeviceClassification: &armazurestackhci.HciEdgeDevice{
// 		Name: to.Ptr("default"),
// 		Type: to.Ptr("Microsoft.AzureStackHCI/edgeDevices"),
// 		ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default"),
// 		SystemData: &armazurestackhci.SystemData{
// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 			CreatedBy: to.Ptr("user1"),
// 			CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 			LastModifiedBy: to.Ptr("user2"),
// 			LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		},
// 		Kind: to.Ptr(armazurestackhci.DeviceKindHCI),
// 		Properties: &armazurestackhci.HciEdgeDeviceProperties{
// 			ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 			ReportedProperties: &armazurestackhci.HciReportedProperties{
// 				DeviceState: to.Ptr(armazurestackhci.DeviceStateConnected),
// 				NetworkProfile: &armazurestackhci.HciNetworkProfile{
// 					HostNetwork: &armazurestackhci.HciEdgeDeviceHostNetwork{
// 						EnableStorageAutoIP: to.Ptr(false),
// 						Intents: []*armazurestackhci.HciEdgeDeviceIntents{
// 							{
// 								AdapterPropertyOverrides: &armazurestackhci.HciEdgeDeviceAdapterPropertyOverrides{
// 									NetworkDirect: to.Ptr("0"),
// 								},
// 								IntentAdapters: []*string{
// 									to.Ptr("ethernet"),
// 									to.Ptr("ethernet2")},
// 									IntentName: to.Ptr("managementcomputestorage"),
// 									IntentType: to.Ptr[int64](14),
// 									IsComputeIntentSet: to.Ptr(true),
// 									IsManagementIntentSet: to.Ptr(true),
// 									IsNetworkIntentType: to.Ptr(true),
// 									IsOnlyStorage: to.Ptr(false),
// 									IsOnlyStretch: to.Ptr(false),
// 									IsStorageIntentSet: to.Ptr(true),
// 									IsStretchIntentSet: to.Ptr(false),
// 									OverrideAdapterProperty: to.Ptr(true),
// 									OverrideQosPolicy: to.Ptr(true),
// 									OverrideVirtualSwitchConfiguration: to.Ptr(true),
// 									QosPolicyOverrides: &armazurestackhci.QosPolicyOverrides{
// 									},
// 									Scope: to.Ptr[int64](0),
// 									VirtualSwitchConfigurationOverrides: &armazurestackhci.HciEdgeDeviceVirtualSwitchConfigurationOverrides{
// 										EnableIov: to.Ptr("True"),
// 										LoadBalancingAlgorithm: to.Ptr("HyperVPort"),
// 									},
// 							}},
// 							StorageConnectivitySwitchless: to.Ptr(false),
// 							StorageNetworks: []*armazurestackhci.HciEdgeDeviceStorageNetworks{
// 								{
// 									Name: to.Ptr("StorageIntent1"),
// 									NetworkAdapterName: to.Ptr("ethernet"),
// 									StorageAdapterIPInfo: []*armazurestackhci.HciEdgeDeviceStorageAdapterIPInfo{
// 										{
// 											IPv4Address: to.Ptr("192.168.120.192"),
// 											PhysicalNode: to.Ptr("v-host1"),
// 											SubnetMask: to.Ptr("255.255.244.0"),
// 									}},
// 									StorageVlanID: to.Ptr("8"),
// 							}},
// 						},
// 						NicDetails: []*armazurestackhci.HciNicDetail{
// 							{
// 								AdapterName: to.Ptr("vmanagement"),
// 								ComponentID: to.Ptr("vms_mp"),
// 								DefaultGateway: to.Ptr("192.168.200.1"),
// 								DefaultIsolationID: to.Ptr("0"),
// 								DNSServers: []*string{
// 									to.Ptr("192.168.200.222")},
// 									DriverVersion: to.Ptr("10.0.25398.1"),
// 									InterfaceDescription: to.Ptr("Hyper-V Virtual Ethernet Adapter"),
// 									Ip4Address: to.Ptr("192.168.200.92"),
// 									MacAddress: to.Ptr("000000000041"),
// 									NicStatus: to.Ptr("Up"),
// 									NicType: to.Ptr("Virtual"),
// 									Slot: to.Ptr("0"),
// 									SubnetMask: to.Ptr("255.255.255.0"),
// 									VlanID: to.Ptr("0"),
// 							}},
// 							SwitchDetails: []*armazurestackhci.SwitchDetail{
// 								{
// 									SwitchName: to.Ptr("vmanagement"),
// 									SwitchType: to.Ptr("External"),
// 							}},
// 						},
// 						OSProfile: &armazurestackhci.HciOsProfile{
// 							AssemblyVersion: to.Ptr("2402.1"),
// 							BootType: to.Ptr("UEFI"),
// 						},
// 						SbeDeploymentPackageInfo: &armazurestackhci.SbeDeploymentPackageInfo{
// 							Code: to.Ptr("NewerThanLatestPublished"),
// 							Message: to.Ptr("The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. "),
// 							SbeManifest: to.Ptr("PEFwcGxpY2Fi"),
// 						},
// 					},
// 				},
// 			},
// 			                        }

Output:

func (*EdgeDevicesClient) BeginDelete 

func (client *EdgeDevicesClient) BeginDelete(ctx context.Context, resourceURI string, edgeDeviceName string, options *EdgeDevicesClientBeginDeleteOptions) (*runtime.Poller[EdgeDevicesClientDeleteResponse], error)

BeginDelete - Delete a EdgeDevice If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceURI - The fully qualified Azure Resource manager identifier of the resource.
  • edgeDeviceName - Name of Device
  • options - EdgeDevicesClientBeginDeleteOptions contains the optional parameters for the EdgeDevicesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteEdgeDevices.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEdgeDevicesClient().BeginDelete(ctx, "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*EdgeDevicesClient) BeginValidate 

func (client *EdgeDevicesClient) BeginValidate(ctx context.Context, resourceURI string, edgeDeviceName string, validateRequest ValidateRequest, options *EdgeDevicesClientBeginValidateOptions) (*runtime.Poller[EdgeDevicesClientValidateResponse], error)

BeginValidate - A long-running resource action. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceURI - The fully qualified Azure Resource manager identifier of the resource.
  • edgeDeviceName - Name of Device
  • validateRequest - The content of the action request
  • options - EdgeDevicesClientBeginValidateOptions contains the optional parameters for the EdgeDevicesClient.BeginValidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ValidateEdgeDevices.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewEdgeDevicesClient().BeginValidate(ctx, "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", "default", armazurestackhci.ValidateRequest{
	AdditionalInfo: to.Ptr("test"),
	EdgeDeviceIDs: []*string{
		to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/edgeDevices/default"),
		to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/edgeDevices/default")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ValidateResponse = armazurestackhci.ValidateResponse{
// 	Status: to.Ptr("success"),
// }

Output:

func (*EdgeDevicesClient) Get 

func (client *EdgeDevicesClient) Get(ctx context.Context, resourceURI string, edgeDeviceName string, options *EdgeDevicesClientGetOptions) (EdgeDevicesClientGetResponse, error)

Get - Get a EdgeDevice If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceURI - The fully qualified Azure Resource manager identifier of the resource.
  • edgeDeviceName - Name of Device
  • options - EdgeDevicesClientGetOptions contains the optional parameters for the EdgeDevicesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetEdgeDevices.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEdgeDevicesClient().Get(ctx, "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armazurestackhci.EdgeDevicesClientGetResponse{
// 	                            EdgeDeviceClassification: &armazurestackhci.HciEdgeDevice{
// 		Name: to.Ptr("default"),
// 		Type: to.Ptr("Microsoft.AzureStackHCI/edgeDevices"),
// 		ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default"),
// 		SystemData: &armazurestackhci.SystemData{
// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 			CreatedBy: to.Ptr("user1"),
// 			CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 			LastModifiedBy: to.Ptr("user2"),
// 			LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		},
// 		Kind: to.Ptr(armazurestackhci.DeviceKindHCI),
// 		Properties: &armazurestackhci.HciEdgeDeviceProperties{
// 			DeviceConfiguration: &armazurestackhci.DeviceConfiguration{
// 				DeviceMetadata: to.Ptr(""),
// 				NicDetails: []*armazurestackhci.NicDetail{
// 					{
// 						AdapterName: to.Ptr("ethernet"),
// 						ComponentID: to.Ptr("VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} "),
// 						DefaultGateway: to.Ptr("10.10.10.1"),
// 						DefaultIsolationID: to.Ptr("0"),
// 						DNSServers: []*string{
// 							to.Ptr("100.10.10.1")},
// 							DriverVersion: to.Ptr("10.0.20348.1547 "),
// 							InterfaceDescription: to.Ptr("NDIS 6.70 "),
// 							Ip4Address: to.Ptr("10.10.10.10"),
// 							SubnetMask: to.Ptr("255.255.255.0"),
// 					}},
// 				},
// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 			},
// 		},
// 		                        }

Output:

func (*EdgeDevicesClient) NewListPager 

func (client *EdgeDevicesClient) NewListPager(resourceURI string, options *EdgeDevicesClientListOptions) *runtime.Pager[EdgeDevicesClientListResponse]

NewListPager - List EdgeDevice resources by parent

Generated from API version 2024-04-01

  • resourceURI - The fully qualified Azure Resource manager identifier of the resource.
  • options - EdgeDevicesClientListOptions contains the optional parameters for the EdgeDevicesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListEdgeDevices.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEdgeDevicesClient().NewListPager("subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EdgeDeviceListResult = armazurestackhci.EdgeDeviceListResult{
	// 	Value: []armazurestackhci.EdgeDeviceClassification{
	// 		&armazurestackhci.HciEdgeDevice{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/edgeDevices"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Kind: to.Ptr(armazurestackhci.DeviceKindHCI),
	// 			Properties: &armazurestackhci.HciEdgeDeviceProperties{
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 				ReportedProperties: &armazurestackhci.HciReportedProperties{
	// 					NetworkProfile: &armazurestackhci.HciNetworkProfile{
	// 						NicDetails: []*armazurestackhci.HciNicDetail{
	// 							{
	// 								AdapterName: to.Ptr("vmanagement"),
	// 								ComponentID: to.Ptr("vms_mp"),
	// 								DefaultGateway: to.Ptr("192.168.200.1"),
	// 								DefaultIsolationID: to.Ptr("0"),
	// 								DNSServers: []*string{
	// 									to.Ptr("192.168.200.222")},
	// 									DriverVersion: to.Ptr("10.0.25398.1"),
	// 									InterfaceDescription: to.Ptr("Hyper-V Virtual Ethernet Adapter"),
	// 									Ip4Address: to.Ptr("192.168.200.92"),
	// 									MacAddress: to.Ptr("000000000041"),
	// 									NicStatus: to.Ptr("Up"),
	// 									NicType: to.Ptr("Virtual"),
	// 									Slot: to.Ptr("0"),
	// 									SubnetMask: to.Ptr("255.255.255.0"),
	// 									VlanID: to.Ptr("0"),
	// 							}},
	// 							SwitchDetails: []*armazurestackhci.SwitchDetail{
	// 								{
	// 									SwitchName: to.Ptr("vmanagement"),
	// 									SwitchType: to.Ptr("External"),
	// 							}},
	// 						},
	// 						OSProfile: &armazurestackhci.HciOsProfile{
	// 							AssemblyVersion: to.Ptr("2402.1"),
	// 							BootType: to.Ptr("UEFI"),
	// 						},
	// 						SbeDeploymentPackageInfo: &armazurestackhci.SbeDeploymentPackageInfo{
	// 							Code: to.Ptr("NewerThanLatestPublished"),
	// 							Message: to.Ptr("The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. "),
	// 							SbeManifest: to.Ptr("PEFwcGxpY2Fi"),
	// 						},
	// 					},
	// 				},
	// 		}},
	// 	}
}

Output:

type EdgeDevicesClientBeginCreateOrUpdateOptions 

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

EdgeDevicesClientBeginCreateOrUpdateOptions contains the optional parameters for the EdgeDevicesClient.BeginCreateOrUpdate method.

type EdgeDevicesClientBeginDeleteOptions 

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

EdgeDevicesClientBeginDeleteOptions contains the optional parameters for the EdgeDevicesClient.BeginDelete method.

type EdgeDevicesClientBeginValidateOptions 

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

EdgeDevicesClientBeginValidateOptions contains the optional parameters for the EdgeDevicesClient.BeginValidate method.

type EdgeDevicesClientCreateOrUpdateResponse 

type EdgeDevicesClientCreateOrUpdateResponse struct {
	// Edge device resource.
	EdgeDeviceClassification
}

EdgeDevicesClientCreateOrUpdateResponse contains the response from method EdgeDevicesClient.BeginCreateOrUpdate.

func (EdgeDevicesClientCreateOrUpdateResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EdgeDevicesClientCreateOrUpdateResponse.

func (*EdgeDevicesClientCreateOrUpdateResponse) UnmarshalJSON 

func (e *EdgeDevicesClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeDevicesClientCreateOrUpdateResponse.

type EdgeDevicesClientDeleteResponse 

type EdgeDevicesClientDeleteResponse struct {
}

EdgeDevicesClientDeleteResponse contains the response from method EdgeDevicesClient.BeginDelete.

type EdgeDevicesClientGetOptions 

type EdgeDevicesClientGetOptions struct {
}

EdgeDevicesClientGetOptions contains the optional parameters for the EdgeDevicesClient.Get method.

type EdgeDevicesClientGetResponse 

type EdgeDevicesClientGetResponse struct {
	// Edge device resource.
	EdgeDeviceClassification
}

EdgeDevicesClientGetResponse contains the response from method EdgeDevicesClient.Get.

func (*EdgeDevicesClientGetResponse) UnmarshalJSON 

func (e *EdgeDevicesClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeDevicesClientGetResponse.

type EdgeDevicesClientListOptions 

type EdgeDevicesClientListOptions struct {
}

EdgeDevicesClientListOptions contains the optional parameters for the EdgeDevicesClient.NewListPager method.

type EdgeDevicesClientListResponse 

type EdgeDevicesClientListResponse struct {
	// The response of a EdgeDevice list operation.
	EdgeDeviceListResult
}

EdgeDevicesClientListResponse contains the response from method EdgeDevicesClient.NewListPager.

type EdgeDevicesClientValidateResponse 

type EdgeDevicesClientValidateResponse struct {
	// An Accepted response with an Operation-Location header.
	ValidateResponse
}

EdgeDevicesClientValidateResponse contains the response from method EdgeDevicesClient.BeginValidate.

type Extension 

type Extension struct {
	// Describes Machine Extension Properties.
	Properties *ExtensionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Extension - Details of a particular extension in HCI Cluster.

func (Extension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Extension.

func (*Extension) UnmarshalJSON 

func (e *Extension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Extension.

type ExtensionAggregateState 

type ExtensionAggregateState string

ExtensionAggregateState - Aggregate state of Arc Extensions across the nodes in this HCI cluster. 

const (
	ExtensionAggregateStateAccepted                       ExtensionAggregateState = "Accepted"
	ExtensionAggregateStateCanceled                       ExtensionAggregateState = "Canceled"
	ExtensionAggregateStateConnected                      ExtensionAggregateState = "Connected"
	ExtensionAggregateStateCreating                       ExtensionAggregateState = "Creating"
	ExtensionAggregateStateDeleted                        ExtensionAggregateState = "Deleted"
	ExtensionAggregateStateDeleting                       ExtensionAggregateState = "Deleting"
	ExtensionAggregateStateDisconnected                   ExtensionAggregateState = "Disconnected"
	ExtensionAggregateStateError                          ExtensionAggregateState = "Error"
	ExtensionAggregateStateFailed                         ExtensionAggregateState = "Failed"
	ExtensionAggregateStateInProgress                     ExtensionAggregateState = "InProgress"
	ExtensionAggregateStateMoving                         ExtensionAggregateState = "Moving"
	ExtensionAggregateStateNotSpecified                   ExtensionAggregateState = "NotSpecified"
	ExtensionAggregateStatePartiallyConnected             ExtensionAggregateState = "PartiallyConnected"
	ExtensionAggregateStatePartiallySucceeded             ExtensionAggregateState = "PartiallySucceeded"
	ExtensionAggregateStateProvisioning                   ExtensionAggregateState = "Provisioning"
	ExtensionAggregateStateSucceeded                      ExtensionAggregateState = "Succeeded"
	ExtensionAggregateStateUpdating                       ExtensionAggregateState = "Updating"
	ExtensionAggregateStateUpgradeFailedRollbackSucceeded ExtensionAggregateState = "UpgradeFailedRollbackSucceeded"
)

func PossibleExtensionAggregateStateValues 

func PossibleExtensionAggregateStateValues() []ExtensionAggregateState

PossibleExtensionAggregateStateValues returns the possible values for the ExtensionAggregateState const type.

type ExtensionInstanceView 

type ExtensionInstanceView struct {
	// The extension name.
	Name *string

	// Instance view status.
	Status *ExtensionInstanceViewStatus

	// Specifies the type of the extension; an example is "MicrosoftMonitoringAgent".
	Type *string

	// Specifies the version of the script handler.
	TypeHandlerVersion *string
}

ExtensionInstanceView - Describes the Extension Instance View.

func (ExtensionInstanceView) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionInstanceView.

func (*ExtensionInstanceView) UnmarshalJSON 

func (e *ExtensionInstanceView) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionInstanceView.

type ExtensionInstanceViewStatus 

type ExtensionInstanceViewStatus struct {
	// The status code.
	Code *string

	// The short localizable label for the status.
	DisplayStatus *string

	// The level code.
	Level *StatusLevelTypes

	// The detailed status message, including for alerts and error messages.
	Message *string

	// The time of the status.
	Time *time.Time
}

ExtensionInstanceViewStatus - Instance view status.

func (ExtensionInstanceViewStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionInstanceViewStatus.

func (*ExtensionInstanceViewStatus) UnmarshalJSON 

func (e *ExtensionInstanceViewStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionInstanceViewStatus.

type ExtensionList 

type ExtensionList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; List of Extensions in HCI cluster.
	Value []*Extension
}

ExtensionList - List of Extensions in HCI cluster.

func (ExtensionList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionList.

func (*ExtensionList) UnmarshalJSON 

func (e *ExtensionList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionList.

type ExtensionManagedBy 

type ExtensionManagedBy string

ExtensionManagedBy - Extension managed by user or Azure. 

const (
	ExtensionManagedByAzure ExtensionManagedBy = "Azure"
	ExtensionManagedByUser  ExtensionManagedBy = "User"
)

func PossibleExtensionManagedByValues 

func PossibleExtensionManagedByValues() []ExtensionManagedBy

PossibleExtensionManagedByValues returns the possible values for the ExtensionManagedBy const type.

type ExtensionParameters 

type ExtensionParameters struct {
	// Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed,
	// however, the extension will not upgrade minor versions unless redeployed, even
	// with this property set to true.
	AutoUpgradeMinorVersion *bool

	// Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
	EnableAutomaticUpgrade *bool

	// How the extension handler should be forced to update even if the extension configuration has not changed.
	ForceUpdateTag *string

	// Protected settings (may contain secrets).
	ProtectedSettings any

	// The name of the extension handler publisher.
	Publisher *string

	// Json formatted public settings for the extension.
	Settings any

	// Specifies the type of the extension; an example is "CustomScriptExtension".
	Type *string

	// Specifies the version of the script handler. Latest version would be used if not specified.
	TypeHandlerVersion *string
}

ExtensionParameters - Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.

func (ExtensionParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionParameters.

func (*ExtensionParameters) UnmarshalJSON 

func (e *ExtensionParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionParameters.

type ExtensionPatch 

type ExtensionPatch struct {
	// Describes Machine Extension Properties that can be updated.
	Properties *ExtensionPatchProperties
}

ExtensionPatch - Extension Details to update

func (ExtensionPatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionPatch.

func (*ExtensionPatch) UnmarshalJSON 

func (e *ExtensionPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionPatch.

type ExtensionPatchParameters 

type ExtensionPatchParameters struct {
	// Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
	EnableAutomaticUpgrade *bool

	// Protected settings (may contain secrets).
	ProtectedSettings any

	// Json formatted public settings for the extension.
	Settings any

	// Specifies the version of the script handler. Latest version would be used if not specified.
	TypeHandlerVersion *string
}

ExtensionPatchParameters - Describes the properties of a Machine Extension that can be updated.

func (ExtensionPatchParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionPatchParameters.

func (*ExtensionPatchParameters) UnmarshalJSON 

func (e *ExtensionPatchParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionPatchParameters.

type ExtensionPatchProperties 

type ExtensionPatchProperties struct {
	// Describes the properties of a Machine Extension that can be updated.
	ExtensionParameters *ExtensionPatchParameters
}

ExtensionPatchProperties - Describes Machine Extension Properties that can be updated.

func (ExtensionPatchProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionPatchProperties.

func (*ExtensionPatchProperties) UnmarshalJSON 

func (e *ExtensionPatchProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionPatchProperties.

type ExtensionProfile 

type ExtensionProfile struct {
	// READ-ONLY; List of Arc extensions installed on edge device.
	Extensions []*HciEdgeDeviceArcExtension
}

ExtensionProfile - Extensions details for edge device.

func (ExtensionProfile) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionProfile.

func (*ExtensionProfile) UnmarshalJSON 

func (e *ExtensionProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionProfile.

type ExtensionProperties 

type ExtensionProperties struct {
	// Parameters specific to this extension type.
	ExtensionParameters *ExtensionParameters

	// READ-ONLY; Aggregate state of Arc Extensions across the nodes in this HCI cluster.
	AggregateState *ExtensionAggregateState

	// READ-ONLY; Indicates if the extension is managed by azure or the user.
	ManagedBy *ExtensionManagedBy

	// READ-ONLY; State of Arc Extension in each of the nodes.
	PerNodeExtensionDetails []*PerNodeExtensionState

	// READ-ONLY; Provisioning state of the Extension proxy resource.
	ProvisioningState *ProvisioningState
}

ExtensionProperties - Status of Arc Extension for a particular node in HCI Cluster.

func (ExtensionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionProperties.

func (*ExtensionProperties) UnmarshalJSON 

func (e *ExtensionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionProperties.

type ExtensionUpgradeParameters 

type ExtensionUpgradeParameters struct {
	// Extension Upgrade Target Version.
	TargetVersion *string
}

ExtensionUpgradeParameters - Describes the parameters for Extension upgrade.

func (ExtensionUpgradeParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtensionUpgradeParameters.

func (*ExtensionUpgradeParameters) UnmarshalJSON 

func (e *ExtensionUpgradeParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionUpgradeParameters.

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 ID of the target subscription. The value must be an UUID.
  • 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, arcSettingName string, extensionName string, extension Extension, options *ExtensionsClientBeginCreateOptions) (*runtime.Poller[ExtensionsClientCreateResponse], error)

BeginCreate - Create Extension for HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • extensionName - The name of the machine extension.
  • extension - Details of the Machine Extension to be created.
  • options - ExtensionsClientBeginCreateOptions contains the optional parameters for the ExtensionsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutExtension.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewExtensionsClient().BeginCreate(ctx, "test-rg", "myCluster", "default", "MicrosoftMonitoringAgent", armazurestackhci.Extension{
	Properties: &armazurestackhci.ExtensionProperties{
		ExtensionParameters: &armazurestackhci.ExtensionParameters{
			Type:                   to.Ptr("MicrosoftMonitoringAgent"),
			EnableAutomaticUpgrade: to.Ptr(false),
			ProtectedSettings: map[string]any{
				"workspaceKey": "xx",
			},
			Publisher: to.Ptr("Microsoft.Compute"),
			Settings: map[string]any{
				"workspaceId": "xx",
			},
			TypeHandlerVersion: to.Ptr("1.10"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Extension = armazurestackhci.Extension{
// 	Name: to.Ptr("MicrosoftMonitoringAgent"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings/extensions"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ExtensionProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ExtensionAggregateStatePartiallySucceeded),
// 		ExtensionParameters: &armazurestackhci.ExtensionParameters{
// 			Type: to.Ptr("string"),
// 			AutoUpgradeMinorVersion: to.Ptr(false),
// 			EnableAutomaticUpgrade: to.Ptr(false),
// 			Publisher: to.Ptr("Microsoft.Compute"),
// 			Settings: map[string]any{
// 				"workspaceId": "xx",
// 			},
// 			TypeHandlerVersion: to.Ptr("1.10.3"),
// 		},
// 		ManagedBy: to.Ptr(armazurestackhci.ExtensionManagedByUser),
// 		PerNodeExtensionDetails: []*armazurestackhci.PerNodeExtensionState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent"),
// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
// 						Code: to.Ptr("success"),
// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
// 						Level: to.Ptr(armazurestackhci.StatusLevelTypes("Information")),
// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
// 					},
// 					TypeHandlerVersion: to.Ptr("1.10.0"),
// 				},
// 				State: to.Ptr(armazurestackhci.NodeExtensionStateSucceeded),
// 				TypeHandlerVersion: to.Ptr("1.10.0"),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent"),
// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
// 						Code: to.Ptr("error"),
// 						DisplayStatus: to.Ptr("Provisioning failed"),
// 						Level: to.Ptr(armazurestackhci.StatusLevelTypesError),
// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
// 					},
// 					TypeHandlerVersion: to.Ptr("1.10.3"),
// 				},
// 				State: to.Ptr(armazurestackhci.NodeExtensionStateFailed),
// 				TypeHandlerVersion: to.Ptr("1.10.3"),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ExtensionsClient) BeginDelete 

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

BeginDelete - Delete particular Arc Extension of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • extensionName - The name of the machine 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/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteExtension.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewExtensionsClient().BeginDelete(ctx, "test-rg", "myCluster", "default", "MicrosoftMonitoringAgent", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ExtensionsClient) BeginUpdate 

func (client *ExtensionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, extensionName string, extension ExtensionPatch, options *ExtensionsClientBeginUpdateOptions) (*runtime.Poller[ExtensionsClientUpdateResponse], error)

BeginUpdate - Update Extension for HCI cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • extensionName - The name of the machine extension.
  • extension - Details of the Machine Extension to be created.
  • options - ExtensionsClientBeginUpdateOptions contains the optional parameters for the ExtensionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PatchExtension.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewExtensionsClient().BeginUpdate(ctx, "test-rg", "myCluster", "default", "MicrosoftMonitoringAgent", armazurestackhci.ExtensionPatch{
	Properties: &armazurestackhci.ExtensionPatchProperties{
		ExtensionParameters: &armazurestackhci.ExtensionPatchParameters{
			EnableAutomaticUpgrade: to.Ptr(false),
			ProtectedSettings: map[string]any{
				"workspaceKey": "xx",
			},
			Settings: map[string]any{
				"workspaceId": "xx",
			},
			TypeHandlerVersion: to.Ptr("1.10"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Extension = armazurestackhci.Extension{
// 	Name: to.Ptr("MicrosoftMonitoringAgent"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings/extensions"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ExtensionProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ExtensionAggregateStatePartiallyConnected),
// 		ExtensionParameters: &armazurestackhci.ExtensionParameters{
// 			Type: to.Ptr("string"),
// 			AutoUpgradeMinorVersion: to.Ptr(false),
// 			EnableAutomaticUpgrade: to.Ptr(false),
// 			Publisher: to.Ptr("Microsoft.Compute"),
// 			Settings: map[string]any{
// 				"workspaceId": "xx",
// 			},
// 			TypeHandlerVersion: to.Ptr("1.10"),
// 		},
// 		ManagedBy: to.Ptr(armazurestackhci.ExtensionManagedByUser),
// 		PerNodeExtensionDetails: []*armazurestackhci.PerNodeExtensionState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent"),
// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
// 						Code: to.Ptr("success"),
// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
// 						Level: to.Ptr(armazurestackhci.StatusLevelTypes("Information")),
// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
// 					},
// 					TypeHandlerVersion: to.Ptr("1.10.0"),
// 				},
// 				State: to.Ptr(armazurestackhci.NodeExtensionStateConnected),
// 				TypeHandlerVersion: to.Ptr("1.10.0"),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent"),
// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
// 						Code: to.Ptr("error"),
// 						DisplayStatus: to.Ptr("Provisioning failed"),
// 						Level: to.Ptr(armazurestackhci.StatusLevelTypesError),
// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
// 					},
// 					TypeHandlerVersion: to.Ptr("1.10.3"),
// 				},
// 				State: to.Ptr(armazurestackhci.NodeExtensionStateDisconnected),
// 				TypeHandlerVersion: to.Ptr("1.10.3"),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ExtensionsClient) BeginUpgrade 

func (client *ExtensionsClient) BeginUpgrade(ctx context.Context, resourceGroupName string, clusterName string, arcSettingName string, extensionName string, extensionUpgradeParameters ExtensionUpgradeParameters, options *ExtensionsClientBeginUpgradeOptions) (*runtime.Poller[ExtensionsClientUpgradeResponse], error)

BeginUpgrade - Upgrade a particular Arc Extension of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • extensionName - The name of the machine extension.
  • extensionUpgradeParameters - Parameters supplied to the Upgrade Extensions operation.
  • options - ExtensionsClientBeginUpgradeOptions contains the optional parameters for the ExtensionsClient.BeginUpgrade method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/Extensions_Upgrade.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewExtensionsClient().BeginUpgrade(ctx, "test-rg", "myCluster", "default", "MicrosoftMonitoringAgent", armazurestackhci.ExtensionUpgradeParameters{
	TargetVersion: to.Ptr("1.0.18062.0"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ExtensionsClient) Get 

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

Get - Get particular Arc Extension of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • extensionName - The name of the machine 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/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetExtension.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewExtensionsClient().Get(ctx, "test-rg", "myCluster", "default", "MicrosoftMonitoringAgent", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Extension = armazurestackhci.Extension{
// 	Name: to.Ptr("MicrosoftMonitoringAgent"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings/extensions"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.ExtensionProperties{
// 		AggregateState: to.Ptr(armazurestackhci.ExtensionAggregateStatePartiallySucceeded),
// 		ExtensionParameters: &armazurestackhci.ExtensionParameters{
// 			Type: to.Ptr("string"),
// 			AutoUpgradeMinorVersion: to.Ptr(false),
// 			EnableAutomaticUpgrade: to.Ptr(true),
// 			Publisher: to.Ptr("Microsoft.Compute"),
// 			Settings: map[string]any{
// 				"workspaceId": "xx",
// 			},
// 			TypeHandlerVersion: to.Ptr("1.10.3"),
// 		},
// 		ManagedBy: to.Ptr(armazurestackhci.ExtensionManagedByAzure),
// 		PerNodeExtensionDetails: []*armazurestackhci.PerNodeExtensionState{
// 			{
// 				Name: to.Ptr("Node-1"),
// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent"),
// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
// 						Code: to.Ptr("success"),
// 						DisplayStatus: to.Ptr("Provisioning succeeded"),
// 						Level: to.Ptr(armazurestackhci.StatusLevelTypes("Information")),
// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
// 					},
// 					TypeHandlerVersion: to.Ptr("1.10.0"),
// 				},
// 				State: to.Ptr(armazurestackhci.NodeExtensionStateSucceeded),
// 				TypeHandlerVersion: to.Ptr("1.10.0"),
// 			},
// 			{
// 				Name: to.Ptr("Node-2"),
// 				Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent"),
// 				InstanceView: &armazurestackhci.ExtensionInstanceView{
// 					Name: to.Ptr("MicrosoftMonitoringAgent"),
// 					Type: to.Ptr("MicrosoftMonitoringAgent"),
// 					Status: &armazurestackhci.ExtensionInstanceViewStatus{
// 						Code: to.Ptr("error"),
// 						DisplayStatus: to.Ptr("Provisioning failed"),
// 						Level: to.Ptr(armazurestackhci.StatusLevelTypesError),
// 						Message: to.Ptr("Finished executing command, StdOut: , StdErr:"),
// 						Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-08T20:42:10.999Z"); return t}()),
// 					},
// 					TypeHandlerVersion: to.Ptr("1.10.3"),
// 				},
// 				State: to.Ptr(armazurestackhci.NodeExtensionStateFailed),
// 				TypeHandlerVersion: to.Ptr("1.10.3"),
// 		}},
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ExtensionsClient) NewListByArcSettingPager 

func (client *ExtensionsClient) NewListByArcSettingPager(resourceGroupName string, clusterName string, arcSettingName string, options *ExtensionsClientListByArcSettingOptions) *runtime.Pager[ExtensionsClientListByArcSettingResponse]

NewListByArcSettingPager - List all Extensions under ArcSetting resource.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.
  • options - ExtensionsClientListByArcSettingOptions contains the optional parameters for the ExtensionsClient.NewListByArcSettingPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListExtensionsByArcSetting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewExtensionsClient().NewListByArcSettingPager("test-rg", "myCluster", "default", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ExtensionList = armazurestackhci.ExtensionList{
	// 	Value: []*armazurestackhci.Extension{
	// 		{
	// 			Name: to.Ptr("MicrosoftMonitoringAgent"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings/extensions"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Properties: &armazurestackhci.ExtensionProperties{
	// 				AggregateState: to.Ptr(armazurestackhci.ExtensionAggregateStatePartiallyConnected),
	// 				ExtensionParameters: &armazurestackhci.ExtensionParameters{
	// 					Type: to.Ptr("string"),
	// 					AutoUpgradeMinorVersion: to.Ptr(false),
	// 					Publisher: to.Ptr("Microsoft.Compute"),
	// 					Settings: map[string]any{
	// 						"workspaceId": "xx",
	// 					},
	// 					TypeHandlerVersion: to.Ptr("1.10.3"),
	// 				},
	// 				ManagedBy: to.Ptr(armazurestackhci.ExtensionManagedByAzure),
	// 				PerNodeExtensionDetails: []*armazurestackhci.PerNodeExtensionState{
	// 					{
	// 						Name: to.Ptr("Node-1"),
	// 						Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent"),
	// 						State: to.Ptr(armazurestackhci.NodeExtensionStateConnected),
	// 					},
	// 					{
	// 						Name: to.Ptr("Node-2"),
	// 						Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent"),
	// 						State: to.Ptr(armazurestackhci.NodeExtensionStateDisconnected),
	// 				}},
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("CustomScriptExtension"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/arcSettings/extensions"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/Extensions/SecurityExtension"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Properties: &armazurestackhci.ExtensionProperties{
	// 				AggregateState: to.Ptr(armazurestackhci.ExtensionAggregateStatePartiallySucceeded),
	// 				ExtensionParameters: &armazurestackhci.ExtensionParameters{
	// 					Type: to.Ptr("string"),
	// 					AutoUpgradeMinorVersion: to.Ptr(false),
	// 					Publisher: to.Ptr("Microsoft.CustomScriptExtension"),
	// 					Settings: map[string]any{
	// 						"scriptLocation": "xx",
	// 					},
	// 					TypeHandlerVersion: to.Ptr("1.10.3"),
	// 				},
	// 				ManagedBy: to.Ptr(armazurestackhci.ExtensionManagedByAzure),
	// 				PerNodeExtensionDetails: []*armazurestackhci.PerNodeExtensionState{
	// 					{
	// 						Name: to.Ptr("Node-1"),
	// 						Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/SecurityExtension"),
	// 						State: to.Ptr(armazurestackhci.NodeExtensionStateSucceeded),
	// 					},
	// 					{
	// 						Name: to.Ptr("Node-2"),
	// 						Extension: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/SecurityExtension"),
	// 						State: to.Ptr(armazurestackhci.NodeExtensionStateFailed),
	// 				}},
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type ExtensionsClientBeginCreateOptions 

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

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

type ExtensionsClientBeginDeleteOptions 

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

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

type ExtensionsClientBeginUpdateOptions 

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

ExtensionsClientBeginUpdateOptions contains the optional parameters for the ExtensionsClient.BeginUpdate method.

type ExtensionsClientBeginUpgradeOptions 

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

ExtensionsClientBeginUpgradeOptions contains the optional parameters for the ExtensionsClient.BeginUpgrade method.

type ExtensionsClientCreateResponse 

type ExtensionsClientCreateResponse struct {
	// Details of a particular extension in HCI Cluster.
	Extension
}

ExtensionsClientCreateResponse contains the response from method ExtensionsClient.BeginCreate.

type ExtensionsClientDeleteResponse 

type ExtensionsClientDeleteResponse struct {
}

ExtensionsClientDeleteResponse contains the response from method ExtensionsClient.BeginDelete.

type ExtensionsClientGetOptions 

type ExtensionsClientGetOptions struct {
}

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

type ExtensionsClientGetResponse 

type ExtensionsClientGetResponse struct {
	// Details of a particular extension in HCI Cluster.
	Extension
}

ExtensionsClientGetResponse contains the response from method ExtensionsClient.Get.

type ExtensionsClientListByArcSettingOptions 

type ExtensionsClientListByArcSettingOptions struct {
}

ExtensionsClientListByArcSettingOptions contains the optional parameters for the ExtensionsClient.NewListByArcSettingPager method.

type ExtensionsClientListByArcSettingResponse 

type ExtensionsClientListByArcSettingResponse struct {
	// List of Extensions in HCI cluster.
	ExtensionList
}

ExtensionsClientListByArcSettingResponse contains the response from method ExtensionsClient.NewListByArcSettingPager.

type ExtensionsClientUpdateResponse 

type ExtensionsClientUpdateResponse struct {
	// Details of a particular extension in HCI Cluster.
	Extension
}

ExtensionsClientUpdateResponse contains the response from method ExtensionsClient.BeginUpdate.

type ExtensionsClientUpgradeResponse 

type ExtensionsClientUpgradeResponse struct {
}

ExtensionsClientUpgradeResponse contains the response from method ExtensionsClient.BeginUpgrade.

type HciEdgeDevice 

type HciEdgeDevice struct {
	// REQUIRED; Device kind to support polymorphic resource.
	Kind *DeviceKind

	// properties for Arc-enabled edge device with HCI OS.
	Properties *HciEdgeDeviceProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

HciEdgeDevice - Arc-enabled edge device with HCI OS.

func (*HciEdgeDevice) GetEdgeDevice 

func (h *HciEdgeDevice) GetEdgeDevice() *EdgeDevice

GetEdgeDevice implements the EdgeDeviceClassification interface for type HciEdgeDevice.

func (HciEdgeDevice) MarshalJSON 

func (h HciEdgeDevice) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDevice.

func (*HciEdgeDevice) UnmarshalJSON 

func (h *HciEdgeDevice) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDevice.

type HciEdgeDeviceAdapterPropertyOverrides 

type HciEdgeDeviceAdapterPropertyOverrides struct {
	// READ-ONLY; This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM
	// validation.
	JumboPacket *string

	// READ-ONLY; This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM
	// validation.
	NetworkDirect *string

	// READ-ONLY; This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM
	// validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'
	NetworkDirectTechnology *string
}

HciEdgeDeviceAdapterPropertyOverrides - The AdapterPropertyOverrides of a cluster.

func (HciEdgeDeviceAdapterPropertyOverrides) MarshalJSON 

func (h HciEdgeDeviceAdapterPropertyOverrides) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceAdapterPropertyOverrides.

func (*HciEdgeDeviceAdapterPropertyOverrides) UnmarshalJSON 

func (h *HciEdgeDeviceAdapterPropertyOverrides) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceAdapterPropertyOverrides.

type HciEdgeDeviceArcExtension 

type HciEdgeDeviceArcExtension struct {
	// READ-ONLY; Error details while installing Arc extension.
	ErrorDetails []*HciValidationFailureDetail

	// READ-ONLY; Arc extension name installed on edge device.
	ExtensionName *string

	// READ-ONLY; Arc Extension Azure resource id.
	ExtensionResourceID *string

	// READ-ONLY; Extension managed by user or Azure.
	ManagedBy *ExtensionManagedBy

	// READ-ONLY; Arc extension state from arc machine extension.
	State *ArcExtensionState

	// READ-ONLY; Extension version installed.
	TypeHandlerVersion *string
}

HciEdgeDeviceArcExtension - Arc extension installed on edge device.

func (HciEdgeDeviceArcExtension) MarshalJSON 

func (h HciEdgeDeviceArcExtension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceArcExtension.

func (*HciEdgeDeviceArcExtension) UnmarshalJSON 

func (h *HciEdgeDeviceArcExtension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceArcExtension.

type HciEdgeDeviceHostNetwork 

type HciEdgeDeviceHostNetwork struct {
	// READ-ONLY; Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask
	// for Storage NICs when Network ATC is not assigning the IPs for storage automatically.
	EnableStorageAutoIP *bool

	// READ-ONLY; The network intents assigned to the network reference pattern used for the deployment. Each intent will define
	// its own name, traffic type, adapter names, and overrides as recommended by your OEM.
	Intents []*HciEdgeDeviceIntents

	// READ-ONLY; Defines how the storage adapters between nodes are connected either switch or switch less.
	StorageConnectivitySwitchless *bool

	// READ-ONLY; List of StorageNetworks config to deploy AzureStackHCI Cluster.
	StorageNetworks []*HciEdgeDeviceStorageNetworks
}

HciEdgeDeviceHostNetwork - The HostNetwork of a cluster.

func (HciEdgeDeviceHostNetwork) MarshalJSON 

func (h HciEdgeDeviceHostNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceHostNetwork.

func (*HciEdgeDeviceHostNetwork) UnmarshalJSON 

func (h *HciEdgeDeviceHostNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceHostNetwork.

type HciEdgeDeviceIntents 

type HciEdgeDeviceIntents struct {
	// READ-ONLY; Set Adapter PropertyOverrides for cluster.
	AdapterPropertyOverrides *HciEdgeDeviceAdapterPropertyOverrides

	// READ-ONLY; Array of adapters used for the network intent.
	IntentAdapters []*string

	// READ-ONLY; Name of the network intent you wish to create.
	IntentName *string

	// READ-ONLY; IntentType for host network intent.
	IntentType *int64

	// READ-ONLY; IsComputeIntentSet for host network intent.
	IsComputeIntentSet *bool

	// READ-ONLY; IsManagementIntentSet for host network intent.
	IsManagementIntentSet *bool

	// READ-ONLY; IsNetworkIntentType for host network intent.
	IsNetworkIntentType *bool

	// READ-ONLY; IntentType for host network intent.
	IsOnlyStorage *bool

	// READ-ONLY; IsOnlyStretch for host network intent.
	IsOnlyStretch *bool

	// READ-ONLY; IsStorageIntentSet for host network intent.
	IsStorageIntentSet *bool

	// READ-ONLY; IsStretchIntentSet for host network intent.
	IsStretchIntentSet *bool

	// READ-ONLY; This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM
	// validation.
	OverrideAdapterProperty *bool

	// READ-ONLY; This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM
	// validation.
	OverrideQosPolicy *bool

	// READ-ONLY; This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM
	// validation.
	OverrideVirtualSwitchConfiguration *bool

	// READ-ONLY; Set QoS PolicyOverrides for cluster.
	QosPolicyOverrides *QosPolicyOverrides

	// READ-ONLY; Scope for host network intent.
	Scope *int64

	// READ-ONLY; Set virtualSwitch ConfigurationOverrides for cluster.
	VirtualSwitchConfigurationOverrides *HciEdgeDeviceVirtualSwitchConfigurationOverrides
}

HciEdgeDeviceIntents - The Intents of a cluster.

func (HciEdgeDeviceIntents) MarshalJSON 

func (h HciEdgeDeviceIntents) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceIntents.

func (*HciEdgeDeviceIntents) UnmarshalJSON 

func (h *HciEdgeDeviceIntents) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceIntents.

type HciEdgeDeviceProperties 

type HciEdgeDeviceProperties struct {
	// Device Configuration
	DeviceConfiguration *DeviceConfiguration

	// READ-ONLY; Provisioning state of edgeDevice resource
	ProvisioningState *ProvisioningState

	// READ-ONLY; The instance view of all current configurations on HCI device.
	ReportedProperties *HciReportedProperties
}

HciEdgeDeviceProperties - properties for Arc-enabled edge device with HCI OS.

func (HciEdgeDeviceProperties) MarshalJSON 

func (h HciEdgeDeviceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceProperties.

func (*HciEdgeDeviceProperties) UnmarshalJSON 

func (h *HciEdgeDeviceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceProperties.

type HciEdgeDeviceStorageAdapterIPInfo 

type HciEdgeDeviceStorageAdapterIPInfo struct {
	// READ-ONLY; The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster.
	IPv4Address *string

	// READ-ONLY; storage adapter physical node name.
	PhysicalNode *string

	// READ-ONLY; The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster.
	SubnetMask *string
}

HciEdgeDeviceStorageAdapterIPInfo - The StorageAdapter physical nodes of a cluster.

func (HciEdgeDeviceStorageAdapterIPInfo) MarshalJSON 

func (h HciEdgeDeviceStorageAdapterIPInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceStorageAdapterIPInfo.

func (*HciEdgeDeviceStorageAdapterIPInfo) UnmarshalJSON 

func (h *HciEdgeDeviceStorageAdapterIPInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceStorageAdapterIPInfo.

type HciEdgeDeviceStorageNetworks 

type HciEdgeDeviceStorageNetworks struct {
	// READ-ONLY; Name of the storage network.
	Name *string

	// READ-ONLY; Name of the storage network adapter.
	NetworkAdapterName *string

	// READ-ONLY; List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.
	StorageAdapterIPInfo []*HciEdgeDeviceStorageAdapterIPInfo

	// READ-ONLY; ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the
	// storage and VM migration traffic.
	StorageVlanID *string
}

HciEdgeDeviceStorageNetworks - The StorageNetworks of a cluster.

func (HciEdgeDeviceStorageNetworks) MarshalJSON 

func (h HciEdgeDeviceStorageNetworks) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceStorageNetworks.

func (*HciEdgeDeviceStorageNetworks) UnmarshalJSON 

func (h *HciEdgeDeviceStorageNetworks) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceStorageNetworks.

type HciEdgeDeviceVirtualSwitchConfigurationOverrides 

type HciEdgeDeviceVirtualSwitchConfigurationOverrides struct {
	// READ-ONLY; Enable IoV for Virtual Switch
	EnableIov *string

	// READ-ONLY; Load Balancing Algorithm for Virtual Switch
	LoadBalancingAlgorithm *string
}

HciEdgeDeviceVirtualSwitchConfigurationOverrides - The VirtualSwitchConfigurationOverrides of a cluster.

func (HciEdgeDeviceVirtualSwitchConfigurationOverrides) MarshalJSON 

func (h HciEdgeDeviceVirtualSwitchConfigurationOverrides) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciEdgeDeviceVirtualSwitchConfigurationOverrides.

func (*HciEdgeDeviceVirtualSwitchConfigurationOverrides) UnmarshalJSON 

func (h *HciEdgeDeviceVirtualSwitchConfigurationOverrides) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciEdgeDeviceVirtualSwitchConfigurationOverrides.

type HciNetworkProfile 

type HciNetworkProfile struct {
	// READ-ONLY; HostNetwork config to deploy AzureStackHCI Cluster.
	HostNetwork *HciEdgeDeviceHostNetwork

	// READ-ONLY; List of NIC Details of device.
	NicDetails []*HciNicDetail

	// READ-ONLY; List of switch details for edge device.
	SwitchDetails []*SwitchDetail
}

HciNetworkProfile - The network profile of a device.

func (HciNetworkProfile) MarshalJSON 

func (h HciNetworkProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciNetworkProfile.

func (*HciNetworkProfile) UnmarshalJSON 

func (h *HciNetworkProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciNetworkProfile.

type HciNicDetail 

type HciNicDetail struct {
	// READ-ONLY; Adapter Name of NIC
	AdapterName *string

	// READ-ONLY; Component Id of NIC
	ComponentID *string

	// READ-ONLY; DNS Servers for NIC
	DNSServers []*string

	// READ-ONLY; Default Gateway of NIC
	DefaultGateway *string

	// READ-ONLY; Default Isolation of Management NIC
	DefaultIsolationID *string

	// READ-ONLY; Driver Version of NIC
	DriverVersion *string

	// READ-ONLY; Interface Description of NIC
	InterfaceDescription *string

	// READ-ONLY; Subnet Mask of NIC
	Ip4Address *string

	// READ-ONLY; MAC address information of NIC.
	MacAddress *string

	// READ-ONLY; The status of NIC, up, disconnected.
	NicStatus *string

	// READ-ONLY; The type of NIC, physical, virtual, management.
	NicType *string

	// READ-ONLY; The slot attached to the NIC.
	Slot *string

	// READ-ONLY; Subnet Mask of NIC
	SubnetMask *string

	// READ-ONLY; The switch attached to the NIC, if any.
	SwitchName *string

	// READ-ONLY; The VLAN ID of the physical NIC.
	VlanID *string
}

HciNicDetail - The NIC Detail of a device.

func (HciNicDetail) MarshalJSON 

func (h HciNicDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciNicDetail.

func (*HciNicDetail) UnmarshalJSON 

func (h *HciNicDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciNicDetail.

type HciOsProfile 

type HciOsProfile struct {
	// READ-ONLY; Version of assembly present on device
	AssemblyVersion *string

	// READ-ONLY; The boot type of the device. e.g. UEFI, Legacy etc
	BootType *string
}

HciOsProfile - OS configurations for HCI device.

func (HciOsProfile) MarshalJSON 

func (h HciOsProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciOsProfile.

func (*HciOsProfile) UnmarshalJSON 

func (h *HciOsProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciOsProfile.

type HciReportedProperties 

type HciReportedProperties struct {
	// READ-ONLY; edge device state.
	DeviceState *DeviceState

	// READ-ONLY; Extensions details for edge device.
	ExtensionProfile *ExtensionProfile

	// READ-ONLY; HCI device network information.
	NetworkProfile *HciNetworkProfile

	// READ-ONLY; HCI device OS specific information.
	OSProfile *HciOsProfile

	// READ-ONLY; Solution builder extension (SBE) deployment package information.
	SbeDeploymentPackageInfo *SbeDeploymentPackageInfo
}

HciReportedProperties - The device Configuration for HCI device.

func (HciReportedProperties) MarshalJSON 

func (h HciReportedProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciReportedProperties.

func (*HciReportedProperties) UnmarshalJSON 

func (h *HciReportedProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciReportedProperties.

type HciValidationFailureDetail 

type HciValidationFailureDetail struct {
	// READ-ONLY; Exception details while installing extension.
	Exception *string
}

HciValidationFailureDetail - details of validation failure

func (HciValidationFailureDetail) MarshalJSON 

func (h HciValidationFailureDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HciValidationFailureDetail.

func (*HciValidationFailureDetail) UnmarshalJSON 

func (h *HciValidationFailureDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HciValidationFailureDetail.

type HealthState 

type HealthState string
const (
	HealthStateError      HealthState = "Error"
	HealthStateFailure    HealthState = "Failure"
	HealthStateInProgress HealthState = "InProgress"
	HealthStateSuccess    HealthState = "Success"
	HealthStateUnknown    HealthState = "Unknown"
	HealthStateWarning    HealthState = "Warning"
)

func PossibleHealthStateValues 

func PossibleHealthStateValues() []HealthState

PossibleHealthStateValues returns the possible values for the HealthState const type.

type IPPools 

type IPPools struct {
	// Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs)
	// are needed for infrastructure services such as clustering.
	EndingAddress *string

	// Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs)
	// are needed for infrastructure services such as clustering.
	StartingAddress *string
}

IPPools - The dnsServers of a device.

func (IPPools) MarshalJSON 

func (i IPPools) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPPools.

func (*IPPools) UnmarshalJSON 

func (i *IPPools) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPPools.

type ImdsAttestation 

type ImdsAttestation string

ImdsAttestation - IMDS attestation status of the cluster. 

const (
	ImdsAttestationDisabled ImdsAttestation = "Disabled"
	ImdsAttestationEnabled  ImdsAttestation = "Enabled"
)

func PossibleImdsAttestationValues 

func PossibleImdsAttestationValues() []ImdsAttestation

PossibleImdsAttestationValues returns the possible values for the ImdsAttestation const type.

type InfrastructureNetwork 

type InfrastructureNetwork struct {
	// IPv4 address of the DNS servers in your environment.
	DNSServers []*string

	// Default gateway that should be used for the provided IP address space.
	Gateway *string

	// Range of IP addresses from which addresses are allocated for nodes within a subnet.
	IPPools []*IPPools

	// Subnet mask that matches the provided IP address space.
	SubnetMask *string

	// Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When
	// true, GW and DNS servers are not required
	UseDhcp *bool
}

InfrastructureNetwork - The InfrastructureNetwork of a AzureStackHCI Cluster.

func (InfrastructureNetwork) MarshalJSON 

func (i InfrastructureNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InfrastructureNetwork.

func (*InfrastructureNetwork) UnmarshalJSON 

func (i *InfrastructureNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InfrastructureNetwork.

type IsolatedVMAttestationConfiguration 

type IsolatedVMAttestationConfiguration struct {
	// READ-ONLY; Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.
	AttestationResourceID *string

	// READ-ONLY; Region specific endpoint for Microsoft Azure Attestation service for the cluster
	AttestationServiceEndpoint *string

	// READ-ONLY; Region specific endpoint for relying party service.
	RelyingPartyServiceEndpoint *string
}

IsolatedVMAttestationConfiguration - Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.

func (IsolatedVMAttestationConfiguration) MarshalJSON 

func (i IsolatedVMAttestationConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IsolatedVMAttestationConfiguration.

func (*IsolatedVMAttestationConfiguration) UnmarshalJSON 

func (i *IsolatedVMAttestationConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IsolatedVMAttestationConfiguration.

type LogCollectionError 

type LogCollectionError struct {
	// READ-ONLY; Error Code of the log collection
	ErrorCode *string

	// READ-ONLY; Error Message of the log collection
	ErrorMessage *string
}

LogCollectionError - Log Collection Error details of the cluster.

func (LogCollectionError) MarshalJSON 

func (l LogCollectionError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogCollectionError.

func (*LogCollectionError) UnmarshalJSON 

func (l *LogCollectionError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogCollectionError.

type LogCollectionJobType 

type LogCollectionJobType string

LogCollectionJobType - LogCollection job type 

const (
	LogCollectionJobTypeOnDemand  LogCollectionJobType = "OnDemand"
	LogCollectionJobTypeScheduled LogCollectionJobType = "Scheduled"
)

func PossibleLogCollectionJobTypeValues 

func PossibleLogCollectionJobTypeValues() []LogCollectionJobType

PossibleLogCollectionJobTypeValues returns the possible values for the LogCollectionJobType const type.

type LogCollectionProperties 

type LogCollectionProperties struct {
	// READ-ONLY; From DateTimeStamp from when logs need to be connected
	FromDate *time.Time

	// READ-ONLY; Recent DateTimeStamp where logs are successfully generated
	LastLogGenerated *time.Time

	// READ-ONLY
	LogCollectionSessionDetails []*LogCollectionSession

	// READ-ONLY; To DateTimeStamp till when logs need to be connected
	ToDate *time.Time
}

LogCollectionProperties - Log Collection properties of the cluster.

func (LogCollectionProperties) MarshalJSON 

func (l LogCollectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogCollectionProperties.

func (*LogCollectionProperties) UnmarshalJSON 

func (l *LogCollectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogCollectionProperties.

type LogCollectionRequest 

type LogCollectionRequest struct {
	// Properties for Log Collection Request
	Properties *LogCollectionRequestProperties
}

LogCollectionRequest - Log Collection Request

func (LogCollectionRequest) MarshalJSON 

func (l LogCollectionRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogCollectionRequest.

func (*LogCollectionRequest) UnmarshalJSON 

func (l *LogCollectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogCollectionRequest.

type LogCollectionRequestProperties 

type LogCollectionRequestProperties struct {
	// REQUIRED; From DateTimeStamp from when logs need to be connected
	FromDate *time.Time

	// REQUIRED; To DateTimeStamp till when logs need to be connected
	ToDate *time.Time
}

LogCollectionRequestProperties - Properties for Log Collection Request

func (LogCollectionRequestProperties) MarshalJSON 

func (l LogCollectionRequestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogCollectionRequestProperties.

func (*LogCollectionRequestProperties) UnmarshalJSON 

func (l *LogCollectionRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogCollectionRequestProperties.

type LogCollectionSession 

type LogCollectionSession struct {
	// READ-ONLY; CorrelationId of the log collection
	CorrelationID *string

	// READ-ONLY; End Time of the logs when it was collected
	EndTimeCollected *time.Time

	// READ-ONLY; Log Collection Error details of the cluster.
	LogCollectionError *LogCollectionError

	// READ-ONLY; LogCollection job type
	LogCollectionJobType *LogCollectionJobType

	// READ-ONLY; LogCollection status
	LogCollectionStatus *LogCollectionStatus

	// READ-ONLY; End Time of the logs when it was collected
	LogEndTime *time.Time

	// READ-ONLY; Size of the logs collected
	LogSize *int64

	// READ-ONLY; Start Time of the logs when it was collected
	LogStartTime *time.Time

	// READ-ONLY; Duration of logs collected
	TimeCollected *time.Time
}

LogCollectionSession - Log Collection Session details of the cluster.

func (LogCollectionSession) MarshalJSON 

func (l LogCollectionSession) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogCollectionSession.

func (*LogCollectionSession) UnmarshalJSON 

func (l *LogCollectionSession) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogCollectionSession.

type LogCollectionStatus 

type LogCollectionStatus string

LogCollectionStatus - LogCollection status 

const (
	LogCollectionStatusFailed     LogCollectionStatus = "Failed"
	LogCollectionStatusInProgress LogCollectionStatus = "InProgress"
	LogCollectionStatusNone       LogCollectionStatus = "None"
	LogCollectionStatusSucceeded  LogCollectionStatus = "Succeeded"
)

func PossibleLogCollectionStatusValues 

func PossibleLogCollectionStatusValues() []LogCollectionStatus

PossibleLogCollectionStatusValues returns the possible values for the LogCollectionStatus const type.

type ManagedServiceIdentity 

type ManagedServiceIdentity struct {
	// REQUIRED; Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
	Type *ManagedServiceIdentityType

	// The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
	// The dictionary values can be empty objects ({}) in
	// requests.
	UserAssignedIdentities map[string]*UserAssignedIdentity

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string
}

ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)

func (ManagedServiceIdentity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedServiceIdentity.

func (*ManagedServiceIdentity) UnmarshalJSON 

func (m *ManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedServiceIdentity.

type ManagedServiceIdentityType 

type ManagedServiceIdentityType string

ManagedServiceIdentityType - Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 

const (
	ManagedServiceIdentityTypeNone                       ManagedServiceIdentityType = "None"
	ManagedServiceIdentityTypeSystemAssigned             ManagedServiceIdentityType = "SystemAssigned"
	ManagedServiceIdentityTypeSystemAssignedUserAssigned ManagedServiceIdentityType = "SystemAssigned, UserAssigned"
	ManagedServiceIdentityTypeUserAssigned               ManagedServiceIdentityType = "UserAssigned"
)

func PossibleManagedServiceIdentityTypeValues 

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

PossibleManagedServiceIdentityTypeValues returns the possible values for the ManagedServiceIdentityType const type.

type NetworkController 

type NetworkController struct {
	// macAddressPoolStart of network controller used for SDN Integration.
	MacAddressPoolStart *string

	// macAddressPoolStop of network controller used for SDN Integration.
	MacAddressPoolStop *string

	// NetworkVirtualizationEnabled of network controller used for SDN Integration.
	NetworkVirtualizationEnabled *bool
}

NetworkController - network controller config for SDN Integration to deploy AzureStackHCI Cluster.

func (NetworkController) MarshalJSON 

func (n NetworkController) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkController.

func (*NetworkController) UnmarshalJSON 

func (n *NetworkController) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkController.

type NicDetail 

type NicDetail struct {
	// Adapter Name of NIC
	AdapterName *string

	// Component Id of NIC
	ComponentID *string

	// DNS Servers for NIC
	DNSServers []*string

	// Default Gateway of NIC
	DefaultGateway *string

	// Default Isolation of Management NIC
	DefaultIsolationID *string

	// Driver Version of NIC
	DriverVersion *string

	// Interface Description of NIC
	InterfaceDescription *string

	// Subnet Mask of NIC
	Ip4Address *string

	// Subnet Mask of NIC
	SubnetMask *string
}

NicDetail - The NIC Detail of a device.

func (NicDetail) MarshalJSON 

func (n NicDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NicDetail.

func (*NicDetail) UnmarshalJSON 

func (n *NicDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NicDetail.

type NodeArcState 

type NodeArcState string

NodeArcState - State of Arc agent in this node. 

const (
	NodeArcStateAccepted           NodeArcState = "Accepted"
	NodeArcStateCanceled           NodeArcState = "Canceled"
	NodeArcStateConnected          NodeArcState = "Connected"
	NodeArcStateCreating           NodeArcState = "Creating"
	NodeArcStateDeleted            NodeArcState = "Deleted"
	NodeArcStateDeleting           NodeArcState = "Deleting"
	NodeArcStateDisableInProgress  NodeArcState = "DisableInProgress"
	NodeArcStateDisconnected       NodeArcState = "Disconnected"
	NodeArcStateError              NodeArcState = "Error"
	NodeArcStateFailed             NodeArcState = "Failed"
	NodeArcStateInProgress         NodeArcState = "InProgress"
	NodeArcStateMoving             NodeArcState = "Moving"
	NodeArcStateNotSpecified       NodeArcState = "NotSpecified"
	NodeArcStatePartiallyConnected NodeArcState = "PartiallyConnected"
	NodeArcStatePartiallySucceeded NodeArcState = "PartiallySucceeded"
	NodeArcStateProvisioning       NodeArcState = "Provisioning"
	NodeArcStateSucceeded          NodeArcState = "Succeeded"
	NodeArcStateUpdating           NodeArcState = "Updating"
)

func PossibleNodeArcStateValues 

func PossibleNodeArcStateValues() []NodeArcState

PossibleNodeArcStateValues returns the possible values for the NodeArcState const type.

type NodeExtensionState 

type NodeExtensionState string

NodeExtensionState - State of Arc Extension in this node. 

const (
	NodeExtensionStateAccepted           NodeExtensionState = "Accepted"
	NodeExtensionStateCanceled           NodeExtensionState = "Canceled"
	NodeExtensionStateConnected          NodeExtensionState = "Connected"
	NodeExtensionStateCreating           NodeExtensionState = "Creating"
	NodeExtensionStateDeleted            NodeExtensionState = "Deleted"
	NodeExtensionStateDeleting           NodeExtensionState = "Deleting"
	NodeExtensionStateDisconnected       NodeExtensionState = "Disconnected"
	NodeExtensionStateError              NodeExtensionState = "Error"
	NodeExtensionStateFailed             NodeExtensionState = "Failed"
	NodeExtensionStateInProgress         NodeExtensionState = "InProgress"
	NodeExtensionStateMoving             NodeExtensionState = "Moving"
	NodeExtensionStateNotSpecified       NodeExtensionState = "NotSpecified"
	NodeExtensionStatePartiallyConnected NodeExtensionState = "PartiallyConnected"
	NodeExtensionStatePartiallySucceeded NodeExtensionState = "PartiallySucceeded"
	NodeExtensionStateProvisioning       NodeExtensionState = "Provisioning"
	NodeExtensionStateSucceeded          NodeExtensionState = "Succeeded"
	NodeExtensionStateUpdating           NodeExtensionState = "Updating"
)

func PossibleNodeExtensionStateValues 

func PossibleNodeExtensionStateValues() []NodeExtensionState

PossibleNodeExtensionStateValues returns the possible values for the NodeExtensionState const type.

type Observability 

type Observability struct {
	// When set to true, collects log data to facilitate quicker issue resolution.
	EpisodicDataUpload *bool

	// Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where
	// your cluster resides. Setting this to false results in all data sent to
	// Microsoft to be stored outside of the EU.
	EuLocation *bool

	// Enables telemetry data to be sent to Microsoft
	StreamingDataClient *bool
}

Observability - The Observability of AzureStackHCI Cluster.

func (Observability) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Observability.

func (*Observability) UnmarshalJSON 

func (o *Observability) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Observability.

type OemActivation 

type OemActivation string

OemActivation - OEM activation status of the cluster. 

const (
	OemActivationDisabled OemActivation = "Disabled"
	OemActivationEnabled  OemActivation = "Enabled"
)

func PossibleOemActivationValues 

func PossibleOemActivationValues() []OemActivation

PossibleOemActivationValues returns the possible values for the OemActivation const type.

type Offer 

type Offer struct {
	// Offer properties.
	Properties *OfferProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Offer details.

func (Offer) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Offer.

func (*Offer) UnmarshalJSON 

func (o *Offer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Offer.

type OfferList 

type OfferList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; List of Offer proxy resources.
	Value []*Offer
}

OfferList - List of Offer proxy resources for the HCI cluster.

func (OfferList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OfferList.

func (*OfferList) UnmarshalJSON 

func (o *OfferList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OfferList.

type OfferProperties 

type OfferProperties struct {
	// JSON serialized catalog content of the offer
	Content *string

	// The API version of the catalog service used to serve the catalog content
	ContentVersion *string

	// Identifier of the Publisher for the offer
	PublisherID *string

	// Array of SKU mappings
	SKUMappings []*SKUMappings

	// READ-ONLY; Provisioning State
	ProvisioningState *string
}

OfferProperties - Publisher properties.

func (OfferProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OfferProperties.

func (*OfferProperties) UnmarshalJSON 

func (o *OfferProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OfferProperties.

type OffersClient 

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

OffersClient contains the methods for the Offers group. Don't use this type directly, use NewOffersClient() instead.

func NewOffersClient 

func NewOffersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OffersClient, error)

NewOffersClient creates a new instance of OffersClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OffersClient) Get 

func (client *OffersClient) Get(ctx context.Context, resourceGroupName string, clusterName string, publisherName string, offerName string, options *OffersClientGetOptions) (OffersClientGetResponse, error)

Get - Get Offer resource details within a publisher of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • publisherName - The name of the publisher available within HCI cluster.
  • offerName - The name of the offer available within HCI cluster.
  • options - OffersClientGetOptions contains the optional parameters for the OffersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetOffer.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOffersClient().Get(ctx, "test-rg", "myCluster", "publisher1", "offer1", &armazurestackhci.OffersClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Offer = armazurestackhci.Offer{
// 	Name: to.Ptr("offer1"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers/offers"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1"),
// 	Properties: &armazurestackhci.OfferProperties{
// 		Content: to.Ptr("{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17.  Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}"),
// 		ContentVersion: to.Ptr("2018-01-01"),
// 		ProvisioningState: to.Ptr("Succeeded"),
// 		PublisherID: to.Ptr("publisher1"),
// 		SKUMappings: []*armazurestackhci.SKUMappings{
// 			{
// 				CatalogPlanID: to.Ptr("microsoftsqlserver.sql2019-ubuntu2004enterprise-arm"),
// 				MarketplaceSKUID: to.Ptr("enterprise"),
// 				MarketplaceSKUVersions: []*string{
// 					to.Ptr("15.0.220208")},
// 			}},
// 		},
// 	}

Output:

func (*OffersClient) NewListByClusterPager 

func (client *OffersClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *OffersClientListByClusterOptions) *runtime.Pager[OffersClientListByClusterResponse]

NewListByClusterPager - List Offers available across publishers for the HCI Cluster.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - OffersClientListByClusterOptions contains the optional parameters for the OffersClient.NewListByClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOffersClient().NewListByClusterPager("test-rg", "myCluster", &armazurestackhci.OffersClientListByClusterOptions{Expand: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OfferList = armazurestackhci.OfferList{
	// 	Value: []*armazurestackhci.Offer{
	// 		{
	// 			Name: to.Ptr("offer1"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers/offers"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1"),
	// 			Properties: &armazurestackhci.OfferProperties{
	// 				Content: to.Ptr("{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17.  Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}"),
	// 				ContentVersion: to.Ptr("2018-01-01"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				PublisherID: to.Ptr("publisher1"),
	// 				SKUMappings: []*armazurestackhci.SKUMappings{
	// 					{
	// 						CatalogPlanID: to.Ptr("microsoftsqlserver.sql2019-ubuntu2004enterprise-arm"),
	// 						MarketplaceSKUID: to.Ptr("enterprise"),
	// 						MarketplaceSKUVersions: []*string{
	// 							to.Ptr("15.0.220208")},
	// 					}},
	// 				},
	// 		}},
	// 	}
}

Output:

func (*OffersClient) NewListByPublisherPager 

func (client *OffersClient) NewListByPublisherPager(resourceGroupName string, clusterName string, publisherName string, options *OffersClientListByPublisherOptions) *runtime.Pager[OffersClientListByPublisherResponse]

NewListByPublisherPager - List Offers available for a publisher within the HCI Cluster.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • publisherName - The name of the publisher available within HCI cluster.
  • options - OffersClientListByPublisherOptions contains the optional parameters for the OffersClient.NewListByPublisherPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListOffersByPublisher.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOffersClient().NewListByPublisherPager("test-rg", "myCluster", "publisher1", &armazurestackhci.OffersClientListByPublisherOptions{Expand: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OfferList = armazurestackhci.OfferList{
	// 	Value: []*armazurestackhci.Offer{
	// 		{
	// 			Name: to.Ptr("offer1"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers/offers"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1"),
	// 			Properties: &armazurestackhci.OfferProperties{
	// 				Content: to.Ptr("{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17.  Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}"),
	// 				ContentVersion: to.Ptr("2018-01-01"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				PublisherID: to.Ptr("publisher1"),
	// 				SKUMappings: []*armazurestackhci.SKUMappings{
	// 					{
	// 						CatalogPlanID: to.Ptr("microsoftsqlserver.sql2019-ubuntu2004enterprise-arm"),
	// 						MarketplaceSKUID: to.Ptr("enterprise"),
	// 						MarketplaceSKUVersions: []*string{
	// 							to.Ptr("15.0.220208")},
	// 					}},
	// 				},
	// 		}},
	// 	}
}

Output:

type OffersClientGetOptions 

type OffersClientGetOptions struct {
	// Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.
	Expand *string
}

OffersClientGetOptions contains the optional parameters for the OffersClient.Get method.

type OffersClientGetResponse 

type OffersClientGetResponse struct {
	// Offer details.
	Offer
}

OffersClientGetResponse contains the response from method OffersClient.Get.

type OffersClientListByClusterOptions 

type OffersClientListByClusterOptions struct {
	// Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.
	Expand *string
}

OffersClientListByClusterOptions contains the optional parameters for the OffersClient.NewListByClusterPager method.

type OffersClientListByClusterResponse 

type OffersClientListByClusterResponse struct {
	// List of Offer proxy resources for the HCI cluster.
	OfferList
}

OffersClientListByClusterResponse contains the response from method OffersClient.NewListByClusterPager.

type OffersClientListByPublisherOptions 

type OffersClientListByPublisherOptions struct {
	// Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.
	Expand *string
}

OffersClientListByPublisherOptions contains the optional parameters for the OffersClient.NewListByPublisherPager method.

type OffersClientListByPublisherResponse 

type OffersClientListByPublisherResponse struct {
	// List of Offer proxy resources for the HCI cluster.
	OfferList
}

OffersClientListByPublisherResponse contains the response from method OffersClient.NewListByPublisherPager.

type Operation 

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane
	// operations.
	IsDataAction *bool

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
	// "Microsoft.Compute/virtualMachines/capture/action"
	Name *string

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
	// value is "user,system"
	Origin *Origin
}

Operation - Details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
	// Machine", "Restart Virtual Machine".
	Operation *string

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
	// Compute".
	Provider *string

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
	// Schedule Collections".
	Resource *string
}

OperationDisplay - Localized display information for this particular operation.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation
}

OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an 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.

func (*OperationListResult) UnmarshalJSON 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationType 

type OperationType string

OperationType - The intended operation for a cluster. 

const (
	// OperationTypeClusterProvisioning - Cluster provisioning operation.
	OperationTypeClusterProvisioning OperationType = "ClusterProvisioning"
	// OperationTypeClusterUpgrade - Cluster upgrade operation.
	OperationTypeClusterUpgrade OperationType = "ClusterUpgrade"
)

func PossibleOperationTypeValues 

func PossibleOperationTypeValues() []OperationType

PossibleOperationTypeValues returns the possible values for the OperationType const type.

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) List 

func (client *OperationsClient) List(ctx context.Context, options *OperationsClientListOptions) (OperationsClientListResponse, error)

List - List all available Microsoft.AzureStackHCI provider operations If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/stable/2024-04-01/examples/ListOperations.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationsClient().List(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationListResult = armazurestackhci.OperationListResult{
// 	Value: []*armazurestackhci.Operation{
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Register/Action"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Registers the subscription for the Azure Stack HCI resource provider and enables the creation of Azure Stack HCI resources."),
// 				Operation: to.Ptr("Registers the Azure Stack HCI Resource Provider"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Register"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Unregister/Action"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Unregisters the subscription for the Azure Stack HCI resource provider."),
// 				Operation: to.Ptr("Unregisters the Azure Stack HCI Resource Provider"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Unregister"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Operations/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets operations"),
// 				Operation: to.Ptr("Gets/List operations resources"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Operations"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets clusters"),
// 				Operation: to.Ptr("Gets/List cluster resources"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates or updates a cluster"),
// 				Operation: to.Ptr("Create/update cluster resources"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes cluster resource"),
// 				Operation: to.Ptr("Deletes cluster resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/ArcSettings/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets arc resource of HCI cluster"),
// 				Operation: to.Ptr("Gets/List arc resources"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/ArcSettings"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/ArcSettings/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Create or updates arc resource of HCI cluster"),
// 				Operation: to.Ptr("Create/Update arc resources"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/ArcSettings"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/ArcSettings/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Delete arc resource of HCI cluster"),
// 				Operation: to.Ptr("Delete arc resources"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/ArcSettings"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets extension resource of HCI cluster"),
// 				Operation: to.Ptr("Gets/List extension resources of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/ArcSettings/Extensions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Create or update extension resource of HCI cluster"),
// 				Operation: to.Ptr("Create/Update extension resources of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/ArcSettings/Extensions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Delete extension resources of HCI cluster"),
// 				Operation: to.Ptr("Delete extension resources of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/ArcSettings/Extensions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Restart/Action"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Restarts virtual machine resource"),
// 				Operation: to.Ptr("Restarts virtual machine resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Start/Action"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Starts virtual machine resource"),
// 				Operation: to.Ptr("Starts virtual machine resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Stop/Action"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Stops virtual machine resource"),
// 				Operation: to.Ptr("Stops virtual machine resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes virtual machine resource"),
// 				Operation: to.Ptr("Deletes virtual machine resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates/Updates virtual machine resource"),
// 				Operation: to.Ptr("Creates/Updates virtual machine resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists virtual machine resource"),
// 				Operation: to.Ptr("Gets/Lists virtual machine resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualNetworks/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes virtual networks resource"),
// 				Operation: to.Ptr("Deletes virtual networks resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualNetworks"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualNetworks/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates/Updates virtual networks resource"),
// 				Operation: to.Ptr("Creates/Updates virtual networks resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualNetworks"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualNetworks/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists virtual networks resource"),
// 				Operation: to.Ptr("Gets/Lists virtual networks resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualNetworks"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualHardDisks/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes virtual hard disk resource"),
// 				Operation: to.Ptr("Deletes virtual hard disk resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualHardDisks"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualHardDisks/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates/Updates virtual hard disk resource"),
// 				Operation: to.Ptr("Creates/Updates virtual hard disk resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualHardDisks"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualHardDisks/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists virtual hard disk resource"),
// 				Operation: to.Ptr("Gets/Lists virtual hard disk resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualHardDisks"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/NetworkInterfaces/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes network interfaces resource"),
// 				Operation: to.Ptr("Deletes network interfaces resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("NetworkInterfaces"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/NetworkInterfaces/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates/Updates network interfaces resource"),
// 				Operation: to.Ptr("Creates/Updates network interfaces resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("NetworkInterfaces"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/NetworkInterfaces/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists network interfaces resource"),
// 				Operation: to.Ptr("Gets/Lists network interfaces resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("NetworkInterfaces"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/GalleryImages/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes gallery images resource"),
// 				Operation: to.Ptr("Deletes gallery images resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("GalleryImages"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/GalleryImages/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates/Updates gallery images resource"),
// 				Operation: to.Ptr("Creates/Updates gallery images resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("GalleryImages"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/GalleryImages/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists gallery images resource"),
// 				Operation: to.Ptr("Gets/Lists gallery images resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("GalleryImages"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/HybridIdentityMetadata/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists virtual machine hybrid identity metadata proxy resource"),
// 				Operation: to.Ptr("Gets/Lists virtual machine hybrid identity metadata proxy resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines/HybridIdentityMetadata"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Extensions/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets/Lists virtual machine extensions resource"),
// 				Operation: to.Ptr("Gets/Lists virtual machine extensions resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines/Extensions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Extensions/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Creates/Updates virtual machine extensions resource"),
// 				Operation: to.Ptr("Creates/Updates virtual machine extensions resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines/Extensions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/VirtualMachines/Extensions/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Deletes virtual machine extensions resource"),
// 				Operation: to.Ptr("Deletes virtual machine extensions resource"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("VirtualMachines/Extensions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/RegisteredSubscriptions/read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Reads registered subscriptions"),
// 				Operation: to.Ptr("Gets/Lists registered subscriptions"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("RegisteredSubscriptions"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Updates/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets available updates for HCI cluster"),
// 				Operation: to.Ptr("Gets/List available updates for HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/Updates"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Updates/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Create or update updates resource of HCI cluster"),
// 				Operation: to.Ptr("Create/Update updates resource of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/Updates"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Updates/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Delete updates resources of HCI cluster"),
// 				Operation: to.Ptr("Delete updates resources of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/Updates"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets available update summaries for HCI cluster"),
// 				Operation: to.Ptr("Gets/List available update summaries for HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/UpdateSummaries"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Create or update update summaries resource of HCI cluster"),
// 				Operation: to.Ptr("Create/Update update summaries resource of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/UpdateSummaries"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Delete update summaries resources of HCI cluster"),
// 				Operation: to.Ptr("Delete updates resource summaries of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/UpdateSummaries"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Read"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Gets available update runs for HCI cluster"),
// 				Operation: to.Ptr("Gets/List available update runs for HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/Updates/UpdateRuns"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Write"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Create or update update runs resource of HCI cluster"),
// 				Operation: to.Ptr("Create/Update update runs resource of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/Updates/UpdateRuns"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 		},
// 		{
// 			Name: to.Ptr("Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Delete"),
// 			Display: &armazurestackhci.OperationDisplay{
// 				Description: to.Ptr("Delete update runs resources of HCI cluster"),
// 				Operation: to.Ptr("Delete updates resource runs of HCI cluster"),
// 				Provider: to.Ptr("Microsoft.AzureStackHCI"),
// 				Resource: to.Ptr("Clusters/Updates/UpdateRuns"),
// 			},
// 			IsDataAction: to.Ptr(false),
// 	}},
// }

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

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

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OptionalServices 

type OptionalServices struct {
	// The name of custom location.
	CustomLocation *string
}

OptionalServices - The OptionalServices of AzureStackHCI Cluster.

func (OptionalServices) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OptionalServices.

func (*OptionalServices) UnmarshalJSON 

func (o *OptionalServices) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OptionalServices.

type Origin 

type Origin string

Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" 

const (
	OriginSystem     Origin = "system"
	OriginUser       Origin = "user"
	OriginUserSystem Origin = "user,system"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

type PackageVersionInfo 

type PackageVersionInfo struct {
	// Last time this component was updated.
	LastUpdated *time.Time

	// Package type
	PackageType *string

	// Package version
	Version *string
}

PackageVersionInfo - Current version of each updatable component.

func (PackageVersionInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PackageVersionInfo.

func (*PackageVersionInfo) UnmarshalJSON 

func (p *PackageVersionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PackageVersionInfo.

type PasswordCredential 

type PasswordCredential struct {
	EndDateTime   *time.Time
	KeyID         *string
	SecretText    *string
	StartDateTime *time.Time
}

func (PasswordCredential) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PasswordCredential.

func (*PasswordCredential) UnmarshalJSON 

func (p *PasswordCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PasswordCredential.

type PerNodeExtensionState 

type PerNodeExtensionState struct {
	// READ-ONLY; Fully qualified resource ID for the particular Arc Extension on this node.
	Extension *string

	// READ-ONLY; The extension instance view.
	InstanceView *ExtensionInstanceView

	// READ-ONLY; Name of the node in HCI Cluster.
	Name *string

	// READ-ONLY; State of Arc Extension in this node.
	State *NodeExtensionState

	// READ-ONLY; Specifies the version of the script handler.
	TypeHandlerVersion *string
}

PerNodeExtensionState - Status of Arc Extension for a particular node in HCI Cluster.

func (PerNodeExtensionState) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PerNodeExtensionState.

func (*PerNodeExtensionState) UnmarshalJSON 

func (p *PerNodeExtensionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PerNodeExtensionState.

type PerNodeRemoteSupportSession 

type PerNodeRemoteSupportSession struct {
	// READ-ONLY; Remote Support Access Level
	AccessLevel *AccessLevel

	// READ-ONLY; Duration of Remote Support Enablement
	Duration *int64

	// READ-ONLY; Name of the node
	NodeName *string

	// READ-ONLY; Remote Support Session EndTime on the Node
	SessionEndTime *time.Time

	// READ-ONLY; Remote Support Session StartTime on the Node
	SessionStartTime *time.Time
}

PerNodeRemoteSupportSession - Remote Support Node Session Details on the Node.

func (PerNodeRemoteSupportSession) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PerNodeRemoteSupportSession.

func (*PerNodeRemoteSupportSession) UnmarshalJSON 

func (p *PerNodeRemoteSupportSession) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PerNodeRemoteSupportSession.

type PerNodeState 

type PerNodeState struct {
	// READ-ONLY; Fully qualified resource ID for the Arc agent of this node.
	ArcInstance *string

	// READ-ONLY; The service principal id of the arc for server node
	ArcNodeServicePrincipalObjectID *string

	// READ-ONLY; Name of the Node in HCI Cluster
	Name *string

	// READ-ONLY; State of Arc agent in this node.
	State *NodeArcState
}

PerNodeState - Status of Arc agent for a particular node in HCI Cluster.

func (PerNodeState) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PerNodeState.

func (*PerNodeState) UnmarshalJSON 

func (p *PerNodeState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PerNodeState.

type PhysicalNodes 

type PhysicalNodes struct {
	// The IPv4 address assigned to each physical server on your Azure Stack HCI cluster.
	IPv4Address *string

	// NETBIOS name of each physical server on your Azure Stack HCI cluster.
	Name *string
}

PhysicalNodes - The PhysicalNodes of a cluster.

func (PhysicalNodes) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PhysicalNodes.

func (*PhysicalNodes) UnmarshalJSON 

func (p *PhysicalNodes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PhysicalNodes.

type PrecheckResult 

type PrecheckResult struct {
	// Property bag of key value pairs for additional information.
	AdditionalData *string

	// Detailed overview of the issue and what impact the issue has on the stamp.
	Description *string

	// The health check DisplayName localized of the individual test executed.
	DisplayName *string

	// The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).
	HealthCheckSource *string

	// Key-value pairs that allow grouping/filtering individual tests.
	HealthCheckTags any

	// Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.
	Name *string

	// Set of steps that can be taken to resolve the issue found.
	Remediation *string

	// Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is
	// the only update-blocking severity.
	Severity *Severity

	// The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or
	// failed.
	Status *Status

	// Key-value pairs that allow grouping/filtering individual tests.
	Tags *PrecheckResultTags

	// The unique identifier for the affected resource (such as a node or drive).
	TargetResourceID *string

	// The name of the affected resource.
	TargetResourceName *string

	// The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring).
	TargetResourceType *string

	// The time in which the HealthCheck was called.
	Timestamp *time.Time

	// User-facing name; one or more sentences indicating the direct issue.
	Title *string
}

func (PrecheckResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrecheckResult.

func (*PrecheckResult) UnmarshalJSON 

func (p *PrecheckResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrecheckResult.

type PrecheckResultTags 

type PrecheckResultTags struct {
	// Key that allow grouping/filtering individual tests.
	Key *string

	// Value of the key that allow grouping/filtering individual tests.
	Value *string
}

PrecheckResultTags - Key-value pairs that allow grouping/filtering individual tests.

func (PrecheckResultTags) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrecheckResultTags.

func (*PrecheckResultTags) UnmarshalJSON 

func (p *PrecheckResultTags) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrecheckResultTags.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the ArcSetting proxy resource. 

const (
	ProvisioningStateAccepted           ProvisioningState = "Accepted"
	ProvisioningStateCanceled           ProvisioningState = "Canceled"
	ProvisioningStateConnected          ProvisioningState = "Connected"
	ProvisioningStateCreating           ProvisioningState = "Creating"
	ProvisioningStateDeleted            ProvisioningState = "Deleted"
	ProvisioningStateDeleting           ProvisioningState = "Deleting"
	ProvisioningStateDisableInProgress  ProvisioningState = "DisableInProgress"
	ProvisioningStateDisconnected       ProvisioningState = "Disconnected"
	ProvisioningStateError              ProvisioningState = "Error"
	ProvisioningStateFailed             ProvisioningState = "Failed"
	ProvisioningStateInProgress         ProvisioningState = "InProgress"
	ProvisioningStateMoving             ProvisioningState = "Moving"
	ProvisioningStateNotSpecified       ProvisioningState = "NotSpecified"
	ProvisioningStatePartiallyConnected ProvisioningState = "PartiallyConnected"
	ProvisioningStatePartiallySucceeded ProvisioningState = "PartiallySucceeded"
	ProvisioningStateProvisioning       ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded          ProvisioningState = "Succeeded"
	ProvisioningStateUpdating           ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type Publisher 

type Publisher struct {
	// Publisher properties.
	Properties *PublisherProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Publisher details.

func (Publisher) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Publisher.

func (*Publisher) UnmarshalJSON 

func (p *Publisher) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Publisher.

type PublisherList 

type PublisherList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; List of Publisher proxy resources.
	Value []*Publisher
}

PublisherList - List of Publisher proxy resources for the HCI cluster.

func (PublisherList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PublisherList.

func (*PublisherList) UnmarshalJSON 

func (p *PublisherList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublisherList.

type PublisherProperties 

type PublisherProperties struct {
	// READ-ONLY; Provisioning State
	ProvisioningState *string
}

PublisherProperties - Publisher properties.

func (PublisherProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PublisherProperties.

func (*PublisherProperties) UnmarshalJSON 

func (p *PublisherProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublisherProperties.

type PublishersClient 

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

PublishersClient contains the methods for the Publishers group. Don't use this type directly, use NewPublishersClient() instead.

func NewPublishersClient 

func NewPublishersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PublishersClient, error)

NewPublishersClient creates a new instance of PublishersClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PublishersClient) Get 

func (client *PublishersClient) Get(ctx context.Context, resourceGroupName string, clusterName string, publisherName string, options *PublishersClientGetOptions) (PublishersClientGetResponse, error)

Get - Get Publisher resource details of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • publisherName - The name of the publisher available within HCI cluster.
  • options - PublishersClientGetOptions contains the optional parameters for the PublishersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetPublisher.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPublishersClient().Get(ctx, "test-rg", "myCluster", "publisher1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Publisher = armazurestackhci.Publisher{
// 	Name: to.Ptr("publisher1"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1"),
// }

Output:

func (*PublishersClient) NewListByClusterPager 

func (client *PublishersClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *PublishersClientListByClusterOptions) *runtime.Pager[PublishersClientListByClusterResponse]

NewListByClusterPager - List Publishers available for the HCI Cluster.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - PublishersClientListByClusterOptions contains the optional parameters for the PublishersClient.NewListByClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListPublishersByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPublishersClient().NewListByClusterPager("test-rg", "myCluster", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PublisherList = armazurestackhci.PublisherList{
	// 	Value: []*armazurestackhci.Publisher{
	// 		{
	// 			Name: to.Ptr("publisher1"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1"),
	// 	}},
	// }
}

Output:

type PublishersClientGetOptions 

type PublishersClientGetOptions struct {
}

PublishersClientGetOptions contains the optional parameters for the PublishersClient.Get method.

type PublishersClientGetResponse 

type PublishersClientGetResponse struct {
	// Publisher details.
	Publisher
}

PublishersClientGetResponse contains the response from method PublishersClient.Get.

type PublishersClientListByClusterOptions 

type PublishersClientListByClusterOptions struct {
}

PublishersClientListByClusterOptions contains the optional parameters for the PublishersClient.NewListByClusterPager method.

type PublishersClientListByClusterResponse 

type PublishersClientListByClusterResponse struct {
	// List of Publisher proxy resources for the HCI cluster.
	PublisherList
}

PublishersClientListByClusterResponse contains the response from method PublishersClient.NewListByClusterPager.

type QosPolicyOverrides 

type QosPolicyOverrides struct {
	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	BandwidthPercentageSMB *string

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	PriorityValue8021ActionCluster *string

	// This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.
	PriorityValue8021ActionSMB *string
}

QosPolicyOverrides - The QoSPolicyOverrides of a cluster.

func (QosPolicyOverrides) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type QosPolicyOverrides.

func (*QosPolicyOverrides) UnmarshalJSON 

func (q *QosPolicyOverrides) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QosPolicyOverrides.

type RawCertificateData 

type RawCertificateData struct {
	Certificates []*string
}

func (RawCertificateData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RawCertificateData.

func (*RawCertificateData) UnmarshalJSON 

func (r *RawCertificateData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RawCertificateData.

type RebootRequirement 

type RebootRequirement string
const (
	RebootRequirementFalse   RebootRequirement = "False"
	RebootRequirementTrue    RebootRequirement = "True"
	RebootRequirementUnknown RebootRequirement = "Unknown"
)

func PossibleRebootRequirementValues 

func PossibleRebootRequirementValues() []RebootRequirement

PossibleRebootRequirementValues returns the possible values for the RebootRequirement const type.

type RemoteSupportNodeSettings 

type RemoteSupportNodeSettings struct {
	// READ-ONLY; Arc ResourceId of the Node
	ArcResourceID *string

	// READ-ONLY; Remote Support Access Connection Error Message on the Node
	ConnectionErrorMessage *string

	// READ-ONLY; Remote Support Access Connection Status on the Node
	ConnectionStatus *string

	// READ-ONLY; Remote Support Enablement Request Created TimeStamp on the Node
	CreatedAt *time.Time

	// READ-ONLY; Remote Support Access Connection State on the Node
	State *string

	// READ-ONLY; Remote Support Transcript location on the node
	TranscriptLocation *string

	// READ-ONLY; Remote Support Enablement Request Updated TimeStamp on the Node
	UpdatedAt *time.Time
}

RemoteSupportNodeSettings - Remote Support Node Settings of the cluster.

func (RemoteSupportNodeSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RemoteSupportNodeSettings.

func (*RemoteSupportNodeSettings) UnmarshalJSON 

func (r *RemoteSupportNodeSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteSupportNodeSettings.

type RemoteSupportProperties 

type RemoteSupportProperties struct {
	// READ-ONLY; Remote Support Access Level
	AccessLevel *AccessLevel

	// READ-ONLY; Expiration DateTimeStamp when Remote Support Access will be expired
	ExpirationTimeStamp *time.Time

	// READ-ONLY
	RemoteSupportNodeSettings []*RemoteSupportNodeSettings

	// READ-ONLY
	RemoteSupportSessionDetails []*PerNodeRemoteSupportSession

	// READ-ONLY; Remote Support Type for cluster
	RemoteSupportType *RemoteSupportType
}

RemoteSupportProperties - Remote Support properties of the cluster.

func (RemoteSupportProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RemoteSupportProperties.

func (*RemoteSupportProperties) UnmarshalJSON 

func (r *RemoteSupportProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteSupportProperties.

type RemoteSupportRequest 

type RemoteSupportRequest struct {
	// Properties for Remote Support Request
	Properties *RemoteSupportRequestProperties
}

RemoteSupportRequest - Remote Support Request

func (RemoteSupportRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RemoteSupportRequest.

func (*RemoteSupportRequest) UnmarshalJSON 

func (r *RemoteSupportRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteSupportRequest.

type RemoteSupportRequestProperties 

type RemoteSupportRequestProperties struct {
	// Expiration DateTimeStamp when Remote Support Access will be expired
	ExpirationTimeStamp *time.Time

	// Remote Support Type for cluster
	RemoteSupportType *RemoteSupportType

	// READ-ONLY; Remote Support Access Level
	AccessLevel *AccessLevel
}

RemoteSupportRequestProperties - Properties for Remote Support Request

func (RemoteSupportRequestProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RemoteSupportRequestProperties.

func (*RemoteSupportRequestProperties) UnmarshalJSON 

func (r *RemoteSupportRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteSupportRequestProperties.

type RemoteSupportType 

type RemoteSupportType string

RemoteSupportType - Remote Support Type for cluster 

const (
	RemoteSupportTypeEnable RemoteSupportType = "Enable"
	RemoteSupportTypeRevoke RemoteSupportType = "Revoke"
)

func PossibleRemoteSupportTypeValues 

func PossibleRemoteSupportTypeValues() []RemoteSupportType

PossibleRemoteSupportTypeValues returns the possible values for the RemoteSupportType const type.

type SKU 

type SKU struct {
	// SKU properties.
	Properties *SKUProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SKU - Sku details.

func (SKU) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUList 

type SKUList struct {
	// READ-ONLY; Link to the next set of results.
	NextLink *string

	// READ-ONLY; List of SKU proxy resources.
	Value []*SKU
}

SKUList - List of SKU proxy resources for the HCI cluster.

func (SKUList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKUList.

func (*SKUList) UnmarshalJSON 

func (s *SKUList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUList.

type SKUMappings 

type SKUMappings struct {
	// Identifier of the CatalogPlan for the sku
	CatalogPlanID *string

	// Identifier for the sku
	MarketplaceSKUID *string

	// Array of SKU versions available
	MarketplaceSKUVersions []*string
}

SKUMappings - SKU Mapping details.

func (SKUMappings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKUMappings.

func (*SKUMappings) UnmarshalJSON 

func (s *SKUMappings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUMappings.

type SKUProperties 

type SKUProperties struct {
	// JSON serialized catalog content of the sku offer
	Content *string

	// The API version of the catalog service used to serve the catalog content
	ContentVersion *string

	// Identifier of the Offer for the sku
	OfferID *string

	// Identifier of the Publisher for the offer
	PublisherID *string

	// Array of SKU mappings
	SKUMappings []*SKUMappings

	// READ-ONLY; Provisioning State
	ProvisioningState *string
}

SKUProperties - SKU properties.

func (SKUProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SKUProperties.

func (*SKUProperties) UnmarshalJSON 

func (s *SKUProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUProperties.

type SKUsClient 

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

SKUsClient contains the methods for the SKUs group. Don't use this type directly, use NewSKUsClient() instead.

func NewSKUsClient 

func NewSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SKUsClient, error)

NewSKUsClient creates a new instance of SKUsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SKUsClient) Get 

func (client *SKUsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, publisherName string, offerName string, skuName string, options *SKUsClientGetOptions) (SKUsClientGetResponse, error)

Get - Get SKU resource details within a offer of HCI Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • publisherName - The name of the publisher available within HCI cluster.
  • offerName - The name of the offer available within HCI cluster.
  • skuName - The name of the SKU available within HCI cluster.
  • options - SKUsClientGetOptions contains the optional parameters for the SKUsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSku.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSKUsClient().Get(ctx, "test-rg", "myCluster", "publisher1", "offer1", "sku1", &armazurestackhci.SKUsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SKU = armazurestackhci.SKU{
// 	Name: to.Ptr("sku1"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers/offers/skus"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1"),
// 	Properties: &armazurestackhci.SKUProperties{
// 		Content: to.Ptr("{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17.  Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}"),
// 		ContentVersion: to.Ptr("2018-01-01"),
// 		OfferID: to.Ptr("offer1"),
// 		ProvisioningState: to.Ptr("Succeeded"),
// 		PublisherID: to.Ptr("publisher1"),
// 		SKUMappings: []*armazurestackhci.SKUMappings{
// 			{
// 				CatalogPlanID: to.Ptr("microsoftsqlserver.sql2019-ubuntu2004enterprise-arm"),
// 				MarketplaceSKUID: to.Ptr("enterprise"),
// 				MarketplaceSKUVersions: []*string{
// 					to.Ptr("15.0.220208")},
// 			}},
// 		},
// 	}

Output:

func (*SKUsClient) NewListByOfferPager 

func (client *SKUsClient) NewListByOfferPager(resourceGroupName string, clusterName string, publisherName string, offerName string, options *SKUsClientListByOfferOptions) *runtime.Pager[SKUsClientListByOfferResponse]

NewListByOfferPager - List Skus available for a offer within the HCI Cluster.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • publisherName - The name of the publisher available within HCI cluster.
  • offerName - The name of the offer available within HCI cluster.
  • options - SKUsClientListByOfferOptions contains the optional parameters for the SKUsClient.NewListByOfferPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSkusByOffer.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSKUsClient().NewListByOfferPager("test-rg", "myCluster", "publisher1", "offer1", &armazurestackhci.SKUsClientListByOfferOptions{Expand: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SKUList = armazurestackhci.SKUList{
	// 	Value: []*armazurestackhci.SKU{
	// 		{
	// 			Name: to.Ptr("sku1"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/publishers/offers/skus"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1"),
	// 			Properties: &armazurestackhci.SKUProperties{
	// 				Content: to.Ptr("{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17.  Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}"),
	// 				ContentVersion: to.Ptr("2018-01-01"),
	// 				OfferID: to.Ptr("offer1"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				PublisherID: to.Ptr("publisher1"),
	// 				SKUMappings: []*armazurestackhci.SKUMappings{
	// 					{
	// 						CatalogPlanID: to.Ptr("microsoftsqlserver.sql2019-ubuntu2004enterprise-arm"),
	// 						MarketplaceSKUID: to.Ptr("enterprise"),
	// 						MarketplaceSKUVersions: []*string{
	// 							to.Ptr("15.0.220208")},
	// 					}},
	// 				},
	// 		}},
	// 	}
}

Output:

type SKUsClientGetOptions 

type SKUsClientGetOptions struct {
	// Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.
	Expand *string
}

SKUsClientGetOptions contains the optional parameters for the SKUsClient.Get method.

type SKUsClientGetResponse 

type SKUsClientGetResponse struct {
	// Sku details.
	SKU
}

SKUsClientGetResponse contains the response from method SKUsClient.Get.

type SKUsClientListByOfferOptions 

type SKUsClientListByOfferOptions struct {
	// Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.
	Expand *string
}

SKUsClientListByOfferOptions contains the optional parameters for the SKUsClient.NewListByOfferPager method.

type SKUsClientListByOfferResponse 

type SKUsClientListByOfferResponse struct {
	// List of SKU proxy resources for the HCI cluster.
	SKUList
}

SKUsClientListByOfferResponse contains the response from method SKUsClient.NewListByOfferPager.

type SbeCredentials 

type SbeCredentials struct {
	// secret name expected for Enterprise Cloud Engine (ECE).
	EceSecretName *string

	// secret URI stored in keyvault.
	SecretLocation *string

	// secret name stored in keyvault.
	SecretName *string
}

SbeCredentials - secrets used for solution builder extension (SBE) partner extensibility.

func (SbeCredentials) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SbeCredentials.

func (*SbeCredentials) UnmarshalJSON 

func (s *SbeCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SbeCredentials.

type SbeDeploymentInfo 

type SbeDeploymentInfo struct {
	// SBE family name.
	Family *string

	// SBE manifest publisher.
	Publisher *string

	// SBE Manifest Creation Date.
	SbeManifestCreationDate *time.Time

	// SBE Manifest Source.
	SbeManifestSource *string

	// SBE package version.
	Version *string
}

SbeDeploymentInfo - Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment.

func (SbeDeploymentInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SbeDeploymentInfo.

func (*SbeDeploymentInfo) UnmarshalJSON 

func (s *SbeDeploymentInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SbeDeploymentInfo.

type SbeDeploymentPackageInfo 

type SbeDeploymentPackageInfo struct {
	// READ-ONLY; SBE deployment validation code.
	Code *string

	// READ-ONLY; A detailed message that explains the SBE package validation result.
	Message *string

	// READ-ONLY; This represents discovered update results for matching updates and store it as SBE manifest.
	SbeManifest *string
}

SbeDeploymentPackageInfo - Solution builder extension (SBE) deployment package information.

func (SbeDeploymentPackageInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SbeDeploymentPackageInfo.

func (*SbeDeploymentPackageInfo) UnmarshalJSON 

func (s *SbeDeploymentPackageInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SbeDeploymentPackageInfo.

type SbePartnerInfo 

type SbePartnerInfo struct {
	// SBE credentials list for AzureStackHCI cluster deployment.
	CredentialList []*SbeCredentials

	// List of SBE partner properties for AzureStackHCI cluster deployment.
	PartnerProperties []*SbePartnerProperties

	// SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment.
	SbeDeploymentInfo *SbeDeploymentInfo
}

SbePartnerInfo - The solution builder extension (SBE) partner deployment info for cluster.

func (SbePartnerInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SbePartnerInfo.

func (*SbePartnerInfo) UnmarshalJSON 

func (s *SbePartnerInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SbePartnerInfo.

type SbePartnerProperties 

type SbePartnerProperties struct {
	// SBE partner property name.
	Name *string

	// SBE partner property value.
	Value *string
}

SbePartnerProperties - Solution builder extension (SBE) partner properties object.

func (SbePartnerProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SbePartnerProperties.

func (*SbePartnerProperties) UnmarshalJSON 

func (s *SbePartnerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SbePartnerProperties.

type ScaleUnits 

type ScaleUnits struct {
	// REQUIRED; Deployment Data to deploy AzureStackHCI Cluster.
	DeploymentData *DeploymentData

	// Solution builder extension (SBE) partner properties
	SbePartnerInfo *SbePartnerInfo
}

ScaleUnits - Scale units will contains list of deployment data

func (ScaleUnits) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScaleUnits.

func (*ScaleUnits) UnmarshalJSON 

func (s *ScaleUnits) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScaleUnits.

type SdnIntegration 

type SdnIntegration struct {
	// network controller config for SDN Integration to deploy AzureStackHCI Cluster.
	NetworkController *NetworkController
}

SdnIntegration - SDN Integration config to deploy AzureStackHCI Cluster.

func (SdnIntegration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SdnIntegration.

func (*SdnIntegration) UnmarshalJSON 

func (s *SdnIntegration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SdnIntegration.

type SecurityComplianceStatus 

type SecurityComplianceStatus struct {
	// READ-ONLY; Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes.
	DataAtRestEncrypted *ComplianceStatus

	// READ-ONLY; Indicates whether HCI cluster has data in-transit protection.
	DataInTransitProtected *ComplianceStatus

	// READ-ONLY; Time in UTC when compliance status was last updated.
	LastUpdated *time.Time

	// READ-ONLY; Indicates whether HCI hosts meets secured-core server requirements.
	SecuredCoreCompliance *ComplianceStatus

	// READ-ONLY; Indicates whether HCI hosts have enforced consistent Windows Defender Application Control.
	WdacCompliance *ComplianceStatus
}

SecurityComplianceStatus - Security compliance properties of the resource

func (SecurityComplianceStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecurityComplianceStatus.

func (*SecurityComplianceStatus) UnmarshalJSON 

func (s *SecurityComplianceStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityComplianceStatus.

type SecurityProperties 

type SecurityProperties struct {
	// The status of the last operation.
	ProvisioningState *ProvisioningState

	// Secured Core Compliance Assignment
	SecuredCoreComplianceAssignment *ComplianceAssignmentType

	// SMB encryption for intra-cluster traffic Compliance Assignment
	SmbEncryptionForIntraClusterTrafficComplianceAssignment *ComplianceAssignmentType

	// WDAC Compliance Assignment
	WdacComplianceAssignment *ComplianceAssignmentType

	// READ-ONLY; Security Compliance Status
	SecurityComplianceStatus *SecurityComplianceStatus
}

SecurityProperties - Security properties of the resource

func (SecurityProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecurityProperties.

func (*SecurityProperties) UnmarshalJSON 

func (s *SecurityProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityProperties.

type SecuritySetting 

type SecuritySetting struct {
	// The resource-specific properties for this resource.
	Properties *SecurityProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SecuritySetting - Security settings proxy resource

func (SecuritySetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecuritySetting.

func (*SecuritySetting) UnmarshalJSON 

func (s *SecuritySetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySetting.

type SecuritySettingListResult 

type SecuritySettingListResult struct {
	// REQUIRED; The SecuritySetting items on this page
	Value []*SecuritySetting

	// The link to the next page of items
	NextLink *string
}

SecuritySettingListResult - The response of a SecuritySetting list operation.

func (SecuritySettingListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecuritySettingListResult.

func (*SecuritySettingListResult) UnmarshalJSON 

func (s *SecuritySettingListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecuritySettingListResult.

type SecuritySettingsClient 

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

SecuritySettingsClient contains the methods for the SecuritySettings group. Don't use this type directly, use NewSecuritySettingsClient() instead.

func NewSecuritySettingsClient 

func NewSecuritySettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SecuritySettingsClient, error)

NewSecuritySettingsClient creates a new instance of SecuritySettingsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SecuritySettingsClient) BeginCreateOrUpdate 

func (client *SecuritySettingsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, securitySettingsName string, resource SecuritySetting, options *SecuritySettingsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SecuritySettingsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a security setting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • securitySettingsName - Name of security setting
  • resource - Resource create parameters.
  • options - SecuritySettingsClientBeginCreateOrUpdateOptions contains the optional parameters for the SecuritySettingsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutSecuritySettings.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSecuritySettingsClient().BeginCreateOrUpdate(ctx, "test-rg", "myCluster", "default", armazurestackhci.SecuritySetting{
	Properties: &armazurestackhci.SecurityProperties{
		SecuredCoreComplianceAssignment:                         to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
		SmbEncryptionForIntraClusterTrafficComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
		WdacComplianceAssignment:                                to.Ptr(armazurestackhci.ComplianceAssignmentTypeApplyAndAutoCorrect),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SecuritySetting = armazurestackhci.SecuritySetting{
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/securitySettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.SecurityProperties{
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		SecuredCoreComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
// 		SecurityComplianceStatus: &armazurestackhci.SecurityComplianceStatus{
// 			DataAtRestEncrypted: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 			DataInTransitProtected: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-11-14T07:09:44.771Z"); return t}()),
// 			SecuredCoreCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 			WdacCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 		},
// 		SmbEncryptionForIntraClusterTrafficComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
// 		WdacComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeApplyAndAutoCorrect),
// 	},
// }

Output:

func (*SecuritySettingsClient) BeginDelete 

func (client *SecuritySettingsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, securitySettingsName string, options *SecuritySettingsClientBeginDeleteOptions) (*runtime.Poller[SecuritySettingsClientDeleteResponse], error)

BeginDelete - Delete a SecuritySetting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • securitySettingsName - Name of security setting
  • options - SecuritySettingsClientBeginDeleteOptions contains the optional parameters for the SecuritySettingsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteSecuritySettings.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSecuritySettingsClient().BeginDelete(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*SecuritySettingsClient) Get 

func (client *SecuritySettingsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, securitySettingsName string, options *SecuritySettingsClientGetOptions) (SecuritySettingsClientGetResponse, error)

Get - Get a SecuritySetting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • securitySettingsName - Name of security setting
  • options - SecuritySettingsClientGetOptions contains the optional parameters for the SecuritySettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetSecuritySettings.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSecuritySettingsClient().Get(ctx, "test-rg", "myCluster", "default", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SecuritySetting = armazurestackhci.SecuritySetting{
// 	Type: to.Ptr("Microsoft.AzureStackHCI/clusters/securitySettings"),
// 	ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default"),
// 	SystemData: &armazurestackhci.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
// 	},
// 	Properties: &armazurestackhci.SecurityProperties{
// 		ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
// 		SecuredCoreComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
// 		SecurityComplianceStatus: &armazurestackhci.SecurityComplianceStatus{
// 			DataAtRestEncrypted: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 			DataInTransitProtected: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-11-14T07:09:44.771Z"); return t}()),
// 			SecuredCoreCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 			WdacCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
// 		},
// 		SmbEncryptionForIntraClusterTrafficComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
// 		WdacComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeApplyAndAutoCorrect),
// 	},
// }

Output:

func (*SecuritySettingsClient) NewListByClustersPager 

func (client *SecuritySettingsClient) NewListByClustersPager(resourceGroupName string, clusterName string, options *SecuritySettingsClientListByClustersOptions) *runtime.Pager[SecuritySettingsClientListByClustersResponse]

NewListByClustersPager - List SecuritySetting resources by Clusters

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - SecuritySettingsClientListByClustersOptions contains the optional parameters for the SecuritySettingsClient.NewListByClustersPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListSecuritySettingsByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSecuritySettingsClient().NewListByClustersPager("test-rg", "myCluster", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SecuritySettingListResult = armazurestackhci.SecuritySettingListResult{
	// 	Value: []*armazurestackhci.SecuritySetting{
	// 		{
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/clusters/securitySettings"),
	// 			ID: to.Ptr("/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default"),
	// 			SystemData: &armazurestackhci.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armazurestackhci.CreatedByTypeUser),
	// 			},
	// 			Properties: &armazurestackhci.SecurityProperties{
	// 				ProvisioningState: to.Ptr(armazurestackhci.ProvisioningStateSucceeded),
	// 				SecuredCoreComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
	// 				SecurityComplianceStatus: &armazurestackhci.SecurityComplianceStatus{
	// 					DataAtRestEncrypted: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 					DataInTransitProtected: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 					LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-11-14T07:09:44.771Z"); return t}()),
	// 					SecuredCoreCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 					WdacCompliance: to.Ptr(armazurestackhci.ComplianceStatusCompliant),
	// 				},
	// 				SmbEncryptionForIntraClusterTrafficComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeAudit),
	// 				WdacComplianceAssignment: to.Ptr(armazurestackhci.ComplianceAssignmentTypeApplyAndAutoCorrect),
	// 			},
	// 	}},
	// }
}

Output:

type SecuritySettingsClientBeginCreateOrUpdateOptions 

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

SecuritySettingsClientBeginCreateOrUpdateOptions contains the optional parameters for the SecuritySettingsClient.BeginCreateOrUpdate method.

type SecuritySettingsClientBeginDeleteOptions 

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

SecuritySettingsClientBeginDeleteOptions contains the optional parameters for the SecuritySettingsClient.BeginDelete method.

type SecuritySettingsClientCreateOrUpdateResponse 

type SecuritySettingsClientCreateOrUpdateResponse struct {
	// Security settings proxy resource
	SecuritySetting
}

SecuritySettingsClientCreateOrUpdateResponse contains the response from method SecuritySettingsClient.BeginCreateOrUpdate.

type SecuritySettingsClientDeleteResponse 

type SecuritySettingsClientDeleteResponse struct {
}

SecuritySettingsClientDeleteResponse contains the response from method SecuritySettingsClient.BeginDelete.

type SecuritySettingsClientGetOptions 

type SecuritySettingsClientGetOptions struct {
}

SecuritySettingsClientGetOptions contains the optional parameters for the SecuritySettingsClient.Get method.

type SecuritySettingsClientGetResponse 

type SecuritySettingsClientGetResponse struct {
	// Security settings proxy resource
	SecuritySetting
}

SecuritySettingsClientGetResponse contains the response from method SecuritySettingsClient.Get.

type SecuritySettingsClientListByClustersOptions 

type SecuritySettingsClientListByClustersOptions struct {
}

SecuritySettingsClientListByClustersOptions contains the optional parameters for the SecuritySettingsClient.NewListByClustersPager method.

type SecuritySettingsClientListByClustersResponse 

type SecuritySettingsClientListByClustersResponse struct {
	// The response of a SecuritySetting list operation.
	SecuritySettingListResult
}

SecuritySettingsClientListByClustersResponse contains the response from method SecuritySettingsClient.NewListByClustersPager.

type Severity 

type Severity string

Severity - Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. 

const (
	SeverityCritical      Severity = "Critical"
	SeverityHidden        Severity = "Hidden"
	SeverityInformational Severity = "Informational"
	SeverityWarning       Severity = "Warning"
)

func PossibleSeverityValues 

func PossibleSeverityValues() []Severity

PossibleSeverityValues returns the possible values for the Severity const type.

type SoftwareAssuranceChangeRequest 

type SoftwareAssuranceChangeRequest struct {
	Properties *SoftwareAssuranceChangeRequestProperties
}

func (SoftwareAssuranceChangeRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SoftwareAssuranceChangeRequest.

func (*SoftwareAssuranceChangeRequest) UnmarshalJSON 

func (s *SoftwareAssuranceChangeRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftwareAssuranceChangeRequest.

type SoftwareAssuranceChangeRequestProperties 

type SoftwareAssuranceChangeRequestProperties struct {
	// Customer Intent for Software Assurance Benefit.
	SoftwareAssuranceIntent *SoftwareAssuranceIntent
}

func (SoftwareAssuranceChangeRequestProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SoftwareAssuranceChangeRequestProperties.

func (*SoftwareAssuranceChangeRequestProperties) UnmarshalJSON 

func (s *SoftwareAssuranceChangeRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftwareAssuranceChangeRequestProperties.

type SoftwareAssuranceIntent 

type SoftwareAssuranceIntent string

SoftwareAssuranceIntent - Customer Intent for Software Assurance Benefit. 

const (
	SoftwareAssuranceIntentDisable SoftwareAssuranceIntent = "Disable"
	SoftwareAssuranceIntentEnable  SoftwareAssuranceIntent = "Enable"
)

func PossibleSoftwareAssuranceIntentValues 

func PossibleSoftwareAssuranceIntentValues() []SoftwareAssuranceIntent

PossibleSoftwareAssuranceIntentValues returns the possible values for the SoftwareAssuranceIntent const type.

type SoftwareAssuranceProperties 

type SoftwareAssuranceProperties struct {
	// Customer Intent for Software Assurance Benefit.
	SoftwareAssuranceIntent *SoftwareAssuranceIntent

	// READ-ONLY; TimeStamp denoting the latest SA benefit applicability is validated.
	LastUpdated *time.Time

	// READ-ONLY; Status of the Software Assurance for the cluster.
	SoftwareAssuranceStatus *SoftwareAssuranceStatus
}

SoftwareAssuranceProperties - Software Assurance properties of the cluster.

func (SoftwareAssuranceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SoftwareAssuranceProperties.

func (*SoftwareAssuranceProperties) UnmarshalJSON 

func (s *SoftwareAssuranceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftwareAssuranceProperties.

type SoftwareAssuranceStatus 

type SoftwareAssuranceStatus string

SoftwareAssuranceStatus - Status of the Software Assurance for the cluster. 

const (
	SoftwareAssuranceStatusDisabled SoftwareAssuranceStatus = "Disabled"
	SoftwareAssuranceStatusEnabled  SoftwareAssuranceStatus = "Enabled"
)

func PossibleSoftwareAssuranceStatusValues 

func PossibleSoftwareAssuranceStatusValues() []SoftwareAssuranceStatus

PossibleSoftwareAssuranceStatusValues returns the possible values for the SoftwareAssuranceStatus const type.

type State 

type State string

State - State of the update as it relates to this stamp. 

const (
	StateAdditionalContentRequired                     State = "AdditionalContentRequired"
	StateDownloadFailed                                State = "DownloadFailed"
	StateDownloading                                   State = "Downloading"
	StateHasPrerequisite                               State = "HasPrerequisite"
	StateHealthCheckFailed                             State = "HealthCheckFailed"
	StateHealthChecking                                State = "HealthChecking"
	StateInstallationFailed                            State = "InstallationFailed"
	StateInstalled                                     State = "Installed"
	StateInstalling                                    State = "Installing"
	StateInvalid                                       State = "Invalid"
	StateNotApplicableBecauseAnotherUpdateIsInProgress State = "NotApplicableBecauseAnotherUpdateIsInProgress"
	StateObsolete                                      State = "Obsolete"
	StatePreparationFailed                             State = "PreparationFailed"
	StatePreparing                                     State = "Preparing"
	StateReady                                         State = "Ready"
	StateReadyToInstall                                State = "ReadyToInstall"
	StateRecalled                                      State = "Recalled"
	StateScanFailed                                    State = "ScanFailed"
	StateScanInProgress                                State = "ScanInProgress"
)

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns the possible values for the State const type.

type Status 

type Status string

Status - Status of the cluster agent. 

const (
	StatusConnectedRecently    Status = "ConnectedRecently"
	StatusDeploymentFailed     Status = "DeploymentFailed"
	StatusDeploymentInProgress Status = "DeploymentInProgress"
	StatusDeploymentSuccess    Status = "DeploymentSuccess"
	StatusDisconnected         Status = "Disconnected"
	StatusError                Status = "Error"
	StatusFailed               Status = "Failed"
	StatusInProgress           Status = "InProgress"
	StatusNotConnectedRecently Status = "NotConnectedRecently"
	StatusNotSpecified         Status = "NotSpecified"
	StatusNotYetRegistered     Status = "NotYetRegistered"
	StatusSucceeded            Status = "Succeeded"
	StatusValidationFailed     Status = "ValidationFailed"
	StatusValidationInProgress Status = "ValidationInProgress"
	StatusValidationSuccess    Status = "ValidationSuccess"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type StatusLevelTypes 

type StatusLevelTypes string

StatusLevelTypes - The level code. 

const (
	StatusLevelTypesError   StatusLevelTypes = "Error"
	StatusLevelTypesInfo    StatusLevelTypes = "Info"
	StatusLevelTypesWarning StatusLevelTypes = "Warning"
)

func PossibleStatusLevelTypesValues 

func PossibleStatusLevelTypesValues() []StatusLevelTypes

PossibleStatusLevelTypesValues returns the possible values for the StatusLevelTypes const type.

type Step 

type Step struct {
	// More detailed description of the step.
	Description *string

	// When the step reached a terminal state.
	EndTimeUTC *time.Time

	// Error message, specified if the step is in a failed state.
	ErrorMessage *string

	// Expected execution time of a given step. This is optionally authored in the update action plan and can be empty.
	ExpectedExecutionTime *string

	// Completion time of this step or the last completed sub-step.
	LastUpdatedTimeUTC *time.Time

	// Name of the step.
	Name *string

	// When the step started, or empty if it has not started executing.
	StartTimeUTC *time.Time

	// Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress',
	// and 'Unknown status'.
	Status *string

	// Recursive model for child steps of this step.
	Steps []*Step
}

Step - Progress representation of the update run steps.

func (Step) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Step.

func (*Step) UnmarshalJSON 

func (s *Step) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Step.

type Storage 

type Storage struct {
	// By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes
	// in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage'
	ConfigurationMode *string
}

Storage - The Storage config of AzureStackHCI Cluster.

func (Storage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Storage.

func (*Storage) UnmarshalJSON 

func (s *Storage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Storage.

type SwitchDetail 

type SwitchDetail struct {
	// READ-ONLY; This represents extensions installed on virtualSwitch.
	Extensions []*SwitchExtension

	// READ-ONLY; The name of the switch.
	SwitchName *string

	// READ-ONLY; The type of the switch. e.g. external, internal.
	SwitchType *string
}

SwitchDetail - List of switch details for edge device.

func (SwitchDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SwitchDetail.

func (*SwitchDetail) UnmarshalJSON 

func (s *SwitchDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SwitchDetail.

type SwitchExtension 

type SwitchExtension struct {
	// READ-ONLY; This represents whether extension is enabled on virtualSwitch.
	ExtensionEnabled *bool

	// READ-ONLY; This will show extension name for virtualSwitch.
	ExtensionName *string

	// READ-ONLY; Unique identifier for virtualSwitch.
	SwitchID *string
}

SwitchExtension - This represents extensions installed on virtualSwitch.

func (SwitchExtension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SwitchExtension.

func (*SwitchExtension) UnmarshalJSON 

func (s *SwitchExtension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SwitchExtension.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

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 Update 

type Update struct {
	// The geo-location where the resource lives
	Location *string

	// Update properties
	Properties *UpdateProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Update details

func (Update) MarshalJSON 

func (u Update) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Update.

func (*Update) UnmarshalJSON 

func (u *Update) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Update.

type UpdateList 

type UpdateList struct {
	// List of Updates
	Value []*Update

	// READ-ONLY; Link to the next set of results.
	NextLink *string
}

UpdateList - List of Updates

func (UpdateList) MarshalJSON 

func (u UpdateList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateList.

func (*UpdateList) UnmarshalJSON 

func (u *UpdateList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateList.

type UpdatePrerequisite 

type UpdatePrerequisite struct {
	// Friendly name of the prerequisite.
	PackageName *string

	// Updatable component type.
	UpdateType *string

	// Version of the prerequisite.
	Version *string
}

UpdatePrerequisite - If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.

func (UpdatePrerequisite) MarshalJSON 

func (u UpdatePrerequisite) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdatePrerequisite.

func (*UpdatePrerequisite) UnmarshalJSON 

func (u *UpdatePrerequisite) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdatePrerequisite.

type UpdateProperties 

type UpdateProperties struct {
	// Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information
	// when an update is flagged as Invalid for the stamp based on OEM type.
	AdditionalProperties *string

	// Indicates the way the update content can be downloaded.
	AvailabilityType *AvailabilityType

	// An array of component versions for a Solution Bundle update, and an empty array otherwise.
	ComponentVersions []*PackageVersionInfo

	// Description of the update.
	Description *string

	// Display name of the Update
	DisplayName *string

	// Last time the package-specific checks were run.
	HealthCheckDate *time.Time

	// An array of PrecheckResult objects.
	HealthCheckResult []*PrecheckResult

	// Overall health state for update-specific health checks.
	HealthState *HealthState

	// Date that the update was installed.
	InstalledDate *time.Time

	// Minimum Sbe Version of the update.
	MinSbeVersionRequired *string

	// Path where the update package is available.
	PackagePath *string

	// Size of the package. This value is a combination of the size from update metadata and size of the payload that results
	// from the live scan operation for OS update content.
	PackageSizeInMb *float32

	// Customer-visible type of the update.
	PackageType *string

	// If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing
	// this update. Otherwise, it is empty.
	Prerequisites []*UpdatePrerequisite

	// Publisher of the update package.
	Publisher      *string
	RebootRequired *RebootRequirement

	// Link to release notes for the update.
	ReleaseLink *string

	// State of the update as it relates to this stamp.
	State *State

	// Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details
	// on this property.
	UpdateStateProperties *UpdateStateProperties

	// Version of the update.
	Version *string

	// READ-ONLY; Provisioning state of the Updates proxy resource.
	ProvisioningState *ProvisioningState
}

UpdateProperties - Details of a singular Update in HCI Cluster

func (UpdateProperties) MarshalJSON 

func (u UpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateProperties.

func (*UpdateProperties) UnmarshalJSON 

func (u *UpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateProperties.

type UpdateRun 

type UpdateRun struct {
	// The geo-location where the resource lives
	Location *string

	// Describes Update Run Properties.
	Properties *UpdateRunProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

UpdateRun - Details of an Update run

func (UpdateRun) MarshalJSON 

func (u UpdateRun) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateRun.

func (*UpdateRun) UnmarshalJSON 

func (u *UpdateRun) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateRun.

type UpdateRunList 

type UpdateRunList struct {
	// List of Update runs
	Value []*UpdateRun

	// READ-ONLY; Link to the next set of results.
	NextLink *string
}

UpdateRunList - List of Update runs

func (UpdateRunList) MarshalJSON 

func (u UpdateRunList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateRunList.

func (*UpdateRunList) UnmarshalJSON 

func (u *UpdateRunList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateRunList.

type UpdateRunProperties 

type UpdateRunProperties struct {
	// Duration of the update run.
	Duration *string

	// Timestamp of the most recently completed step in the update run.
	LastUpdatedTime *time.Time

	// Progress representation of the update run steps.
	Progress *Step

	// State of the update run.
	State *UpdateRunPropertiesState

	// Timestamp of the update run was started.
	TimeStarted *time.Time

	// READ-ONLY; Provisioning state of the UpdateRuns proxy resource.
	ProvisioningState *ProvisioningState
}

UpdateRunProperties - Details of an Update run

func (UpdateRunProperties) MarshalJSON 

func (u UpdateRunProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateRunProperties.

func (*UpdateRunProperties) UnmarshalJSON 

func (u *UpdateRunProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateRunProperties.

type UpdateRunPropertiesState 

type UpdateRunPropertiesState string

UpdateRunPropertiesState - State of the update run. 

const (
	UpdateRunPropertiesStateFailed     UpdateRunPropertiesState = "Failed"
	UpdateRunPropertiesStateInProgress UpdateRunPropertiesState = "InProgress"
	UpdateRunPropertiesStateSucceeded  UpdateRunPropertiesState = "Succeeded"
	UpdateRunPropertiesStateUnknown    UpdateRunPropertiesState = "Unknown"
)

func PossibleUpdateRunPropertiesStateValues 

func PossibleUpdateRunPropertiesStateValues() []UpdateRunPropertiesState

PossibleUpdateRunPropertiesStateValues returns the possible values for the UpdateRunPropertiesState const type.

type UpdateRunsClient 

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

UpdateRunsClient contains the methods for the UpdateRuns group. Don't use this type directly, use NewUpdateRunsClient() instead.

func NewUpdateRunsClient 

func NewUpdateRunsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UpdateRunsClient, error)

NewUpdateRunsClient creates a new instance of UpdateRunsClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*UpdateRunsClient) BeginDelete 

func (client *UpdateRunsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, updateName string, updateRunName string, options *UpdateRunsClientBeginDeleteOptions) (*runtime.Poller[UpdateRunsClientDeleteResponse], error)

BeginDelete - Delete specified Update Run If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • updateRunName - The name of the Update Run
  • options - UpdateRunsClientBeginDeleteOptions contains the optional parameters for the UpdateRunsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateRuns.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewUpdateRunsClient().BeginDelete(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", "23b779ba-0d52-4a80-8571-45ca74664ec3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*UpdateRunsClient) Get 

func (client *UpdateRunsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, updateName string, updateRunName string, options *UpdateRunsClientGetOptions) (UpdateRunsClientGetResponse, error)

Get - Get the Update run for a specified update If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • updateRunName - The name of the Update Run
  • options - UpdateRunsClientGetOptions contains the optional parameters for the UpdateRunsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateRuns.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUpdateRunsClient().Get(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", "23b779ba-0d52-4a80-8571-45ca74664ec3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.UpdateRun = armazurestackhci.UpdateRun{
// 	Name: to.Ptr("Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/updates/updateRuns"),
// 	ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3"),
// 	Location: to.Ptr("West US"),
// 	Properties: &armazurestackhci.UpdateRunProperties{
// 		Progress: &armazurestackhci.Step{
// 			Name: to.Ptr("Unnamed step"),
// 			Description: to.Ptr("Update Azure Stack."),
// 			EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t}()),
// 			ErrorMessage: to.Ptr(""),
// 			LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t}()),
// 			StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t}()),
// 			Status: to.Ptr("Success"),
// 			Steps: []*armazurestackhci.Step{
// 				{
// 					Name: to.Ptr("PreUpdate Cloud"),
// 					Description: to.Ptr("Prepare for SSU update"),
// 					EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t}()),
// 					ErrorMessage: to.Ptr(""),
// 					LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t}()),
// 					StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t}()),
// 					Status: to.Ptr("Success"),
// 					Steps: []*armazurestackhci.Step{
// 					},
// 			}},
// 		},
// 	},
// }

Output:

func (*UpdateRunsClient) NewListPager 

func (client *UpdateRunsClient) NewListPager(resourceGroupName string, clusterName string, updateName string, options *UpdateRunsClientListOptions) *runtime.Pager[UpdateRunsClientListResponse]

NewListPager - List all Update runs for a specified update

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • options - UpdateRunsClientListOptions contains the optional parameters for the UpdateRunsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateRuns.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewUpdateRunsClient().NewListPager("testrg", "testcluster", "Microsoft4.2203.2.32", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.UpdateRunList = armazurestackhci.UpdateRunList{
	// 	Value: []*armazurestackhci.UpdateRun{
	// 		{
	// 			Name: to.Ptr("Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/updates/updateRuns"),
	// 			ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3"),
	// 			Location: to.Ptr("West US"),
	// 			Properties: &armazurestackhci.UpdateRunProperties{
	// 				Progress: &armazurestackhci.Step{
	// 					Name: to.Ptr("Unnamed step"),
	// 					Description: to.Ptr("Update Azure Stack."),
	// 					EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t}()),
	// 					ErrorMessage: to.Ptr(""),
	// 					LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t}()),
	// 					StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t}()),
	// 					Status: to.Ptr("Success"),
	// 					Steps: []*armazurestackhci.Step{
	// 						{
	// 							Name: to.Ptr("PreUpdate Cloud"),
	// 							Description: to.Ptr("Prepare for SSU update"),
	// 							EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t}()),
	// 							ErrorMessage: to.Ptr(""),
	// 							LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t}()),
	// 							StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t}()),
	// 							Status: to.Ptr("Success"),
	// 							Steps: []*armazurestackhci.Step{
	// 							},
	// 					}},
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*UpdateRunsClient) Put 

func (client *UpdateRunsClient) Put(ctx context.Context, resourceGroupName string, clusterName string, updateName string, updateRunName string, updateRunsProperties UpdateRun, options *UpdateRunsClientPutOptions) (UpdateRunsClientPutResponse, error)

Put - Put Update runs for a specified update If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • updateRunName - The name of the Update Run
  • updateRunsProperties - Properties of the updateRuns object
  • options - UpdateRunsClientPutOptions contains the optional parameters for the UpdateRunsClient.Put method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateRuns.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUpdateRunsClient().Put(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", "23b779ba-0d52-4a80-8571-45ca74664ec3", armazurestackhci.UpdateRun{
	Properties: &armazurestackhci.UpdateRunProperties{
		Progress: &armazurestackhci.Step{
			Name:               to.Ptr("Unnamed step"),
			Description:        to.Ptr("Update Azure Stack."),
			EndTimeUTC:         to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t }()),
			ErrorMessage:       to.Ptr(""),
			LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t }()),
			StartTimeUTC:       to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t }()),
			Status:             to.Ptr("Success"),
			Steps: []*armazurestackhci.Step{
				{
					Name:               to.Ptr("PreUpdate Cloud"),
					Description:        to.Ptr("Prepare for SSU update"),
					EndTimeUTC:         to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t }()),
					ErrorMessage:       to.Ptr(""),
					LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t }()),
					StartTimeUTC:       to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t }()),
					Status:             to.Ptr("Success"),
					Steps:              []*armazurestackhci.Step{},
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.UpdateRun = armazurestackhci.UpdateRun{
// 	Name: to.Ptr("Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/updates/updateRuns"),
// 	ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3"),
// 	Location: to.Ptr("West US"),
// 	Properties: &armazurestackhci.UpdateRunProperties{
// 		Progress: &armazurestackhci.Step{
// 			Name: to.Ptr("Unnamed step"),
// 			Description: to.Ptr("Update Azure Stack."),
// 			EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t}()),
// 			ErrorMessage: to.Ptr(""),
// 			LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T13:58:42.969Z"); return t}()),
// 			StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t}()),
// 			Status: to.Ptr("Success"),
// 			Steps: []*armazurestackhci.Step{
// 				{
// 					Name: to.Ptr("PreUpdate Cloud"),
// 					Description: to.Ptr("Prepare for SSU update"),
// 					EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t}()),
// 					ErrorMessage: to.Ptr(""),
// 					LastUpdatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:37:16.872Z"); return t}()),
// 					StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T01:36:33.387Z"); return t}()),
// 					Status: to.Ptr("Success"),
// 					Steps: []*armazurestackhci.Step{
// 					},
// 			}},
// 		},
// 	},
// }

Output:

type UpdateRunsClientBeginDeleteOptions 

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

UpdateRunsClientBeginDeleteOptions contains the optional parameters for the UpdateRunsClient.BeginDelete method.

type UpdateRunsClientDeleteResponse 

type UpdateRunsClientDeleteResponse struct {
}

UpdateRunsClientDeleteResponse contains the response from method UpdateRunsClient.BeginDelete.

type UpdateRunsClientGetOptions 

type UpdateRunsClientGetOptions struct {
}

UpdateRunsClientGetOptions contains the optional parameters for the UpdateRunsClient.Get method.

type UpdateRunsClientGetResponse 

type UpdateRunsClientGetResponse struct {
	// Details of an Update run
	UpdateRun
}

UpdateRunsClientGetResponse contains the response from method UpdateRunsClient.Get.

type UpdateRunsClientListOptions 

type UpdateRunsClientListOptions struct {
}

UpdateRunsClientListOptions contains the optional parameters for the UpdateRunsClient.NewListPager method.

type UpdateRunsClientListResponse 

type UpdateRunsClientListResponse struct {
	// List of Update runs
	UpdateRunList
}

UpdateRunsClientListResponse contains the response from method UpdateRunsClient.NewListPager.

type UpdateRunsClientPutOptions 

type UpdateRunsClientPutOptions struct {
}

UpdateRunsClientPutOptions contains the optional parameters for the UpdateRunsClient.Put method.

type UpdateRunsClientPutResponse 

type UpdateRunsClientPutResponse struct {
	// Details of an Update run
	UpdateRun
}

UpdateRunsClientPutResponse contains the response from method UpdateRunsClient.Put.

type UpdateStateProperties 

type UpdateStateProperties struct {
	// Brief message with instructions for updates of AvailabilityType Notify.
	NotifyMessage *string

	// Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state,
	// where it maps to how much of the update content has been downloaded.
	ProgressPercentage *float32
}

UpdateStateProperties - Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.

func (UpdateStateProperties) MarshalJSON 

func (u UpdateStateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateStateProperties.

func (*UpdateStateProperties) UnmarshalJSON 

func (u *UpdateStateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateStateProperties.

type UpdateSummaries 

type UpdateSummaries struct {
	// The geo-location where the resource lives
	Location *string

	// Update summaries properties
	Properties *UpdateSummariesProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

UpdateSummaries - Get the update summaries for the cluster

func (UpdateSummaries) MarshalJSON 

func (u UpdateSummaries) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateSummaries.

func (*UpdateSummaries) UnmarshalJSON 

func (u *UpdateSummaries) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummaries.

type UpdateSummariesClient 

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

UpdateSummariesClient contains the methods for the UpdateSummaries group. Don't use this type directly, use NewUpdateSummariesClient() instead.

func NewUpdateSummariesClient 

func NewUpdateSummariesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UpdateSummariesClient, error)

NewUpdateSummariesClient creates a new instance of UpdateSummariesClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*UpdateSummariesClient) BeginDelete 

func (client *UpdateSummariesClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, options *UpdateSummariesClientBeginDeleteOptions) (*runtime.Poller[UpdateSummariesClientDeleteResponse], error)

BeginDelete - Delete Update Summaries If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - UpdateSummariesClientBeginDeleteOptions contains the optional parameters for the UpdateSummariesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdateSummaries.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewUpdateSummariesClient().BeginDelete(ctx, "testrg", "testcluster", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*UpdateSummariesClient) Get 

func (client *UpdateSummariesClient) Get(ctx context.Context, resourceGroupName string, clusterName string, options *UpdateSummariesClientGetOptions) (UpdateSummariesClientGetResponse, error)

Get - Get all Update summaries under the HCI cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - UpdateSummariesClientGetOptions contains the optional parameters for the UpdateSummariesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdateSummaries.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUpdateSummariesClient().Get(ctx, "testrg", "testcluster", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.UpdateSummaries = armazurestackhci.UpdateSummaries{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/updateSummaries"),
// 	ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default"),
// 	Location: to.Ptr("West US"),
// 	Properties: &armazurestackhci.UpdateSummariesProperties{
// 		CurrentVersion: to.Ptr("4.2203.2.32"),
// 		HardwareModel: to.Ptr("PowerEdge R730xd"),
// 		OemFamily: to.Ptr("DellEMC"),
// 		PackageVersions: []*armazurestackhci.PackageVersionInfo{
// 			{
// 				LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
// 				PackageType: to.Ptr("OEM"),
// 				Version: to.Ptr("2.2.2108.6"),
// 			},
// 			{
// 				LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
// 				PackageType: to.Ptr("Services"),
// 				Version: to.Ptr("4.2203.2.32"),
// 			},
// 			{
// 				LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
// 				PackageType: to.Ptr("Infrastructure"),
// 				Version: to.Ptr("4.2203.2.32"),
// 		}},
// 		State: to.Ptr(armazurestackhci.UpdateSummariesPropertiesStateAppliedSuccessfully),
// 	},
// }

Output:

func (*UpdateSummariesClient) NewListPager 

func (client *UpdateSummariesClient) NewListPager(resourceGroupName string, clusterName string, options *UpdateSummariesClientListOptions) *runtime.Pager[UpdateSummariesClientListResponse]

NewListPager - List all Update summaries under the HCI cluster

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - UpdateSummariesClientListOptions contains the optional parameters for the UpdateSummariesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdateSummaries.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewUpdateSummariesClient().NewListPager("testrg", "testcluster", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.UpdateSummariesList = armazurestackhci.UpdateSummariesList{
	// 	Value: []*armazurestackhci.UpdateSummaries{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AzureStackHCI/updateSummaries"),
	// 			ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default"),
	// 			Location: to.Ptr("West US"),
	// 			Properties: &armazurestackhci.UpdateSummariesProperties{
	// 				CurrentVersion: to.Ptr("4.2203.2.32"),
	// 				HardwareModel: to.Ptr("PowerEdge R730xd"),
	// 				OemFamily: to.Ptr("DellEMC"),
	// 				PackageVersions: []*armazurestackhci.PackageVersionInfo{
	// 					{
	// 						LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
	// 						PackageType: to.Ptr("OEM"),
	// 						Version: to.Ptr("2.2.2108.6"),
	// 					},
	// 					{
	// 						LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
	// 						PackageType: to.Ptr("Services"),
	// 						Version: to.Ptr("4.2203.2.32"),
	// 					},
	// 					{
	// 						LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
	// 						PackageType: to.Ptr("Infrastructure"),
	// 						Version: to.Ptr("4.2203.2.32"),
	// 				}},
	// 				State: to.Ptr(armazurestackhci.UpdateSummariesPropertiesStateAppliedSuccessfully),
	// 			},
	// 	}},
	// }
}

Output:

func (*UpdateSummariesClient) Put 

func (client *UpdateSummariesClient) Put(ctx context.Context, resourceGroupName string, clusterName string, updateLocationProperties UpdateSummaries, options *UpdateSummariesClientPutOptions) (UpdateSummariesClientPutResponse, error)

Put - Put Update summaries under the HCI cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateLocationProperties - Properties of the UpdateSummaries resource
  • options - UpdateSummariesClientPutOptions contains the optional parameters for the UpdateSummariesClient.Put method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdateSummaries.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUpdateSummariesClient().Put(ctx, "testrg", "testcluster", armazurestackhci.UpdateSummaries{
	Properties: &armazurestackhci.UpdateSummariesProperties{
		CurrentVersion: to.Ptr("4.2203.2.32"),
		HardwareModel:  to.Ptr("PowerEdge R730xd"),
		LastChecked:    to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t }()),
		LastUpdated:    to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T14:08:18.254Z"); return t }()),
		OemFamily:      to.Ptr("DellEMC"),
		State:          to.Ptr(armazurestackhci.UpdateSummariesPropertiesStateAppliedSuccessfully),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.UpdateSummaries = armazurestackhci.UpdateSummaries{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/updateSummaries"),
// 	ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default"),
// 	Location: to.Ptr("West US"),
// 	Properties: &armazurestackhci.UpdateSummariesProperties{
// 		CurrentVersion: to.Ptr("4.2203.2.32"),
// 		HardwareModel: to.Ptr("PowerEdge R730xd"),
// 		OemFamily: to.Ptr("DellEMC"),
// 		PackageVersions: []*armazurestackhci.PackageVersionInfo{
// 			{
// 				LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
// 				PackageType: to.Ptr("OEM"),
// 				Version: to.Ptr("2.2.2108.6"),
// 			},
// 			{
// 				LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
// 				PackageType: to.Ptr("Services"),
// 				Version: to.Ptr("4.2203.2.32"),
// 			},
// 			{
// 				LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-07T18:04:07.000Z"); return t}()),
// 				PackageType: to.Ptr("Infrastructure"),
// 				Version: to.Ptr("4.2203.2.32"),
// 		}},
// 		State: to.Ptr(armazurestackhci.UpdateSummariesPropertiesStateAppliedSuccessfully),
// 	},
// }

Output:

type UpdateSummariesClientBeginDeleteOptions 

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

UpdateSummariesClientBeginDeleteOptions contains the optional parameters for the UpdateSummariesClient.BeginDelete method.

type UpdateSummariesClientDeleteResponse 

type UpdateSummariesClientDeleteResponse struct {
}

UpdateSummariesClientDeleteResponse contains the response from method UpdateSummariesClient.BeginDelete.

type UpdateSummariesClientGetOptions 

type UpdateSummariesClientGetOptions struct {
}

UpdateSummariesClientGetOptions contains the optional parameters for the UpdateSummariesClient.Get method.

type UpdateSummariesClientGetResponse 

type UpdateSummariesClientGetResponse struct {
	// Get the update summaries for the cluster
	UpdateSummaries
}

UpdateSummariesClientGetResponse contains the response from method UpdateSummariesClient.Get.

type UpdateSummariesClientListOptions 

type UpdateSummariesClientListOptions struct {
}

UpdateSummariesClientListOptions contains the optional parameters for the UpdateSummariesClient.NewListPager method.

type UpdateSummariesClientListResponse 

type UpdateSummariesClientListResponse struct {
	// List of Update Summaries
	UpdateSummariesList
}

UpdateSummariesClientListResponse contains the response from method UpdateSummariesClient.NewListPager.

type UpdateSummariesClientPutOptions 

type UpdateSummariesClientPutOptions struct {
}

UpdateSummariesClientPutOptions contains the optional parameters for the UpdateSummariesClient.Put method.

type UpdateSummariesClientPutResponse 

type UpdateSummariesClientPutResponse struct {
	// Get the update summaries for the cluster
	UpdateSummaries
}

UpdateSummariesClientPutResponse contains the response from method UpdateSummariesClient.Put.

type UpdateSummariesList 

type UpdateSummariesList struct {
	// List of Update Summaries
	Value []*UpdateSummaries

	// READ-ONLY; Link to the next set of results.
	NextLink *string
}

UpdateSummariesList - List of Update Summaries

func (UpdateSummariesList) MarshalJSON 

func (u UpdateSummariesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateSummariesList.

func (*UpdateSummariesList) UnmarshalJSON 

func (u *UpdateSummariesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummariesList.

type UpdateSummariesProperties 

type UpdateSummariesProperties struct {
	// Current OEM Version.
	CurrentOemVersion *string

	// Current Sbe version of the stamp.
	CurrentSbeVersion *string

	// Current Solution Bundle version of the stamp.
	CurrentVersion *string

	// Name of the hardware model.
	HardwareModel *string

	// Last time the package-specific checks were run.
	HealthCheckDate *time.Time

	// An array of pre-check result objects.
	HealthCheckResult []*PrecheckResult

	// Overall health state for update-specific health checks.
	HealthState *HealthState

	// Last time the update service successfully checked for updates
	LastChecked *time.Time

	// Last time an update installation completed successfully.
	LastUpdated *time.Time

	// OEM family name.
	OemFamily *string

	// Current version of each updatable component.
	PackageVersions []*PackageVersionInfo

	// Overall update state of the stamp.
	State *UpdateSummariesPropertiesState

	// READ-ONLY; Provisioning state of the UpdateSummaries proxy resource.
	ProvisioningState *ProvisioningState
}

UpdateSummariesProperties - Properties of Update summaries

func (UpdateSummariesProperties) MarshalJSON 

func (u UpdateSummariesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateSummariesProperties.

func (*UpdateSummariesProperties) UnmarshalJSON 

func (u *UpdateSummariesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateSummariesProperties.

type UpdateSummariesPropertiesState 

type UpdateSummariesPropertiesState string

UpdateSummariesPropertiesState - Overall update state of the stamp. 

const (
	UpdateSummariesPropertiesStateAppliedSuccessfully   UpdateSummariesPropertiesState = "AppliedSuccessfully"
	UpdateSummariesPropertiesStateNeedsAttention        UpdateSummariesPropertiesState = "NeedsAttention"
	UpdateSummariesPropertiesStatePreparationFailed     UpdateSummariesPropertiesState = "PreparationFailed"
	UpdateSummariesPropertiesStatePreparationInProgress UpdateSummariesPropertiesState = "PreparationInProgress"
	UpdateSummariesPropertiesStateUnknown               UpdateSummariesPropertiesState = "Unknown"
	UpdateSummariesPropertiesStateUpdateAvailable       UpdateSummariesPropertiesState = "UpdateAvailable"
	UpdateSummariesPropertiesStateUpdateFailed          UpdateSummariesPropertiesState = "UpdateFailed"
	UpdateSummariesPropertiesStateUpdateInProgress      UpdateSummariesPropertiesState = "UpdateInProgress"
)

func PossibleUpdateSummariesPropertiesStateValues 

func PossibleUpdateSummariesPropertiesStateValues() []UpdateSummariesPropertiesState

PossibleUpdateSummariesPropertiesStateValues returns the possible values for the UpdateSummariesPropertiesState const type.

type UpdatesClient 

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

UpdatesClient contains the methods for the Updates group. Don't use this type directly, use NewUpdatesClient() instead.

func NewUpdatesClient 

func NewUpdatesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UpdatesClient, error)

NewUpdatesClient creates a new instance of UpdatesClient with the specified values.

  • subscriptionID - The ID of the target subscription. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*UpdatesClient) BeginDelete 

func (client *UpdatesClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, updateName string, options *UpdatesClientBeginDeleteOptions) (*runtime.Poller[UpdatesClientDeleteResponse], error)

BeginDelete - Delete specified Update If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • options - UpdatesClientBeginDeleteOptions contains the optional parameters for the UpdatesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/DeleteUpdates.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewUpdatesClient().BeginDelete(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*UpdatesClient) BeginPost 

func (client *UpdatesClient) BeginPost(ctx context.Context, resourceGroupName string, clusterName string, updateName string, options *UpdatesClientBeginPostOptions) (*runtime.Poller[UpdatesClientPostResponse], error)

BeginPost - Apply Update If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • options - UpdatesClientBeginPostOptions contains the optional parameters for the UpdatesClient.BeginPost method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PostUpdates.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewUpdatesClient().BeginPost(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*UpdatesClient) Get 

func (client *UpdatesClient) Get(ctx context.Context, resourceGroupName string, clusterName string, updateName string, options *UpdatesClientGetOptions) (UpdatesClientGetResponse, error)

Get - Get specified Update If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • options - UpdatesClientGetOptions contains the optional parameters for the UpdatesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/GetUpdates.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUpdatesClient().Get(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Update = armazurestackhci.Update{
// 	Name: to.Ptr("Microsoft4.2203.2.32"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/updates"),
// 	ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32"),
// 	Location: to.Ptr("West US"),
// 	Properties: &armazurestackhci.UpdateProperties{
// 		Description: to.Ptr("AzS Update 4.2203.2.32"),
// 		AdditionalProperties: to.Ptr("additional properties"),
// 		AvailabilityType: to.Ptr(armazurestackhci.AvailabilityTypeLocal),
// 		DisplayName: to.Ptr("AzS Update - 4.2203.2.32"),
// 		InstalledDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T14:08:18.254Z"); return t}()),
// 		PackagePath: to.Ptr("\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32"),
// 		PackageSizeInMb: to.Ptr[float32](18858),
// 		PackageType: to.Ptr("Infrastructure"),
// 		Prerequisites: []*armazurestackhci.UpdatePrerequisite{
// 			{
// 				PackageName: to.Ptr("update package name"),
// 				UpdateType: to.Ptr("update type"),
// 				Version: to.Ptr("prerequisite version"),
// 		}},
// 		Publisher: to.Ptr("Microsoft"),
// 		ReleaseLink: to.Ptr("https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203"),
// 		State: to.Ptr(armazurestackhci.StateInstalled),
// 		UpdateStateProperties: &armazurestackhci.UpdateStateProperties{
// 			NotifyMessage: to.Ptr("Brief message with instructions for updates of AvailabilityType Notify"),
// 			ProgressPercentage: to.Ptr[float32](0),
// 		},
// 		Version: to.Ptr("4.2203.2.32"),
// 	},
// }

Output:

func (*UpdatesClient) NewListPager 

func (client *UpdatesClient) NewListPager(resourceGroupName string, clusterName string, options *UpdatesClientListOptions) *runtime.Pager[UpdatesClientListResponse]

NewListPager - List all Updates

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • options - UpdatesClientListOptions contains the optional parameters for the UpdatesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/ListUpdates.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewUpdatesClient().NewListPager("testrg", "testcluster", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.UpdateList = armazurestackhci.UpdateList{
	// 	Value: []*armazurestackhci.Update{
	// 		{
	// 			Name: to.Ptr("Microsoft4.2203.2.32"),
	// 			Type: to.Ptr(" Microsoft. AzureStackHCI/updates"),
	// 			ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32"),
	// 			Location: to.Ptr("West US"),
	// 			Properties: &armazurestackhci.UpdateProperties{
	// 				Description: to.Ptr("AzS Update 4.2203.2.32"),
	// 				AdditionalProperties: to.Ptr("additional properties"),
	// 				AvailabilityType: to.Ptr(armazurestackhci.AvailabilityTypeLocal),
	// 				DisplayName: to.Ptr("AzS Update - 4.2203.2.32"),
	// 				InstalledDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T14:08:18.254Z"); return t}()),
	// 				PackagePath: to.Ptr("\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32"),
	// 				PackageSizeInMb: to.Ptr[float32](18858),
	// 				PackageType: to.Ptr("Infrastructure"),
	// 				Prerequisites: []*armazurestackhci.UpdatePrerequisite{
	// 					{
	// 						PackageName: to.Ptr("update package name"),
	// 						UpdateType: to.Ptr("update type"),
	// 						Version: to.Ptr("prerequisite version"),
	// 				}},
	// 				Publisher: to.Ptr("Microsoft"),
	// 				ReleaseLink: to.Ptr("https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203"),
	// 				State: to.Ptr(armazurestackhci.StateInstalled),
	// 				UpdateStateProperties: &armazurestackhci.UpdateStateProperties{
	// 					NotifyMessage: to.Ptr("Brief message with instructions for updates of AvailabilityType Notify"),
	// 					ProgressPercentage: to.Ptr[float32](0),
	// 				},
	// 				Version: to.Ptr("4.2203.2.32"),
	// 			},
	// 	}},
	// }
}

Output:

func (*UpdatesClient) Put 

func (client *UpdatesClient) Put(ctx context.Context, resourceGroupName string, clusterName string, updateName string, updateProperties Update, options *UpdatesClientPutOptions) (UpdatesClientPutResponse, error)

Put - Put specified Update If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-04-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the cluster.
  • updateName - The name of the Update
  • updateProperties - Properties of the Updates object
  • options - UpdatesClientPutOptions contains the optional parameters for the UpdatesClient.Put method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c9b146c38df5f76e2d34a3ef771979805ff4ff73/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/stable/2024-04-01/examples/PutUpdates.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armazurestackhci.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUpdatesClient().Put(ctx, "testrg", "testcluster", "Microsoft4.2203.2.32", armazurestackhci.Update{
	Properties: &armazurestackhci.UpdateProperties{
		Description:          to.Ptr("AzS Update 4.2203.2.32"),
		AdditionalProperties: to.Ptr("additional properties"),
		AvailabilityType:     to.Ptr(armazurestackhci.AvailabilityTypeLocal),
		DisplayName:          to.Ptr("AzS Update - 4.2203.2.32"),
		InstalledDate:        to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T14:08:18.254Z"); return t }()),
		PackagePath:          to.Ptr("\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32"),
		PackageSizeInMb:      to.Ptr[float32](18858),
		PackageType:          to.Ptr("Infrastructure"),
		Prerequisites: []*armazurestackhci.UpdatePrerequisite{
			{
				PackageName: to.Ptr("update package name"),
				UpdateType:  to.Ptr("update type"),
				Version:     to.Ptr("prerequisite version"),
			}},
		Publisher:   to.Ptr("Microsoft"),
		ReleaseLink: to.Ptr("https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203"),
		State:       to.Ptr(armazurestackhci.StateInstalled),
		UpdateStateProperties: &armazurestackhci.UpdateStateProperties{
			NotifyMessage:      to.Ptr("Brief message with instructions for updates of AvailabilityType Notify"),
			ProgressPercentage: to.Ptr[float32](0),
		},
		Version: to.Ptr("4.2203.2.32"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Update = armazurestackhci.Update{
// 	Name: to.Ptr("Microsoft4.2203.2.32"),
// 	Type: to.Ptr("Microsoft.AzureStackHCI/updates"),
// 	ID: to.Ptr("/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32"),
// 	Location: to.Ptr("West US"),
// 	Properties: &armazurestackhci.UpdateProperties{
// 		Description: to.Ptr("AzS Update 4.2203.2.32"),
// 		AdditionalProperties: to.Ptr("additional properties"),
// 		AvailabilityType: to.Ptr(armazurestackhci.AvailabilityTypeLocal),
// 		DisplayName: to.Ptr("AzS Update - 4.2203.2.32"),
// 		InstalledDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-06T14:08:18.254Z"); return t}()),
// 		PackagePath: to.Ptr("\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32"),
// 		PackageSizeInMb: to.Ptr[float32](18858),
// 		PackageType: to.Ptr("Infrastructure"),
// 		Prerequisites: []*armazurestackhci.UpdatePrerequisite{
// 			{
// 				PackageName: to.Ptr("update package name"),
// 				UpdateType: to.Ptr("update type"),
// 				Version: to.Ptr("prerequisite version"),
// 		}},
// 		Publisher: to.Ptr("Microsoft"),
// 		ReleaseLink: to.Ptr("https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203"),
// 		State: to.Ptr(armazurestackhci.StateInstalled),
// 		UpdateStateProperties: &armazurestackhci.UpdateStateProperties{
// 			NotifyMessage: to.Ptr("Brief message with instructions for updates of AvailabilityType Notify"),
// 			ProgressPercentage: to.Ptr[float32](0),
// 		},
// 		Version: to.Ptr("4.2203.2.32"),
// 	},
// }

Output:

type UpdatesClientBeginDeleteOptions 

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

UpdatesClientBeginDeleteOptions contains the optional parameters for the UpdatesClient.BeginDelete method.

type UpdatesClientBeginPostOptions 

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

UpdatesClientBeginPostOptions contains the optional parameters for the UpdatesClient.BeginPost method.

type UpdatesClientDeleteResponse 

type UpdatesClientDeleteResponse struct {
}

UpdatesClientDeleteResponse contains the response from method UpdatesClient.BeginDelete.

type UpdatesClientGetOptions 

type UpdatesClientGetOptions struct {
}

UpdatesClientGetOptions contains the optional parameters for the UpdatesClient.Get method.

type UpdatesClientGetResponse 

type UpdatesClientGetResponse struct {
	// Update details
	Update
}

UpdatesClientGetResponse contains the response from method UpdatesClient.Get.

type UpdatesClientListOptions 

type UpdatesClientListOptions struct {
}

UpdatesClientListOptions contains the optional parameters for the UpdatesClient.NewListPager method.

type UpdatesClientListResponse 

type UpdatesClientListResponse struct {
	// List of Updates
	UpdateList
}

UpdatesClientListResponse contains the response from method UpdatesClient.NewListPager.

type UpdatesClientPostResponse 

type UpdatesClientPostResponse struct {
}

UpdatesClientPostResponse contains the response from method UpdatesClient.BeginPost.

type UpdatesClientPutOptions 

type UpdatesClientPutOptions struct {
}

UpdatesClientPutOptions contains the optional parameters for the UpdatesClient.Put method.

type UpdatesClientPutResponse 

type UpdatesClientPutResponse struct {
	// Update details
	Update
}

UpdatesClientPutResponse contains the response from method UpdatesClient.Put.

type UploadCertificateRequest 

type UploadCertificateRequest struct {
	Properties *RawCertificateData
}

func (UploadCertificateRequest) MarshalJSON 

func (u UploadCertificateRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UploadCertificateRequest.

func (*UploadCertificateRequest) UnmarshalJSON 

func (u *UploadCertificateRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadCertificateRequest.

type UserAssignedIdentity 

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON 

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON 

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

type ValidateRequest 

type ValidateRequest struct {
	// REQUIRED; Node Ids against which, current node has to be validated.
	EdgeDeviceIDs []*string

	// Additional info required for validation.
	AdditionalInfo *string
}

ValidateRequest - The validate request for Edge Device.

func (ValidateRequest) MarshalJSON 

func (v ValidateRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidateRequest.

func (*ValidateRequest) UnmarshalJSON 

func (v *ValidateRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValidateRequest.

type ValidateResponse 

type ValidateResponse struct {
	// READ-ONLY; edge device validation status
	Status *string
}

ValidateResponse - An Accepted response with an Operation-Location header.

func (ValidateResponse) MarshalJSON 

func (v ValidateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidateResponse.

func (*ValidateResponse) UnmarshalJSON 

func (v *ValidateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValidateResponse.

type WindowsServerSubscription 

type WindowsServerSubscription string

WindowsServerSubscription - Desired state of Windows Server Subscription. 

const (
	WindowsServerSubscriptionDisabled WindowsServerSubscription = "Disabled"
	WindowsServerSubscriptionEnabled  WindowsServerSubscription = "Enabled"
)

func PossibleWindowsServerSubscriptionValues 

func PossibleWindowsServerSubscriptionValues() []WindowsServerSubscription

PossibleWindowsServerSubscriptionValues returns the possible values for the WindowsServerSubscription const type.

Source Files

View all Source files

Directories

Path Synopsis

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.