README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/purview/2020-12-01-preview/account
Documentation
The account
SDK allows for interaction with the Azure Resource Manager Service purview
(API Version 2020-12-01-preview
).
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-sdk/resource-manager/purview/2020-12-01-preview/account"
Client Initialization
client := account.NewAccountClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AccountClient.CreateOrUpdate
ctx := context.TODO()
id := account.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
payload := account.Account{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: AccountClient.Delete
ctx := context.TODO()
id := account.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: AccountClient.Get
ctx := context.TODO()
id := account.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AccountClient.ListByResourceGroup
ctx := context.TODO()
id := account.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: AccountClient.ListBySubscription
ctx := context.TODO()
id := account.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: AccountClient.ListKeys
ctx := context.TODO()
id := account.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
read, err := client.ListKeys(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AccountClient.Update
ctx := context.TODO()
id := account.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")
payload := account.AccountUpdateParameters{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForName() []string
- func PossibleValuesForProvisioningState() []string
- func PossibleValuesForPublicNetworkAccess() []string
- func PossibleValuesForStatus() []string
- func ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)
- type AccessKeys
- type Account
- type AccountClient
- func (c AccountClient) CreateOrUpdate(ctx context.Context, id AccountId, input Account) (result CreateOrUpdateOperationResponse, err error)
- func (c AccountClient) CreateOrUpdateThenPoll(ctx context.Context, id AccountId, input Account) error
- func (c AccountClient) Delete(ctx context.Context, id AccountId) (result DeleteOperationResponse, err error)
- func (c AccountClient) DeleteThenPoll(ctx context.Context, id AccountId) error
- func (c AccountClient) Get(ctx context.Context, id AccountId) (result GetOperationResponse, err error)
- func (c AccountClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (resp ListByResourceGroupOperationResponse, err error)
- func (c AccountClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c AccountClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (resp ListByResourceGroupCompleteResult, err error)
- func (c AccountClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp ListBySubscriptionOperationResponse, err error)
- func (c AccountClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
- func (c AccountClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp ListBySubscriptionCompleteResult, err error)
- func (c AccountClient) ListKeys(ctx context.Context, id AccountId) (result ListKeysOperationResponse, err error)
- func (c AccountClient) Update(ctx context.Context, id AccountId, input AccountUpdateParameters) (result UpdateOperationResponse, err error)
- func (c AccountClient) UpdateThenPoll(ctx context.Context, id AccountId, input AccountUpdateParameters) error
- type AccountEndpoints
- type AccountId
- type AccountOperationPredicate
- type AccountProperties
- type AccountSku
- type AccountUpdateParameters
- type CloudConnectors
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionOperationResponse
- type ListKeysOperationResponse
- type ManagedResources
- type Name
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionProperties
- type PrivateLinkServiceConnectionState
- type ProvisioningState
- type PublicNetworkAccess
- type Status
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForName ¶
func PossibleValuesForName() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func PossibleValuesForPublicNetworkAccess ¶
func PossibleValuesForPublicNetworkAccess() []string
func PossibleValuesForStatus ¶
func PossibleValuesForStatus() []string
func ValidateAccountID ¶
ValidateAccountID checks that 'input' can be parsed as a Account ID
Types ¶
type AccessKeys ¶
type Account ¶
type Account struct { Id *string `json:"id,omitempty"` Identity *identity.SystemAssigned `json:"identity,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *AccountProperties `json:"properties,omitempty"` Sku *AccountSku `json:"sku,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type AccountClient ¶
func NewAccountClientWithBaseURI ¶
func NewAccountClientWithBaseURI(endpoint string) AccountClient
func (AccountClient) CreateOrUpdate ¶
func (c AccountClient) CreateOrUpdate(ctx context.Context, id AccountId, input Account) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (AccountClient) CreateOrUpdateThenPoll ¶
func (c AccountClient) CreateOrUpdateThenPoll(ctx context.Context, id AccountId, input Account) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (AccountClient) Delete ¶
func (c AccountClient) Delete(ctx context.Context, id AccountId) (result DeleteOperationResponse, err error)
Delete ...
func (AccountClient) DeleteThenPoll ¶
func (c AccountClient) DeleteThenPoll(ctx context.Context, id AccountId) error
DeleteThenPoll performs Delete then polls until it's completed
func (AccountClient) Get ¶
func (c AccountClient) Get(ctx context.Context, id AccountId) (result GetOperationResponse, err error)
Get ...
func (AccountClient) ListByResourceGroup ¶
func (c AccountClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (resp ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (AccountClient) ListByResourceGroupComplete ¶
func (c AccountClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all of the results into a single object
func (AccountClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c AccountClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AccountOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (AccountClient) ListBySubscription ¶
func (c AccountClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
func (AccountClient) ListBySubscriptionComplete ¶
func (c AccountClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
ListBySubscriptionComplete retrieves all of the results into a single object
func (AccountClient) ListBySubscriptionCompleteMatchingPredicate ¶
func (c AccountClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AccountOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)
ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (AccountClient) ListKeys ¶
func (c AccountClient) ListKeys(ctx context.Context, id AccountId) (result ListKeysOperationResponse, err error)
ListKeys ...
func (AccountClient) Update ¶
func (c AccountClient) Update(ctx context.Context, id AccountId, input AccountUpdateParameters) (result UpdateOperationResponse, err error)
Update ...
func (AccountClient) UpdateThenPoll ¶
func (c AccountClient) UpdateThenPoll(ctx context.Context, id AccountId, input AccountUpdateParameters) error
UpdateThenPoll performs Update then polls until it's completed
type AccountEndpoints ¶
type AccountId ¶
AccountId is a struct representing the Resource ID for a Account
func NewAccountID ¶
NewAccountID returns a new AccountId struct
func ParseAccountID ¶
ParseAccountID parses 'input' into a AccountId
func ParseAccountIDInsensitively ¶
ParseAccountIDInsensitively parses 'input' case-insensitively into a AccountId note: this method should only be used for API response data and not user input
func (AccountId) Segments ¶
func (id AccountId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Account ID
type AccountOperationPredicate ¶
func (AccountOperationPredicate) Matches ¶
func (p AccountOperationPredicate) Matches(input Account) bool
type AccountProperties ¶
type AccountProperties struct { CloudConnectors *CloudConnectors `json:"cloudConnectors,omitempty"` CreatedAt *string `json:"createdAt,omitempty"` CreatedBy *string `json:"createdBy,omitempty"` CreatedByObjectId *string `json:"createdByObjectId,omitempty"` Endpoints *AccountEndpoints `json:"endpoints,omitempty"` FriendlyName *string `json:"friendlyName,omitempty"` ManagedResourceGroupName *string `json:"managedResourceGroupName,omitempty"` ManagedResources *ManagedResources `json:"managedResources,omitempty"` PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` }
func (*AccountProperties) GetCreatedAtAsTime ¶
func (o *AccountProperties) GetCreatedAtAsTime() (*time.Time, error)
func (*AccountProperties) SetCreatedAtAsTime ¶
func (o *AccountProperties) SetCreatedAtAsTime(input time.Time)
type AccountSku ¶
type AccountUpdateParameters ¶
type AccountUpdateParameters struct { Properties *AccountProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type CloudConnectors ¶
type CloudConnectors struct {
AwsExternalId *string `json:"awsExternalId,omitempty"`
}
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetOperationResponse ¶
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct {
Items []Account
}
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response Model *[]Account // contains filtered or unexported fields }
func (ListByResourceGroupOperationResponse) HasMore ¶
func (r ListByResourceGroupOperationResponse) HasMore() bool
func (ListByResourceGroupOperationResponse) LoadMore ¶
func (r ListByResourceGroupOperationResponse) LoadMore(ctx context.Context) (resp ListByResourceGroupOperationResponse, err error)
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct {
Items []Account
}
type ListBySubscriptionOperationResponse ¶
type ListBySubscriptionOperationResponse struct { HttpResponse *http.Response Model *[]Account // contains filtered or unexported fields }
func (ListBySubscriptionOperationResponse) HasMore ¶
func (r ListBySubscriptionOperationResponse) HasMore() bool
func (ListBySubscriptionOperationResponse) LoadMore ¶
func (r ListBySubscriptionOperationResponse) LoadMore(ctx context.Context) (resp ListBySubscriptionOperationResponse, err error)
type ListKeysOperationResponse ¶
type ListKeysOperationResponse struct { HttpResponse *http.Response Model *AccessKeys }
type ManagedResources ¶
type PrivateEndpoint ¶
type PrivateEndpoint struct {
Id *string `json:"id,omitempty"`
}
type PrivateEndpointConnection ¶
type PrivateEndpointConnection struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct { PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"` PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` }
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateCreating ProvisioningState = "Creating" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateMoving ProvisioningState = "Moving" ProvisioningStateSoftDeleted ProvisioningState = "SoftDeleted" ProvisioningStateSoftDeleting ProvisioningState = "SoftDeleting" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUnknown ProvisioningState = "Unknown" )
type PublicNetworkAccess ¶
type PublicNetworkAccess string
const ( PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled" PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled" PublicNetworkAccessNotSpecified PublicNetworkAccess = "NotSpecified" )
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
Source Files ¶
- client.go
- constants.go
- id_account.go
- method_createorupdate_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_listbyresourcegroup_autorest.go
- method_listbysubscription_autorest.go
- method_listkeys_autorest.go
- method_update_autorest.go
- model_accesskeys.go
- model_account.go
- model_accountendpoints.go
- model_accountproperties.go
- model_accountsku.go
- model_accountupdateparameters.go
- model_cloudconnectors.go
- model_managedresources.go
- model_privateendpoint.go
- model_privateendpointconnection.go
- model_privateendpointconnectionproperties.go
- model_privatelinkserviceconnectionstate.go
- predicates.go
- version.go