armresourceconnector

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Jun 29, 2022 License: MIT Imports: 16 Imported by: 3

README

Azure Resource Connector Module for Go

PkgGoDev

The armresourceconnector module provides operations for working with Azure Resource Connector.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Resource Connector module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector

Authorization

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

cred, err := azidentity.NewDefaultAzureCredential(nil)

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

Clients

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

client, err := armresourceconnector.NewAppliancesClient(<subscription ID>, cred, nil)

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

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

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Resource Connector 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 AccessProfileType 

type AccessProfileType string

AccessProfileType - Name which contains the role of the kubeconfig. 

const (
	AccessProfileTypeClusterCustomerUser AccessProfileType = "clusterCustomerUser"
	AccessProfileTypeClusterUser         AccessProfileType = "clusterUser"
)

func PossibleAccessProfileTypeValues 

func PossibleAccessProfileTypeValues() []AccessProfileType

PossibleAccessProfileTypeValues returns the possible values for the AccessProfileType const type.

type Appliance 

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

	// Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`

	// The set of properties specific to an Appliance
	Properties *ApplianceProperties `json:"properties,omitempty"`

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

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

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

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

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

Appliances definition.

func (Appliance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Appliance.

func (*Appliance) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Appliance.

type ApplianceCredentialKubeconfig 

type ApplianceCredentialKubeconfig struct {
	// READ-ONLY; Name which contains the role of the kubeconfig.
	Name *AccessProfileType `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Contains the kubeconfig value.
	Value *string `json:"value,omitempty" azure:"ro"`
}

ApplianceCredentialKubeconfig - Cluster User Credential appliance.

func (ApplianceCredentialKubeconfig) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceCredentialKubeconfig.

func (*ApplianceCredentialKubeconfig) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceCredentialKubeconfig.

type ApplianceListClusterCustomerUserCredentialResults added in v0.2.0 

type ApplianceListClusterCustomerUserCredentialResults struct {
	// READ-ONLY; The list of appliance kubeconfigs.
	Kubeconfigs []*ApplianceCredentialKubeconfig `json:"kubeconfigs,omitempty" azure:"ro"`

	// READ-ONLY; Map of Customer User Public and Private SSH Keys
	SSHKeys map[string]*SSHKey `json:"sshKeys,omitempty" azure:"ro"`
}

ApplianceListClusterCustomerUserCredentialResults - The List Cluster Customer User Credential Results appliance.

func (ApplianceListClusterCustomerUserCredentialResults) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceListClusterCustomerUserCredentialResults.

func (*ApplianceListClusterCustomerUserCredentialResults) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceListClusterCustomerUserCredentialResults.

type ApplianceListCredentialResults 

type ApplianceListCredentialResults struct {
	// READ-ONLY; Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).
	HybridConnectionConfig *HybridConnectionConfig `json:"hybridConnectionConfig,omitempty" azure:"ro"`

	// READ-ONLY; The list of appliance kubeconfigs.
	Kubeconfigs []*ApplianceCredentialKubeconfig `json:"kubeconfigs,omitempty" azure:"ro"`
}

ApplianceListCredentialResults - The List Cluster User Credential appliance.

func (ApplianceListCredentialResults) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceListCredentialResults.

func (*ApplianceListCredentialResults) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceListCredentialResults.

type ApplianceListResult 

type ApplianceListResult struct {
	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of Appliances.
	Value []*Appliance `json:"value,omitempty" azure:"ro"`
}

ApplianceListResult - The List Appliances operation response.

func (ApplianceListResult) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceListResult.

func (*ApplianceListResult) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceListResult.

type ApplianceOperation 

type ApplianceOperation struct {
	// Describes the properties of an Appliances Operation Value Display.
	Display *ApplianceOperationValueDisplay `json:"display,omitempty"`

	// READ-ONLY; Is this Operation a data plane operation
	IsDataAction *bool `json:"isDataAction,omitempty" azure:"ro"`

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

	// READ-ONLY; The origin of the compute operation.
	Origin *string `json:"origin,omitempty" azure:"ro"`
}

ApplianceOperation - Appliances operation.

func (ApplianceOperation) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceOperation.

func (*ApplianceOperation) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceOperation.

type ApplianceOperationValueDisplay 

type ApplianceOperationValueDisplay struct {
	// READ-ONLY; The description of the operation.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The display name of the compute operation.
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; The resource provider for the operation.
	Provider *string `json:"provider,omitempty" azure:"ro"`

	// READ-ONLY; The display name of the resource the operation applies to.
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

ApplianceOperationValueDisplay - Describes the properties of an Appliances Operation Value Display.

func (ApplianceOperationValueDisplay) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceOperationValueDisplay.

func (*ApplianceOperationValueDisplay) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceOperationValueDisplay.

type ApplianceOperationsList 

type ApplianceOperationsList struct {
	// REQUIRED; Array of applianceOperation
	Value []*ApplianceOperation `json:"value,omitempty"`

	// Next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

ApplianceOperationsList - Lists of Appliances operations.

func (ApplianceOperationsList) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceOperationsList.

func (*ApplianceOperationsList) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceOperationsList.

type ApplianceProperties 

type ApplianceProperties struct {
	// Represents a supported Fabric/Infra. (AKSEdge etc…).
	Distro *Distro `json:"distro,omitempty"`

	// Contains infrastructure information about the Appliance
	InfrastructureConfig *AppliancePropertiesInfrastructureConfig `json:"infrastructureConfig,omitempty"`

	// Certificates pair used to download MSI certificate from HIS
	PublicKey *string `json:"publicKey,omitempty"`

	// Version of the Appliance
	Version *string `json:"version,omitempty"`

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

	// READ-ONLY; Appliance’s health and state of connection to on-prem
	Status *Status `json:"status,omitempty" azure:"ro"`
}

ApplianceProperties - Properties for an appliance.

func (ApplianceProperties) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ApplianceProperties.

func (*ApplianceProperties) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplianceProperties.

type AppliancePropertiesInfrastructureConfig 

type AppliancePropertiesInfrastructureConfig struct {
	// Information about the connected appliance.
	Provider *Provider `json:"provider,omitempty"`
}

AppliancePropertiesInfrastructureConfig - Contains infrastructure information about the Appliance

func (AppliancePropertiesInfrastructureConfig) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type AppliancePropertiesInfrastructureConfig.

func (*AppliancePropertiesInfrastructureConfig) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppliancePropertiesInfrastructureConfig.

type AppliancesClient 

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

AppliancesClient contains the methods for the Appliances group. Don't use this type directly, use NewAppliancesClient() instead.

func NewAppliancesClient 

func NewAppliancesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AppliancesClient, error)

NewAppliancesClient creates a new instance of AppliancesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AppliancesClient) BeginCreateOrUpdate 

func (client *AppliancesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters Appliance, options *AppliancesClientBeginCreateOrUpdateOptions) (*runtime.Poller[AppliancesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an Appliance in the specified Subscription and Resource Group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. parameters - Parameters supplied to create or update an Appliance. options - AppliancesClientBeginCreateOrUpdateOptions contains the optional parameters for the AppliancesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesCreate_Update.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"testresourcegroup",
		"appliance01",
		armresourceconnector.Appliance{
			Location: to.Ptr("West US"),
			Properties: &armresourceconnector.ApplianceProperties{
				Distro: to.Ptr(armresourceconnector.DistroAKSEdge),
				InfrastructureConfig: &armresourceconnector.AppliancePropertiesInfrastructureConfig{
					Provider: to.Ptr(armresourceconnector.ProviderVMWare),
				},
			},
		},
		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)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppliancesClient) BeginDelete 

func (client *AppliancesClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceName string, options *AppliancesClientBeginDeleteOptions) (*runtime.Poller[AppliancesClientDeleteResponse], error)

BeginDelete - Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. options - AppliancesClientBeginDeleteOptions contains the optional parameters for the AppliancesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"testresourcegroup",
		"appliance01",
		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 (*AppliancesClient) Get 

func (client *AppliancesClient) Get(ctx context.Context, resourceGroupName string, resourceName string, options *AppliancesClientGetOptions) (AppliancesClientGetResponse, error)

Get - Gets the details of an Appliance with a specified resource group and name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. options - AppliancesClientGetOptions contains the optional parameters for the AppliancesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"testresourcegroup",
		"appliance01",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppliancesClient) GetUpgradeGraph added in v0.2.0 

func (client *AppliancesClient) GetUpgradeGraph(ctx context.Context, resourceGroupName string, resourceName string, upgradeGraph string, options *AppliancesClientGetUpgradeGraphOptions) (AppliancesClientGetUpgradeGraphResponse, error)

GetUpgradeGraph - Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. upgradeGraph - Upgrade graph version, ex - stable options - AppliancesClientGetUpgradeGraphOptions contains the optional parameters for the AppliancesClient.GetUpgradeGraph method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/UpgradeGraph.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetUpgradeGraph(ctx,
		"testresourcegroup",
		"appliance01",
		"stable",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppliancesClient) ListClusterCustomerUserCredential added in v0.2.0 

func (client *AppliancesClient) ListClusterCustomerUserCredential(ctx context.Context, resourceGroupName string, resourceName string, options *AppliancesClientListClusterCustomerUserCredentialOptions) (AppliancesClientListClusterCustomerUserCredentialResponse, error)

ListClusterCustomerUserCredential - Returns the cluster customer user credentials for the dedicated appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. options - AppliancesClientListClusterCustomerUserCredentialOptions contains the optional parameters for the AppliancesClient.ListClusterCustomerUserCredential method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesListClusterCustomerUserCredential.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListClusterCustomerUserCredential(ctx,
		"testresourcegroup",
		"appliance01",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppliancesClient) ListClusterUserCredential 

func (client *AppliancesClient) ListClusterUserCredential(ctx context.Context, resourceGroupName string, resourceName string, options *AppliancesClientListClusterUserCredentialOptions) (AppliancesClientListClusterUserCredentialResponse, error)

ListClusterUserCredential - Returns the cluster user credentials for the dedicated appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. options - AppliancesClientListClusterUserCredentialOptions contains the optional parameters for the AppliancesClient.ListClusterUserCredential method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesListClusterUserCredential.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListClusterUserCredential(ctx,
		"testresourcegroup",
		"appliance01",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppliancesClient) NewListByResourceGroupPager 

func (client *AppliancesClient) NewListByResourceGroupPager(resourceGroupName string, options *AppliancesClientListByResourceGroupOptions) *runtime.Pager[AppliancesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. options - AppliancesClientListByResourceGroupOptions contains the optional parameters for the AppliancesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("testresourcegroup",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*AppliancesClient) NewListBySubscriptionPager 

func (client *AppliancesClient) NewListBySubscriptionPager(options *AppliancesClientListBySubscriptionOptions) *runtime.Pager[AppliancesClientListBySubscriptionResponse]

NewListBySubscriptionPager - Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview options - AppliancesClientListBySubscriptionOptions contains the optional parameters for the AppliancesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*AppliancesClient) NewListOperationsPager 

func (client *AppliancesClient) NewListOperationsPager(options *AppliancesClientListOperationsOptions) *runtime.Pager[AppliancesClientListOperationsResponse]

NewListOperationsPager - Lists all available Appliances operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview options - AppliancesClientListOperationsOptions contains the optional parameters for the AppliancesClient.ListOperations method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesListOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourceconnector/armresourceconnector"
)

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

Output:

func (*AppliancesClient) Update 

func (client *AppliancesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters PatchableAppliance, options *AppliancesClientUpdateOptions) (AppliancesClientUpdateResponse, error)

Update - Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-15-preview resourceGroupName - The name of the resource group. The name is case insensitive. resourceName - Appliances name. parameters - The updatable fields of an existing Appliance. options - AppliancesClientUpdateOptions contains the optional parameters for the AppliancesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/examples/AppliancesPatch.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresourceconnector.NewAppliancesClient("11111111-2222-3333-4444-555555555555", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"testresourcegroup",
		"appliance01",
		armresourceconnector.PatchableAppliance{
			Tags: map[string]*string{
				"key": to.Ptr("value"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type AppliancesClientBeginCreateOrUpdateOptions 

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

AppliancesClientBeginCreateOrUpdateOptions contains the optional parameters for the AppliancesClient.BeginCreateOrUpdate method.

type AppliancesClientBeginDeleteOptions 

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

AppliancesClientBeginDeleteOptions contains the optional parameters for the AppliancesClient.BeginDelete method.

type AppliancesClientCreateOrUpdateResponse 

type AppliancesClientCreateOrUpdateResponse struct {
	Appliance
}

AppliancesClientCreateOrUpdateResponse contains the response from method AppliancesClient.CreateOrUpdate.

type AppliancesClientDeleteResponse 

type AppliancesClientDeleteResponse struct {
}

AppliancesClientDeleteResponse contains the response from method AppliancesClient.Delete.

type AppliancesClientGetOptions 

type AppliancesClientGetOptions struct {
}

AppliancesClientGetOptions contains the optional parameters for the AppliancesClient.Get method.

type AppliancesClientGetResponse 

type AppliancesClientGetResponse struct {
	Appliance
}

AppliancesClientGetResponse contains the response from method AppliancesClient.Get.

type AppliancesClientGetUpgradeGraphOptions added in v0.2.0 

type AppliancesClientGetUpgradeGraphOptions struct {
}

AppliancesClientGetUpgradeGraphOptions contains the optional parameters for the AppliancesClient.GetUpgradeGraph method.

type AppliancesClientGetUpgradeGraphResponse added in v0.2.0 

type AppliancesClientGetUpgradeGraphResponse struct {
	UpgradeGraph
}

AppliancesClientGetUpgradeGraphResponse contains the response from method AppliancesClient.GetUpgradeGraph.

type AppliancesClientListByResourceGroupOptions 

type AppliancesClientListByResourceGroupOptions struct {
}

AppliancesClientListByResourceGroupOptions contains the optional parameters for the AppliancesClient.ListByResourceGroup method.

type AppliancesClientListByResourceGroupResponse 

type AppliancesClientListByResourceGroupResponse struct {
	ApplianceListResult
}

AppliancesClientListByResourceGroupResponse contains the response from method AppliancesClient.ListByResourceGroup.

type AppliancesClientListBySubscriptionOptions 

type AppliancesClientListBySubscriptionOptions struct {
}

AppliancesClientListBySubscriptionOptions contains the optional parameters for the AppliancesClient.ListBySubscription method.

type AppliancesClientListBySubscriptionResponse 

type AppliancesClientListBySubscriptionResponse struct {
	ApplianceListResult
}

AppliancesClientListBySubscriptionResponse contains the response from method AppliancesClient.ListBySubscription.

type AppliancesClientListClusterCustomerUserCredentialOptions added in v0.2.0 

type AppliancesClientListClusterCustomerUserCredentialOptions struct {
}

AppliancesClientListClusterCustomerUserCredentialOptions contains the optional parameters for the AppliancesClient.ListClusterCustomerUserCredential method.

type AppliancesClientListClusterCustomerUserCredentialResponse added in v0.2.0 

type AppliancesClientListClusterCustomerUserCredentialResponse struct {
	ApplianceListClusterCustomerUserCredentialResults
}

AppliancesClientListClusterCustomerUserCredentialResponse contains the response from method AppliancesClient.ListClusterCustomerUserCredential.

type AppliancesClientListClusterUserCredentialOptions 

type AppliancesClientListClusterUserCredentialOptions struct {
}

AppliancesClientListClusterUserCredentialOptions contains the optional parameters for the AppliancesClient.ListClusterUserCredential method.

type AppliancesClientListClusterUserCredentialResponse 

type AppliancesClientListClusterUserCredentialResponse struct {
	ApplianceListCredentialResults
}

AppliancesClientListClusterUserCredentialResponse contains the response from method AppliancesClient.ListClusterUserCredential.

type AppliancesClientListOperationsOptions 

type AppliancesClientListOperationsOptions struct {
}

AppliancesClientListOperationsOptions contains the optional parameters for the AppliancesClient.ListOperations method.

type AppliancesClientListOperationsResponse 

type AppliancesClientListOperationsResponse struct {
	ApplianceOperationsList
}

AppliancesClientListOperationsResponse contains the response from method AppliancesClient.ListOperations.

type AppliancesClientUpdateOptions 

type AppliancesClientUpdateOptions struct {
}

AppliancesClientUpdateOptions contains the optional parameters for the AppliancesClient.Update method.

type AppliancesClientUpdateResponse 

type AppliancesClientUpdateResponse struct {
	Appliance
}

AppliancesClientUpdateResponse contains the response from method AppliancesClient.Update.

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 Distro 

type Distro string

Distro - Represents a supported Fabric/Infra. (AKSEdge etc…). 

const (
	DistroAKSEdge Distro = "AKSEdge"
)

func PossibleDistroValues 

func PossibleDistroValues() []Distro

PossibleDistroValues returns the possible values for the Distro const type.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

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

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type HybridConnectionConfig 

type HybridConnectionConfig struct {
	// READ-ONLY; Timestamp when this token will be expired.
	ExpirationTime *int64 `json:"expirationTime,omitempty" azure:"ro"`

	// READ-ONLY; Name of the connection
	HybridConnectionName *string `json:"hybridConnectionName,omitempty" azure:"ro"`

	// READ-ONLY; Name of the notification service.
	Relay *string `json:"relay,omitempty" azure:"ro"`

	// READ-ONLY; Listener access token
	Token *string `json:"token,omitempty" azure:"ro"`
}

HybridConnectionConfig - Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).

func (HybridConnectionConfig) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type HybridConnectionConfig.

func (*HybridConnectionConfig) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HybridConnectionConfig.

type Identity 

type Identity struct {
	// The identity type.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource.

func (Identity) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type PatchableAppliance 

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

PatchableAppliance - The Appliances patchable resource definition.

func (PatchableAppliance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PatchableAppliance.

func (*PatchableAppliance) UnmarshalJSON added in v0.2.0 

func (p *PatchableAppliance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchableAppliance.

type Provider 

type Provider string

Provider - Information about the connected appliance. 

const (
	ProviderHCI       Provider = "HCI"
	ProviderKubeVirt  Provider = "KubeVirt"
	ProviderOpenStack Provider = "OpenStack"
	ProviderSCVMM     Provider = "SCVMM"
	ProviderVMWare    Provider = "VMWare"
)

func PossibleProviderValues 

func PossibleProviderValues() []Provider

PossibleProviderValues returns the possible values for the Provider const type.

type Resource 

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

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

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

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

func (Resource) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v0.2.0 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The identity type. 

const (
	ResourceIdentityTypeNone           ResourceIdentityType = "None"
	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

type SSHKey added in v0.2.0 

type SSHKey struct {
	// User Private Key.
	PrivateKey *string `json:"privateKey,omitempty"`

	// User Public Key.
	PublicKey *string `json:"publicKey,omitempty"`
}

SSHKey - Appliance SSHKey definition.

func (SSHKey) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type SSHKey.

func (*SSHKey) UnmarshalJSON added in v0.2.0 

func (s *SSHKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SSHKey.

type SSHKeyType added in v0.2.0 

type SSHKeyType string

SSHKeyType - Appliance SSHKeyType definition. 

const (
	SSHKeyTypeSSHCustomerUser SSHKeyType = "SSHCustomerUser"
)

func PossibleSSHKeyTypeValues added in v0.2.0 

func PossibleSSHKeyTypeValues() []SSHKeyType

PossibleSSHKeyTypeValues returns the possible values for the SSHKeyType const type.

type Status 

type Status string

Status - Appliance’s health and state of connection to on-prem 

const (
	StatusConnected                             Status = "Connected"
	StatusConnecting                            Status = "Connecting"
	StatusNone                                  Status = "None"
	StatusOffline                               Status = "Offline"
	StatusPostUpgrade                           Status = "PostUpgrade"
	StatusPreUpgrade                            Status = "PreUpgrade"
	StatusPreparingForUpgrade                   Status = "PreparingForUpgrade"
	StatusRunning                               Status = "Running"
	StatusUpdatingCAPI                          Status = "UpdatingCAPI"
	StatusUpdatingCloudOperator                 Status = "UpdatingCloudOperator"
	StatusUpdatingCluster                       Status = "UpdatingCluster"
	StatusUpgradeClusterExtensionFailedToDelete Status = "UpgradeClusterExtensionFailedToDelete"
	StatusUpgradeComplete                       Status = "UpgradeComplete"
	StatusUpgradeFailed                         Status = "UpgradeFailed"
	StatusUpgradePrerequisitesCompleted         Status = "UpgradePrerequisitesCompleted"
	StatusValidating                            Status = "Validating"
	StatusWaitingForCloudOperator               Status = "WaitingForCloudOperator"
	StatusWaitingForHeartbeat                   Status = "WaitingForHeartbeat"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type SupportedVersion added in v0.2.0 

type SupportedVersion struct {
	// READ-ONLY; This is the metadata of the supported newer version.
	Metadata *SupportedVersionMetadata `json:"metadata,omitempty" azure:"ro"`

	// READ-ONLY; The newer version available for upgrade.
	Version *string `json:"version,omitempty" azure:"ro"`
}

SupportedVersion - The SupportedVersion object for appliance.

func (SupportedVersion) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type SupportedVersion.

func (*SupportedVersion) UnmarshalJSON added in v0.2.0 

func (s *SupportedVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedVersion.

type SupportedVersionCatalogVersion added in v0.2.0 

type SupportedVersionCatalogVersion struct {
	// READ-ONLY; The newer supported version catalog version data.
	Data *SupportedVersionCatalogVersionData `json:"data,omitempty" azure:"ro"`

	// READ-ONLY; The catalog version name for the version available for upgrade.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The catalog version namespace for the version available for upgrade.
	Namespace *string `json:"namespace,omitempty" azure:"ro"`
}

SupportedVersionCatalogVersion - The SupportedVersionCatalogVersion object for appliance.

func (SupportedVersionCatalogVersion) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type SupportedVersionCatalogVersion.

func (*SupportedVersionCatalogVersion) UnmarshalJSON added in v0.2.0 

func (s *SupportedVersionCatalogVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedVersionCatalogVersion.

type SupportedVersionCatalogVersionData added in v0.2.0 

type SupportedVersionCatalogVersionData struct {
	// READ-ONLY; The image audience name for the version available for upgrade.
	Audience *string `json:"audience,omitempty" azure:"ro"`

	// READ-ONLY; The image catalog name for the version available for upgrade.
	Catalog *string `json:"catalog,omitempty" azure:"ro"`

	// READ-ONLY; The image offer name for the version available for upgrade.
	Offer *string `json:"offer,omitempty" azure:"ro"`

	// READ-ONLY; The image version for the version available for upgrade.
	Version *string `json:"version,omitempty" azure:"ro"`
}

SupportedVersionCatalogVersionData - The SupportedVersionCatalogVersionData object for appliance.

func (SupportedVersionCatalogVersionData) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type SupportedVersionCatalogVersionData.

func (*SupportedVersionCatalogVersionData) UnmarshalJSON added in v0.2.0 

func (s *SupportedVersionCatalogVersionData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedVersionCatalogVersionData.

type SupportedVersionMetadata added in v0.2.0 

type SupportedVersionMetadata struct {
	// READ-ONLY; The newer supported version catalog version.
	CatalogVersion *SupportedVersionCatalogVersion `json:"catalogVersion,omitempty" azure:"ro"`
}

SupportedVersionMetadata - The SupportedVersionMetadata object for appliance.

func (SupportedVersionMetadata) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type SupportedVersionMetadata.

func (*SupportedVersionMetadata) UnmarshalJSON added in v0.2.0 

func (s *SupportedVersionMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedVersionMetadata.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TrackedResource 

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

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

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

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

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

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON added in v0.2.0 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type UpgradeGraph added in v0.2.0 

type UpgradeGraph struct {
	// The properties of supported version
	Properties *UpgradeGraphProperties `json:"properties,omitempty"`

	// READ-ONLY; The appliance resource path
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The release train name.
	Name *string `json:"name,omitempty" azure:"ro"`
}

UpgradeGraph - The Upgrade Graph for appliance.

func (UpgradeGraph) MarshalJSON added in v0.2.0 

func (u UpgradeGraph) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpgradeGraph.

func (*UpgradeGraph) UnmarshalJSON added in v0.2.0 

func (u *UpgradeGraph) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpgradeGraph.

type UpgradeGraphProperties added in v0.2.0 

type UpgradeGraphProperties struct {
	// READ-ONLY; The current appliance version
	ApplianceVersion *string `json:"applianceVersion,omitempty" azure:"ro"`

	// READ-ONLY; This contains the current version and supported upgrade versions.
	SupportedVersions []*SupportedVersion `json:"supportedVersions,omitempty" azure:"ro"`
}

UpgradeGraphProperties - The Upgrade Graph Properties for appliance.

func (UpgradeGraphProperties) MarshalJSON added in v0.2.0 

func (u UpgradeGraphProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpgradeGraphProperties.

func (*UpgradeGraphProperties) UnmarshalJSON added in v0.2.0 

func (u *UpgradeGraphProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpgradeGraphProperties.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.