singlesignon

package
v0.20231027.1054629 Latest Latest
Warning

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

Go to latest
Published: Oct 27, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/datadog/2023-01-01/singlesignon Documentation

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

Client Initialization

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

Example Usage: SingleSignOnClient.ConfigurationsCreateOrUpdate

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

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


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

Example Usage: SingleSignOnClient.ConfigurationsGet

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

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

Example Usage: SingleSignOnClient.ConfigurationsList

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

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

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

type ConfigurationsGetOperationResponse

type ConfigurationsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatadogSingleSignOnResource
}

type ConfigurationsListCompleteResult

type ConfigurationsListCompleteResult struct {
	Items []DatadogSingleSignOnResource
}

type ConfigurationsListOperationResponse

type ConfigurationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DatadogSingleSignOnResource
}

type DatadogSingleSignOnProperties

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

type DatadogSingleSignOnResource

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

type DatadogSingleSignOnResourceOperationPredicate

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

func (DatadogSingleSignOnResourceOperationPredicate) 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"
)

func (*ProvisioningState) UnmarshalJSON

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

ConfigurationsCreateOrUpdate ...

func (SingleSignOnClient) ConfigurationsCreateOrUpdateThenPoll

func (c SingleSignOnClient) ConfigurationsCreateOrUpdateThenPoll(ctx context.Context, id SingleSignOnConfigurationId, input DatadogSingleSignOnResource) error

ConfigurationsCreateOrUpdateThenPoll performs ConfigurationsCreateOrUpdate then polls until it's completed

func (SingleSignOnClient) ConfigurationsGet

ConfigurationsGet ...

func (SingleSignOnClient) ConfigurationsList

func (c SingleSignOnClient) ConfigurationsList(ctx context.Context, id MonitorId) (result ConfigurationsListOperationResponse, err error)

ConfigurationsList ...

func (SingleSignOnClient) ConfigurationsListComplete

func (c SingleSignOnClient) ConfigurationsListComplete(ctx context.Context, id MonitorId) (ConfigurationsListCompleteResult, error)

ConfigurationsListComplete retrieves all the results into a single object

func (SingleSignOnClient) ConfigurationsListCompleteMatchingPredicate

func (c SingleSignOnClient) ConfigurationsListCompleteMatchingPredicate(ctx context.Context, id MonitorId, predicate DatadogSingleSignOnResourceOperationPredicate) (result ConfigurationsListCompleteResult, err error)

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

func (*SingleSignOnStates) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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