singlesignon

package
v0.20230518.1071203 Latest Latest
Warning

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

Go to latest
Published: May 18, 2023 License: MPL-2.0 Imports: 10 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       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []LogzSingleSignOnResource
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]LogzSingleSignOnResource
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

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

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

type SingleSignOnClient

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

func NewSingleSignOnClientWithBaseURI

func NewSingleSignOnClientWithBaseURI(endpoint string) SingleSignOnClient

func (SingleSignOnClient) CreateOrUpdate

CreateOrUpdate ...

func (SingleSignOnClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SingleSignOnClient) Get

Get ...

func (SingleSignOnClient) List

List ...

func (SingleSignOnClient) ListComplete

ListComplete retrieves all of the results into a single object

func (SingleSignOnClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all of the results and then applied 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) ID

ID returns the formatted Single Sign On Configuration ID

func (SingleSignOnConfigurationId) Segments

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL