armnetapp

package module
v3.0.0 Latest Latest
Warning

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

Go to latest
Published: Sep 20, 2022 License: MIT Imports: 17 Imported by: 1

README

Azure NetApp Files Module for Go

PkgGoDev

The armnetapp module provides operations for working with Azure NetApp Files.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure NetApp Files module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v2

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure NetApp Files. 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 NetApp Files 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 := armnetapp.NewBackupsClient(<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 := armnetapp.NewBackupsClient(<subscription ID>, cred, &options)

Major Version Upgrade

Go uses semantic import versioning to ensure a good backward compatibility for modules. For Azure Go management SDK, we usually upgrade module version according to cooresponding service's API version. Regarding it could be a complicated experience for major version upgrade, we will try our best to keep the SDK API stable and release new version in backward compatible way. However, if any unavoidable breaking changes and a new major version releases for SDK modules, you could use these commands under your module folder to upgrade:

go install github.com/icholy/gomajor@latest
gomajor get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute@latest

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the NetApp Files 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 Account

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

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

	// NetApp Account properties
	Properties *AccountProperties `json:"properties,omitempty"`

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

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// 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; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

Account - NetApp account resource

func (Account) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Account.

func (*Account) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Account.

type AccountBackupsClient

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

AccountBackupsClient contains the methods for the AccountBackups group. Don't use this type directly, use NewAccountBackupsClient() instead.

func NewAccountBackupsClient

func NewAccountBackupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccountBackupsClient, error)

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

func (*AccountBackupsClient) BeginDelete

func (client *AccountBackupsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, backupName string, options *AccountBackupsClientBeginDeleteOptions) (*runtime.Poller[AccountBackupsClientDeleteResponse], error)

BeginDelete - Delete the specified Backup for a Netapp Account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account backupName - The name of the backup options - AccountBackupsClientBeginDeleteOptions contains the optional parameters for the AccountBackupsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Account_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "resourceGroup", "accountName", "backupName", 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 (*AccountBackupsClient) Get

func (client *AccountBackupsClient) Get(ctx context.Context, resourceGroupName string, accountName string, backupName string, options *AccountBackupsClientGetOptions) (AccountBackupsClientGetResponse, error)

Get - Gets the specified backup for a Netapp Account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account backupName - The name of the backup options - AccountBackupsClientGetOptions contains the optional parameters for the AccountBackupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Account_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "backup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AccountBackupsClient) NewListPager

func (client *AccountBackupsClient) NewListPager(resourceGroupName string, accountName string, options *AccountBackupsClientListOptions) *runtime.Pager[AccountBackupsClientListResponse]

NewListPager - List all Backups for a Netapp Account Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - AccountBackupsClientListOptions contains the optional parameters for the AccountBackupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Account_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", 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:

type AccountBackupsClientBeginDeleteOptions

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

AccountBackupsClientBeginDeleteOptions contains the optional parameters for the AccountBackupsClient.BeginDelete method.

type AccountBackupsClientDeleteResponse

type AccountBackupsClientDeleteResponse struct {
}

AccountBackupsClientDeleteResponse contains the response from method AccountBackupsClient.Delete.

type AccountBackupsClientGetOptions

type AccountBackupsClientGetOptions struct {
}

AccountBackupsClientGetOptions contains the optional parameters for the AccountBackupsClient.Get method.

type AccountBackupsClientGetResponse

type AccountBackupsClientGetResponse struct {
	Backup
}

AccountBackupsClientGetResponse contains the response from method AccountBackupsClient.Get.

type AccountBackupsClientListOptions

type AccountBackupsClientListOptions struct {
}

AccountBackupsClientListOptions contains the optional parameters for the AccountBackupsClient.List method.

type AccountBackupsClientListResponse

type AccountBackupsClientListResponse struct {
	BackupsList
}

AccountBackupsClientListResponse contains the response from method AccountBackupsClient.List.

type AccountEncryption

type AccountEncryption struct {
	// Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'.
	Identity *EncryptionIdentity `json:"identity,omitempty"`

	// The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault
	KeySource *KeySource `json:"keySource,omitempty"`

	// Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'.
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

AccountEncryption - Encryption settings

func (AccountEncryption) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AccountEncryption.

func (*AccountEncryption) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AccountEncryption.

type AccountList

type AccountList struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Multiple NetApp accounts
	Value []*Account `json:"value,omitempty"`
}

AccountList - List of NetApp account resources

