netappaccounts

package
v0.20240620.1161515 Latest Latest
Warning

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

 Go to latest Published: Jun 20, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-11-01/netappaccounts Documentation

The netappaccounts SDK allows for interaction with the Azure Resource Manager Service netapp (API Version 2023-11-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-11-01/netappaccounts"

Client Initialization

client := netappaccounts.NewNetAppAccountsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetAppAccountsClient.AccountsCreateOrUpdate

ctx := context.TODO()
id := netappaccounts.NewNetAppAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue")

payload := netappaccounts.NetAppAccount{
	// ...
}


if err := client.AccountsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: NetAppAccountsClient.AccountsDelete

ctx := context.TODO()
id := netappaccounts.NewNetAppAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue")

if err := client.AccountsDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: NetAppAccountsClient.AccountsGet

ctx := context.TODO()
id := netappaccounts.NewNetAppAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue")

read, err := client.AccountsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: NetAppAccountsClient.AccountsList

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.AccountsList(ctx, id)` can be used to do batched pagination
items, err := client.AccountsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: NetAppAccountsClient.AccountsListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.AccountsListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.AccountsListBySubscriptionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: NetAppAccountsClient.AccountsRenewCredentials

ctx := context.TODO()
id := netappaccounts.NewNetAppAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue")

if err := client.AccountsRenewCredentialsThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: NetAppAccountsClient.AccountsUpdate

ctx := context.TODO()
id := netappaccounts.NewNetAppAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue")

payload := netappaccounts.NetAppAccountPatch{
	// ...
}


if err := client.AccountsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForActiveDirectoryStatus 

func PossibleValuesForActiveDirectoryStatus() []string

func PossibleValuesForKeySource 

func PossibleValuesForKeySource() []string

func PossibleValuesForKeyVaultStatus 

func PossibleValuesForKeyVaultStatus() []string

func ValidateNetAppAccountID 

func ValidateNetAppAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateNetAppAccountID checks that 'input' can be parsed as a Net App Account ID

Types

type AccountEncryption 

type AccountEncryption struct {
	Identity           *EncryptionIdentity `json:"identity,omitempty"`
	KeySource          *KeySource          `json:"keySource,omitempty"`
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

type AccountProperties 

type AccountProperties struct {
	ActiveDirectories *[]ActiveDirectory `json:"activeDirectories,omitempty"`
	DisableShowmount  *bool              `json:"disableShowmount,omitempty"`
	Encryption        *AccountEncryption `json:"encryption,omitempty"`
	ProvisioningState *string            `json:"provisioningState,omitempty"`
}

type AccountsCreateOrUpdateOperationResponse 

type AccountsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetAppAccount
}

type AccountsDeleteOperationResponse 

type AccountsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccountsGetOperationResponse 

type AccountsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetAppAccount
}

type AccountsListBySubscriptionCompleteResult 

type AccountsListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetAppAccount
}

type AccountsListBySubscriptionOperationResponse 

type AccountsListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetAppAccount
}

type AccountsListCompleteResult 

type AccountsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetAppAccount
}

type AccountsListOperationResponse 

type AccountsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetAppAccount
}

type AccountsRenewCredentialsOperationResponse 

type AccountsRenewCredentialsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccountsUpdateOperationResponse 

type AccountsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetAppAccount
}

type ActiveDirectory 

type ActiveDirectory struct {
	ActiveDirectoryId             *string                `json:"activeDirectoryId,omitempty"`
	AdName                        *string                `json:"adName,omitempty"`
	Administrators                *[]string              `json:"administrators,omitempty"`
	AesEncryption                 *bool                  `json:"aesEncryption,omitempty"`
	AllowLocalNfsUsersWithLdap    *bool                  `json:"allowLocalNfsUsersWithLdap,omitempty"`
	BackupOperators               *[]string              `json:"backupOperators,omitempty"`
	Dns                           *string                `json:"dns,omitempty"`
	Domain                        *string                `json:"domain,omitempty"`
	EncryptDCConnections          *bool                  `json:"encryptDCConnections,omitempty"`
	KdcIP                         *string                `json:"kdcIP,omitempty"`
	LdapOverTLS                   *bool                  `json:"ldapOverTLS,omitempty"`
	LdapSearchScope               *LdapSearchScopeOpt    `json:"ldapSearchScope,omitempty"`
	LdapSigning                   *bool                  `json:"ldapSigning,omitempty"`
	OrganizationalUnit            *string                `json:"organizationalUnit,omitempty"`
	Password                      *string                `json:"password,omitempty"`
	PreferredServersForLdapClient *string                `json:"preferredServersForLdapClient,omitempty"`
	SecurityOperators             *[]string              `json:"securityOperators,omitempty"`
	ServerRootCACertificate       *string                `json:"serverRootCACertificate,omitempty"`
	Site                          *string                `json:"site,omitempty"`
	SmbServerName                 *string                `json:"smbServerName,omitempty"`
	Status                        *ActiveDirectoryStatus `json:"status,omitempty"`
	StatusDetails                 *string                `json:"statusDetails,omitempty"`
	Username                      *string                `json:"username,omitempty"`
}

type ActiveDirectoryStatus 

type ActiveDirectoryStatus string
const (
	ActiveDirectoryStatusCreated  ActiveDirectoryStatus = "Created"
	ActiveDirectoryStatusDeleted  ActiveDirectoryStatus = "Deleted"
	ActiveDirectoryStatusError    ActiveDirectoryStatus = "Error"
	ActiveDirectoryStatusInUse    ActiveDirectoryStatus = "InUse"
	ActiveDirectoryStatusUpdating ActiveDirectoryStatus = "Updating"
)

func (*ActiveDirectoryStatus) UnmarshalJSON 

func (s *ActiveDirectoryStatus) UnmarshalJSON(bytes []byte) error

type EncryptionIdentity 

type EncryptionIdentity struct {
	PrincipalId          *string `json:"principalId,omitempty"`
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

type KeySource 

type KeySource string
const (
	KeySourceMicrosoftPointKeyVault KeySource = "Microsoft.KeyVault"
	KeySourceMicrosoftPointNetApp   KeySource = "Microsoft.NetApp"
)

func (*KeySource) UnmarshalJSON 

func (s *KeySource) UnmarshalJSON(bytes []byte) error

type KeyVaultProperties 

type KeyVaultProperties struct {
	KeyName            string          `json:"keyName"`
	KeyVaultId         *string         `json:"keyVaultId,omitempty"`
	KeyVaultResourceId string          `json:"keyVaultResourceId"`
	KeyVaultUri        string          `json:"keyVaultUri"`
	Status             *KeyVaultStatus `json:"status,omitempty"`
}

type KeyVaultStatus 

type KeyVaultStatus string
const (
	KeyVaultStatusCreated  KeyVaultStatus = "Created"
	KeyVaultStatusDeleted  KeyVaultStatus = "Deleted"
	KeyVaultStatusError    KeyVaultStatus = "Error"
	KeyVaultStatusInUse    KeyVaultStatus = "InUse"
	KeyVaultStatusUpdating KeyVaultStatus = "Updating"
)

func (*KeyVaultStatus) UnmarshalJSON 

func (s *KeyVaultStatus) UnmarshalJSON(bytes []byte) error

type LdapSearchScopeOpt 

type LdapSearchScopeOpt struct {
	GroupDN               *string `json:"groupDN,omitempty"`
	GroupMembershipFilter *string `json:"groupMembershipFilter,omitempty"`
	UserDN                *string `json:"userDN,omitempty"`
}

type NetAppAccount 

type NetAppAccount struct {
	Etag       *string                                  `json:"etag,omitempty"`
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *AccountProperties                       `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type NetAppAccountId 

type NetAppAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	NetAppAccountName string
}

NetAppAccountId is a struct representing the Resource ID for a Net App Account

func NewNetAppAccountID 

func NewNetAppAccountID(subscriptionId string, resourceGroupName string, netAppAccountName string) NetAppAccountId

NewNetAppAccountID returns a new NetAppAccountId struct

func ParseNetAppAccountID 

func ParseNetAppAccountID(input string) (*NetAppAccountId, error)

ParseNetAppAccountID parses 'input' into a NetAppAccountId

func ParseNetAppAccountIDInsensitively 

func ParseNetAppAccountIDInsensitively(input string) (*NetAppAccountId, error)

ParseNetAppAccountIDInsensitively parses 'input' case-insensitively into a NetAppAccountId note: this method should only be used for API response data and not user input

func (*NetAppAccountId) FromParseResult 

func (id *NetAppAccountId) FromParseResult(input resourceids.ParseResult) error

func (NetAppAccountId) ID 

func (id NetAppAccountId) ID() string

ID returns the formatted Net App Account ID

func (NetAppAccountId) Segments 

func (id NetAppAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Net App Account ID

func (NetAppAccountId) String 

func (id NetAppAccountId) String() string

String returns a human-readable description of this Net App Account ID

type NetAppAccountOperationPredicate 

type NetAppAccountOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (NetAppAccountOperationPredicate) Matches 

func (p NetAppAccountOperationPredicate) Matches(input NetAppAccount) bool

type NetAppAccountPatch 

type NetAppAccountPatch struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                                  `json:"location,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *AccountProperties                       `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type NetAppAccountsClient 

type NetAppAccountsClient struct {
	Client *resourcemanager.Client
}

func NewNetAppAccountsClientWithBaseURI 

func NewNetAppAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetAppAccountsClient, error)

