trustedidproviders

README

github.com/hashicorp/go-azure-sdk/resource-manager/datalakestore/2016-11-01/trustedidproviders Documentation

The trustedidproviders SDK allows for interaction with the Azure Resource Manager Service datalakestore (API Version 2016-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-sdk/resource-manager/datalakestore/2016-11-01/trustedidproviders"

Client Initialization

client := trustedidproviders.NewTrustedIdProvidersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TrustedIdProvidersClient.CreateOrUpdate

ctx := context.TODO()
id := trustedidproviders.NewTrustedIdProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "trustedIdProviderValue")

payload := trustedidproviders.CreateOrUpdateTrustedIdProviderParameters{
	// ...
}


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

Example Usage: TrustedIdProvidersClient.Delete

ctx := context.TODO()
id := trustedidproviders.NewTrustedIdProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "trustedIdProviderValue")

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

Example Usage: TrustedIdProvidersClient.Get

ctx := context.TODO()
id := trustedidproviders.NewTrustedIdProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "trustedIdProviderValue")

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: TrustedIdProvidersClient.ListByAccount

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

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

Example Usage: TrustedIdProvidersClient.Update

ctx := context.TODO()
id := trustedidproviders.NewTrustedIdProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "trustedIdProviderValue")

payload := trustedidproviders.UpdateTrustedIdProviderParameters{
	// ...
}


read, err := client.Update(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 ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateTrustedIdProviderID(input interface{}, key string) (warnings []string, errors []error)
• type AccountId
  • func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId
  • func ParseAccountID(input string) (*AccountId, error)
  • func ParseAccountIDInsensitively(input string) (*AccountId, error)
  • func (id AccountId) ID() string
  • func (id AccountId) Segments() []resourceids.Segment
  • func (id AccountId) String() string
• type CreateOrUpdateOperationResponse
• type CreateOrUpdateTrustedIdProviderParameters
• type CreateOrUpdateTrustedIdProviderProperties
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByAccountCompleteResult
• type ListByAccountOperationResponse
• type TrustedIdProvider
• type TrustedIdProviderId
  • func NewTrustedIdProviderID(subscriptionId string, resourceGroupName string, accountName string, ...) TrustedIdProviderId
  • func ParseTrustedIdProviderID(input string) (*TrustedIdProviderId, error)
  • func ParseTrustedIdProviderIDInsensitively(input string) (*TrustedIdProviderId, error)
  • func (id TrustedIdProviderId) ID() string
  • func (id TrustedIdProviderId) Segments() []resourceids.Segment
  • func (id TrustedIdProviderId) String() string
• type TrustedIdProviderOperationPredicate
  • func (p TrustedIdProviderOperationPredicate) Matches(input TrustedIdProvider) bool
• type TrustedIdProviderProperties
• type TrustedIdProvidersClient
  • func NewTrustedIdProvidersClientWithBaseURI(api environments.Api) (*TrustedIdProvidersClient, error)
  • func (c TrustedIdProvidersClient) CreateOrUpdate(ctx context.Context, id TrustedIdProviderId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c TrustedIdProvidersClient) Delete(ctx context.Context, id TrustedIdProviderId) (result DeleteOperationResponse, err error)
  • func (c TrustedIdProvidersClient) Get(ctx context.Context, id TrustedIdProviderId) (result GetOperationResponse, err error)
  • func (c TrustedIdProvidersClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)
  • func (c TrustedIdProvidersClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)
  • func (c TrustedIdProvidersClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, ...) (result ListByAccountCompleteResult, err error)
  • func (c TrustedIdProvidersClient) Update(ctx context.Context, id TrustedIdProviderId, ...) (result UpdateOperationResponse, err error)
• type UpdateOperationResponse
• type UpdateTrustedIdProviderParameters
• type UpdateTrustedIdProviderProperties

Functions

func ValidateAccountID

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateTrustedIdProviderID

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

ValidateTrustedIdProviderID checks that 'input' can be parsed as a Trusted Id Provider ID

Types

type AccountId

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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) ID

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments

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

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

func (AccountId) String

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TrustedIdProvider
}

type CreateOrUpdateTrustedIdProviderParameters

