provider

README

github.com/hashicorp/go-azure-sdk/resource-manager/purview/2020-12-01-preview/provider Documentation

The provider 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/provider"

Client Initialization

client := provider.NewProviderClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
if err != nil {
	// handle the error
}

Example Usage: ProviderClient.AccountsCheckNameAvailability

ctx := context.TODO()
id := provider.NewSubscriptionID()

payload := provider.CheckNameAvailabilityRequest{
	// ...
}

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

Documentation

Index

• func PossibleValuesForReason() []string
• type AccountsCheckNameAvailabilityOperationResponse
• type CheckNameAvailabilityRequest
• type CheckNameAvailabilityResult
• type ProviderClient
  • func NewProviderClientWithBaseURI(endpoint string) ProviderClient
  • func (c ProviderClient) AccountsCheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, ...) (result AccountsCheckNameAvailabilityOperationResponse, err error)
• type Reason

Functions

func PossibleValuesForReason

func PossibleValuesForReason() []string

Types

type AccountsCheckNameAvailabilityOperationResponse

type AccountsCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityResult
}

type CheckNameAvailabilityRequest

type CheckNameAvailabilityRequest struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	Message       *string `json:"message,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *Reason `json:"reason,omitempty"`
}

type ProviderClient

type ProviderClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewProviderClientWithBaseURI

func NewProviderClientWithBaseURI(endpoint string) ProviderClient

func (ProviderClient) AccountsCheckNameAvailability

func (c ProviderClient) AccountsCheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailabilityRequest) (result AccountsCheckNameAvailabilityOperationResponse, err error)

AccountsCheckNameAvailability ...

type Reason

type Reason string

const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)