func (NetAppAccountsClient) AccountsCreateOrUpdate 

func (c NetAppAccountsClient) AccountsCreateOrUpdate(ctx context.Context, id NetAppAccountId, input NetAppAccount) (result AccountsCreateOrUpdateOperationResponse, err error)

AccountsCreateOrUpdate ...

func (NetAppAccountsClient) AccountsCreateOrUpdateThenPoll 

func (c NetAppAccountsClient) AccountsCreateOrUpdateThenPoll(ctx context.Context, id NetAppAccountId, input NetAppAccount) error

AccountsCreateOrUpdateThenPoll performs AccountsCreateOrUpdate then polls until it's completed

func (NetAppAccountsClient) AccountsDelete 

func (c NetAppAccountsClient) AccountsDelete(ctx context.Context, id NetAppAccountId) (result AccountsDeleteOperationResponse, err error)

AccountsDelete ...

func (NetAppAccountsClient) AccountsDeleteThenPoll 

func (c NetAppAccountsClient) AccountsDeleteThenPoll(ctx context.Context, id NetAppAccountId) error

AccountsDeleteThenPoll performs AccountsDelete then polls until it's completed

func (NetAppAccountsClient) AccountsGet 

func (c NetAppAccountsClient) AccountsGet(ctx context.Context, id NetAppAccountId) (result AccountsGetOperationResponse, err error)

AccountsGet ...

func (NetAppAccountsClient) AccountsList 

func (c NetAppAccountsClient) AccountsList(ctx context.Context, id commonids.ResourceGroupId) (result AccountsListOperationResponse, err error)

AccountsList ...

func (NetAppAccountsClient) AccountsListBySubscription 

func (c NetAppAccountsClient) AccountsListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result AccountsListBySubscriptionOperationResponse, err error)

AccountsListBySubscription ...

func (NetAppAccountsClient) AccountsListBySubscriptionComplete 

func (c NetAppAccountsClient) AccountsListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (AccountsListBySubscriptionCompleteResult, error)

AccountsListBySubscriptionComplete retrieves all the results into a single object

func (NetAppAccountsClient) AccountsListBySubscriptionCompleteMatchingPredicate 

func (c NetAppAccountsClient) AccountsListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate NetAppAccountOperationPredicate) (result AccountsListBySubscriptionCompleteResult, err error)

AccountsListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetAppAccountsClient) AccountsListComplete 

func (c NetAppAccountsClient) AccountsListComplete(ctx context.Context, id commonids.ResourceGroupId) (AccountsListCompleteResult, error)

AccountsListComplete retrieves all the results into a single object

func (NetAppAccountsClient) AccountsListCompleteMatchingPredicate 

func (c NetAppAccountsClient) AccountsListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate NetAppAccountOperationPredicate) (result AccountsListCompleteResult, err error)

AccountsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetAppAccountsClient) AccountsRenewCredentials 

func (c NetAppAccountsClient) AccountsRenewCredentials(ctx context.Context, id NetAppAccountId) (result AccountsRenewCredentialsOperationResponse, err error)

AccountsRenewCredentials ...

func (NetAppAccountsClient) AccountsRenewCredentialsThenPoll 

func (c NetAppAccountsClient) AccountsRenewCredentialsThenPoll(ctx context.Context, id NetAppAccountId) error

AccountsRenewCredentialsThenPoll performs AccountsRenewCredentials then polls until it's completed

func (NetAppAccountsClient) AccountsUpdate 

func (c NetAppAccountsClient) AccountsUpdate(ctx context.Context, id NetAppAccountId, input NetAppAccountPatch) (result AccountsUpdateOperationResponse, err error)

AccountsUpdate ...

func (NetAppAccountsClient) AccountsUpdateThenPoll 

func (c NetAppAccountsClient) AccountsUpdateThenPoll(ctx context.Context, id NetAppAccountId, input NetAppAccountPatch) error

AccountsUpdateThenPoll performs AccountsUpdate then polls until it's completed

Source Files

View all Source files

Jump to

Keyboard shortcuts

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