singlesignon

package
v0.20240108.1121319 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/logz/2020-10-01/singlesignon Documentation

The singlesignon SDK allows for interaction with the Azure Resource Manager Service logz (API Version 2020-10-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/logz/2020-10-01/singlesignon"

Client Initialization

client := singlesignon.NewSingleSignOnClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SingleSignOnClient.CreateOrUpdate

ctx := context.TODO()
id := singlesignon.NewSingleSignOnConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue", "singleSignOnConfigurationValue")

payload := singlesignon.LogzSingleSignOnResource{
	// ...
}


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

Example Usage: SingleSignOnClient.Get

ctx := context.TODO()
id := singlesignon.NewSingleSignOnConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue", "singleSignOnConfigurationValue")

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: SingleSignOnClient.List

ctx := context.TODO()
id := singlesignon.NewMonitorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSingleSignOnStates 

func PossibleValuesForSingleSignOnStates() []string

func ValidateMonitorID 

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

ValidateMonitorID checks that 'input' can be parsed as a Monitor ID

func ValidateSingleSignOnConfigurationID 

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

ValidateSingleSignOnConfigurationID checks that 'input' can be parsed as a Single Sign On Configuration ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []LogzSingleSignOnResource
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]LogzSingleSignOnResource
}

type LogzSingleSignOnProperties 

type LogzSingleSignOnProperties struct {
	EnterpriseAppId   *string             `json:"enterpriseAppId,omitempty"`
	ProvisioningState *ProvisioningState  `json:"provisioningState,omitempty"`
	SingleSignOnState *SingleSignOnStates `json:"singleSignOnState,omitempty"`
	SingleSignOnUrl   *string             `json:"singleSignOnUrl,omitempty"`
}

type LogzSingleSignOnResource 

type LogzSingleSignOnResource struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *LogzSingleSignOnProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type LogzSingleSignOnResourceOperationPredicate 

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

func (LogzSingleSignOnResourceOperationPredicate) Matches 

func (p LogzSingleSignOnResourceOperationPredicate) Matches(input LogzSingleSignOnResource) bool

type MonitorId 

type MonitorId struct {
	SubscriptionId    string
	ResourceGroupName string
	MonitorName       string
}

MonitorId is a struct representing the Resource ID for a Monitor

func NewMonitorID 

func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId

NewMonitorID returns a new MonitorId struct

func ParseMonitorID 

func ParseMonitorID(input string) (*MonitorId, error)

ParseMonitorID parses 'input' into a MonitorId

func ParseMonitorIDInsensitively 

func ParseMonitorIDInsensitively(input string) (*MonitorId, error)

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

func (*MonitorId) FromParseResult added in v0.20231127.1171502 

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

func (MonitorId) ID 

func (id MonitorId) ID() string

ID returns the formatted Monitor ID

func (MonitorId) Segments 

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

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

func (MonitorId) String 

func (id MonitorId) String() string

String returns a human-readable description of this Monitor ID

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230712.1163130 

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

type SingleSignOnClient 

type SingleSignOnClient struct {
	Client *resourcemanager.Client
}

func NewSingleSignOnClientWithBaseURI 

func NewSingleSignOnClientWithBaseURI(sdkApi sdkEnv.Api) (*SingleSignOnClient, error)

func (SingleSignOnClient) CreateOrUpdate 

func (c SingleSignOnClient) CreateOrUpdate(ctx context.Context, id SingleSignOnConfigurationId, input LogzSingleSignOnResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SingleSignOnClient) CreateOrUpdateThenPoll 

func (c SingleSignOnClient) CreateOrUpdateThenPoll(ctx context.Context, id SingleSignOnConfigurationId, input LogzSingleSignOnResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SingleSignOnClient) Get 

func (c SingleSignOnClient) Get(ctx context.Context, id SingleSignOnConfigurationId) (result GetOperationResponse, err error)

Get ...

func (SingleSignOnClient) List 

func (c SingleSignOnClient) List(ctx context.Context, id MonitorId) (result ListOperationResponse, err error)

List ...

func (SingleSignOnClient) ListComplete 

func (c SingleSignOnClient) ListComplete(ctx context.Context, id MonitorId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SingleSignOnClient) ListCompleteMatchingPredicate 

func (c SingleSignOnClient) ListCompleteMatchingPredicate(ctx context.Context, id MonitorId, predicate LogzSingleSignOnResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SingleSignOnConfigurationId 

type SingleSignOnConfigurationId struct {
	SubscriptionId                string
	ResourceGroupName             string
	MonitorName                   string
	SingleSignOnConfigurationName string
}

SingleSignOnConfigurationId is a struct representing the Resource ID for a Single Sign On Configuration

func NewSingleSignOnConfigurationID 

func NewSingleSignOnConfigurationID(subscriptionId string, resourceGroupName string, monitorName string, singleSignOnConfigurationName string) SingleSignOnConfigurationId

NewSingleSignOnConfigurationID returns a new SingleSignOnConfigurationId struct

func ParseSingleSignOnConfigurationID 

func ParseSingleSignOnConfigurationID(input string) (*SingleSignOnConfigurationId, error)

ParseSingleSignOnConfigurationID parses 'input' into a SingleSignOnConfigurationId

func ParseSingleSignOnConfigurationIDInsensitively 

func ParseSingleSignOnConfigurationIDInsensitively(input string) (*SingleSignOnConfigurationId, error)

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

func (*SingleSignOnConfigurationId) FromParseResult added in v0.20231127.1171502 

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

func (SingleSignOnConfigurationId) ID 

func (id SingleSignOnConfigurationId) ID() string

ID returns the formatted Single Sign On Configuration ID

func (SingleSignOnConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Single Sign On Configuration ID

func (SingleSignOnConfigurationId) String 

func (id SingleSignOnConfigurationId) String() string

String returns a human-readable description of this Single Sign On Configuration ID

type SingleSignOnStates 

type SingleSignOnStates string
const (
	SingleSignOnStatesDisable  SingleSignOnStates = "Disable"
	SingleSignOnStatesEnable   SingleSignOnStates = "Enable"
	SingleSignOnStatesExisting SingleSignOnStates = "Existing"
	SingleSignOnStatesInitial  SingleSignOnStates = "Initial"
)

func (*SingleSignOnStates) UnmarshalJSON added in v0.20230712.1163130 

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

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.