defaultaccount

README

github.com/hashicorp/go-azure-sdk/resource-manager/purview/2021-12-01/defaultaccount Documentation

The defaultaccount SDK allows for interaction with the Azure Resource Manager Service purview (API Version 2021-12-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-sdk/resource-manager/purview/2021-12-01/defaultaccount"

Client Initialization

client := defaultaccount.NewDefaultAccountClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DefaultAccountClient.Get

ctx := context.TODO()


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

Example Usage: DefaultAccountClient.Remove

ctx := context.TODO()


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

Example Usage: DefaultAccountClient.Set

ctx := context.TODO()

payload := defaultaccount.DefaultAccountPayload{
	// ...
}


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

Documentation

Index

• func PossibleValuesForScopeType() []string
• type DefaultAccountClient
  • func NewDefaultAccountClientWithBaseURI(sdkApi sdkEnv.Api) (*DefaultAccountClient, error)
  • func (c DefaultAccountClient) Get(ctx context.Context, options GetOperationOptions) (result GetOperationResponse, err error)
  • func (c DefaultAccountClient) Remove(ctx context.Context, options RemoveOperationOptions) (result RemoveOperationResponse, err error)
  • func (c DefaultAccountClient) Set(ctx context.Context, input DefaultAccountPayload) (result SetOperationResponse, err error)
• type DefaultAccountPayload
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
  • func (o GetOperationOptions) ToHeaders() *client.Headers
  • func (o GetOperationOptions) ToOData() *odata.Query
  • func (o GetOperationOptions) ToQuery() *client.QueryParams
• type GetOperationResponse
• type RemoveOperationOptions
  • func DefaultRemoveOperationOptions() RemoveOperationOptions
  • func (o RemoveOperationOptions) ToHeaders() *client.Headers
  • func (o RemoveOperationOptions) ToOData() *odata.Query
  • func (o RemoveOperationOptions) ToQuery() *client.QueryParams
• type RemoveOperationResponse
• type ScopeType
  • func (s *ScopeType) UnmarshalJSON(bytes []byte) error
• type SetOperationResponse

Functions

func PossibleValuesForScopeType

func PossibleValuesForScopeType() []string

Types

type DefaultAccountClient

type DefaultAccountClient struct {
	Client *resourcemanager.Client
}

func NewDefaultAccountClientWithBaseURI

func NewDefaultAccountClientWithBaseURI(sdkApi sdkEnv.Api) (*DefaultAccountClient, error)

func (DefaultAccountClient) Get

func (c DefaultAccountClient) Get(ctx context.Context, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (DefaultAccountClient) Remove

func (c DefaultAccountClient) Remove(ctx context.Context, options RemoveOperationOptions) (result RemoveOperationResponse, err error)

Remove ...

func (DefaultAccountClient) Set

func (c DefaultAccountClient) Set(ctx context.Context, input DefaultAccountPayload) (result SetOperationResponse, err error)

Set ...

type DefaultAccountPayload

type DefaultAccountPayload struct {
	AccountName       *string    `json:"accountName,omitempty"`
	ResourceGroupName *string    `json:"resourceGroupName,omitempty"`
	Scope             *string    `json:"scope,omitempty"`
	ScopeTenantId     *string    `json:"scopeTenantId,omitempty"`
	ScopeType         *ScopeType `json:"scopeType,omitempty"`
	SubscriptionId    *string    `json:"subscriptionId,omitempty"`
}

type GetOperationOptions

type GetOperationOptions struct {
	Scope         *string
	ScopeTenantId *string
	ScopeType     *ScopeType
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DefaultAccountPayload
}

type RemoveOperationOptions

type RemoveOperationOptions struct {
	Scope         *string
	ScopeTenantId *string
	ScopeType     *ScopeType
}

func DefaultRemoveOperationOptions

func DefaultRemoveOperationOptions() RemoveOperationOptions

func (RemoveOperationOptions) ToHeaders

func (o RemoveOperationOptions) ToHeaders() *client.Headers

func (RemoveOperationOptions) ToOData

func (o RemoveOperationOptions) ToOData() *odata.Query

func (RemoveOperationOptions) ToQuery

func (o RemoveOperationOptions) ToQuery() *client.QueryParams

type RemoveOperationResponse

type RemoveOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ScopeType

type ScopeType string

const (
	ScopeTypeSubscription ScopeType = "Subscription"
	ScopeTypeTenant       ScopeType = "Tenant"
)

func (*ScopeType) UnmarshalJSON

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

type SetOperationResponse

type SetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DefaultAccountPayload
}