type CreateOrUpdateTrustedIdProviderParameters struct {
	Properties CreateOrUpdateTrustedIdProviderProperties `json:"properties"`
}

type CreateOrUpdateTrustedIdProviderProperties

type CreateOrUpdateTrustedIdProviderProperties struct {
	IdProvider string `json:"idProvider"`
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByAccountCompleteResult

type ListByAccountCompleteResult struct {
	Items []TrustedIdProvider
}

type ListByAccountOperationResponse

type ListByAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TrustedIdProvider
}

type TrustedIdProvider

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

type TrustedIdProviderId

type TrustedIdProviderId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AccountName           string
	TrustedIdProviderName string
}

TrustedIdProviderId is a struct representing the Resource ID for a Trusted Id Provider

func NewTrustedIdProviderID

func NewTrustedIdProviderID(subscriptionId string, resourceGroupName string, accountName string, trustedIdProviderName string) TrustedIdProviderId

NewTrustedIdProviderID returns a new TrustedIdProviderId struct

func ParseTrustedIdProviderID

func ParseTrustedIdProviderID(input string) (*TrustedIdProviderId, error)

ParseTrustedIdProviderID parses 'input' into a TrustedIdProviderId

func ParseTrustedIdProviderIDInsensitively

func ParseTrustedIdProviderIDInsensitively(input string) (*TrustedIdProviderId, error)

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

func (TrustedIdProviderId) ID

func (id TrustedIdProviderId) ID() string

ID returns the formatted Trusted Id Provider ID

func (TrustedIdProviderId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Trusted Id Provider ID

func (TrustedIdProviderId) String

func (id TrustedIdProviderId) String() string

String returns a human-readable description of this Trusted Id Provider ID

type TrustedIdProviderOperationPredicate

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

func (TrustedIdProviderOperationPredicate) Matches

func (p TrustedIdProviderOperationPredicate) Matches(input TrustedIdProvider) bool

type TrustedIdProviderProperties

type TrustedIdProviderProperties struct {
	IdProvider *string `json:"idProvider,omitempty"`
}

type TrustedIdProvidersClient

type TrustedIdProvidersClient struct {
	Client *resourcemanager.Client
}

func NewTrustedIdProvidersClientWithBaseURI

func NewTrustedIdProvidersClientWithBaseURI(api environments.Api) (*TrustedIdProvidersClient, error)

func (TrustedIdProvidersClient) CreateOrUpdate

func (c TrustedIdProvidersClient) CreateOrUpdate(ctx context.Context, id TrustedIdProviderId, input CreateOrUpdateTrustedIdProviderParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TrustedIdProvidersClient) Delete

func (c TrustedIdProvidersClient) Delete(ctx context.Context, id TrustedIdProviderId) (result DeleteOperationResponse, err error)

Delete ...

func (TrustedIdProvidersClient) Get

func (c TrustedIdProvidersClient) Get(ctx context.Context, id TrustedIdProviderId) (result GetOperationResponse, err error)

Get ...

func (TrustedIdProvidersClient) ListByAccount

func (c TrustedIdProvidersClient) ListByAccount(ctx context.Context, id AccountId) (result ListByAccountOperationResponse, err error)

ListByAccount ...

func (TrustedIdProvidersClient) ListByAccountComplete

func (c TrustedIdProvidersClient) ListByAccountComplete(ctx context.Context, id AccountId) (ListByAccountCompleteResult, error)

ListByAccountComplete retrieves all the results into a single object

func (TrustedIdProvidersClient) ListByAccountCompleteMatchingPredicate

func (c TrustedIdProvidersClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate TrustedIdProviderOperationPredicate) (result ListByAccountCompleteResult, err error)

ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TrustedIdProvidersClient) Update

func (c TrustedIdProvidersClient) Update(ctx context.Context, id TrustedIdProviderId, input UpdateTrustedIdProviderParameters) (result UpdateOperationResponse, err error)

Update ...

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TrustedIdProvider
}

type UpdateTrustedIdProviderParameters

type UpdateTrustedIdProviderParameters struct {
	Properties *UpdateTrustedIdProviderProperties `json:"properties,omitempty"`
}

type UpdateTrustedIdProviderProperties

type UpdateTrustedIdProviderProperties struct {
	IdProvider *string `json:"idProvider,omitempty"`
}