func (AccountList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AccountList.

func (*AccountList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AccountList.

type AccountPatch

type AccountPatch struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// NetApp Account properties
	Properties *AccountProperties `json:"properties,omitempty"`

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

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

AccountPatch - NetApp account patch resource

func (AccountPatch) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AccountPatch.

func (*AccountPatch) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AccountPatch.

type AccountProperties

type AccountProperties struct {
	// Active Directories
	ActiveDirectories []*ActiveDirectory `json:"activeDirectories,omitempty"`

	// Encryption settings
	Encryption *AccountEncryption `json:"encryption,omitempty"`

	// READ-ONLY; Shows the status of disableShowmount for all volumes under the subscription, null equals false
	DisableShowmount *bool `json:"disableShowmount,omitempty" azure:"ro"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

AccountProperties - NetApp account properties

func (AccountProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AccountProperties.

func (*AccountProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AccountProperties.

type AccountsClient

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

AccountsClient contains the methods for the Accounts group. Don't use this type directly, use NewAccountsClient() instead.

func NewAccountsClient

func NewAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccountsClient, error)

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

func (*AccountsClient) BeginCreateOrUpdate

func (client *AccountsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, body Account, options *AccountsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AccountsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update the specified NetApp account within the resource group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account body - NetApp Account object supplied in the body of the operation. options - AccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the AccountsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Accounts_CreateOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "myRG", "account1", armnetapp.Account{
	Location: to.Ptr("eastus"),
	Properties: &armnetapp.AccountProperties{
		ActiveDirectories: []*armnetapp.ActiveDirectory{
			{
				AesEncryption:      to.Ptr(true),
				DNS:                to.Ptr("10.10.10.3, 10.10.10.4"),
				Domain:             to.Ptr("10.10.10.3"),
				LdapOverTLS:        to.Ptr(false),
				LdapSigning:        to.Ptr(false),
				OrganizationalUnit: to.Ptr("OU=Engineering"),
				Password:           to.Ptr("ad_password"),
				Site:               to.Ptr("SiteName"),
				SmbServerName:      to.Ptr("SMBServer"),
				Username:           to.Ptr("ad_user_name"),
			}},
	},
}, 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 (*AccountsClient) BeginDelete

func (client *AccountsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientBeginDeleteOptions) (*runtime.Poller[AccountsClientDeleteResponse], error)

BeginDelete - Delete the specified NetApp account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Accounts_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account1", 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 (*AccountsClient) BeginRenewCredentials

func (client *AccountsClient) BeginRenewCredentials(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientBeginRenewCredentialsOptions) (*runtime.Poller[AccountsClientRenewCredentialsResponse], error)

BeginRenewCredentials - Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - AccountsClientBeginRenewCredentialsOptions contains the optional parameters for the AccountsClient.BeginRenewCredentials method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Accounts_RenewCredentials.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRenewCredentials(ctx, "myRG", "account1", 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 (*AccountsClient) BeginUpdate

func (client *AccountsClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, body AccountPatch, options *AccountsClientBeginUpdateOptions) (*runtime.Poller[AccountsClientUpdateResponse], error)

BeginUpdate - Patch the specified NetApp account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account body - NetApp Account object supplied in the body of the operation. options - AccountsClientBeginUpdateOptions contains the optional parameters for the AccountsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Accounts_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", armnetapp.AccountPatch{
	Tags: map[string]*string{
		"Tag1": to.Ptr("Value1"),
	},
}, 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 (*AccountsClient) Get

func (client *AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientGetOptions) (AccountsClientGetResponse, error)

Get - Get the NetApp account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Accounts_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AccountsClient) NewListBySubscriptionPager

NewListBySubscriptionPager - List and describe all NetApp accounts in the subscription. Generated from API version 2022-05-01 options - AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Accounts_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewAccountsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", 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 (*AccountsClient) NewListPager

func (client *AccountsClient) NewListPager(resourceGroupName string, options *AccountsClientListOptions) *runtime.Pager[AccountsClientListResponse]

NewListPager - List and describe all NetApp accounts in the resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - AccountsClientListOptions contains the optional parameters for the AccountsClient.List method.

type AccountsClientBeginCreateOrUpdateOptions

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

AccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the AccountsClient.BeginCreateOrUpdate method.

type AccountsClientBeginDeleteOptions

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

AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.

type AccountsClientBeginRenewCredentialsOptions

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

AccountsClientBeginRenewCredentialsOptions contains the optional parameters for the AccountsClient.BeginRenewCredentials method.

type AccountsClientBeginUpdateOptions

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

AccountsClientBeginUpdateOptions contains the optional parameters for the AccountsClient.BeginUpdate method.

type AccountsClientCreateOrUpdateResponse

type AccountsClientCreateOrUpdateResponse struct {
	Account
}

AccountsClientCreateOrUpdateResponse contains the response from method AccountsClient.CreateOrUpdate.

type AccountsClientDeleteResponse

type AccountsClientDeleteResponse struct {
}

AccountsClientDeleteResponse contains the response from method AccountsClient.Delete.

type AccountsClientGetOptions

type AccountsClientGetOptions struct {
}

AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.

type AccountsClientGetResponse

type AccountsClientGetResponse struct {
	Account
}

AccountsClientGetResponse contains the response from method AccountsClient.Get.

type AccountsClientListBySubscriptionOptions

type AccountsClientListBySubscriptionOptions struct {
}

AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.ListBySubscription method.

type AccountsClientListBySubscriptionResponse

type AccountsClientListBySubscriptionResponse struct {
	AccountList
}

AccountsClientListBySubscriptionResponse contains the response from method AccountsClient.ListBySubscription.

type AccountsClientListOptions

type AccountsClientListOptions struct {
}

AccountsClientListOptions contains the optional parameters for the AccountsClient.List method.

type AccountsClientListResponse

type AccountsClientListResponse struct {
	AccountList
}

AccountsClientListResponse contains the response from method AccountsClient.List.

type AccountsClientRenewCredentialsResponse

type AccountsClientRenewCredentialsResponse struct {
}

AccountsClientRenewCredentialsResponse contains the response from method AccountsClient.RenewCredentials.

type AccountsClientUpdateResponse

type AccountsClientUpdateResponse struct {
	Account
}

AccountsClientUpdateResponse contains the response from method AccountsClient.Update.

type ActiveDirectory

type ActiveDirectory struct {
	// Id of the Active Directory
	ActiveDirectoryID *string `json:"activeDirectoryId,omitempty"`

	// Name of the active directory machine. This optional parameter is used only while creating kerberos volume
	AdName *string `json:"adName,omitempty"`

	// Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier
	Administrators []*string `json:"administrators,omitempty"`

	// If enabled, AES encryption will be enabled for SMB communication.
	AesEncryption *bool `json:"aesEncryption,omitempty"`

	// If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.
	AllowLocalNfsUsersWithLdap *bool `json:"allowLocalNfsUsersWithLdap,omitempty"`

	// Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier
	BackupOperators []*string `json:"backupOperators,omitempty"`

	// Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain
	DNS *string `json:"dns,omitempty"`

	// Name of the Active Directory domain
	Domain *string `json:"domain,omitempty"`

	// If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.
	EncryptDCConnections *bool `json:"encryptDCConnections,omitempty"`

	// kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos
	// volume.
	KdcIP *string `json:"kdcIP,omitempty"`

	// Specifies whether or not the LDAP traffic needs to be secured via TLS.
	LdapOverTLS *bool `json:"ldapOverTLS,omitempty"`

	// LDAP Search scope options
	LdapSearchScope *LdapSearchScopeOpt `json:"ldapSearchScope,omitempty"`

	// Specifies whether or not the LDAP traffic needs to be signed.
	LdapSigning *bool `json:"ldapSigning,omitempty"`

	// The Organizational Unit (OU) within the Windows Active Directory
	OrganizationalUnit *string `json:"organizationalUnit,omitempty"`

	// Plain text password of Active Directory domain administrator, value is masked in the response
	Password *string `json:"password,omitempty"`

	// Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares
	// for SQL). A list of unique usernames without domain specifier
	SecurityOperators []*string `json:"securityOperators,omitempty"`

	// When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's
	// self-signed root CA certificate, this optional parameter is used only for
	// dual protocol with LDAP user-mapping volumes.
	ServerRootCACertificate *string `json:"serverRootCACertificate,omitempty"`

	// The Active Directory site the service will limit Domain Controller discovery to
	Site *string `json:"site,omitempty"`

	// NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes
	SmbServerName *string `json:"smbServerName,omitempty"`

	// Username of Active Directory domain administrator
	Username *string `json:"username,omitempty"`

	// READ-ONLY; Status of the Active Directory
	Status *ActiveDirectoryStatus `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; Any details in regards to the Status of the Active Directory
	StatusDetails *string `json:"statusDetails,omitempty" azure:"ro"`
}

ActiveDirectory - Active Directory

func (ActiveDirectory) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveDirectory.

func (*ActiveDirectory) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveDirectory.

type ActiveDirectoryStatus

type ActiveDirectoryStatus string

ActiveDirectoryStatus - Status of the Active Directory

const (
	// ActiveDirectoryStatusCreated - Active Directory created but not in use
	ActiveDirectoryStatusCreated ActiveDirectoryStatus = "Created"
	// ActiveDirectoryStatusDeleted - Active Directory Deleted
	ActiveDirectoryStatusDeleted ActiveDirectoryStatus = "Deleted"
	// ActiveDirectoryStatusError - Error with the Active Directory
	ActiveDirectoryStatusError ActiveDirectoryStatus = "Error"
	// ActiveDirectoryStatusInUse - Active Directory in use by SMB Volume
	ActiveDirectoryStatusInUse ActiveDirectoryStatus = "InUse"
	// ActiveDirectoryStatusUpdating - Active Directory Updating
	ActiveDirectoryStatusUpdating ActiveDirectoryStatus = "Updating"
)

func PossibleActiveDirectoryStatusValues

func PossibleActiveDirectoryStatusValues() []ActiveDirectoryStatus

PossibleActiveDirectoryStatusValues returns the possible values for the ActiveDirectoryStatus const type.

type ApplicationType

type ApplicationType string

ApplicationType - Application Type

const (
	ApplicationTypeSAPHANA ApplicationType = "SAP-HANA"
)

func PossibleApplicationTypeValues

func PossibleApplicationTypeValues() []ApplicationType

PossibleApplicationTypeValues returns the possible values for the ApplicationType const type.

type AuthorizeRequest

type AuthorizeRequest struct {
	// Resource id of the remote volume
	RemoteVolumeResourceID *string `json:"remoteVolumeResourceId,omitempty"`
}

AuthorizeRequest - Authorize request

func (AuthorizeRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AuthorizeRequest.

func (*AuthorizeRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizeRequest.

type AvsDataStore

type AvsDataStore string

AvsDataStore - Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose

const (
	// AvsDataStoreDisabled - avsDataStore is disabled
	AvsDataStoreDisabled AvsDataStore = "Disabled"
	// AvsDataStoreEnabled - avsDataStore is enabled
	AvsDataStoreEnabled AvsDataStore = "Enabled"
)

func PossibleAvsDataStoreValues

func PossibleAvsDataStoreValues() []AvsDataStore

PossibleAvsDataStoreValues returns the possible values for the AvsDataStore const type.

type Backup

type Backup struct {
	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// REQUIRED; Backup Properties
	Properties *BackupProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Backup of a Volume

func (Backup) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Backup.

func (*Backup) UnmarshalJSON

func (b *Backup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Backup.

type BackupPatch

type BackupPatch struct {
	// Backup Properties
	Properties *BackupProperties `json:"properties,omitempty"`

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

BackupPatch - Backup patch

func (BackupPatch) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupPatch.

func (*BackupPatch) UnmarshalJSON

func (b *BackupPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupPatch.

type BackupPoliciesClient

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

BackupPoliciesClient contains the methods for the BackupPolicies group. Don't use this type directly, use NewBackupPoliciesClient() instead.

func NewBackupPoliciesClient

func NewBackupPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupPoliciesClient, error)

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

func (*BackupPoliciesClient) BeginCreate

func (client *BackupPoliciesClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, backupPolicyName string, body BackupPolicy, options *BackupPoliciesClientBeginCreateOptions) (*runtime.Poller[BackupPoliciesClientCreateResponse], error)

BeginCreate - Create a backup policy for Netapp Account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account backupPolicyName - Backup policy Name which uniquely identify backup policy. body - Backup policy object supplied in the body of the operation. options - BackupPoliciesClientBeginCreateOptions contains the optional parameters for the BackupPoliciesClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/BackupPolicies_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "myRG", "account1", "backupPolicyName", armnetapp.BackupPolicy{
	Location: to.Ptr("westus"),
	Properties: &armnetapp.BackupPolicyProperties{
		DailyBackupsToKeep:   to.Ptr[int32](10),
		Enabled:              to.Ptr(true),
		MonthlyBackupsToKeep: to.Ptr[int32](10),
		WeeklyBackupsToKeep:  to.Ptr[int32](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)
}
// TODO: use response item
_ = res
Output:

func (*BackupPoliciesClient) BeginDelete

func (client *BackupPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, backupPolicyName string, options *BackupPoliciesClientBeginDeleteOptions) (*runtime.Poller[BackupPoliciesClientDeleteResponse], error)

BeginDelete - Delete backup policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account backupPolicyName - Backup policy Name which uniquely identify backup policy. options - BackupPoliciesClientBeginDeleteOptions contains the optional parameters for the BackupPoliciesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/BackupPolicies_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "resourceGroup", "accountName", "backupPolicyName", 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 (*BackupPoliciesClient) BeginUpdate

func (client *BackupPoliciesClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, backupPolicyName string, body BackupPolicyPatch, options *BackupPoliciesClientBeginUpdateOptions) (*runtime.Poller[BackupPoliciesClientUpdateResponse], error)

BeginUpdate - Patch a backup policy for Netapp Account If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account backupPolicyName - Backup policy Name which uniquely identify backup policy. body - Backup policy object supplied in the body of the operation. options - BackupPoliciesClientBeginUpdateOptions contains the optional parameters for the BackupPoliciesClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/BackupPolicies_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "backupPolicyName", armnetapp.BackupPolicyPatch{
	Location: to.Ptr("westus"),
	Properties: &armnetapp.BackupPolicyProperties{
		DailyBackupsToKeep:   to.Ptr[int32](5),
		Enabled:              to.Ptr(false),
		MonthlyBackupsToKeep: to.Ptr[int32](10),
		WeeklyBackupsToKeep:  to.Ptr[int32](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)
}
// TODO: use response item
_ = res
Output:

func (*BackupPoliciesClient) Get

func (client *BackupPoliciesClient) Get(ctx context.Context, resourceGroupName string, accountName string, backupPolicyName string, options *BackupPoliciesClientGetOptions) (BackupPoliciesClientGetResponse, error)

Get - Get a particular backup Policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account backupPolicyName - Backup policy Name which uniquely identify backup policy. options - BackupPoliciesClientGetOptions contains the optional parameters for the BackupPoliciesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/BackupPolicies_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "backupPolicyName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BackupPoliciesClient) NewListPager

func (client *BackupPoliciesClient) NewListPager(resourceGroupName string, accountName string, options *BackupPoliciesClientListOptions) *runtime.Pager[BackupPoliciesClientListResponse]

NewListPager - List backup policies for Netapp Account Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - BackupPoliciesClientListOptions contains the optional parameters for the BackupPoliciesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/BackupPolicies_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", 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:

type BackupPoliciesClientBeginCreateOptions

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

BackupPoliciesClientBeginCreateOptions contains the optional parameters for the BackupPoliciesClient.BeginCreate method.

type BackupPoliciesClientBeginDeleteOptions

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

BackupPoliciesClientBeginDeleteOptions contains the optional parameters for the BackupPoliciesClient.BeginDelete method.

type BackupPoliciesClientBeginUpdateOptions

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

BackupPoliciesClientBeginUpdateOptions contains the optional parameters for the BackupPoliciesClient.BeginUpdate method.

type BackupPoliciesClientCreateResponse

type BackupPoliciesClientCreateResponse struct {
	BackupPolicy
}

BackupPoliciesClientCreateResponse contains the response from method BackupPoliciesClient.Create.

type BackupPoliciesClientDeleteResponse

type BackupPoliciesClientDeleteResponse struct {
}

BackupPoliciesClientDeleteResponse contains the response from method BackupPoliciesClient.Delete.

type BackupPoliciesClientGetOptions

type BackupPoliciesClientGetOptions struct {
}

BackupPoliciesClientGetOptions contains the optional parameters for the BackupPoliciesClient.Get method.

type BackupPoliciesClientGetResponse

type BackupPoliciesClientGetResponse struct {
	BackupPolicy
}

BackupPoliciesClientGetResponse contains the response from method BackupPoliciesClient.Get.

type BackupPoliciesClientListOptions

type BackupPoliciesClientListOptions struct {
}

BackupPoliciesClientListOptions contains the optional parameters for the BackupPoliciesClient.List method.

type BackupPoliciesClientListResponse

type BackupPoliciesClientListResponse struct {
	BackupPoliciesList
}

BackupPoliciesClientListResponse contains the response from method BackupPoliciesClient.List.

type BackupPoliciesClientUpdateResponse

type BackupPoliciesClientUpdateResponse struct {
	BackupPolicy
}

BackupPoliciesClientUpdateResponse contains the response from method BackupPoliciesClient.Update.

type BackupPoliciesList

type BackupPoliciesList struct {
	// A list of backup policies
	Value []*BackupPolicy `json:"value,omitempty"`
}

BackupPoliciesList - List of Backup Policies

func (BackupPoliciesList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupPoliciesList.

func (*BackupPoliciesList) UnmarshalJSON

func (b *BackupPoliciesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupPoliciesList.

type BackupPolicy

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

	// REQUIRED; Backup policy Properties
	Properties *BackupPolicyProperties `json:"properties,omitempty"`

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

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// 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; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

BackupPolicy - Backup policy information

func (BackupPolicy) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupPolicy.

func (*BackupPolicy) UnmarshalJSON

func (b *BackupPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupPolicy.

type BackupPolicyPatch

type BackupPolicyPatch struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// Backup policy Properties
	Properties *BackupPolicyProperties `json:"properties,omitempty"`

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

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

BackupPolicyPatch - Backup policy Details for create and update

func (BackupPolicyPatch) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupPolicyPatch.

func (*BackupPolicyPatch) UnmarshalJSON

func (b *BackupPolicyPatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupPolicyPatch.

type BackupPolicyProperties

type BackupPolicyProperties struct {
	// Daily backups count to keep
	DailyBackupsToKeep *int32 `json:"dailyBackupsToKeep,omitempty"`

	// The property to decide policy is enabled or not
	Enabled *bool `json:"enabled,omitempty"`

	// Monthly backups count to keep
	MonthlyBackupsToKeep *int32 `json:"monthlyBackupsToKeep,omitempty"`

	// Weekly backups count to keep
	WeeklyBackupsToKeep *int32 `json:"weeklyBackupsToKeep,omitempty"`

	// READ-ONLY; Backup Policy Resource ID
	BackupPolicyID *string `json:"backupPolicyId,omitempty" azure:"ro"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; A list of volumes assigned to this policy
	VolumeBackups []*VolumeBackups `json:"volumeBackups,omitempty" azure:"ro"`

	// READ-ONLY; Volumes using current backup policy
	VolumesAssigned *int32 `json:"volumesAssigned,omitempty" azure:"ro"`
}

BackupPolicyProperties - Backup policy properties

func (BackupPolicyProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupPolicyProperties.

func (*BackupPolicyProperties) UnmarshalJSON

func (b *BackupPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupPolicyProperties.

type BackupProperties

type BackupProperties struct {
	// Label for backup
	Label *string `json:"label,omitempty"`

	// Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
	UseExistingSnapshot *bool `json:"useExistingSnapshot,omitempty"`

	// READ-ONLY; UUID v4 used to identify the Backup
	BackupID *string `json:"backupId,omitempty" azure:"ro"`

	// READ-ONLY; Type of backup Manual or Scheduled
	BackupType *BackupType `json:"backupType,omitempty" azure:"ro"`

	// READ-ONLY; The creation date of the backup
	CreationDate *time.Time `json:"creationDate,omitempty" azure:"ro"`

	// READ-ONLY; Failure reason
	FailureReason *string `json:"failureReason,omitempty" azure:"ro"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Size of backup
	Size *int64 `json:"size,omitempty" azure:"ro"`

	// READ-ONLY; Volume name
	VolumeName *string `json:"volumeName,omitempty" azure:"ro"`
}

BackupProperties - Backup properties

func (BackupProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupProperties.

func (*BackupProperties) UnmarshalJSON

func (b *BackupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupProperties.

type BackupStatus

type BackupStatus struct {
	// READ-ONLY; Displays error message if the backup is in an error state
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Backup health status
	Healthy *bool `json:"healthy,omitempty" azure:"ro"`

	// READ-ONLY; Displays the last transfer size
	LastTransferSize *int64 `json:"lastTransferSize,omitempty" azure:"ro"`

	// READ-ONLY; Displays the last transfer type
	LastTransferType *string `json:"lastTransferType,omitempty" azure:"ro"`

	// READ-ONLY; The status of the backup
	MirrorState *MirrorState `json:"mirrorState,omitempty" azure:"ro"`

	// READ-ONLY; Status of the backup mirror relationship
	RelationshipStatus *RelationshipStatus `json:"relationshipStatus,omitempty" azure:"ro"`

	// READ-ONLY; Displays the total bytes transferred
	TotalTransferBytes *int64 `json:"totalTransferBytes,omitempty" azure:"ro"`

	// READ-ONLY; Reason for the unhealthy backup relationship
	UnhealthyReason *string `json:"unhealthyReason,omitempty" azure:"ro"`
}

BackupStatus - Backup status

func (BackupStatus) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupStatus.

func (*BackupStatus) UnmarshalJSON

func (b *BackupStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupStatus.

type BackupType

type BackupType string

BackupType - Type of backup Manual or Scheduled

const (
	// BackupTypeManual - Manual backup
	BackupTypeManual BackupType = "Manual"
	// BackupTypeScheduled - Scheduled backup
	BackupTypeScheduled BackupType = "Scheduled"
)

func PossibleBackupTypeValues

func PossibleBackupTypeValues() []BackupType

PossibleBackupTypeValues returns the possible values for the BackupType const type.

type BackupsClient

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

BackupsClient contains the methods for the Backups group. Don't use this type directly, use NewBackupsClient() instead.

func NewBackupsClient

func NewBackupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BackupsClient, error)

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

func (*BackupsClient) BeginCreate

func (client *BackupsClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, backupName string, body Backup, options *BackupsClientBeginCreateOptions) (*runtime.Poller[BackupsClientCreateResponse], error)

BeginCreate - Create a backup for the volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume backupName - The name of the backup body - Backup object supplied in the body of the operation. options - BackupsClientBeginCreateOptions contains the optional parameters for the BackupsClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "myRG", "account1", "pool1", "volume1", "backup1", armnetapp.Backup{
	Location: to.Ptr("eastus"),
	Properties: &armnetapp.BackupProperties{
		Label: to.Ptr("myLabel"),
	},
}, 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 (*BackupsClient) BeginDelete

func (client *BackupsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, backupName string, options *BackupsClientBeginDeleteOptions) (*runtime.Poller[BackupsClientDeleteResponse], error)

BeginDelete - Delete a backup of the volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume backupName - The name of the backup options - BackupsClientBeginDeleteOptions contains the optional parameters for the BackupsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "resourceGroup", "accountName", "poolName", "volumeName", "backupName", 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 (*BackupsClient) BeginUpdate

func (client *BackupsClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, backupName string, body BackupPatch, options *BackupsClientBeginUpdateOptions) (*runtime.Poller[BackupsClientUpdateResponse], error)

BeginUpdate - Patch a backup for the volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume backupName - The name of the backup body - Backup object supplied in the body of the operation. options - BackupsClientBeginUpdateOptions contains the optional parameters for the BackupsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "pool1", "volume1", "backup1", armnetapp.BackupPatch{}, &armnetapp.BackupsClientBeginUpdateOptions{})
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 (*BackupsClient) Get

func (client *BackupsClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, backupName string, options *BackupsClientGetOptions) (BackupsClientGetResponse, error)

Get - Gets the specified backup of the volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume backupName - The name of the backup options - BackupsClientGetOptions contains the optional parameters for the BackupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "pool1", "volume1", "backup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BackupsClient) GetStatus

func (client *BackupsClient) GetStatus(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *BackupsClientGetStatusOptions) (BackupsClientGetStatusResponse, error)

GetStatus - Get the status of the backup for a volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - BackupsClientGetStatusOptions contains the optional parameters for the BackupsClient.GetStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_BackupStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetStatus(ctx, "myRG", "account1", "pool1", "volume1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BackupsClient) GetVolumeRestoreStatus

func (client *BackupsClient) GetVolumeRestoreStatus(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *BackupsClientGetVolumeRestoreStatusOptions) (BackupsClientGetVolumeRestoreStatusResponse, error)

GetVolumeRestoreStatus - Get the status of the restore for a volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - BackupsClientGetVolumeRestoreStatusOptions contains the optional parameters for the BackupsClient.GetVolumeRestoreStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_RestoreStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetVolumeRestoreStatus(ctx, "myRG", "account1", "pool1", "volume1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BackupsClient) NewListPager

func (client *BackupsClient) NewListPager(resourceGroupName string, accountName string, poolName string, volumeName string, options *BackupsClientListOptions) *runtime.Pager[BackupsClientListResponse]

NewListPager - List all backups for a volume Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - BackupsClientListOptions contains the optional parameters for the BackupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Backups_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewBackupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", "pool1", "volume1", 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:

type BackupsClientBeginCreateOptions

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

BackupsClientBeginCreateOptions contains the optional parameters for the BackupsClient.BeginCreate method.

type BackupsClientBeginDeleteOptions

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

BackupsClientBeginDeleteOptions contains the optional parameters for the BackupsClient.BeginDelete method.

type BackupsClientBeginUpdateOptions

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

BackupsClientBeginUpdateOptions contains the optional parameters for the BackupsClient.BeginUpdate method.

type BackupsClientCreateResponse

type BackupsClientCreateResponse struct {
	Backup
}

BackupsClientCreateResponse contains the response from method BackupsClient.Create.

type BackupsClientDeleteResponse

type BackupsClientDeleteResponse struct {
}

BackupsClientDeleteResponse contains the response from method BackupsClient.Delete.

type BackupsClientGetOptions

type BackupsClientGetOptions struct {
}

BackupsClientGetOptions contains the optional parameters for the BackupsClient.Get method.

type BackupsClientGetResponse

type BackupsClientGetResponse struct {
	Backup
}

BackupsClientGetResponse contains the response from method BackupsClient.Get.

type BackupsClientGetStatusOptions

type BackupsClientGetStatusOptions struct {
}

BackupsClientGetStatusOptions contains the optional parameters for the BackupsClient.GetStatus method.

type BackupsClientGetStatusResponse

type BackupsClientGetStatusResponse struct {
	BackupStatus
}

BackupsClientGetStatusResponse contains the response from method BackupsClient.GetStatus.

type BackupsClientGetVolumeRestoreStatusOptions

type BackupsClientGetVolumeRestoreStatusOptions struct {
}

BackupsClientGetVolumeRestoreStatusOptions contains the optional parameters for the BackupsClient.GetVolumeRestoreStatus method.

type BackupsClientGetVolumeRestoreStatusResponse

type BackupsClientGetVolumeRestoreStatusResponse struct {
	RestoreStatus
}

BackupsClientGetVolumeRestoreStatusResponse contains the response from method BackupsClient.GetVolumeRestoreStatus.

type BackupsClientListOptions

type BackupsClientListOptions struct {
}

BackupsClientListOptions contains the optional parameters for the BackupsClient.List method.

type BackupsClientListResponse

type BackupsClientListResponse struct {
	BackupsList
}

BackupsClientListResponse contains the response from method BackupsClient.List.

type BackupsClientUpdateResponse

type BackupsClientUpdateResponse struct {
	Backup
}

BackupsClientUpdateResponse contains the response from method BackupsClient.Update.

type BackupsList

type BackupsList struct {
	// A list of Backups
	Value []*Backup `json:"value,omitempty"`
}

BackupsList - List of Backups

func (BackupsList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BackupsList.

func (*BackupsList) UnmarshalJSON

func (b *BackupsList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupsList.

type BreakReplicationRequest

type BreakReplicationRequest struct {
	// If replication is in status transferring and you want to force break the replication, set to true
	ForceBreakReplication *bool `json:"forceBreakReplication,omitempty"`
}

BreakReplicationRequest - Break replication request

func (BreakReplicationRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BreakReplicationRequest.

func (*BreakReplicationRequest) UnmarshalJSON

func (b *BreakReplicationRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BreakReplicationRequest.

type CapacityPool

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

	// REQUIRED; Capacity pool properties
	Properties *PoolProperties `json:"properties,omitempty"`

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

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// 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; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

CapacityPool - Capacity pool resource

func (CapacityPool) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CapacityPool.

func (*CapacityPool) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CapacityPool.

type CapacityPoolList

type CapacityPoolList struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Capacity pools
	Value []*CapacityPool `json:"value,omitempty"`
}

CapacityPoolList - List of capacity pool resources

func (CapacityPoolList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CapacityPoolList.

func (*CapacityPoolList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CapacityPoolList.

type CapacityPoolPatch

type CapacityPoolPatch struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// Capacity pool properties
	Properties *PoolPatchProperties `json:"properties,omitempty"`

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

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

CapacityPoolPatch - Capacity pool patch resource

func (CapacityPoolPatch) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CapacityPoolPatch.

func (*CapacityPoolPatch) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CapacityPoolPatch.

type CheckAvailabilityResponse

type CheckAvailabilityResponse struct {
	// true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.
	IsAvailable *bool `json:"isAvailable,omitempty"`

	// If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements
	// so that the user can select a valid name. If reason == AlreadyExists,
	// explain that resource name is already in use, and direct them to select a different name.
	Message *string `json:"message,omitempty"`

	// Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that
	// the name is already in use and is therefore unavailable.
	Reason *InAvailabilityReasonType `json:"reason,omitempty"`
}

CheckAvailabilityResponse - Information regarding availability of a resource.

func (CheckAvailabilityResponse) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CheckAvailabilityResponse.

func (*CheckAvailabilityResponse) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckAvailabilityResponse.

type CheckNameResourceTypes

type CheckNameResourceTypes string

CheckNameResourceTypes - Resource type used for verification.

const (
	CheckNameResourceTypesMicrosoftNetAppNetAppAccounts                              CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts"
	CheckNameResourceTypesMicrosoftNetAppNetAppAccountsCapacityPools                 CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools"
	CheckNameResourceTypesMicrosoftNetAppNetAppAccountsCapacityPoolsVolumes          CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"
	CheckNameResourceTypesMicrosoftNetAppNetAppAccountsCapacityPoolsVolumesSnapshots CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"
)

func PossibleCheckNameResourceTypesValues

func PossibleCheckNameResourceTypesValues() []CheckNameResourceTypes

PossibleCheckNameResourceTypesValues returns the possible values for the CheckNameResourceTypes const type.

type CheckQuotaNameResourceTypes

type CheckQuotaNameResourceTypes string

CheckQuotaNameResourceTypes - Resource type used for verification.

const (
	CheckQuotaNameResourceTypesMicrosoftNetAppNetAppAccounts                              CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts"
	CheckQuotaNameResourceTypesMicrosoftNetAppNetAppAccountsCapacityPools                 CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools"
	CheckQuotaNameResourceTypesMicrosoftNetAppNetAppAccountsCapacityPoolsVolumes          CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"
	CheckQuotaNameResourceTypesMicrosoftNetAppNetAppAccountsCapacityPoolsVolumesSnapshots CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"
)

func PossibleCheckQuotaNameResourceTypesValues

func PossibleCheckQuotaNameResourceTypesValues() []CheckQuotaNameResourceTypes

PossibleCheckQuotaNameResourceTypesValues returns the possible values for the CheckQuotaNameResourceTypes const type.

type ChownMode

type ChownMode string

ChownMode - This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.

const (
	ChownModeRestricted   ChownMode = "Restricted"
	ChownModeUnrestricted ChownMode = "Unrestricted"
)

func PossibleChownModeValues

func PossibleChownModeValues() []ChownMode

PossibleChownModeValues returns the possible values for the ChownMode 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 DailySchedule

type DailySchedule struct {
	// Indicates which hour in UTC timezone a snapshot should be taken
	Hour *int32 `json:"hour,omitempty"`

	// Indicates which minute snapshot should be taken
	Minute *int32 `json:"minute,omitempty"`

	// Daily snapshot count to keep
	SnapshotsToKeep *int32 `json:"snapshotsToKeep,omitempty"`

	// Resource size in bytes, current storage usage for the volume in bytes
	UsedBytes *int64 `json:"usedBytes,omitempty"`
}

DailySchedule - Daily Schedule properties

func (DailySchedule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DailySchedule.

func (*DailySchedule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DailySchedule.

type Dimension

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

	// Display name of dimension.
	Name *string `json:"name,omitempty"`
}

Dimension of blobs, possibly be blob type or access tier.

func (Dimension) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Dimension.

func (*Dimension) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Dimension.

type EnableSubvolumes

type EnableSubvolumes string

EnableSubvolumes - Flag indicating whether subvolume operations are enabled on the volume

const (
	// EnableSubvolumesDisabled - subvolumes are not enabled
	EnableSubvolumesDisabled EnableSubvolumes = "Disabled"
	// EnableSubvolumesEnabled - subvolumes are enabled
	EnableSubvolumesEnabled EnableSubvolumes = "Enabled"
)

func PossibleEnableSubvolumesValues

func PossibleEnableSubvolumesValues() []EnableSubvolumes

PossibleEnableSubvolumesValues returns the possible values for the EnableSubvolumes const type.

type EncryptionIdentity

type EncryptionIdentity struct {
	// The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type
	// has 'UserAssigned'. It should match key of identity.userAssignedIdentities.
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`

	// READ-ONLY; The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

EncryptionIdentity - Identity used to authenticate with key vault.

func (EncryptionIdentity) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type EncryptionIdentity.

func (*EncryptionIdentity) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionIdentity.

type EncryptionKeySource

type EncryptionKeySource string

EncryptionKeySource - Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'

const (
	// EncryptionKeySourceMicrosoftKeyVault - Customer-managed key encryption
	EncryptionKeySourceMicrosoftKeyVault EncryptionKeySource = "Microsoft.KeyVault"
	// EncryptionKeySourceMicrosoftNetApp - Microsoft-managed key encryption
	EncryptionKeySourceMicrosoftNetApp EncryptionKeySource = "Microsoft.NetApp"
)

func PossibleEncryptionKeySourceValues

func PossibleEncryptionKeySourceValues() []EncryptionKeySource

PossibleEncryptionKeySourceValues returns the possible values for the EncryptionKeySource const type.

type EncryptionType

type EncryptionType string

EncryptionType - Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.

const (
	// EncryptionTypeDouble - EncryptionType Double, volumes will use double encryption at rest
	EncryptionTypeDouble EncryptionType = "Double"
	// EncryptionTypeSingle - EncryptionType Single, volumes will use single encryption at rest
	EncryptionTypeSingle EncryptionType = "Single"
)

func PossibleEncryptionTypeValues

func PossibleEncryptionTypeValues() []EncryptionType

PossibleEncryptionTypeValues returns the possible values for the EncryptionType const type.

type EndpointType

type EndpointType string

EndpointType - Indicates whether the local volume is the source or destination for the Volume Replication

const (
	EndpointTypeDst EndpointType = "dst"
	EndpointTypeSrc EndpointType = "src"
)

func PossibleEndpointTypeValues

func PossibleEndpointTypeValues() []EndpointType

PossibleEndpointTypeValues returns the possible values for the EndpointType const type.

type ExportPolicyRule

type ExportPolicyRule struct {
	// Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
	AllowedClients *string `json:"allowedClients,omitempty"`

	// This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the
	// ownership of the file. unrestricted - Non-root users can change ownership of
	// files that they own.
	ChownMode *ChownMode `json:"chownMode,omitempty"`

	// Allows CIFS protocol
	Cifs *bool `json:"cifs,omitempty"`

	// Has root access to volume
	HasRootAccess *bool `json:"hasRootAccess,omitempty"`

	// Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
	Kerberos5IReadOnly *bool `json:"kerberos5iReadOnly,omitempty"`

	// Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
	Kerberos5IReadWrite *bool `json:"kerberos5iReadWrite,omitempty"`

	// Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
	Kerberos5PReadOnly *bool `json:"kerberos5pReadOnly,omitempty"`

	// Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
	Kerberos5PReadWrite *bool `json:"kerberos5pReadWrite,omitempty"`

	// Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
	Kerberos5ReadOnly *bool `json:"kerberos5ReadOnly,omitempty"`

	// Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
	Kerberos5ReadWrite *bool `json:"kerberos5ReadWrite,omitempty"`

	// Allows NFSv3 protocol. Enable only for NFSv3 type volumes
	Nfsv3 *bool `json:"nfsv3,omitempty"`

	// Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
	Nfsv41 *bool `json:"nfsv41,omitempty"`

	// Order index
	RuleIndex *int32 `json:"ruleIndex,omitempty"`

	// Read only access
	UnixReadOnly *bool `json:"unixReadOnly,omitempty"`

	// Read and write access
	UnixReadWrite *bool `json:"unixReadWrite,omitempty"`
}

ExportPolicyRule - Volume Export Policy Rule

func (ExportPolicyRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ExportPolicyRule.

func (*ExportPolicyRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExportPolicyRule.

type FilePathAvailabilityRequest

type FilePathAvailabilityRequest struct {
	// REQUIRED; File path to verify.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
	SubnetID *string `json:"subnetId,omitempty"`
}

FilePathAvailabilityRequest - File path availability request content - availability is based on the name and the subnetId.

func (FilePathAvailabilityRequest) MarshalJSON

func (f FilePathAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FilePathAvailabilityRequest.

func (*FilePathAvailabilityRequest) UnmarshalJSON

func (f *FilePathAvailabilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FilePathAvailabilityRequest.

type HourlySchedule

type HourlySchedule struct {
	// Indicates which minute snapshot should be taken
	Minute *int32 `json:"minute,omitempty"`

	// Hourly snapshot count to keep
	SnapshotsToKeep *int32 `json:"snapshotsToKeep,omitempty"`

	// Resource size in bytes, current storage usage for the volume in bytes
	UsedBytes *int64 `json:"usedBytes,omitempty"`
}

HourlySchedule - Hourly Schedule properties

func (HourlySchedule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type HourlySchedule.

func (*HourlySchedule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type HourlySchedule.

type Identity

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

	// Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage
	// account. The key is the ARM resource identifier of the identity. Only 1
	// User Assigned identity is permitted here.
	UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities,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

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

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type IdentityType

type IdentityType string

IdentityType - The identity type.

const (
	IdentityTypeNone                       IdentityType = "None"
	IdentityTypeSystemAssigned             IdentityType = "SystemAssigned"
	IdentityTypeSystemAssignedUserAssigned IdentityType = "SystemAssigned,UserAssigned"
	IdentityTypeUserAssigned               IdentityType = "UserAssigned"
)

func PossibleIdentityTypeValues

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

type InAvailabilityReasonType

type InAvailabilityReasonType string

InAvailabilityReasonType - Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.

const (
	InAvailabilityReasonTypeAlreadyExists InAvailabilityReasonType = "AlreadyExists"
	InAvailabilityReasonTypeInvalid       InAvailabilityReasonType = "Invalid"
)

func PossibleInAvailabilityReasonTypeValues

func PossibleInAvailabilityReasonTypeValues() []InAvailabilityReasonType

PossibleInAvailabilityReasonTypeValues returns the possible values for the InAvailabilityReasonType const type.

type KeySource

type KeySource string

KeySource - The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault

const (
	// KeySourceMicrosoftKeyVault - Customer-managed key encryption
	KeySourceMicrosoftKeyVault KeySource = "Microsoft.KeyVault"
	// KeySourceMicrosoftNetApp - Microsoft-managed key encryption
	KeySourceMicrosoftNetApp KeySource = "Microsoft.NetApp"
)

func PossibleKeySourceValues

func PossibleKeySourceValues() []KeySource

PossibleKeySourceValues returns the possible values for the KeySource const type.

type KeyVaultProperties

type KeyVaultProperties struct {
	// REQUIRED; The name of KeyVault key.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; The resource ID of KeyVault.
	KeyVaultResourceID *string `json:"keyVaultResourceId,omitempty"`

	// REQUIRED; The Uri of KeyVault.
	KeyVaultURI *string `json:"keyVaultUri,omitempty"`

	// READ-ONLY; UUID v4 used to identify the Azure Key Vault configuration
	KeyVaultID *string `json:"keyVaultId,omitempty" azure:"ro"`

	// READ-ONLY; Status of the KeyVault connection.
	Status *KeyVaultStatus `json:"status,omitempty" azure:"ro"`
}

KeyVaultProperties - Properties of key vault.

func (KeyVaultProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type KeyVaultProperties.

func (*KeyVaultProperties) UnmarshalJSON

func (k *KeyVaultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultProperties.

type KeyVaultStatus

type KeyVaultStatus string

KeyVaultStatus - Status of the KeyVault connection.

const (
	// KeyVaultStatusCreated - KeyVault connection created but not in use
	KeyVaultStatusCreated KeyVaultStatus = "Created"
	// KeyVaultStatusDeleted - KeyVault connection Deleted
	KeyVaultStatusDeleted KeyVaultStatus = "Deleted"
	// KeyVaultStatusError - Error with the KeyVault connection
	KeyVaultStatusError KeyVaultStatus = "Error"
	// KeyVaultStatusInUse - KeyVault connection in use by SMB Volume
	KeyVaultStatusInUse KeyVaultStatus = "InUse"
	// KeyVaultStatusUpdating - KeyVault connection Updating
	KeyVaultStatusUpdating KeyVaultStatus = "Updating"
)

func PossibleKeyVaultStatusValues

func PossibleKeyVaultStatusValues() []KeyVaultStatus

PossibleKeyVaultStatusValues returns the possible values for the KeyVaultStatus const type.

type LdapSearchScopeOpt

type LdapSearchScopeOpt struct {
	// This specifies the group DN, which overrides the base DN for group lookups.
	GroupDN *string `json:"groupDN,omitempty"`

	// This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.
	GroupMembershipFilter *string `json:"groupMembershipFilter,omitempty"`

	// This specifies the user DN, which overrides the base DN for user lookups.
	UserDN *string `json:"userDN,omitempty"`
}

LdapSearchScopeOpt - LDAP search scope

func (LdapSearchScopeOpt) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type LdapSearchScopeOpt.

func (*LdapSearchScopeOpt) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type LdapSearchScopeOpt.

type ListReplications

type ListReplications struct {
	// A list of replications
	Value []*Replication `json:"value,omitempty"`
}

ListReplications - List Replications

func (ListReplications) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ListReplications.

func (*ListReplications) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ListReplications.

type LogSpecification

type LogSpecification struct {
	// Display name of log specification.
	DisplayName *string `json:"displayName,omitempty"`

	// Name of log specification.
	Name *string `json:"name,omitempty"`
}

LogSpecification - Log Definition of a single resource metric.

func (LogSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type LogSpecification.

func (*LogSpecification) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type LogSpecification.

type MetricAggregationType

type MetricAggregationType string
const (
	MetricAggregationTypeAverage MetricAggregationType = "Average"
)

func PossibleMetricAggregationTypeValues

func PossibleMetricAggregationTypeValues() []MetricAggregationType

PossibleMetricAggregationTypeValues returns the possible values for the MetricAggregationType const type.

type MetricSpecification

type MetricSpecification struct {
	// Aggregation type could be Average.
	AggregationType *string `json:"aggregationType,omitempty"`

	// The category this metric specification belong to, could be Capacity.
	Category *string `json:"category,omitempty"`

	// Dimensions of blobs, including blob type and access tier.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

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

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

	// Whether or not the service is using regional MDM accounts.
	EnableRegionalMdmAccount *bool `json:"enableRegionalMdmAccount,omitempty"`

	// The property to decide fill gap with zero or not.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// The internal metric name.
	InternalMetricName *string `json:"internalMetricName,omitempty"`

	// Whether the metric is internal.
	IsInternal *bool `json:"isInternal,omitempty"`

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

	// Account Resource Id.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`

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

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

	// Support metric aggregation type.
	SupportedAggregationTypes []*MetricAggregationType `json:"supportedAggregationTypes,omitempty"`

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

	// Unit could be Bytes or Count.
	Unit *string `json:"unit,omitempty"`
}

MetricSpecification - Metric specification of operation.

func (MetricSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type MetricSpecification.

func (*MetricSpecification) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type MetricSpecification.

type MirrorState

type MirrorState string

MirrorState - The status of the replication

const (
	MirrorStateBroken        MirrorState = "Broken"
	MirrorStateMirrored      MirrorState = "Mirrored"
	MirrorStateUninitialized MirrorState = "Uninitialized"
)

func PossibleMirrorStateValues

func PossibleMirrorStateValues() []MirrorState

PossibleMirrorStateValues returns the possible values for the MirrorState const type.

type MonthlySchedule

type MonthlySchedule struct {
	// Indicates which days of the month snapshot should be taken. A comma delimited string.
	DaysOfMonth *string `json:"daysOfMonth,omitempty"`

	// Indicates which hour in UTC timezone a snapshot should be taken
	Hour *int32 `json:"hour,omitempty"`

	// Indicates which minute snapshot should be taken
	Minute *int32 `json:"minute,omitempty"`

	// Monthly snapshot count to keep
	SnapshotsToKeep *int32 `json:"snapshotsToKeep,omitempty"`

	// Resource size in bytes, current storage usage for the volume in bytes
	UsedBytes *int64 `json:"usedBytes,omitempty"`
}

MonthlySchedule - Monthly Schedule properties

func (MonthlySchedule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type MonthlySchedule.

func (*MonthlySchedule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type MonthlySchedule.

type MountTargetProperties

type MountTargetProperties struct {
	// REQUIRED; UUID v4 used to identify the MountTarget
	FileSystemID *string `json:"fileSystemId,omitempty"`

	// The SMB server's Fully Qualified Domain Name, FQDN
	SmbServerFqdn *string `json:"smbServerFqdn,omitempty"`

	// READ-ONLY; The mount target's IPv4 address
	IPAddress *string `json:"ipAddress,omitempty" azure:"ro"`

	// READ-ONLY; UUID v4 used to identify the MountTarget
	MountTargetID *string `json:"mountTargetId,omitempty" azure:"ro"`
}

MountTargetProperties - Mount target properties

func (MountTargetProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type MountTargetProperties.

func (*MountTargetProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type MountTargetProperties.

type NetworkFeatures

type NetworkFeatures string

NetworkFeatures - Basic network, or Standard features available to the volume.

const (
	// NetworkFeaturesBasic - Basic network feature.
	NetworkFeaturesBasic NetworkFeatures = "Basic"
	// NetworkFeaturesStandard - Standard network feature.
	NetworkFeaturesStandard NetworkFeatures = "Standard"
)

func PossibleNetworkFeaturesValues

func PossibleNetworkFeaturesValues() []NetworkFeatures

PossibleNetworkFeaturesValues returns the possible values for the NetworkFeatures const type.

type Operation

type Operation struct {
	// Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`

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

	// The origin of operations.
	Origin *string `json:"origin,omitempty"`

	// Properties of operation, include metric specifications.
	Properties *OperationProperties `json:"properties,omitempty"`
}

Operation - Microsoft.NetApp REST API operation definition.

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 {
	// Operation description.
	Description *string `json:"description,omitempty"`

	// Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft NetApp.
	Provider *string `json:"provider,omitempty"`

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

OperationDisplay - Display metadata associated with the 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 {
	// List of Storage operations supported by the Storage resource provider.
	Value []*Operation `json:"value,omitempty"`
}

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

func (OperationListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationProperties

type OperationProperties struct {
	// One property of operation, include metric specifications.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - Properties of operation, include metric specifications.

func (OperationProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationProperties.

func (*OperationProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationProperties.

type OperationsClient

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

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

func NewOperationsClient

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

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

func (*OperationsClient) NewListPager

NewListPager - Lists all of the available Microsoft.NetApp Rest API operations Generated from API version 2022-05-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/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/OperationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewOperationsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(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:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

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

type OperationsClientListResponse

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PlacementKeyValuePairs

type PlacementKeyValuePairs struct {
	// REQUIRED; Key for an application specific parameter for the placement of volumes in the volume group
	Key *string `json:"key,omitempty"`

	// REQUIRED; Value for an application specific parameter for the placement of volumes in the volume group
	Value *string `json:"value,omitempty"`
}

PlacementKeyValuePairs - Application specific parameters for the placement of volumes in the volume group

func (PlacementKeyValuePairs) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PlacementKeyValuePairs.

func (*PlacementKeyValuePairs) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type PlacementKeyValuePairs.

type PoolChangeRequest

type PoolChangeRequest struct {
	// REQUIRED; Resource id of the pool to move volume to
	NewPoolResourceID *string `json:"newPoolResourceId,omitempty"`
}

PoolChangeRequest - Pool change request

func (PoolChangeRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PoolChangeRequest.

func (*PoolChangeRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type PoolChangeRequest.

type PoolPatchProperties

type PoolPatchProperties struct {
	// If enabled (true) the pool can contain cool Access enabled volumes.
	CoolAccess *bool `json:"coolAccess,omitempty"`

	// The qos type of the pool
	QosType *QosType `json:"qosType,omitempty"`

	// Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104).
	Size *int64 `json:"size,omitempty"`
}

PoolPatchProperties - Patchable pool properties

func (PoolPatchProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PoolPatchProperties.

func (*PoolPatchProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type PoolPatchProperties.

type PoolProperties

type PoolProperties struct {
	// REQUIRED; The service level of the file system
	ServiceLevel *ServiceLevel `json:"serviceLevel,omitempty"`

	// REQUIRED; Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104).
	Size *int64 `json:"size,omitempty"`

	// If enabled (true) the pool can contain cool Access enabled volumes.
	CoolAccess *bool `json:"coolAccess,omitempty"`

	// Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value
	// can only be set when creating new pool.
	EncryptionType *EncryptionType `json:"encryptionType,omitempty"`

	// The qos type of the pool
	QosType *QosType `json:"qosType,omitempty"`

	// READ-ONLY; UUID v4 used to identify the Pool
	PoolID *string `json:"poolId,omitempty" azure:"ro"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Total throughput of pool in MiB/s
	TotalThroughputMibps *float32 `json:"totalThroughputMibps,omitempty" azure:"ro"`

	// READ-ONLY; Utilized throughput of pool in MiB/s
	UtilizedThroughputMibps *float32 `json:"utilizedThroughputMibps,omitempty" azure:"ro"`
}

PoolProperties - Pool properties

func (PoolProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PoolProperties.

func (*PoolProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type PoolProperties.

type PoolsClient

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

PoolsClient contains the methods for the Pools group. Don't use this type directly, use NewPoolsClient() instead.

func NewPoolsClient

func NewPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PoolsClient, error)

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

func (*PoolsClient) BeginCreateOrUpdate

func (client *PoolsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, body CapacityPool, options *PoolsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PoolsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a capacity pool If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool body - Capacity pool object supplied in the body of the operation. options - PoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the PoolsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Pools_CreateOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewPoolsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "myRG", "account1", "pool1", armnetapp.CapacityPool{
	Location: to.Ptr("eastus"),
	Properties: &armnetapp.PoolProperties{
		QosType:      to.Ptr(armnetapp.QosTypeAuto),
		ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
		Size:         to.Ptr[int64](4398046511104),
	},
}, 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 (*PoolsClient) BeginDelete

func (client *PoolsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, poolName string, options *PoolsClientBeginDeleteOptions) (*runtime.Poller[PoolsClientDeleteResponse], error)

BeginDelete - Delete the specified capacity pool If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool options - PoolsClientBeginDeleteOptions contains the optional parameters for the PoolsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Pools_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewPoolsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account1", "pool1", 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 (*PoolsClient) BeginUpdate

func (client *PoolsClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, body CapacityPoolPatch, options *PoolsClientBeginUpdateOptions) (*runtime.Poller[PoolsClientUpdateResponse], error)

BeginUpdate - Patch the specified capacity pool If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool body - Capacity pool object supplied in the body of the operation. options - PoolsClientBeginUpdateOptions contains the optional parameters for the PoolsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Pools_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewPoolsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "pool1", armnetapp.CapacityPoolPatch{}, 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 (*PoolsClient) Get

func (client *PoolsClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string, options *PoolsClientGetOptions) (PoolsClientGetResponse, error)

Get - Get details of the specified capacity pool If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool options - PoolsClientGetOptions contains the optional parameters for the PoolsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Pools_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewPoolsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "pool1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PoolsClient) NewListPager

func (client *PoolsClient) NewListPager(resourceGroupName string, accountName string, options *PoolsClientListOptions) *runtime.Pager[PoolsClientListResponse]

NewListPager - List all capacity pools in the NetApp Account Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - PoolsClientListOptions contains the optional parameters for the PoolsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Pools_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewPoolsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", 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:

type PoolsClientBeginCreateOrUpdateOptions

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

PoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the PoolsClient.BeginCreateOrUpdate method.

type PoolsClientBeginDeleteOptions

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

PoolsClientBeginDeleteOptions contains the optional parameters for the PoolsClient.BeginDelete method.

type PoolsClientBeginUpdateOptions

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

PoolsClientBeginUpdateOptions contains the optional parameters for the PoolsClient.BeginUpdate method.

type PoolsClientCreateOrUpdateResponse

type PoolsClientCreateOrUpdateResponse struct {
	CapacityPool
}

PoolsClientCreateOrUpdateResponse contains the response from method PoolsClient.CreateOrUpdate.

type PoolsClientDeleteResponse

type PoolsClientDeleteResponse struct {
}

PoolsClientDeleteResponse contains the response from method PoolsClient.Delete.

type PoolsClientGetOptions

type PoolsClientGetOptions struct {
}

PoolsClientGetOptions contains the optional parameters for the PoolsClient.Get method.

type PoolsClientGetResponse

type PoolsClientGetResponse struct {
	CapacityPool
}

PoolsClientGetResponse contains the response from method PoolsClient.Get.

type PoolsClientListOptions

type PoolsClientListOptions struct {
}

PoolsClientListOptions contains the optional parameters for the PoolsClient.List method.

type PoolsClientListResponse

type PoolsClientListResponse struct {
	CapacityPoolList
}

PoolsClientListResponse contains the response from method PoolsClient.List.

type PoolsClientUpdateResponse

type PoolsClientUpdateResponse struct {
	CapacityPool
}

PoolsClientUpdateResponse contains the response from method PoolsClient.Update.

type ProvisioningState

type ProvisioningState string

ProvisioningState - Gets the status of the VolumeQuotaRule at the time the operation was called.

const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStatePatching  ProvisioningState = "Patching"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type QosType

type QosType string

QosType - The qos type of the pool

const (
	// QosTypeAuto - qos type Auto
	QosTypeAuto QosType = "Auto"
	// QosTypeManual - qos type Manual
	QosTypeManual QosType = "Manual"
)

func PossibleQosTypeValues

func PossibleQosTypeValues() []QosType

PossibleQosTypeValues returns the possible values for the QosType const type.

type QuotaAvailabilityRequest

type QuotaAvailabilityRequest struct {
	// REQUIRED; Name of the resource to verify.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Resource group name.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// REQUIRED; Resource type used for verification.
	Type *CheckQuotaNameResourceTypes `json:"type,omitempty"`
}

QuotaAvailabilityRequest - Quota availability request content.

func (QuotaAvailabilityRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type QuotaAvailabilityRequest.

func (*QuotaAvailabilityRequest) UnmarshalJSON

func (q *QuotaAvailabilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QuotaAvailabilityRequest.

type ReestablishReplicationRequest

type ReestablishReplicationRequest struct {
	// Resource id of the source volume for the replication
	SourceVolumeID *string `json:"sourceVolumeId,omitempty"`
}

ReestablishReplicationRequest - Re-establish request object supplied in the body of the operation.

func (ReestablishReplicationRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ReestablishReplicationRequest.

func (*ReestablishReplicationRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ReestablishReplicationRequest.

type RegionInfo

type RegionInfo struct {
	// Provides logical availability zone mappings for the subscription for a region.
	AvailabilityZoneMappings []*RegionInfoAvailabilityZoneMappingsItem `json:"availabilityZoneMappings,omitempty"`

	// Provides storage to network proximity information in the region.
	StorageToNetworkProximity *RegionStorageToNetworkProximity `json:"storageToNetworkProximity,omitempty"`
}

RegionInfo - Provides region specific information.

func (RegionInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RegionInfo.

func (*RegionInfo) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type RegionInfo.

type RegionInfoAvailabilityZoneMappingsItem

type RegionInfoAvailabilityZoneMappingsItem struct {
	// Logical availability zone.
	AvailabilityZone *string `json:"availabilityZone,omitempty"`

	// Available availability zone
	IsAvailable *bool `json:"isAvailable,omitempty"`
}

func (RegionInfoAvailabilityZoneMappingsItem) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RegionInfoAvailabilityZoneMappingsItem.

func (*RegionInfoAvailabilityZoneMappingsItem) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type RegionInfoAvailabilityZoneMappingsItem.

type RegionStorageToNetworkProximity

type RegionStorageToNetworkProximity string

RegionStorageToNetworkProximity - Provides storage to network proximity information in the region.

const (
	// RegionStorageToNetworkProximityDefault - Basic network connectivity.
	RegionStorageToNetworkProximityDefault RegionStorageToNetworkProximity = "Default"
	// RegionStorageToNetworkProximityT1 - Standard T1 network connectivity.
	RegionStorageToNetworkProximityT1 RegionStorageToNetworkProximity = "T1"
	// RegionStorageToNetworkProximityT1AndT2 - Standard T1 and T2 network connectivity.
	RegionStorageToNetworkProximityT1AndT2 RegionStorageToNetworkProximity = "T1AndT2"
	// RegionStorageToNetworkProximityT2 - Standard T2 network connectivity.
	RegionStorageToNetworkProximityT2 RegionStorageToNetworkProximity = "T2"
)

func PossibleRegionStorageToNetworkProximityValues

func PossibleRegionStorageToNetworkProximityValues() []RegionStorageToNetworkProximity

PossibleRegionStorageToNetworkProximityValues returns the possible values for the RegionStorageToNetworkProximity const type.

type RelationshipStatus

type RelationshipStatus string

RelationshipStatus - Status of the mirror relationship

const (
	RelationshipStatusIdle         RelationshipStatus = "Idle"
	RelationshipStatusTransferring RelationshipStatus = "Transferring"
)

func PossibleRelationshipStatusValues

func PossibleRelationshipStatusValues() []RelationshipStatus

PossibleRelationshipStatusValues returns the possible values for the RelationshipStatus const type.

type RelocateVolumeRequest

type RelocateVolumeRequest struct {
	// New creation token for the volume that controls the mount point name
	CreationToken *string `json:"creationToken,omitempty"`
}

RelocateVolumeRequest - Relocate volume request

func (RelocateVolumeRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RelocateVolumeRequest.

func (*RelocateVolumeRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type RelocateVolumeRequest.

type Replication

type Replication struct {
	// REQUIRED; The resource ID of the remote volume.
	RemoteVolumeResourceID *string `json:"remoteVolumeResourceId,omitempty"`

	// Indicates whether the local volume is the source or destination for the Volume Replication
	EndpointType *EndpointType `json:"endpointType,omitempty"`

	// The remote region for the other end of the Volume Replication.
	RemoteVolumeRegion *string `json:"remoteVolumeRegion,omitempty"`

	// Schedule
	ReplicationSchedule *ReplicationSchedule `json:"replicationSchedule,omitempty"`
}

Replication properties

func (Replication) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Replication.

func (*Replication) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Replication.

type ReplicationObject

type ReplicationObject struct {
	// REQUIRED; The resource ID of the remote volume.
	RemoteVolumeResourceID *string `json:"remoteVolumeResourceId,omitempty"`

	// Indicates whether the local volume is the source or destination for the Volume Replication
	EndpointType *EndpointType `json:"endpointType,omitempty"`

	// The remote region for the other end of the Volume Replication.
	RemoteVolumeRegion *string `json:"remoteVolumeRegion,omitempty"`

	// Id
	ReplicationID *string `json:"replicationId,omitempty"`

	// Schedule
	ReplicationSchedule *ReplicationSchedule `json:"replicationSchedule,omitempty"`
}

ReplicationObject - Replication properties

func (ReplicationObject) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ReplicationObject.

func (*ReplicationObject) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicationObject.

type ReplicationSchedule

type ReplicationSchedule string

ReplicationSchedule - Schedule

const (
	ReplicationSchedule10Minutely ReplicationSchedule = "_10minutely"
	ReplicationScheduleDaily      ReplicationSchedule = "daily"
	ReplicationScheduleHourly     ReplicationSchedule = "hourly"
)

func PossibleReplicationScheduleValues

func PossibleReplicationScheduleValues() []ReplicationSchedule

PossibleReplicationScheduleValues returns the possible values for the ReplicationSchedule const type.

type ReplicationStatus

type ReplicationStatus struct {
	// Displays error message if the replication is in an error state
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Replication health check
	Healthy *bool `json:"healthy,omitempty"`

	// The status of the replication
	MirrorState *MirrorState `json:"mirrorState,omitempty"`

	// Status of the mirror relationship
	RelationshipStatus *RelationshipStatus `json:"relationshipStatus,omitempty"`

	// The progress of the replication
	TotalProgress *string `json:"totalProgress,omitempty"`
}

ReplicationStatus - Replication status

func (ReplicationStatus) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ReplicationStatus.

func (*ReplicationStatus) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicationStatus.

type ResourceClient

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

ResourceClient contains the methods for the NetAppResource group. Don't use this type directly, use NewResourceClient() instead.

func NewResourceClient

func NewResourceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceClient, error)

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

func (*ResourceClient) CheckFilePathAvailability

CheckFilePathAvailability - Check if a file path is available. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location body - File path availability request. options - ResourceClientCheckFilePathAvailabilityOptions contains the optional parameters for the ResourceClient.CheckFilePathAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/CheckFilePathAvailability.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewResourceClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CheckFilePathAvailability(ctx, "eastus", armnetapp.FilePathAvailabilityRequest{
	Name:     to.Ptr("my-exact-filepth"),
	SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ResourceClient) CheckNameAvailability

CheckNameAvailability - Check if a resource name is available. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location body - Name availability request. options - ResourceClientCheckNameAvailabilityOptions contains the optional parameters for the ResourceClient.CheckNameAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/CheckNameAvailability.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewResourceClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CheckNameAvailability(ctx, "eastus", armnetapp.ResourceNameAvailabilityRequest{
	Name:          to.Ptr("accName"),
	Type:          to.Ptr(armnetapp.CheckNameResourceTypes("netAppAccount")),
	ResourceGroup: to.Ptr("myRG"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ResourceClient) CheckQuotaAvailability

CheckQuotaAvailability - Check if a quota is available. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location body - Quota availability request. options - ResourceClientCheckQuotaAvailabilityOptions contains the optional parameters for the ResourceClient.CheckQuotaAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/CheckQuotaAvailability.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewResourceClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CheckQuotaAvailability(ctx, "eastus", armnetapp.QuotaAvailabilityRequest{
	Name:          to.Ptr("resource1"),
	Type:          to.Ptr(armnetapp.CheckQuotaNameResourceTypesMicrosoftNetAppNetAppAccounts),
	ResourceGroup: to.Ptr("myRG"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ResourceClient) QueryRegionInfo

QueryRegionInfo - Provides storage to network proximity and logical zone mapping information. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location options - ResourceClientQueryRegionInfoOptions contains the optional parameters for the ResourceClient.QueryRegionInfo method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/RegionInfo.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewResourceClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.QueryRegionInfo(ctx, "eastus", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ResourceClientCheckFilePathAvailabilityOptions

type ResourceClientCheckFilePathAvailabilityOptions struct {
}

ResourceClientCheckFilePathAvailabilityOptions contains the optional parameters for the ResourceClient.CheckFilePathAvailability method.

type ResourceClientCheckFilePathAvailabilityResponse

type ResourceClientCheckFilePathAvailabilityResponse struct {
	CheckAvailabilityResponse
}

ResourceClientCheckFilePathAvailabilityResponse contains the response from method ResourceClient.CheckFilePathAvailability.

type ResourceClientCheckNameAvailabilityOptions

type ResourceClientCheckNameAvailabilityOptions struct {
}

ResourceClientCheckNameAvailabilityOptions contains the optional parameters for the ResourceClient.CheckNameAvailability method.

type ResourceClientCheckNameAvailabilityResponse

type ResourceClientCheckNameAvailabilityResponse struct {
	CheckAvailabilityResponse
}

ResourceClientCheckNameAvailabilityResponse contains the response from method ResourceClient.CheckNameAvailability.

type ResourceClientCheckQuotaAvailabilityOptions

type ResourceClientCheckQuotaAvailabilityOptions struct {
}

ResourceClientCheckQuotaAvailabilityOptions contains the optional parameters for the ResourceClient.CheckQuotaAvailability method.

type ResourceClientCheckQuotaAvailabilityResponse

type ResourceClientCheckQuotaAvailabilityResponse struct {
	CheckAvailabilityResponse
}

ResourceClientCheckQuotaAvailabilityResponse contains the response from method ResourceClient.CheckQuotaAvailability.

type ResourceClientQueryRegionInfoOptions

type ResourceClientQueryRegionInfoOptions struct {
}

ResourceClientQueryRegionInfoOptions contains the optional parameters for the ResourceClient.QueryRegionInfo method.

type ResourceClientQueryRegionInfoResponse

type ResourceClientQueryRegionInfoResponse struct {
	RegionInfo
}

ResourceClientQueryRegionInfoResponse contains the response from method ResourceClient.QueryRegionInfo.

type ResourceNameAvailabilityRequest

type ResourceNameAvailabilityRequest struct {
	// REQUIRED; Resource name to verify.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Resource group name.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// REQUIRED; Resource type used for verification.
	Type *CheckNameResourceTypes `json:"type,omitempty"`
}

ResourceNameAvailabilityRequest - Resource name availability request content.

func (ResourceNameAvailabilityRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ResourceNameAvailabilityRequest.

func (*ResourceNameAvailabilityRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceNameAvailabilityRequest.

type ResourceQuotaLimitsClient

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

ResourceQuotaLimitsClient contains the methods for the NetAppResourceQuotaLimits group. Don't use this type directly, use NewResourceQuotaLimitsClient() instead.

func NewResourceQuotaLimitsClient

func NewResourceQuotaLimitsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceQuotaLimitsClient, error)

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

func (*ResourceQuotaLimitsClient) Get

Get - Get the default and current subscription quota limit If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location quotaLimitName - The name of the Quota Limit options - ResourceQuotaLimitsClientGetOptions contains the optional parameters for the ResourceQuotaLimitsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/QuotaLimits_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewResourceQuotaLimitsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "eastus", "totalCoolAccessVolumesPerSubscription", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ResourceQuotaLimitsClient) NewListPager

NewListPager - Get the default and current limits for quotas Generated from API version 2022-05-01 location - The location options - ResourceQuotaLimitsClientListOptions contains the optional parameters for the ResourceQuotaLimitsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/QuotaLimits_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewResourceQuotaLimitsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("eastus", 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:

type ResourceQuotaLimitsClientGetOptions

type ResourceQuotaLimitsClientGetOptions struct {
}

ResourceQuotaLimitsClientGetOptions contains the optional parameters for the ResourceQuotaLimitsClient.Get method.

type ResourceQuotaLimitsClientGetResponse

type ResourceQuotaLimitsClientGetResponse struct {
	SubscriptionQuotaItem
}

ResourceQuotaLimitsClientGetResponse contains the response from method ResourceQuotaLimitsClient.Get.

type ResourceQuotaLimitsClientListOptions

type ResourceQuotaLimitsClientListOptions struct {
}

ResourceQuotaLimitsClientListOptions contains the optional parameters for the ResourceQuotaLimitsClient.List method.

type ResourceQuotaLimitsClientListResponse

type ResourceQuotaLimitsClientListResponse struct {
	SubscriptionQuotaItemList
}

ResourceQuotaLimitsClientListResponse contains the response from method ResourceQuotaLimitsClient.List.

type RestoreStatus

type RestoreStatus struct {
	// READ-ONLY; Displays error message if the restore is in an error state
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Restore health status
	Healthy *bool `json:"healthy,omitempty" azure:"ro"`

	// READ-ONLY; The status of the restore
	MirrorState *MirrorState `json:"mirrorState,omitempty" azure:"ro"`

	// READ-ONLY; Status of the restore SnapMirror relationship
	RelationshipStatus *RelationshipStatus `json:"relationshipStatus,omitempty" azure:"ro"`

	// READ-ONLY; Displays the total bytes transferred
	TotalTransferBytes *int64 `json:"totalTransferBytes,omitempty" azure:"ro"`

	// READ-ONLY; Reason for the unhealthy restore relationship
	UnhealthyReason *string `json:"unhealthyReason,omitempty" azure:"ro"`
}

RestoreStatus - Restore status

func (RestoreStatus) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RestoreStatus.

func (*RestoreStatus) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreStatus.

type SecurityStyle

type SecurityStyle string

SecurityStyle - The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol

const (
	SecurityStyleNtfs SecurityStyle = "ntfs"
	SecurityStyleUnix SecurityStyle = "unix"
)

func PossibleSecurityStyleValues

func PossibleSecurityStyleValues() []SecurityStyle

PossibleSecurityStyleValues returns the possible values for the SecurityStyle const type.

type ServiceLevel

type ServiceLevel string

ServiceLevel - The service level of the file system

const (
	// ServiceLevelPremium - Premium service level
	ServiceLevelPremium ServiceLevel = "Premium"
	// ServiceLevelStandard - Standard service level
	ServiceLevelStandard ServiceLevel = "Standard"
	// ServiceLevelStandardZRS - Zone redundant storage service level
	ServiceLevelStandardZRS ServiceLevel = "StandardZRS"
	// ServiceLevelUltra - Ultra service level
	ServiceLevelUltra ServiceLevel = "Ultra"
)

func PossibleServiceLevelValues

func PossibleServiceLevelValues() []ServiceLevel

PossibleServiceLevelValues returns the possible values for the ServiceLevel const type.

type ServiceSpecification

type ServiceSpecification struct {
	// Log specification of operation.
	LogSpecifications []*LogSpecification `json:"logSpecifications,omitempty"`

	// Metric specifications of operation.
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification - One property of operation, include metric specifications.

func (ServiceSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

func (*ServiceSpecification) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceSpecification.

type SmbAccessBasedEnumeration

type SmbAccessBasedEnumeration string

SmbAccessBasedEnumeration - Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume

const (
	// SmbAccessBasedEnumerationDisabled - smbAccessBasedEnumeration share setting is disabled
	SmbAccessBasedEnumerationDisabled SmbAccessBasedEnumeration = "Disabled"
	// SmbAccessBasedEnumerationEnabled - smbAccessBasedEnumeration share setting is enabled
	SmbAccessBasedEnumerationEnabled SmbAccessBasedEnumeration = "Enabled"
)

func PossibleSmbAccessBasedEnumerationValues

func PossibleSmbAccessBasedEnumerationValues() []SmbAccessBasedEnumeration

PossibleSmbAccessBasedEnumerationValues returns the possible values for the SmbAccessBasedEnumeration const type.

type SmbNonBrowsable

type SmbNonBrowsable string

SmbNonBrowsable - Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume

const (
	// SmbNonBrowsableDisabled - smbNonBrowsable share setting is disabled
	SmbNonBrowsableDisabled SmbNonBrowsable = "Disabled"
	// SmbNonBrowsableEnabled - smbNonBrowsable share setting is enabled
	SmbNonBrowsableEnabled SmbNonBrowsable = "Enabled"
)

func PossibleSmbNonBrowsableValues

func PossibleSmbNonBrowsableValues() []SmbNonBrowsable

PossibleSmbNonBrowsableValues returns the possible values for the SmbNonBrowsable const type.

type Snapshot

type Snapshot struct {
	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// Snapshot Properties
	Properties *SnapshotProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Snapshot of a Volume

func (Snapshot) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Snapshot.

func (*Snapshot) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Snapshot.

type SnapshotPoliciesClient

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

SnapshotPoliciesClient contains the methods for the SnapshotPolicies group. Don't use this type directly, use NewSnapshotPoliciesClient() instead.

func NewSnapshotPoliciesClient

func NewSnapshotPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SnapshotPoliciesClient, error)

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

func (*SnapshotPoliciesClient) BeginDelete

func (client *SnapshotPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, snapshotPolicyName string, options *SnapshotPoliciesClientBeginDeleteOptions) (*runtime.Poller[SnapshotPoliciesClientDeleteResponse], error)

BeginDelete - Delete snapshot policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account snapshotPolicyName - The name of the snapshot policy options - SnapshotPoliciesClientBeginDeleteOptions contains the optional parameters for the SnapshotPoliciesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/SnapshotPolicies_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "resourceGroup", "accountName", "snapshotPolicyName", 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 (*SnapshotPoliciesClient) BeginUpdate

func (client *SnapshotPoliciesClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, snapshotPolicyName string, body SnapshotPolicyPatch, options *SnapshotPoliciesClientBeginUpdateOptions) (*runtime.Poller[SnapshotPoliciesClientUpdateResponse], error)

BeginUpdate - Patch a snapshot policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account snapshotPolicyName - The name of the snapshot policy body - Snapshot policy object supplied in the body of the operation. options - SnapshotPoliciesClientBeginUpdateOptions contains the optional parameters for the SnapshotPoliciesClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/SnapshotPolicies_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "snapshotPolicyName", armnetapp.SnapshotPolicyPatch{
	Location: to.Ptr("eastus"),
	Properties: &armnetapp.SnapshotPolicyProperties{
		DailySchedule: &armnetapp.DailySchedule{
			Hour:            to.Ptr[int32](14),
			Minute:          to.Ptr[int32](30),
			SnapshotsToKeep: to.Ptr[int32](4),
		},
		Enabled: to.Ptr(true),
		HourlySchedule: &armnetapp.HourlySchedule{
			Minute:          to.Ptr[int32](50),
			SnapshotsToKeep: to.Ptr[int32](2),
		},
		MonthlySchedule: &armnetapp.MonthlySchedule{
			DaysOfMonth:     to.Ptr("10,11,12"),
			Hour:            to.Ptr[int32](14),
			Minute:          to.Ptr[int32](15),
			SnapshotsToKeep: to.Ptr[int32](5),
		},
		WeeklySchedule: &armnetapp.WeeklySchedule{
			Day:             to.Ptr("Wednesday"),
			Hour:            to.Ptr[int32](14),
			Minute:          to.Ptr[int32](45),
			SnapshotsToKeep: to.Ptr[int32](3),
		},
	},
}, 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 (*SnapshotPoliciesClient) Create

func (client *SnapshotPoliciesClient) Create(ctx context.Context, resourceGroupName string, accountName string, snapshotPolicyName string, body SnapshotPolicy, options *SnapshotPoliciesClientCreateOptions) (SnapshotPoliciesClientCreateResponse, error)

Create - Create a snapshot policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account snapshotPolicyName - The name of the snapshot policy body - Snapshot policy object supplied in the body of the operation. options - SnapshotPoliciesClientCreateOptions contains the optional parameters for the SnapshotPoliciesClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/SnapshotPolicies_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Create(ctx, "myRG", "account1", "snapshotPolicyName", armnetapp.SnapshotPolicy{
	Location: to.Ptr("eastus"),
	Properties: &armnetapp.SnapshotPolicyProperties{
		DailySchedule: &armnetapp.DailySchedule{
			Hour:            to.Ptr[int32](14),
			Minute:          to.Ptr[int32](30),
			SnapshotsToKeep: to.Ptr[int32](4),
		},
		Enabled: to.Ptr(true),
		HourlySchedule: &armnetapp.HourlySchedule{
			Minute:          to.Ptr[int32](50),
			SnapshotsToKeep: to.Ptr[int32](2),
		},
		MonthlySchedule: &armnetapp.MonthlySchedule{
			DaysOfMonth:     to.Ptr("10,11,12"),
			Hour:            to.Ptr[int32](14),
			Minute:          to.Ptr[int32](15),
			SnapshotsToKeep: to.Ptr[int32](5),
		},
		WeeklySchedule: &armnetapp.WeeklySchedule{
			Day:             to.Ptr("Wednesday"),
			Hour:            to.Ptr[int32](14),
			Minute:          to.Ptr[int32](45),
			SnapshotsToKeep: to.Ptr[int32](3),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SnapshotPoliciesClient) Get

func (client *SnapshotPoliciesClient) Get(ctx context.Context, resourceGroupName string, accountName string, snapshotPolicyName string, options *SnapshotPoliciesClientGetOptions) (SnapshotPoliciesClientGetResponse, error)

Get - Get a snapshot Policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account snapshotPolicyName - The name of the snapshot policy options - SnapshotPoliciesClientGetOptions contains the optional parameters for the SnapshotPoliciesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/SnapshotPolicies_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "snapshotPolicyName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SnapshotPoliciesClient) ListVolumes

func (client *SnapshotPoliciesClient) ListVolumes(ctx context.Context, resourceGroupName string, accountName string, snapshotPolicyName string, options *SnapshotPoliciesClientListVolumesOptions) (SnapshotPoliciesClientListVolumesResponse, error)

ListVolumes - Get volumes associated with snapshot policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account snapshotPolicyName - The name of the snapshot policy options - SnapshotPoliciesClientListVolumesOptions contains the optional parameters for the SnapshotPoliciesClient.ListVolumes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/SnapshotPolicies_ListVolumes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListVolumes(ctx, "myRG", "account1", "snapshotPolicyName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SnapshotPoliciesClient) NewListPager

func (client *SnapshotPoliciesClient) NewListPager(resourceGroupName string, accountName string, options *SnapshotPoliciesClientListOptions) *runtime.Pager[SnapshotPoliciesClientListResponse]

NewListPager - List snapshot policy Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - SnapshotPoliciesClientListOptions contains the optional parameters for the SnapshotPoliciesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/SnapshotPolicies_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotPoliciesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", 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:

type SnapshotPoliciesClientBeginDeleteOptions

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

SnapshotPoliciesClientBeginDeleteOptions contains the optional parameters for the SnapshotPoliciesClient.BeginDelete method.

type SnapshotPoliciesClientBeginUpdateOptions

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

SnapshotPoliciesClientBeginUpdateOptions contains the optional parameters for the SnapshotPoliciesClient.BeginUpdate method.

type SnapshotPoliciesClientCreateOptions

type SnapshotPoliciesClientCreateOptions struct {
}

SnapshotPoliciesClientCreateOptions contains the optional parameters for the SnapshotPoliciesClient.Create method.

type SnapshotPoliciesClientCreateResponse

type SnapshotPoliciesClientCreateResponse struct {
	SnapshotPolicy
}

SnapshotPoliciesClientCreateResponse contains the response from method SnapshotPoliciesClient.Create.

type SnapshotPoliciesClientDeleteResponse

type SnapshotPoliciesClientDeleteResponse struct {
}

SnapshotPoliciesClientDeleteResponse contains the response from method SnapshotPoliciesClient.Delete.

type SnapshotPoliciesClientGetOptions

type SnapshotPoliciesClientGetOptions struct {
}

SnapshotPoliciesClientGetOptions contains the optional parameters for the SnapshotPoliciesClient.Get method.

type SnapshotPoliciesClientGetResponse

type SnapshotPoliciesClientGetResponse struct {
	SnapshotPolicy
}

SnapshotPoliciesClientGetResponse contains the response from method SnapshotPoliciesClient.Get.

type SnapshotPoliciesClientListOptions

type SnapshotPoliciesClientListOptions struct {
}

SnapshotPoliciesClientListOptions contains the optional parameters for the SnapshotPoliciesClient.List method.

type SnapshotPoliciesClientListResponse

type SnapshotPoliciesClientListResponse struct {
	SnapshotPoliciesList
}

SnapshotPoliciesClientListResponse contains the response from method SnapshotPoliciesClient.List.

type SnapshotPoliciesClientListVolumesOptions

type SnapshotPoliciesClientListVolumesOptions struct {
}

SnapshotPoliciesClientListVolumesOptions contains the optional parameters for the SnapshotPoliciesClient.ListVolumes method.

type SnapshotPoliciesClientListVolumesResponse

type SnapshotPoliciesClientListVolumesResponse struct {
	SnapshotPolicyVolumeList
}

SnapshotPoliciesClientListVolumesResponse contains the response from method SnapshotPoliciesClient.ListVolumes.

type SnapshotPoliciesClientUpdateResponse

type SnapshotPoliciesClientUpdateResponse struct {
	SnapshotPolicy
}

SnapshotPoliciesClientUpdateResponse contains the response from method SnapshotPoliciesClient.Update.

type SnapshotPoliciesList

type SnapshotPoliciesList struct {
	// A list of snapshot policies
	Value []*SnapshotPolicy `json:"value,omitempty"`
}

SnapshotPoliciesList - List of Snapshot Policies

func (SnapshotPoliciesList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotPoliciesList.

func (*SnapshotPoliciesList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotPoliciesList.

type SnapshotPolicy

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

	// REQUIRED; Snapshot policy Properties
	Properties *SnapshotPolicyProperties `json:"properties,omitempty"`

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

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// 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; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

SnapshotPolicy - Snapshot policy information

func (SnapshotPolicy) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotPolicy.

func (*SnapshotPolicy) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotPolicy.

type SnapshotPolicyPatch

type SnapshotPolicyPatch struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// Snapshot Policy properties
	Properties *SnapshotPolicyProperties `json:"properties,omitempty"`

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

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

SnapshotPolicyPatch - Snapshot policy Details for create and update

func (SnapshotPolicyPatch) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotPolicyPatch.

func (*SnapshotPolicyPatch) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotPolicyPatch.

type SnapshotPolicyProperties

type SnapshotPolicyProperties struct {
	// Schedule for daily snapshots
	DailySchedule *DailySchedule `json:"dailySchedule,omitempty"`

	// The property to decide policy is enabled or not
	Enabled *bool `json:"enabled,omitempty"`

	// Schedule for hourly snapshots
	HourlySchedule *HourlySchedule `json:"hourlySchedule,omitempty"`

	// Schedule for monthly snapshots
	MonthlySchedule *MonthlySchedule `json:"monthlySchedule,omitempty"`

	// Schedule for weekly snapshots
	WeeklySchedule *WeeklySchedule `json:"weeklySchedule,omitempty"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SnapshotPolicyProperties - Snapshot policy properties

func (SnapshotPolicyProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotPolicyProperties.

func (*SnapshotPolicyProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotPolicyProperties.

type SnapshotPolicyVolumeList

type SnapshotPolicyVolumeList struct {
	// List of volumes
	Value []*Volume `json:"value,omitempty"`
}

SnapshotPolicyVolumeList - Volumes associated with snapshot policy

func (SnapshotPolicyVolumeList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotPolicyVolumeList.

func (*SnapshotPolicyVolumeList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotPolicyVolumeList.

type SnapshotProperties

type SnapshotProperties struct {
	// READ-ONLY; The creation date of the snapshot
	Created *time.Time `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; UUID v4 used to identify the Snapshot
	SnapshotID *string `json:"snapshotId,omitempty" azure:"ro"`
}

SnapshotProperties - Snapshot properties

func (SnapshotProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotProperties.

func (*SnapshotProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotProperties.

type SnapshotRestoreFiles

type SnapshotRestoreFiles struct {
	// REQUIRED; List of files to be restored
	FilePaths []*string `json:"filePaths,omitempty"`

	// Destination folder where the files will be restored
	DestinationPath *string `json:"destinationPath,omitempty"`
}

SnapshotRestoreFiles - Restore payload for Single File Snapshot Restore

func (SnapshotRestoreFiles) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotRestoreFiles.

func (*SnapshotRestoreFiles) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotRestoreFiles.

type SnapshotsClient

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

SnapshotsClient contains the methods for the Snapshots group. Don't use this type directly, use NewSnapshotsClient() instead.

func NewSnapshotsClient

func NewSnapshotsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SnapshotsClient, error)

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

func (*SnapshotsClient) BeginCreate

func (client *SnapshotsClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, snapshotName string, body Snapshot, options *SnapshotsClientBeginCreateOptions) (*runtime.Poller[SnapshotsClientCreateResponse], error)

BeginCreate - Create the specified snapshot within the given volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume snapshotName - The name of the snapshot body - Snapshot object supplied in the body of the operation. options - SnapshotsClientBeginCreateOptions contains the optional parameters for the SnapshotsClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Snapshots_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "myRG", "account1", "pool1", "volume1", "snapshot1", armnetapp.Snapshot{
	Location: to.Ptr("eastus"),
}, 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 (*SnapshotsClient) BeginDelete

func (client *SnapshotsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, snapshotName string, options *SnapshotsClientBeginDeleteOptions) (*runtime.Poller[SnapshotsClientDeleteResponse], error)

BeginDelete - Delete snapshot If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume snapshotName - The name of the snapshot options - SnapshotsClientBeginDeleteOptions contains the optional parameters for the SnapshotsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Snapshots_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account1", "pool1", "volume1", "snapshot1", 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 (*SnapshotsClient) BeginRestoreFiles

func (client *SnapshotsClient) BeginRestoreFiles(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, snapshotName string, body SnapshotRestoreFiles, options *SnapshotsClientBeginRestoreFilesOptions) (*runtime.Poller[SnapshotsClientRestoreFilesResponse], error)

BeginRestoreFiles - Restore the specified files from the specified snapshot to the active filesystem If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume snapshotName - The name of the snapshot body - Restore payload supplied in the body of the operation. options - SnapshotsClientBeginRestoreFilesOptions contains the optional parameters for the SnapshotsClient.BeginRestoreFiles method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Snapshots_SingleFileRestore.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRestoreFiles(ctx, "myRG", "account1", "pool1", "volume1", "snapshot1", armnetapp.SnapshotRestoreFiles{
	FilePaths: []*string{
		to.Ptr("/dir1/customer1.db"),
		to.Ptr("/dir1/customer2.db")},
}, 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 (*SnapshotsClient) BeginUpdate

func (client *SnapshotsClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, snapshotName string, body interface{}, options *SnapshotsClientBeginUpdateOptions) (*runtime.Poller[SnapshotsClientUpdateResponse], error)

BeginUpdate - Patch a snapshot If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume snapshotName - The name of the snapshot body - Snapshot object supplied in the body of the operation. options - SnapshotsClientBeginUpdateOptions contains the optional parameters for the SnapshotsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Snapshots_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "pool1", "volume1", "snapshot1", map[string]interface{}{}, 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 (*SnapshotsClient) Get

func (client *SnapshotsClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, snapshotName string, options *SnapshotsClientGetOptions) (SnapshotsClientGetResponse, error)

Get - Get details of the specified snapshot If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume snapshotName - The name of the snapshot options - SnapshotsClientGetOptions contains the optional parameters for the SnapshotsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Snapshots_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "pool1", "volume1", "snapshot1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SnapshotsClient) NewListPager

func (client *SnapshotsClient) NewListPager(resourceGroupName string, accountName string, poolName string, volumeName string, options *SnapshotsClientListOptions) *runtime.Pager[SnapshotsClientListResponse]

NewListPager - List all snapshots associated with the volume Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - SnapshotsClientListOptions contains the optional parameters for the SnapshotsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Snapshots_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSnapshotsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", "pool1", "volume1", 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:

type SnapshotsClientBeginCreateOptions

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

SnapshotsClientBeginCreateOptions contains the optional parameters for the SnapshotsClient.BeginCreate method.

type SnapshotsClientBeginDeleteOptions

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

SnapshotsClientBeginDeleteOptions contains the optional parameters for the SnapshotsClient.BeginDelete method.

type SnapshotsClientBeginRestoreFilesOptions

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

SnapshotsClientBeginRestoreFilesOptions contains the optional parameters for the SnapshotsClient.BeginRestoreFiles method.

type SnapshotsClientBeginUpdateOptions

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

SnapshotsClientBeginUpdateOptions contains the optional parameters for the SnapshotsClient.BeginUpdate method.

type SnapshotsClientCreateResponse

type SnapshotsClientCreateResponse struct {
	Snapshot
}

SnapshotsClientCreateResponse contains the response from method SnapshotsClient.Create.

type SnapshotsClientDeleteResponse

type SnapshotsClientDeleteResponse struct {
}

SnapshotsClientDeleteResponse contains the response from method SnapshotsClient.Delete.

type SnapshotsClientGetOptions

type SnapshotsClientGetOptions struct {
}

SnapshotsClientGetOptions contains the optional parameters for the SnapshotsClient.Get method.

type SnapshotsClientGetResponse

type SnapshotsClientGetResponse struct {
	Snapshot
}

SnapshotsClientGetResponse contains the response from method SnapshotsClient.Get.

type SnapshotsClientListOptions

type SnapshotsClientListOptions struct {
}

SnapshotsClientListOptions contains the optional parameters for the SnapshotsClient.List method.

type SnapshotsClientListResponse

type SnapshotsClientListResponse struct {
	SnapshotsList
}

SnapshotsClientListResponse contains the response from method SnapshotsClient.List.

type SnapshotsClientRestoreFilesResponse

type SnapshotsClientRestoreFilesResponse struct {
}

SnapshotsClientRestoreFilesResponse contains the response from method SnapshotsClient.RestoreFiles.

type SnapshotsClientUpdateResponse

type SnapshotsClientUpdateResponse struct {
	Snapshot
}

SnapshotsClientUpdateResponse contains the response from method SnapshotsClient.Update.

type SnapshotsList

type SnapshotsList struct {
	// A list of Snapshots
	Value []*Snapshot `json:"value,omitempty"`
}

SnapshotsList - List of Snapshots

func (SnapshotsList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SnapshotsList.

func (*SnapshotsList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotsList.

type SubscriptionQuotaItem

type SubscriptionQuotaItem struct {
	// SubscriptionQuotaItem properties
	Properties *SubscriptionQuotaItemProperties `json:"properties,omitempty"`

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

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

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

SubscriptionQuotaItem - Information regarding Subscription Quota Item.

func (SubscriptionQuotaItem) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubscriptionQuotaItem.

func (*SubscriptionQuotaItem) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionQuotaItem.

type SubscriptionQuotaItemList

type SubscriptionQuotaItemList struct {
	// A list of SubscriptionQuotaItems
	Value []*SubscriptionQuotaItem `json:"value,omitempty"`
}

SubscriptionQuotaItemList - List of Subscription Quota Items

func (SubscriptionQuotaItemList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubscriptionQuotaItemList.

func (*SubscriptionQuotaItemList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionQuotaItemList.

type SubscriptionQuotaItemProperties

type SubscriptionQuotaItemProperties struct {
	// READ-ONLY; The current quota value.
	Current *int32 `json:"current,omitempty" azure:"ro"`

	// READ-ONLY; The default quota value.
	Default *int32 `json:"default,omitempty" azure:"ro"`
}

SubscriptionQuotaItemProperties - SubscriptionQuotaItem Properties

func (SubscriptionQuotaItemProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubscriptionQuotaItemProperties.

func (*SubscriptionQuotaItemProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionQuotaItemProperties.

type SubvolumeInfo

type SubvolumeInfo struct {
	// Subvolume Properties
	Properties *SubvolumeProperties `json:"properties,omitempty"`

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

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

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

SubvolumeInfo - Subvolume Information properties

func (SubvolumeInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumeInfo.

func (*SubvolumeInfo) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumeInfo.

type SubvolumeModel

type SubvolumeModel struct {
	// It represents the minimal properties of the subvolume.
	Properties *SubvolumeModelProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

SubvolumeModel - Result of the post subvolume and action is to get metadata of the subvolume.

func (SubvolumeModel) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumeModel.

func (*SubvolumeModel) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumeModel.

type SubvolumeModelProperties

type SubvolumeModelProperties struct {
	// Most recent access time and date
	AccessedTimeStamp *time.Time `json:"accessedTimeStamp,omitempty"`

	// Bytes used
	BytesUsed *int64 `json:"bytesUsed,omitempty"`

	// Most recent change time and date
	ChangedTimeStamp *time.Time `json:"changedTimeStamp,omitempty"`

	// Creation time and date
	CreationTimeStamp *time.Time `json:"creationTimeStamp,omitempty"`

	// Most recent modification time and date
	ModifiedTimeStamp *time.Time `json:"modifiedTimeStamp,omitempty"`

	// Path to the parent subvolume
	ParentPath *string `json:"parentPath,omitempty"`

	// Path to the subvolume
	Path *string `json:"path,omitempty"`

	// Permissions of the subvolume
	Permissions *string `json:"permissions,omitempty"`

	// Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Size of subvolume
	Size *int64 `json:"size,omitempty"`
}

SubvolumeModelProperties - Properties which represents actual subvolume model which is stored as a file in the system.

func (SubvolumeModelProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumeModelProperties.

func (*SubvolumeModelProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumeModelProperties.

type SubvolumePatchParams

type SubvolumePatchParams struct {
	// path to the subvolume
	Path *string `json:"path,omitempty"`

	// Truncate subvolume to the provided size in bytes
	Size *int64 `json:"size,omitempty"`
}

SubvolumePatchParams - Parameters with which a subvolume can be updated

func (SubvolumePatchParams) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumePatchParams.

func (*SubvolumePatchParams) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumePatchParams.

type SubvolumePatchRequest

type SubvolumePatchRequest struct {
	// Subvolume Properties
	Properties *SubvolumePatchParams `json:"properties,omitempty"`
}

SubvolumePatchRequest - Subvolume Patch Request properties

func (SubvolumePatchRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumePatchRequest.

func (*SubvolumePatchRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumePatchRequest.

type SubvolumeProperties

type SubvolumeProperties struct {
	// parent path to the subvolume
	ParentPath *string `json:"parentPath,omitempty"`

	// Path to the subvolume
	Path *string `json:"path,omitempty"`

	// Truncate subvolume to the provided size in bytes
	Size *int64 `json:"size,omitempty"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SubvolumeProperties - This represents path associated with the subvolume

func (SubvolumeProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumeProperties.

func (*SubvolumeProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumeProperties.

type SubvolumesClient

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

SubvolumesClient contains the methods for the Subvolumes group. Don't use this type directly, use NewSubvolumesClient() instead.

func NewSubvolumesClient

func NewSubvolumesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SubvolumesClient, error)

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

func (*SubvolumesClient) BeginCreate

func (client *SubvolumesClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, subvolumeName string, body SubvolumeInfo, options *SubvolumesClientBeginCreateOptions) (*runtime.Poller[SubvolumesClientCreateResponse], error)

BeginCreate - Creates a subvolume in the path or clones the subvolume mentioned in the parentPath If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume subvolumeName - The name of the subvolume. body - Subvolume object supplied in the body of the operation. options - SubvolumesClientBeginCreateOptions contains the optional parameters for the SubvolumesClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Subvolumes_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSubvolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "myRG", "account1", "pool1", "volume1", "subvolume1", armnetapp.SubvolumeInfo{
	Properties: &armnetapp.SubvolumeProperties{
		Path: to.Ptr("/subvolumePath"),
	},
}, 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 (*SubvolumesClient) BeginDelete

func (client *SubvolumesClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, subvolumeName string, options *SubvolumesClientBeginDeleteOptions) (*runtime.Poller[SubvolumesClientDeleteResponse], error)

BeginDelete - Delete subvolume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume subvolumeName - The name of the subvolume. options - SubvolumesClientBeginDeleteOptions contains the optional parameters for the SubvolumesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Subvolumes_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSubvolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account1", "pool1", "volume1", "subvolume1", 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 (*SubvolumesClient) BeginGetMetadata

func (client *SubvolumesClient) BeginGetMetadata(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, subvolumeName string, options *SubvolumesClientBeginGetMetadataOptions) (*runtime.Poller[SubvolumesClientGetMetadataResponse], error)

BeginGetMetadata - Get details of the specified subvolume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume subvolumeName - The name of the subvolume. options - SubvolumesClientBeginGetMetadataOptions contains the optional parameters for the SubvolumesClient.BeginGetMetadata method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Subvolumes_Metadata.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSubvolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetMetadata(ctx, "myRG", "account1", "pool1", "volume1", "subvolume1", 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 (*SubvolumesClient) BeginUpdate

func (client *SubvolumesClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, subvolumeName string, body SubvolumePatchRequest, options *SubvolumesClientBeginUpdateOptions) (*runtime.Poller[SubvolumesClientUpdateResponse], error)

BeginUpdate - Patch a subvolume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume subvolumeName - The name of the subvolume. body - Subvolume object supplied in the body of the operation. options - SubvolumesClientBeginUpdateOptions contains the optional parameters for the SubvolumesClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Subvolumes_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSubvolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "pool1", "volume1", "subvolume1", armnetapp.SubvolumePatchRequest{
	Properties: &armnetapp.SubvolumePatchParams{
		Path: to.Ptr("/subvolumePath"),
	},
}, 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 (*SubvolumesClient) Get

func (client *SubvolumesClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, subvolumeName string, options *SubvolumesClientGetOptions) (SubvolumesClientGetResponse, error)

Get - Returns the path associated with the subvolumeName provided If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume subvolumeName - The name of the subvolume. options - SubvolumesClientGetOptions contains the optional parameters for the SubvolumesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Subvolumes_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSubvolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "pool1", "volume1", "subvolume1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SubvolumesClient) NewListByVolumePager

func (client *SubvolumesClient) NewListByVolumePager(resourceGroupName string, accountName string, poolName string, volumeName string, options *SubvolumesClientListByVolumeOptions) *runtime.Pager[SubvolumesClientListByVolumeResponse]

NewListByVolumePager - Returns a list of the subvolumes in the volume Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - SubvolumesClientListByVolumeOptions contains the optional parameters for the SubvolumesClient.ListByVolume method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Subvolumes_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewSubvolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVolumePager("myRG", "account1", "pool1", "volume1", 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:

type SubvolumesClientBeginCreateOptions

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

SubvolumesClientBeginCreateOptions contains the optional parameters for the SubvolumesClient.BeginCreate method.

type SubvolumesClientBeginDeleteOptions

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

SubvolumesClientBeginDeleteOptions contains the optional parameters for the SubvolumesClient.BeginDelete method.

type SubvolumesClientBeginGetMetadataOptions

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

SubvolumesClientBeginGetMetadataOptions contains the optional parameters for the SubvolumesClient.BeginGetMetadata method.

type SubvolumesClientBeginUpdateOptions

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

SubvolumesClientBeginUpdateOptions contains the optional parameters for the SubvolumesClient.BeginUpdate method.

type SubvolumesClientCreateResponse

type SubvolumesClientCreateResponse struct {
	SubvolumeInfo
}

SubvolumesClientCreateResponse contains the response from method SubvolumesClient.Create.

type SubvolumesClientDeleteResponse

type SubvolumesClientDeleteResponse struct {
}

SubvolumesClientDeleteResponse contains the response from method SubvolumesClient.Delete.

type SubvolumesClientGetMetadataResponse

type SubvolumesClientGetMetadataResponse struct {
	SubvolumeModel
}

SubvolumesClientGetMetadataResponse contains the response from method SubvolumesClient.GetMetadata.

type SubvolumesClientGetOptions

type SubvolumesClientGetOptions struct {
}

SubvolumesClientGetOptions contains the optional parameters for the SubvolumesClient.Get method.

type SubvolumesClientGetResponse

type SubvolumesClientGetResponse struct {
	SubvolumeInfo
}

SubvolumesClientGetResponse contains the response from method SubvolumesClient.Get.

type SubvolumesClientListByVolumeOptions

type SubvolumesClientListByVolumeOptions struct {
}

SubvolumesClientListByVolumeOptions contains the optional parameters for the SubvolumesClient.ListByVolume method.

type SubvolumesClientListByVolumeResponse

type SubvolumesClientListByVolumeResponse struct {
	SubvolumesList
}

SubvolumesClientListByVolumeResponse contains the response from method SubvolumesClient.ListByVolume.

type SubvolumesClientUpdateResponse

type SubvolumesClientUpdateResponse struct {
	SubvolumeInfo
}

SubvolumesClientUpdateResponse contains the response from method SubvolumesClient.Update.

type SubvolumesList

type SubvolumesList struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of Subvolumes
	Value []*SubvolumeInfo `json:"value,omitempty"`
}

SubvolumesList - List of Subvolumes

func (SubvolumesList) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubvolumesList.

func (*SubvolumesList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubvolumesList.

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 Type

type Type string

Type - Type of quota

const (
	// TypeDefaultGroupQuota - Default group quota
	TypeDefaultGroupQuota Type = "DefaultGroupQuota"
	// TypeDefaultUserQuota - Default user quota
	TypeDefaultUserQuota Type = "DefaultUserQuota"
	// TypeIndividualGroupQuota - Individual group quota
	TypeIndividualGroupQuota Type = "IndividualGroupQuota"
	// TypeIndividualUserQuota - Individual user quota
	TypeIndividualUserQuota Type = "IndividualUserQuota"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UserAssignedIdentity

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

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

UserAssignedIdentity for the resource.

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 Vault

type Vault struct {
	// REQUIRED; Vault Properties
	Properties *VaultProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Vault information

func (Vault) MarshalJSON

func (v Vault) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Vault.

func (*Vault) UnmarshalJSON

func (v *Vault) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Vault.

type VaultList

type VaultList struct {
	// A list of vaults
	Value []*Vault `json:"value,omitempty"`
}

VaultList - List of Vaults

func (VaultList) MarshalJSON

func (v VaultList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VaultList.

func (*VaultList) UnmarshalJSON

func (v *VaultList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VaultList.

type VaultProperties

type VaultProperties struct {
	// Vault Name
	VaultName *string `json:"vaultName,omitempty"`
}

VaultProperties - Vault properties

func (VaultProperties) MarshalJSON

func (v VaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VaultProperties.

func (*VaultProperties) UnmarshalJSON

func (v *VaultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VaultProperties.

type VaultsClient

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

VaultsClient contains the methods for the Vaults group. Don't use this type directly, use NewVaultsClient() instead.

func NewVaultsClient

func NewVaultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VaultsClient, error)

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

func (*VaultsClient) NewListPager

func (client *VaultsClient) NewListPager(resourceGroupName string, accountName string, options *VaultsClientListOptions) *runtime.Pager[VaultsClientListResponse]

NewListPager - List vaults for a Netapp Account Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - VaultsClientListOptions contains the optional parameters for the VaultsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Vaults_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVaultsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", 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:

type VaultsClientListOptions

type VaultsClientListOptions struct {
}

VaultsClientListOptions contains the optional parameters for the VaultsClient.List method.

type VaultsClientListResponse

type VaultsClientListResponse struct {
	VaultList
}

VaultsClientListResponse contains the response from method VaultsClient.List.

type Volume

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

	// REQUIRED; Volume properties
	Properties *VolumeProperties `json:"properties,omitempty"`

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

	// Availability Zone
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// 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; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

Volume resource

func (Volume) MarshalJSON

func (v Volume) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Volume.

func (*Volume) UnmarshalJSON

func (v *Volume) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Volume.

type VolumeBackupProperties

type VolumeBackupProperties struct {
	// Backup Enabled
	BackupEnabled *bool `json:"backupEnabled,omitempty"`

	// Backup Policy Resource ID
	BackupPolicyID *string `json:"backupPolicyId,omitempty"`

	// Policy Enforced
	PolicyEnforced *bool `json:"policyEnforced,omitempty"`

	// Vault Resource ID
	VaultID *string `json:"vaultId,omitempty"`
}

VolumeBackupProperties - Volume Backup Properties

func (VolumeBackupProperties) MarshalJSON

func (v VolumeBackupProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeBackupProperties.

func (*VolumeBackupProperties) UnmarshalJSON

func (v *VolumeBackupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeBackupProperties.

type VolumeBackups

type VolumeBackups struct {
	// Total count of backups for volume
	BackupsCount *int32 `json:"backupsCount,omitempty"`

	// Policy enabled
	PolicyEnabled *bool `json:"policyEnabled,omitempty"`

	// Volume name
	VolumeName *string `json:"volumeName,omitempty"`
}

VolumeBackups - Volume details using the backup policy

func (VolumeBackups) MarshalJSON

func (v VolumeBackups) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeBackups.

func (*VolumeBackups) UnmarshalJSON

func (v *VolumeBackups) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeBackups.

type VolumeGroup

type VolumeGroup struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// Volume group properties
	Properties *VolumeGroupListProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

VolumeGroup - Volume group resource

func (VolumeGroup) MarshalJSON

func (v VolumeGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroup.

func (*VolumeGroup) UnmarshalJSON

func (v *VolumeGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroup.

type VolumeGroupDetails

type VolumeGroupDetails struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// Volume group properties
	Properties *VolumeGroupProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

VolumeGroupDetails - Volume group resource for create

func (VolumeGroupDetails) MarshalJSON

func (v VolumeGroupDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroupDetails.

func (*VolumeGroupDetails) UnmarshalJSON

func (v *VolumeGroupDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroupDetails.

type VolumeGroupList

type VolumeGroupList struct {
	// List of volume Groups
	Value []*VolumeGroup `json:"value,omitempty"`
}

VolumeGroupList - List of volume group resources

func (VolumeGroupList) MarshalJSON

func (v VolumeGroupList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroupList.

func (*VolumeGroupList) UnmarshalJSON

func (v *VolumeGroupList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroupList.

type VolumeGroupListProperties

type VolumeGroupListProperties struct {
	// Volume group details
	GroupMetaData *VolumeGroupMetaData `json:"groupMetaData,omitempty"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

VolumeGroupListProperties - Volume group properties

func (VolumeGroupListProperties) MarshalJSON

func (v VolumeGroupListProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroupListProperties.

func (*VolumeGroupListProperties) UnmarshalJSON

func (v *VolumeGroupListProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroupListProperties.

type VolumeGroupMetaData

type VolumeGroupMetaData struct {
	// Application specific identifier
	ApplicationIdentifier *string `json:"applicationIdentifier,omitempty"`

	// Application Type
	ApplicationType *ApplicationType `json:"applicationType,omitempty"`

	// Application specific identifier of deployment rules for the volume group
	DeploymentSpecID *string `json:"deploymentSpecId,omitempty"`

	// Application specific placement rules for the volume group
	GlobalPlacementRules []*PlacementKeyValuePairs `json:"globalPlacementRules,omitempty"`

	// Group Description
	GroupDescription *string `json:"groupDescription,omitempty"`

	// READ-ONLY; Number of volumes in volume group
	VolumesCount *int64 `json:"volumesCount,omitempty" azure:"ro"`
}

VolumeGroupMetaData - Volume group properties

func (VolumeGroupMetaData) MarshalJSON

func (v VolumeGroupMetaData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroupMetaData.

func (*VolumeGroupMetaData) UnmarshalJSON

func (v *VolumeGroupMetaData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroupMetaData.

type VolumeGroupProperties

type VolumeGroupProperties struct {
	// Volume group details
	GroupMetaData *VolumeGroupMetaData `json:"groupMetaData,omitempty"`

	// List of volumes from group
	Volumes []*VolumeGroupVolumeProperties `json:"volumes,omitempty"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

VolumeGroupProperties - Volume group properties

func (VolumeGroupProperties) MarshalJSON

func (v VolumeGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroupProperties.

func (*VolumeGroupProperties) UnmarshalJSON

func (v *VolumeGroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroupProperties.

type VolumeGroupVolumeProperties

type VolumeGroupVolumeProperties struct {
	// REQUIRED; Volume properties
	Properties *VolumeProperties `json:"properties,omitempty"`

	// Resource name
	Name *string `json:"name,omitempty"`

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

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

VolumeGroupVolumeProperties - Volume resource

func (VolumeGroupVolumeProperties) MarshalJSON

func (v VolumeGroupVolumeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeGroupVolumeProperties.

func (*VolumeGroupVolumeProperties) UnmarshalJSON

func (v *VolumeGroupVolumeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeGroupVolumeProperties.

type VolumeGroupsClient

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

VolumeGroupsClient contains the methods for the VolumeGroups group. Don't use this type directly, use NewVolumeGroupsClient() instead.

func NewVolumeGroupsClient

func NewVolumeGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VolumeGroupsClient, error)

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

func (*VolumeGroupsClient) BeginCreate

func (client *VolumeGroupsClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, volumeGroupName string, body VolumeGroupDetails, options *VolumeGroupsClientBeginCreateOptions) (*runtime.Poller[VolumeGroupsClientCreateResponse], error)

BeginCreate - Create a volume group along with specified volumes If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account volumeGroupName - The name of the volumeGroup body - Volume Group object supplied in the body of the operation. options - VolumeGroupsClientBeginCreateOptions contains the optional parameters for the VolumeGroupsClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeGroups_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeGroupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "myRG", "account1", "group1", armnetapp.VolumeGroupDetails{
	Location: to.Ptr("westus"),
	Properties: &armnetapp.VolumeGroupProperties{
		GroupMetaData: &armnetapp.VolumeGroupMetaData{
			ApplicationIdentifier: to.Ptr("DEV"),
			ApplicationType:       to.Ptr(armnetapp.ApplicationTypeSAPHANA),
			DeploymentSpecID:      to.Ptr("fb04dbeb-005d-2703-197e-6208dfadb5d9"),
			GroupDescription:      to.Ptr("Volume group"),
		},
		Volumes: []*armnetapp.VolumeGroupVolumeProperties{
			{
				Name: to.Ptr("testVol1"),
				Properties: &armnetapp.VolumeProperties{
					CapacityPoolResourceID:  to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1"),
					CreationToken:           to.Ptr("testVol1"),
					ProximityPlacementGroup: to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg"),
					ServiceLevel:            to.Ptr(armnetapp.ServiceLevelPremium),
					SubnetID:                to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
					ThroughputMibps:         to.Ptr[float32](10),
					UsageThreshold:          to.Ptr[int64](107374182400),
					VolumeSpecName:          to.Ptr("data"),
				},
			},
			{
				Name: to.Ptr("testVol2"),
				Properties: &armnetapp.VolumeProperties{
					CapacityPoolResourceID:  to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1"),
					CreationToken:           to.Ptr("testVol2"),
					ProximityPlacementGroup: to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg"),
					ServiceLevel:            to.Ptr(armnetapp.ServiceLevelPremium),
					SubnetID:                to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
					ThroughputMibps:         to.Ptr[float32](10),
					UsageThreshold:          to.Ptr[int64](107374182400),
					VolumeSpecName:          to.Ptr("log"),
				},
			},
			{
				Name: to.Ptr("testVol3"),
				Properties: &armnetapp.VolumeProperties{
					CapacityPoolResourceID:  to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1"),
					CreationToken:           to.Ptr("testVol3"),
					ProximityPlacementGroup: to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg"),
					ServiceLevel:            to.Ptr(armnetapp.ServiceLevelPremium),
					SubnetID:                to.Ptr("/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
					ThroughputMibps:         to.Ptr[float32](10),
					UsageThreshold:          to.Ptr[int64](107374182400),
					VolumeSpecName:          to.Ptr("shared"),
				},
			}},
	},
}, 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 (*VolumeGroupsClient) BeginDelete

func (client *VolumeGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, volumeGroupName string, options *VolumeGroupsClientBeginDeleteOptions) (*runtime.Poller[VolumeGroupsClientDeleteResponse], error)

BeginDelete - Delete the specified volume group only if there are no volumes under volume group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account volumeGroupName - The name of the volumeGroup options - VolumeGroupsClientBeginDeleteOptions contains the optional parameters for the VolumeGroupsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeGroups_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeGroupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account1", "group1", 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 (*VolumeGroupsClient) Get

func (client *VolumeGroupsClient) Get(ctx context.Context, resourceGroupName string, accountName string, volumeGroupName string, options *VolumeGroupsClientGetOptions) (VolumeGroupsClientGetResponse, error)

Get - Get details of the specified volume group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account volumeGroupName - The name of the volumeGroup options - VolumeGroupsClientGetOptions contains the optional parameters for the VolumeGroupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeGroups_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeGroupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "group1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VolumeGroupsClient) NewListByNetAppAccountPager

func (client *VolumeGroupsClient) NewListByNetAppAccountPager(resourceGroupName string, accountName string, options *VolumeGroupsClientListByNetAppAccountOptions) *runtime.Pager[VolumeGroupsClientListByNetAppAccountResponse]

NewListByNetAppAccountPager - List all volume groups for given account Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account options - VolumeGroupsClientListByNetAppAccountOptions contains the optional parameters for the VolumeGroupsClient.ListByNetAppAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeGroups_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeGroupsClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByNetAppAccountPager("myRG", "account1", 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:

type VolumeGroupsClientBeginCreateOptions

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

VolumeGroupsClientBeginCreateOptions contains the optional parameters for the VolumeGroupsClient.BeginCreate method.

type VolumeGroupsClientBeginDeleteOptions

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

VolumeGroupsClientBeginDeleteOptions contains the optional parameters for the VolumeGroupsClient.BeginDelete method.

type VolumeGroupsClientCreateResponse

type VolumeGroupsClientCreateResponse struct {
	VolumeGroupDetails
}

VolumeGroupsClientCreateResponse contains the response from method VolumeGroupsClient.Create.

type VolumeGroupsClientDeleteResponse

type VolumeGroupsClientDeleteResponse struct {
}

VolumeGroupsClientDeleteResponse contains the response from method VolumeGroupsClient.Delete.

type VolumeGroupsClientGetOptions

type VolumeGroupsClientGetOptions struct {
}

VolumeGroupsClientGetOptions contains the optional parameters for the VolumeGroupsClient.Get method.

type VolumeGroupsClientGetResponse

type VolumeGroupsClientGetResponse struct {
	VolumeGroupDetails
}

VolumeGroupsClientGetResponse contains the response from method VolumeGroupsClient.Get.

type VolumeGroupsClientListByNetAppAccountOptions

type VolumeGroupsClientListByNetAppAccountOptions struct {
}

VolumeGroupsClientListByNetAppAccountOptions contains the optional parameters for the VolumeGroupsClient.ListByNetAppAccount method.

type VolumeGroupsClientListByNetAppAccountResponse

type VolumeGroupsClientListByNetAppAccountResponse struct {
	VolumeGroupList
}

VolumeGroupsClientListByNetAppAccountResponse contains the response from method VolumeGroupsClient.ListByNetAppAccount.

type VolumeList

type VolumeList struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of volumes
	Value []*Volume `json:"value,omitempty"`
}

VolumeList - List of volume resources

func (VolumeList) MarshalJSON

func (v VolumeList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeList.

func (*VolumeList) UnmarshalJSON

func (v *VolumeList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeList.

type VolumePatch

type VolumePatch struct {
	// Resource location
	Location *string `json:"location,omitempty"`

	// Patchable volume properties
	Properties *VolumePatchProperties `json:"properties,omitempty"`

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

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

VolumePatch - Volume patch resource

func (VolumePatch) MarshalJSON

func (v VolumePatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumePatch.

func (*VolumePatch) UnmarshalJSON

func (v *VolumePatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumePatch.

type VolumePatchProperties

type VolumePatchProperties struct {
	// Specifies whether Cool Access(tiering) is enabled for the volume.
	CoolAccess *bool `json:"coolAccess,omitempty"`

	// Specifies the number of days after which data that is not accessed by clients will be tiered.
	CoolnessPeriod *int32 `json:"coolnessPeriod,omitempty"`

	// DataProtection type volumes include an object containing details of the replication
	DataProtection *VolumePatchPropertiesDataProtection `json:"dataProtection,omitempty"`

	// Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
	DefaultGroupQuotaInKiBs *int64 `json:"defaultGroupQuotaInKiBs,omitempty"`

	// Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
	DefaultUserQuotaInKiBs *int64 `json:"defaultUserQuotaInKiBs,omitempty"`

	// Set of export policy rules
	ExportPolicy *VolumePatchPropertiesExportPolicy `json:"exportPolicy,omitempty"`

	// Specifies if default quota is enabled for the volume.
	IsDefaultQuotaEnabled *bool `json:"isDefaultQuotaEnabled,omitempty"`

	// The service level of the file system
	ServiceLevel *ServiceLevel `json:"serviceLevel,omitempty"`

	// Maximum throughput in Mibps that can be achieved by this volume and this will be accepted as input only for manual qosType
	// volume
	ThroughputMibps *float32 `json:"throughputMibps,omitempty"`

	// UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID
	// (2) and sticky (1) attributes. Second digit selects permission for the owner of
	// the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth
	// for other users not in the group. 0755 - gives read/write/execute permissions to
	// owner and read/execute to group and other users.
	UnixPermissions *string `json:"unixPermissions,omitempty"`

	// Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is
	// 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume. Specified in bytes.
	UsageThreshold *int64 `json:"usageThreshold,omitempty"`
}

VolumePatchProperties - Patchable volume properties

func (VolumePatchProperties) MarshalJSON

func (v VolumePatchProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumePatchProperties.

func (*VolumePatchProperties) UnmarshalJSON

func (v *VolumePatchProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumePatchProperties.

type VolumePatchPropertiesDataProtection

type VolumePatchPropertiesDataProtection struct {
	// Backup Properties
	Backup *VolumeBackupProperties `json:"backup,omitempty"`

	// Snapshot properties.
	Snapshot *VolumeSnapshotProperties `json:"snapshot,omitempty"`
}

VolumePatchPropertiesDataProtection - DataProtection type volumes include an object containing details of the replication

func (VolumePatchPropertiesDataProtection) MarshalJSON

func (v VolumePatchPropertiesDataProtection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumePatchPropertiesDataProtection.

func (*VolumePatchPropertiesDataProtection) UnmarshalJSON

func (v *VolumePatchPropertiesDataProtection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumePatchPropertiesDataProtection.

type VolumePatchPropertiesExportPolicy

type VolumePatchPropertiesExportPolicy struct {
	// Export policy rule
	Rules []*ExportPolicyRule `json:"rules,omitempty"`
}

VolumePatchPropertiesExportPolicy - Set of export policy rules

func (VolumePatchPropertiesExportPolicy) MarshalJSON

func (v VolumePatchPropertiesExportPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumePatchPropertiesExportPolicy.

func (*VolumePatchPropertiesExportPolicy) UnmarshalJSON

func (v *VolumePatchPropertiesExportPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumePatchPropertiesExportPolicy.

type VolumeProperties

type VolumeProperties struct {
	// REQUIRED; A unique file path for the volume. Used when creating mount targets
	CreationToken *string `json:"creationToken,omitempty"`

	// REQUIRED; The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
	SubnetID *string `json:"subnetId,omitempty"`

	// REQUIRED; Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum
	// size is 500 GiB. Upper limit is 100TiB, 500Tib for LargeVolume. Specified in bytes.
	UsageThreshold *int64 `json:"usageThreshold,omitempty"`

	// Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
	AvsDataStore *AvsDataStore `json:"avsDataStore,omitempty"`

	// UUID v4 or resource identifier used to identify the Backup.
	BackupID *string `json:"backupId,omitempty"`

	// Pool Resource Id used in case of creating a volume through volume group
	CapacityPoolResourceID *string `json:"capacityPoolResourceId,omitempty"`

	// Specifies whether Cool Access(tiering) is enabled for the volume.
	CoolAccess *bool `json:"coolAccess,omitempty"`

	// Specifies the number of days after which data that is not accessed by clients will be tiered.
	CoolnessPeriod *int32 `json:"coolnessPeriod,omitempty"`

	// DataProtection type volumes include an object containing details of the replication
	DataProtection *VolumePropertiesDataProtection `json:"dataProtection,omitempty"`

	// Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
	DefaultGroupQuotaInKiBs *int64 `json:"defaultGroupQuotaInKiBs,omitempty"`

	// Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
	DefaultUserQuotaInKiBs *int64 `json:"defaultUserQuotaInKiBs,omitempty"`

	// If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation
	// has finished. Defaults to false
	DeleteBaseSnapshot *bool `json:"deleteBaseSnapshot,omitempty"`

	// Flag indicating whether subvolume operations are enabled on the volume
	EnableSubvolumes *EnableSubvolumes `json:"enableSubvolumes,omitempty"`

	// Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'.
	// Possible values (case-insensitive) are: 'Microsoft.NetApp,
	// Microsoft.KeyVault'
	EncryptionKeySource *EncryptionKeySource `json:"encryptionKeySource,omitempty"`

	// Set of export policy rules
	ExportPolicy *VolumePropertiesExportPolicy `json:"exportPolicy,omitempty"`

	// Specifies if default quota is enabled for the volume.
	IsDefaultQuotaEnabled *bool `json:"isDefaultQuotaEnabled,omitempty"`

	// Restoring
	IsRestoring *bool `json:"isRestoring,omitempty"`

	// Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
	KerberosEnabled *bool `json:"kerberosEnabled,omitempty"`

	// The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource
	// = 'Microsoft.KeyVault'.
	KeyVaultPrivateEndpointResourceID *string `json:"keyVaultPrivateEndpointResourceId,omitempty"`

	// Specifies whether LDAP is enabled or not for a given NFS volume.
	LdapEnabled *bool `json:"ldapEnabled,omitempty"`

	// Basic network, or Standard features available to the volume.
	NetworkFeatures *NetworkFeatures `json:"networkFeatures,omitempty"`

	// Application specific placement rules for the particular volume
	PlacementRules []*PlacementKeyValuePairs `json:"placementRules,omitempty"`

	// Set of protocol types, default NFSv3, CIFS for SMB protocol
	ProtocolTypes []*string `json:"protocolTypes,omitempty"`

	// Proximity placement group associated with the volume
	ProximityPlacementGroup *string `json:"proximityPlacementGroup,omitempty"`

	// The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
	SecurityStyle *SecurityStyle `json:"securityStyle,omitempty"`

	// The service level of the file system
	ServiceLevel *ServiceLevel `json:"serviceLevel,omitempty"`

	// Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
	SmbAccessBasedEnumeration *SmbAccessBasedEnumeration `json:"smbAccessBasedEnumeration,omitempty"`

	// Enables continuously available share property for smb volume. Only applicable for SMB volume
	SmbContinuouslyAvailable *bool `json:"smbContinuouslyAvailable,omitempty"`

	// Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version
	// 2020-08-01 or later
	SmbEncryption *bool `json:"smbEncryption,omitempty"`

	// Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
	SmbNonBrowsable *SmbNonBrowsable `json:"smbNonBrowsable,omitempty"`

	// If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's
	// snapshots (default to true).
	SnapshotDirectoryVisible *bool `json:"snapshotDirectoryVisible,omitempty"`

	// UUID v4 or resource identifier used to identify the Snapshot.
	SnapshotID *string `json:"snapshotId,omitempty"`

	// Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType
	// volume
	ThroughputMibps *float32 `json:"throughputMibps,omitempty"`

	// UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID
	// (2) and sticky (1) attributes. Second digit selects permission for the owner of
	// the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth
	// for other users not in the group. 0755 - gives read/write/execute permissions to
	// owner and read/execute to group and other users.
	UnixPermissions *string `json:"unixPermissions,omitempty"`

	// Volume spec name is the application specific designation or identifier for the particular volume in a volume group for
	// e.g. data, log
	VolumeSpecName *string `json:"volumeSpecName,omitempty"`

	// What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
	VolumeType *string `json:"volumeType,omitempty"`

	// READ-ONLY; Unique Baremetal Tenant Identifier.
	BaremetalTenantID *string `json:"baremetalTenantId,omitempty" azure:"ro"`

	// READ-ONLY; When a volume is being restored from another volume's snapshot, will show the percentage completion of this
	// cloning process. When this value is empty/null there is no cloning process currently
	// happening on this volume. This value will update every 5 minutes during cloning.
	CloneProgress *int32 `json:"cloneProgress,omitempty" azure:"ro"`

	// READ-ONLY; Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
	Encrypted *bool `json:"encrypted,omitempty" azure:"ro"`

	// READ-ONLY; Unique FileSystem Identifier.
	FileSystemID *string `json:"fileSystemId,omitempty" azure:"ro"`

	// READ-ONLY; Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed
	// if volume quota is more than 4TiB.
	MaximumNumberOfFiles *int64 `json:"maximumNumberOfFiles,omitempty" azure:"ro"`

	// READ-ONLY; List of mount targets
	MountTargets []*MountTargetProperties `json:"mountTargets,omitempty" azure:"ro"`

	// READ-ONLY; Network Sibling Set ID for the the group of volumes sharing networking resources.
	NetworkSiblingSetID *string `json:"networkSiblingSetId,omitempty" azure:"ro"`

	// READ-ONLY; Azure lifecycle management
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Provides storage to network proximity information for the volume.
	StorageToNetworkProximity *VolumeStorageToNetworkProximity `json:"storageToNetworkProximity,omitempty" azure:"ro"`

	// READ-ONLY; T2 network information
	T2Network *string `json:"t2Network,omitempty" azure:"ro"`

	// READ-ONLY; Volume Group Name
	VolumeGroupName *string `json:"volumeGroupName,omitempty" azure:"ro"`
}

VolumeProperties - Volume properties

func (VolumeProperties) MarshalJSON

func (v VolumeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeProperties.

func (*VolumeProperties) UnmarshalJSON

func (v *VolumeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeProperties.

type VolumePropertiesDataProtection

type VolumePropertiesDataProtection struct {
	// Backup Properties
	Backup *VolumeBackupProperties `json:"backup,omitempty"`

	// Replication properties
	Replication *ReplicationObject `json:"replication,omitempty"`

	// Snapshot properties.
	Snapshot *VolumeSnapshotProperties `json:"snapshot,omitempty"`
}

VolumePropertiesDataProtection - DataProtection type volumes include an object containing details of the replication

func (VolumePropertiesDataProtection) MarshalJSON

func (v VolumePropertiesDataProtection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumePropertiesDataProtection.

func (*VolumePropertiesDataProtection) UnmarshalJSON

func (v *VolumePropertiesDataProtection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumePropertiesDataProtection.

type VolumePropertiesExportPolicy

type VolumePropertiesExportPolicy struct {
	// Export policy rule
	Rules []*ExportPolicyRule `json:"rules,omitempty"`
}

VolumePropertiesExportPolicy - Set of export policy rules

func (VolumePropertiesExportPolicy) MarshalJSON

func (v VolumePropertiesExportPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumePropertiesExportPolicy.

func (*VolumePropertiesExportPolicy) UnmarshalJSON

func (v *VolumePropertiesExportPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumePropertiesExportPolicy.

type VolumeQuotaRule

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

	// Volume Quota Rule Properties
	Properties *VolumeQuotaRulesProperties `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; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	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"`
}

VolumeQuotaRule - Quota Rule of a Volume

func (VolumeQuotaRule) MarshalJSON

func (v VolumeQuotaRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeQuotaRule.

func (*VolumeQuotaRule) UnmarshalJSON

func (v *VolumeQuotaRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeQuotaRule.

type VolumeQuotaRulePatch

type VolumeQuotaRulePatch struct {
	// Volume Quota Rule Properties
	Properties *VolumeQuotaRulesProperties `json:"properties,omitempty"`
}

VolumeQuotaRulePatch - Patchable Quota Rule of a Volume

func (VolumeQuotaRulePatch) MarshalJSON

func (v VolumeQuotaRulePatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeQuotaRulePatch.

func (*VolumeQuotaRulePatch) UnmarshalJSON

func (v *VolumeQuotaRulePatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeQuotaRulePatch.

type VolumeQuotaRulesClient

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

VolumeQuotaRulesClient contains the methods for the VolumeQuotaRules group. Don't use this type directly, use NewVolumeQuotaRulesClient() instead.

func NewVolumeQuotaRulesClient

func NewVolumeQuotaRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VolumeQuotaRulesClient, error)

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

func (*VolumeQuotaRulesClient) BeginCreate

func (client *VolumeQuotaRulesClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, volumeQuotaRuleName string, body VolumeQuotaRule, options *VolumeQuotaRulesClientBeginCreateOptions) (*runtime.Poller[VolumeQuotaRulesClientCreateResponse], error)

BeginCreate - Create the specified quota rule within the given volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume volumeQuotaRuleName - The name of volume quota rule body - Quota rule object supplied in the body of the operation. options - VolumeQuotaRulesClientBeginCreateOptions contains the optional parameters for the VolumeQuotaRulesClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeQuotaRules_Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeQuotaRulesClient("5275316f-a498-48d6-b324-2cbfdc4311b9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "myRG", "account-9957", "pool-5210", "volume-6387", "rule-0004", armnetapp.VolumeQuotaRule{
	Location: to.Ptr("westus"),
	Properties: &armnetapp.VolumeQuotaRulesProperties{
		QuotaSizeInKiBs: to.Ptr[int64](100005),
		QuotaTarget:     to.Ptr("1821"),
		QuotaType:       to.Ptr(armnetapp.TypeIndividualUserQuota),
	},
}, 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 (*VolumeQuotaRulesClient) BeginDelete

func (client *VolumeQuotaRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, volumeQuotaRuleName string, options *VolumeQuotaRulesClientBeginDeleteOptions) (*runtime.Poller[VolumeQuotaRulesClientDeleteResponse], error)

BeginDelete - Delete quota rule If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume volumeQuotaRuleName - The name of volume quota rule options - VolumeQuotaRulesClientBeginDeleteOptions contains the optional parameters for the VolumeQuotaRulesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeQuotaRules_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeQuotaRulesClient("5275316f-a498-48d6-b324-2cbfdc4311b9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account-9957", "pool-5210", "volume-6387", "rule-0004", 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 (*VolumeQuotaRulesClient) BeginUpdate

func (client *VolumeQuotaRulesClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, volumeQuotaRuleName string, body VolumeQuotaRulePatch, options *VolumeQuotaRulesClientBeginUpdateOptions) (*runtime.Poller[VolumeQuotaRulesClientUpdateResponse], error)

BeginUpdate - Patch a quota rule If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume volumeQuotaRuleName - The name of volume quota rule body - Quota rule object supplied in the body of the operation. options - VolumeQuotaRulesClientBeginUpdateOptions contains the optional parameters for the VolumeQuotaRulesClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeQuotaRules_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeQuotaRulesClient("5275316f-a498-48d6-b324-2cbfdc4311b9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account-9957", "pool-5210", "volume-6387", "rule-0004", armnetapp.VolumeQuotaRulePatch{
	Properties: &armnetapp.VolumeQuotaRulesProperties{
		QuotaSizeInKiBs: to.Ptr[int64](100009),
	},
}, 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 (*VolumeQuotaRulesClient) Get

func (client *VolumeQuotaRulesClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, volumeQuotaRuleName string, options *VolumeQuotaRulesClientGetOptions) (VolumeQuotaRulesClientGetResponse, error)

Get - Get details of the specified quota rule If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume volumeQuotaRuleName - The name of volume quota rule options - VolumeQuotaRulesClientGetOptions contains the optional parameters for the VolumeQuotaRulesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeQuotaRules_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeQuotaRulesClient("5275316f-a498-48d6-b324-2cbfdc4311b9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account-9957", "pool-5210", "volume-6387", "rule-0004", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VolumeQuotaRulesClient) NewListByVolumePager

func (client *VolumeQuotaRulesClient) NewListByVolumePager(resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumeQuotaRulesClientListByVolumeOptions) *runtime.Pager[VolumeQuotaRulesClientListByVolumeResponse]

NewListByVolumePager - List all quota rules associated with the volume Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumeQuotaRulesClientListByVolumeOptions contains the optional parameters for the VolumeQuotaRulesClient.ListByVolume method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/VolumeQuotaRules_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumeQuotaRulesClient("5275316f-a498-48d6-b324-2cbfdc4311b9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVolumePager("myRG", "account-9957", "pool-5210", "volume-6387", 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:

type VolumeQuotaRulesClientBeginCreateOptions

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

VolumeQuotaRulesClientBeginCreateOptions contains the optional parameters for the VolumeQuotaRulesClient.BeginCreate method.

type VolumeQuotaRulesClientBeginDeleteOptions

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

VolumeQuotaRulesClientBeginDeleteOptions contains the optional parameters for the VolumeQuotaRulesClient.BeginDelete method.

type VolumeQuotaRulesClientBeginUpdateOptions

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

VolumeQuotaRulesClientBeginUpdateOptions contains the optional parameters for the VolumeQuotaRulesClient.BeginUpdate method.

type VolumeQuotaRulesClientCreateResponse

type VolumeQuotaRulesClientCreateResponse struct {
	VolumeQuotaRule
}

VolumeQuotaRulesClientCreateResponse contains the response from method VolumeQuotaRulesClient.Create.

type VolumeQuotaRulesClientDeleteResponse

type VolumeQuotaRulesClientDeleteResponse struct {
}

VolumeQuotaRulesClientDeleteResponse contains the response from method VolumeQuotaRulesClient.Delete.

type VolumeQuotaRulesClientGetOptions

type VolumeQuotaRulesClientGetOptions struct {
}

VolumeQuotaRulesClientGetOptions contains the optional parameters for the VolumeQuotaRulesClient.Get method.

type VolumeQuotaRulesClientGetResponse

type VolumeQuotaRulesClientGetResponse struct {
	VolumeQuotaRule
}

VolumeQuotaRulesClientGetResponse contains the response from method VolumeQuotaRulesClient.Get.

type VolumeQuotaRulesClientListByVolumeOptions

type VolumeQuotaRulesClientListByVolumeOptions struct {
}

VolumeQuotaRulesClientListByVolumeOptions contains the optional parameters for the VolumeQuotaRulesClient.ListByVolume method.

type VolumeQuotaRulesClientListByVolumeResponse

type VolumeQuotaRulesClientListByVolumeResponse struct {
	VolumeQuotaRulesList
}

VolumeQuotaRulesClientListByVolumeResponse contains the response from method VolumeQuotaRulesClient.ListByVolume.

type VolumeQuotaRulesClientUpdateResponse

type VolumeQuotaRulesClientUpdateResponse struct {
	VolumeQuotaRule
}

VolumeQuotaRulesClientUpdateResponse contains the response from method VolumeQuotaRulesClient.Update.

type VolumeQuotaRulesList

type VolumeQuotaRulesList struct {
	// A list of Volume Quota Rules
	Value []*VolumeQuotaRule `json:"value,omitempty"`
}

VolumeQuotaRulesList - List of Volume Quota Rules

func (VolumeQuotaRulesList) MarshalJSON

func (v VolumeQuotaRulesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeQuotaRulesList.

func (*VolumeQuotaRulesList) UnmarshalJSON

func (v *VolumeQuotaRulesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeQuotaRulesList.

type VolumeQuotaRulesProperties

type VolumeQuotaRulesProperties struct {
	// Size of quota
	QuotaSizeInKiBs *int64 `json:"quotaSizeInKiBs,omitempty"`

	// UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command
	// for the user or group and SID can be found by running
	QuotaTarget *string `json:"quotaTarget,omitempty"`

	// Type of quota
	QuotaType *Type `json:"quotaType,omitempty"`

	// READ-ONLY; Gets the status of the VolumeQuotaRule at the time the operation was called.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VolumeQuotaRulesProperties - Volume Quota Rule properties

func (VolumeQuotaRulesProperties) MarshalJSON

func (v VolumeQuotaRulesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeQuotaRulesProperties.

func (*VolumeQuotaRulesProperties) UnmarshalJSON

func (v *VolumeQuotaRulesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeQuotaRulesProperties.

type VolumeRevert

type VolumeRevert struct {
	// Resource id of the snapshot
	SnapshotID *string `json:"snapshotId,omitempty"`
}

VolumeRevert - revert a volume to the snapshot

func (VolumeRevert) MarshalJSON

func (v VolumeRevert) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeRevert.

func (*VolumeRevert) UnmarshalJSON

func (v *VolumeRevert) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeRevert.

type VolumeSnapshotProperties

type VolumeSnapshotProperties struct {
	// Snapshot Policy ResourceId
	SnapshotPolicyID *string `json:"snapshotPolicyId,omitempty"`
}

VolumeSnapshotProperties - Volume Snapshot Properties

func (VolumeSnapshotProperties) MarshalJSON

func (v VolumeSnapshotProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeSnapshotProperties.

func (*VolumeSnapshotProperties) UnmarshalJSON

func (v *VolumeSnapshotProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeSnapshotProperties.

type VolumeStorageToNetworkProximity

type VolumeStorageToNetworkProximity string

VolumeStorageToNetworkProximity - Provides storage to network proximity information for the volume.

const (
	// VolumeStorageToNetworkProximityDefault - Basic storage to network connectivity.
	VolumeStorageToNetworkProximityDefault VolumeStorageToNetworkProximity = "Default"
	// VolumeStorageToNetworkProximityT1 - Standard T1 storage to network connectivity.
	VolumeStorageToNetworkProximityT1 VolumeStorageToNetworkProximity = "T1"
	// VolumeStorageToNetworkProximityT2 - Standard T2 storage to network connectivity.
	VolumeStorageToNetworkProximityT2 VolumeStorageToNetworkProximity = "T2"
)

func PossibleVolumeStorageToNetworkProximityValues

func PossibleVolumeStorageToNetworkProximityValues() []VolumeStorageToNetworkProximity

PossibleVolumeStorageToNetworkProximityValues returns the possible values for the VolumeStorageToNetworkProximity const type.

type VolumesClient

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

VolumesClient contains the methods for the Volumes group. Don't use this type directly, use NewVolumesClient() instead.

func NewVolumesClient

func NewVolumesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VolumesClient, error)

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

func (*VolumesClient) BeginAuthorizeReplication

func (client *VolumesClient) BeginAuthorizeReplication(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, body AuthorizeRequest, options *VolumesClientBeginAuthorizeReplicationOptions) (*runtime.Poller[VolumesClientAuthorizeReplicationResponse], error)

BeginAuthorizeReplication - Authorize the replication connection on the source volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume body - Authorize request object supplied in the body of the operation. options - VolumesClientBeginAuthorizeReplicationOptions contains the optional parameters for the VolumesClient.BeginAuthorizeReplication method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_AuthorizeReplication.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginAuthorizeReplication(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.AuthorizeRequest{
	RemoteVolumeResourceID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1"),
}, 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 (*VolumesClient) BeginBreakReplication

func (client *VolumesClient) BeginBreakReplication(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginBreakReplicationOptions) (*runtime.Poller[VolumesClientBreakReplicationResponse], error)

BeginBreakReplication - Break the replication connection on the destination volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginBreakReplicationOptions contains the optional parameters for the VolumesClient.BeginBreakReplication method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_BreakReplication.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginBreakReplication(ctx, "myRG", "account1", "pool1", "volume1", &armnetapp.VolumesClientBeginBreakReplicationOptions{Body: &armnetapp.BreakReplicationRequest{
	ForceBreakReplication: to.Ptr(false),
},
})
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 (*VolumesClient) BeginCreateOrUpdate

func (client *VolumesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, body Volume, options *VolumesClientBeginCreateOrUpdateOptions) (*runtime.Poller[VolumesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update the specified volume within the capacity pool If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume body - Volume object supplied in the body of the operation. options - VolumesClientBeginCreateOrUpdateOptions contains the optional parameters for the VolumesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_CreateOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.Volume{
	Location: to.Ptr("eastus"),
	Properties: &armnetapp.VolumeProperties{
		CreationToken:       to.Ptr("my-unique-file-path"),
		EncryptionKeySource: to.Ptr(armnetapp.EncryptionKeySourceMicrosoftKeyVault),
		ServiceLevel:        to.Ptr(armnetapp.ServiceLevelPremium),
		SubnetID:            to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
		ThroughputMibps:     to.Ptr[float32](128),
		UsageThreshold:      to.Ptr[int64](107374182400),
	},
}, 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 (*VolumesClient) BeginDelete

func (client *VolumesClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginDeleteOptions) (*runtime.Poller[VolumesClientDeleteResponse], error)

BeginDelete - Delete the specified volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginDeleteOptions contains the optional parameters for the VolumesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myRG", "account1", "pool1", "volume1", &armnetapp.VolumesClientBeginDeleteOptions{ForceDelete: 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 (*VolumesClient) BeginDeleteReplication

func (client *VolumesClient) BeginDeleteReplication(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginDeleteReplicationOptions) (*runtime.Poller[VolumesClientDeleteReplicationResponse], error)

BeginDeleteReplication - Delete the replication connection on the destination volume, and send release to the source replication If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginDeleteReplicationOptions contains the optional parameters for the VolumesClient.BeginDeleteReplication method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_DeleteReplication.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDeleteReplication(ctx, "myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) BeginFinalizeRelocation

func (client *VolumesClient) BeginFinalizeRelocation(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginFinalizeRelocationOptions) (*runtime.Poller[VolumesClientFinalizeRelocationResponse], error)

BeginFinalizeRelocation - Finalizes the relocation of the volume and cleans up the old volume. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginFinalizeRelocationOptions contains the optional parameters for the VolumesClient.BeginFinalizeRelocation method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_FinalizeRelocation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginFinalizeRelocation(ctx, "myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) BeginPoolChange

func (client *VolumesClient) BeginPoolChange(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, body PoolChangeRequest, options *VolumesClientBeginPoolChangeOptions) (*runtime.Poller[VolumesClientPoolChangeResponse], error)

BeginPoolChange - Moves volume to another pool If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume body - Move volume to the pool supplied in the body of the operation. options - VolumesClientBeginPoolChangeOptions contains the optional parameters for the VolumesClient.BeginPoolChange method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_PoolChange.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginPoolChange(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.PoolChangeRequest{
	NewPoolResourceID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1"),
}, 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 (*VolumesClient) BeginReInitializeReplication

func (client *VolumesClient) BeginReInitializeReplication(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginReInitializeReplicationOptions) (*runtime.Poller[VolumesClientReInitializeReplicationResponse], error)

BeginReInitializeReplication - Re-Initializes the replication connection on the destination volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginReInitializeReplicationOptions contains the optional parameters for the VolumesClient.BeginReInitializeReplication method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_ReInitializeReplication.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginReInitializeReplication(ctx, "myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) BeginReestablishReplication

func (client *VolumesClient) BeginReestablishReplication(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, body ReestablishReplicationRequest, options *VolumesClientBeginReestablishReplicationOptions) (*runtime.Poller[VolumesClientReestablishReplicationResponse], error)

BeginReestablishReplication - Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume body - body for the id of the source volume. options - VolumesClientBeginReestablishReplicationOptions contains the optional parameters for the VolumesClient.BeginReestablishReplication method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_ReestablishReplication.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginReestablishReplication(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.ReestablishReplicationRequest{
	SourceVolumeID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1"),
}, 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 (*VolumesClient) BeginRelocate

func (client *VolumesClient) BeginRelocate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginRelocateOptions) (*runtime.Poller[VolumesClientRelocateResponse], error)

BeginRelocate - Relocates volume to a new stamp If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginRelocateOptions contains the optional parameters for the VolumesClient.BeginRelocate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_Relocate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRelocate(ctx, "myRG", "account1", "pool1", "volume1", &armnetapp.VolumesClientBeginRelocateOptions{Body: &armnetapp.RelocateVolumeRequest{}})
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 (*VolumesClient) BeginResetCifsPassword

func (client *VolumesClient) BeginResetCifsPassword(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginResetCifsPasswordOptions) (*runtime.Poller[VolumesClientResetCifsPasswordResponse], error)

BeginResetCifsPassword - Reset cifs password from volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginResetCifsPasswordOptions contains the optional parameters for the VolumesClient.BeginResetCifsPassword method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_ResetCifsPassword.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResetCifsPassword(ctx, "myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) BeginResyncReplication

func (client *VolumesClient) BeginResyncReplication(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginResyncReplicationOptions) (*runtime.Poller[VolumesClientResyncReplicationResponse], error)

BeginResyncReplication - Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginResyncReplicationOptions contains the optional parameters for the VolumesClient.BeginResyncReplication method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_ResyncReplication.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResyncReplication(ctx, "myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) BeginRevert

func (client *VolumesClient) BeginRevert(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, body VolumeRevert, options *VolumesClientBeginRevertOptions) (*runtime.Poller[VolumesClientRevertResponse], error)

BeginRevert - Revert a volume to the snapshot specified in the body If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume body - Object for snapshot to revert supplied in the body of the operation. options - VolumesClientBeginRevertOptions contains the optional parameters for the VolumesClient.BeginRevert method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_Revert.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRevert(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.VolumeRevert{
	SnapshotID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1"),
}, 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 (*VolumesClient) BeginRevertRelocation

func (client *VolumesClient) BeginRevertRelocation(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientBeginRevertRelocationOptions) (*runtime.Poller[VolumesClientRevertRelocationResponse], error)

BeginRevertRelocation - Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientBeginRevertRelocationOptions contains the optional parameters for the VolumesClient.BeginRevertRelocation method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_RevertRelocation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRevertRelocation(ctx, "myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) BeginUpdate

func (client *VolumesClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, body VolumePatch, options *VolumesClientBeginUpdateOptions) (*runtime.Poller[VolumesClientUpdateResponse], error)

BeginUpdate - Patch the specified volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume body - Volume object supplied in the body of the operation. options - VolumesClientBeginUpdateOptions contains the optional parameters for the VolumesClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_Update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.VolumePatch{}, 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 (*VolumesClient) Get

func (client *VolumesClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientGetOptions) (VolumesClientGetResponse, error)

Get - Get the details of the specified volume If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientGetOptions contains the optional parameters for the VolumesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myRG", "account1", "pool1", "volume1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VolumesClient) NewListPager

func (client *VolumesClient) NewListPager(resourceGroupName string, accountName string, poolName string, options *VolumesClientListOptions) *runtime.Pager[VolumesClientListResponse]

NewListPager - List all volumes within the capacity pool Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool options - VolumesClientListOptions contains the optional parameters for the VolumesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myRG", "account1", "pool1", 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 (*VolumesClient) NewListReplicationsPager

func (client *VolumesClient) NewListReplicationsPager(resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientListReplicationsOptions) *runtime.Pager[VolumesClientListReplicationsResponse]

NewListReplicationsPager - List all replications for a specified volume Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientListReplicationsOptions contains the optional parameters for the VolumesClient.ListReplications method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_ListReplications.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListReplicationsPager("myRG", "account1", "pool1", "volume1", 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 (*VolumesClient) ReplicationStatus

func (client *VolumesClient) ReplicationStatus(ctx context.Context, resourceGroupName string, accountName string, poolName string, volumeName string, options *VolumesClientReplicationStatusOptions) (VolumesClientReplicationStatusResponse, error)

ReplicationStatus - Get the status of the replication If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. accountName - The name of the NetApp account poolName - The name of the capacity pool volumeName - The name of the volume options - VolumesClientReplicationStatusOptions contains the optional parameters for the VolumesClient.ReplicationStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/netapp/resource-manager/Microsoft.NetApp/stable/2022-05-01/examples/Volumes_ReplicationStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetapp.NewVolumesClient("D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ReplicationStatus(ctx, "myRG", "account1", "pool1", "volume1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VolumesClientAuthorizeReplicationResponse

type VolumesClientAuthorizeReplicationResponse struct {
}

VolumesClientAuthorizeReplicationResponse contains the response from method VolumesClient.AuthorizeReplication.

type VolumesClientBeginAuthorizeReplicationOptions

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

VolumesClientBeginAuthorizeReplicationOptions contains the optional parameters for the VolumesClient.BeginAuthorizeReplication method.

type VolumesClientBeginBreakReplicationOptions

type VolumesClientBeginBreakReplicationOptions struct {
	// Optional body to force break the replication.
	Body *BreakReplicationRequest
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VolumesClientBeginBreakReplicationOptions contains the optional parameters for the VolumesClient.BeginBreakReplication method.

type VolumesClientBeginCreateOrUpdateOptions

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

VolumesClientBeginCreateOrUpdateOptions contains the optional parameters for the VolumesClient.BeginCreateOrUpdate method.

type VolumesClientBeginDeleteOptions

type VolumesClientBeginDeleteOptions struct {
	// An option to force delete the volume. Will cleanup resources connected to the particular volume
	ForceDelete *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VolumesClientBeginDeleteOptions contains the optional parameters for the VolumesClient.BeginDelete method.

type VolumesClientBeginDeleteReplicationOptions

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

VolumesClientBeginDeleteReplicationOptions contains the optional parameters for the VolumesClient.BeginDeleteReplication method.

type VolumesClientBeginFinalizeRelocationOptions

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

VolumesClientBeginFinalizeRelocationOptions contains the optional parameters for the VolumesClient.BeginFinalizeRelocation method.

type VolumesClientBeginPoolChangeOptions

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

VolumesClientBeginPoolChangeOptions contains the optional parameters for the VolumesClient.BeginPoolChange method.

type VolumesClientBeginReInitializeReplicationOptions

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

VolumesClientBeginReInitializeReplicationOptions contains the optional parameters for the VolumesClient.BeginReInitializeReplication method.

type VolumesClientBeginReestablishReplicationOptions

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

VolumesClientBeginReestablishReplicationOptions contains the optional parameters for the VolumesClient.BeginReestablishReplication method.

type VolumesClientBeginRelocateOptions

type VolumesClientBeginRelocateOptions struct {
	// Relocate volume request
	Body *RelocateVolumeRequest
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VolumesClientBeginRelocateOptions contains the optional parameters for the VolumesClient.BeginRelocate method.

type VolumesClientBeginResetCifsPasswordOptions

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

VolumesClientBeginResetCifsPasswordOptions contains the optional parameters for the VolumesClient.BeginResetCifsPassword method.

type VolumesClientBeginResyncReplicationOptions

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

VolumesClientBeginResyncReplicationOptions contains the optional parameters for the VolumesClient.BeginResyncReplication method.

type VolumesClientBeginRevertOptions

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

VolumesClientBeginRevertOptions contains the optional parameters for the VolumesClient.BeginRevert method.

type VolumesClientBeginRevertRelocationOptions

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

VolumesClientBeginRevertRelocationOptions contains the optional parameters for the VolumesClient.BeginRevertRelocation method.

type VolumesClientBeginUpdateOptions

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

VolumesClientBeginUpdateOptions contains the optional parameters for the VolumesClient.BeginUpdate method.

type VolumesClientBreakReplicationResponse

type VolumesClientBreakReplicationResponse struct {
}

VolumesClientBreakReplicationResponse contains the response from method VolumesClient.BreakReplication.

type VolumesClientCreateOrUpdateResponse

type VolumesClientCreateOrUpdateResponse struct {
	Volume
}

VolumesClientCreateOrUpdateResponse contains the response from method VolumesClient.CreateOrUpdate.

type VolumesClientDeleteReplicationResponse

type VolumesClientDeleteReplicationResponse struct {
}

VolumesClientDeleteReplicationResponse contains the response from method VolumesClient.DeleteReplication.

type VolumesClientDeleteResponse

type VolumesClientDeleteResponse struct {
}

VolumesClientDeleteResponse contains the response from method VolumesClient.Delete.

type VolumesClientFinalizeRelocationResponse

type VolumesClientFinalizeRelocationResponse struct {
}

VolumesClientFinalizeRelocationResponse contains the response from method VolumesClient.FinalizeRelocation.

type VolumesClientGetOptions

type VolumesClientGetOptions struct {
}

VolumesClientGetOptions contains the optional parameters for the VolumesClient.Get method.

type VolumesClientGetResponse

type VolumesClientGetResponse struct {
	Volume
}

VolumesClientGetResponse contains the response from method VolumesClient.Get.

type VolumesClientListOptions

type VolumesClientListOptions struct {
}

VolumesClientListOptions contains the optional parameters for the VolumesClient.List method.

type VolumesClientListReplicationsOptions

type VolumesClientListReplicationsOptions struct {
}

VolumesClientListReplicationsOptions contains the optional parameters for the VolumesClient.ListReplications method.

type VolumesClientListReplicationsResponse

type VolumesClientListReplicationsResponse struct {
	ListReplications
}

VolumesClientListReplicationsResponse contains the response from method VolumesClient.ListReplications.

type VolumesClientListResponse

type VolumesClientListResponse struct {
	VolumeList
}

VolumesClientListResponse contains the response from method VolumesClient.List.

type VolumesClientPoolChangeResponse

type VolumesClientPoolChangeResponse struct {
}

VolumesClientPoolChangeResponse contains the response from method VolumesClient.PoolChange.

type VolumesClientReInitializeReplicationResponse

type VolumesClientReInitializeReplicationResponse struct {
}

VolumesClientReInitializeReplicationResponse contains the response from method VolumesClient.ReInitializeReplication.

type VolumesClientReestablishReplicationResponse

type VolumesClientReestablishReplicationResponse struct {
}

VolumesClientReestablishReplicationResponse contains the response from method VolumesClient.ReestablishReplication.

type VolumesClientRelocateResponse

type VolumesClientRelocateResponse struct {
}

VolumesClientRelocateResponse contains the response from method VolumesClient.Relocate.

type VolumesClientReplicationStatusOptions

type VolumesClientReplicationStatusOptions struct {
}

VolumesClientReplicationStatusOptions contains the optional parameters for the VolumesClient.ReplicationStatus method.

type VolumesClientReplicationStatusResponse

type VolumesClientReplicationStatusResponse struct {
	ReplicationStatus
}

VolumesClientReplicationStatusResponse contains the response from method VolumesClient.ReplicationStatus.

type VolumesClientResetCifsPasswordResponse

type VolumesClientResetCifsPasswordResponse struct {
}

VolumesClientResetCifsPasswordResponse contains the response from method VolumesClient.ResetCifsPassword.

type VolumesClientResyncReplicationResponse

type VolumesClientResyncReplicationResponse struct {
}

VolumesClientResyncReplicationResponse contains the response from method VolumesClient.ResyncReplication.

type VolumesClientRevertRelocationResponse

type VolumesClientRevertRelocationResponse struct {
}

VolumesClientRevertRelocationResponse contains the response from method VolumesClient.RevertRelocation.

type VolumesClientRevertResponse

type VolumesClientRevertResponse struct {
}

VolumesClientRevertResponse contains the response from method VolumesClient.Revert.

type VolumesClientUpdateResponse

type VolumesClientUpdateResponse struct {
	Volume
}

VolumesClientUpdateResponse contains the response from method VolumesClient.Update.

type WeeklySchedule

type WeeklySchedule struct {
	// Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english
	Day *string `json:"day,omitempty"`

	// Indicates which hour in UTC timezone a snapshot should be taken
	Hour *int32 `json:"hour,omitempty"`

	// Indicates which minute snapshot should be taken
	Minute *int32 `json:"minute,omitempty"`

	// Weekly snapshot count to keep
	SnapshotsToKeep *int32 `json:"snapshotsToKeep,omitempty"`

	// Resource size in bytes, current storage usage for the volume in bytes
	UsedBytes *int64 `json:"usedBytes,omitempty"`
}

WeeklySchedule - Weekly Schedule properties, make a snapshot every week at a specific day or days

func (WeeklySchedule) MarshalJSON

func (w WeeklySchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WeeklySchedule.

func (*WeeklySchedule) UnmarshalJSON

func (w *WeeklySchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WeeklySchedule.

Jump to

Keyboard shortcuts

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