workspaceazureadonlyauthentications

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/workspaceazureadonlyauthentications Documentation

The workspaceazureadonlyauthentications SDK allows for interaction with Azure Resource Manager synapse (API Version 2021-06-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/synapse/2021-06-01/workspaceazureadonlyauthentications"

Client Initialization

client := workspaceazureadonlyauthentications.NewWorkspaceAzureADOnlyAuthenticationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspaceAzureADOnlyAuthenticationsClient.AzureADOnlyAuthenticationsCreate

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

payload := workspaceazureadonlyauthentications.AzureADOnlyAuthentication{
	// ...
}


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

Example Usage: WorkspaceAzureADOnlyAuthenticationsClient.AzureADOnlyAuthenticationsGet

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

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

Example Usage: WorkspaceAzureADOnlyAuthenticationsClient.AzureADOnlyAuthenticationsList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForStateValue 

func PossibleValuesForStateValue() []string

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type AzureADOnlyAuthentication 

type AzureADOnlyAuthentication struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *AzureADOnlyAuthenticationProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type AzureADOnlyAuthenticationOperationPredicate 

type AzureADOnlyAuthenticationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (AzureADOnlyAuthenticationOperationPredicate) Matches 

func (p AzureADOnlyAuthenticationOperationPredicate) Matches(input AzureADOnlyAuthentication) bool

type AzureADOnlyAuthenticationProperties 

type AzureADOnlyAuthenticationProperties struct {
	AzureADOnlyAuthentication bool        `json:"azureADOnlyAuthentication"`
	CreationDate              *string     `json:"creationDate,omitempty"`
	State                     *StateValue `json:"state,omitempty"`
}

func (*AzureADOnlyAuthenticationProperties) GetCreationDateAsTime 

func (o *AzureADOnlyAuthenticationProperties) GetCreationDateAsTime() (*time.Time, error)

func (*AzureADOnlyAuthenticationProperties) SetCreationDateAsTime 

func (o *AzureADOnlyAuthenticationProperties) SetCreationDateAsTime(input time.Time)

type AzureADOnlyAuthenticationsCreateOperationResponse 

type AzureADOnlyAuthenticationsCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureADOnlyAuthentication
}

type AzureADOnlyAuthenticationsGetOperationResponse 

type AzureADOnlyAuthenticationsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureADOnlyAuthentication
}

type AzureADOnlyAuthenticationsListCompleteResult 

type AzureADOnlyAuthenticationsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureADOnlyAuthentication
}

type AzureADOnlyAuthenticationsListCustomPager 

type AzureADOnlyAuthenticationsListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *AzureADOnlyAuthenticationsListCustomPager) NextPageLink() *odata.Link

type AzureADOnlyAuthenticationsListOperationResponse 

type AzureADOnlyAuthenticationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureADOnlyAuthentication
}

type StateValue 

type StateValue string
const (
	StateValueConsistent   StateValue = "Consistent"
	StateValueInConsistent StateValue = "InConsistent"
	StateValueUpdating     StateValue = "Updating"
)

func (*StateValue) UnmarshalJSON 

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

type WorkspaceAzureADOnlyAuthenticationsClient 

type WorkspaceAzureADOnlyAuthenticationsClient struct {
	Client *resourcemanager.Client
}

func NewWorkspaceAzureADOnlyAuthenticationsClientWithBaseURI 

func NewWorkspaceAzureADOnlyAuthenticationsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspaceAzureADOnlyAuthenticationsClient, error)

func (WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsCreate 

func (c WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsCreate(ctx context.Context, id WorkspaceId, input AzureADOnlyAuthentication) (result AzureADOnlyAuthenticationsCreateOperationResponse, err error)

AzureADOnlyAuthenticationsCreate ...

func (WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsCreateThenPoll 

func (c WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsCreateThenPoll(ctx context.Context, id WorkspaceId, input AzureADOnlyAuthentication) error

AzureADOnlyAuthenticationsCreateThenPoll performs AzureADOnlyAuthenticationsCreate then polls until it's completed

func (WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsGet 

func (c WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsGet(ctx context.Context, id WorkspaceId) (result AzureADOnlyAuthenticationsGetOperationResponse, err error)

AzureADOnlyAuthenticationsGet ...

func (WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsList 

func (c WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsList(ctx context.Context, id WorkspaceId) (result AzureADOnlyAuthenticationsListOperationResponse, err error)

AzureADOnlyAuthenticationsList ...

func (WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsListComplete 

func (c WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsListComplete(ctx context.Context, id WorkspaceId) (AzureADOnlyAuthenticationsListCompleteResult, error)

AzureADOnlyAuthenticationsListComplete retrieves all the results into a single object

func (WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsListCompleteMatchingPredicate 

func (c WorkspaceAzureADOnlyAuthenticationsClient) AzureADOnlyAuthenticationsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate AzureADOnlyAuthenticationOperationPredicate) (result AzureADOnlyAuthenticationsListCompleteResult, err error)

AzureADOnlyAuthenticationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

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.