identityprovider

package
v0.20241126.1723 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: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-03-01-preview/identityprovider Documentation

The identityprovider SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2023-03-01-preview).

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/apimanagement/2023-03-01-preview/identityprovider"

Client Initialization

client := identityprovider.NewIdentityProviderClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IdentityProviderClient.CreateOrUpdate

ctx := context.TODO()
id := identityprovider.NewIdentityProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "aad")

payload := identityprovider.IdentityProviderCreateContract{
	// ...
}


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

Example Usage: IdentityProviderClient.Delete

ctx := context.TODO()
id := identityprovider.NewIdentityProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "aad")

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

Example Usage: IdentityProviderClient.Get

ctx := context.TODO()
id := identityprovider.NewIdentityProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "aad")

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: IdentityProviderClient.GetEntityTag

ctx := context.TODO()
id := identityprovider.NewIdentityProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "aad")

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

Example Usage: IdentityProviderClient.ListByService

ctx := context.TODO()
id := identityprovider.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName")

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

Example Usage: IdentityProviderClient.ListSecrets

ctx := context.TODO()
id := identityprovider.NewIdentityProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "aad")

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

Example Usage: IdentityProviderClient.Update

ctx := context.TODO()
id := identityprovider.NewIdentityProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "aad")

payload := identityprovider.IdentityProviderUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForIdentityProviderType 

func PossibleValuesForIdentityProviderType() []string

func ValidateIdentityProviderID 

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

ValidateIdentityProviderID checks that 'input' can be parsed as a Identity Provider ID

func ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type ClientSecretContract 

type ClientSecretContract struct {
	ClientSecret *string `json:"clientSecret,omitempty"`
}

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData 

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type GetEntityTagOperationResponse 

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

type GetOperationResponse 

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

type IdentityProviderClient 

type IdentityProviderClient struct {
	Client *resourcemanager.Client
}

func NewIdentityProviderClientWithBaseURI 

func NewIdentityProviderClientWithBaseURI(sdkApi sdkEnv.Api) (*IdentityProviderClient, error)

func (IdentityProviderClient) CreateOrUpdate 

func (c IdentityProviderClient) CreateOrUpdate(ctx context.Context, id IdentityProviderId, input IdentityProviderCreateContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (IdentityProviderClient) Delete 

func (c IdentityProviderClient) Delete(ctx context.Context, id IdentityProviderId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (IdentityProviderClient) Get 

func (c IdentityProviderClient) Get(ctx context.Context, id IdentityProviderId) (result GetOperationResponse, err error)

Get ...

func (IdentityProviderClient) GetEntityTag 

func (c IdentityProviderClient) GetEntityTag(ctx context.Context, id IdentityProviderId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (IdentityProviderClient) ListByService 

func (c IdentityProviderClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

func (IdentityProviderClient) ListByServiceComplete 

func (c IdentityProviderClient) ListByServiceComplete(ctx context.Context, id ServiceId) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (IdentityProviderClient) ListByServiceCompleteMatchingPredicate 

func (c IdentityProviderClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate IdentityProviderContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IdentityProviderClient) ListSecrets 

func (c IdentityProviderClient) ListSecrets(ctx context.Context, id IdentityProviderId) (result ListSecretsOperationResponse, err error)

ListSecrets ...

func (IdentityProviderClient) Update 

func (c IdentityProviderClient) Update(ctx context.Context, id IdentityProviderId, input IdentityProviderUpdateParameters, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type IdentityProviderContract 

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

type IdentityProviderContractOperationPredicate 

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

func (IdentityProviderContractOperationPredicate) Matches 

func (p IdentityProviderContractOperationPredicate) Matches(input IdentityProviderContract) bool

type IdentityProviderContractProperties 

type IdentityProviderContractProperties struct {
	AllowedTenants           *[]string             `json:"allowedTenants,omitempty"`
	Authority                *string               `json:"authority,omitempty"`
	ClientId                 string                `json:"clientId"`
	ClientLibrary            *string               `json:"clientLibrary,omitempty"`
	ClientSecret             *string               `json:"clientSecret,omitempty"`
	PasswordResetPolicyName  *string               `json:"passwordResetPolicyName,omitempty"`
	ProfileEditingPolicyName *string               `json:"profileEditingPolicyName,omitempty"`
	SigninPolicyName         *string               `json:"signinPolicyName,omitempty"`
	SigninTenant             *string               `json:"signinTenant,omitempty"`
	SignupPolicyName         *string               `json:"signupPolicyName,omitempty"`
	Type                     *IdentityProviderType `json:"type,omitempty"`
}

type IdentityProviderCreateContract 

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

type IdentityProviderCreateContractProperties 

type IdentityProviderCreateContractProperties struct {
	AllowedTenants           *[]string             `json:"allowedTenants,omitempty"`
	Authority                *string               `json:"authority,omitempty"`
	ClientId                 string                `json:"clientId"`
	ClientLibrary            *string               `json:"clientLibrary,omitempty"`
	ClientSecret             string                `json:"clientSecret"`
	PasswordResetPolicyName  *string               `json:"passwordResetPolicyName,omitempty"`
	ProfileEditingPolicyName *string               `json:"profileEditingPolicyName,omitempty"`
	SigninPolicyName         *string               `json:"signinPolicyName,omitempty"`
	SigninTenant             *string               `json:"signinTenant,omitempty"`
	SignupPolicyName         *string               `json:"signupPolicyName,omitempty"`
	Type                     *IdentityProviderType `json:"type,omitempty"`
}

type IdentityProviderId 

type IdentityProviderId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ServiceName          string
	IdentityProviderName IdentityProviderType
}

IdentityProviderId is a struct representing the Resource ID for a Identity Provider

func NewIdentityProviderID 

func NewIdentityProviderID(subscriptionId string, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) IdentityProviderId

NewIdentityProviderID returns a new IdentityProviderId struct

func ParseIdentityProviderID 

func ParseIdentityProviderID(input string) (*IdentityProviderId, error)

ParseIdentityProviderID parses 'input' into a IdentityProviderId

func ParseIdentityProviderIDInsensitively 

func ParseIdentityProviderIDInsensitively(input string) (*IdentityProviderId, error)

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

func (*IdentityProviderId) FromParseResult 

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

func (IdentityProviderId) ID 

func (id IdentityProviderId) ID() string

ID returns the formatted Identity Provider ID

func (IdentityProviderId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Identity Provider ID

func (IdentityProviderId) String 

func (id IdentityProviderId) String() string

String returns a human-readable description of this Identity Provider ID

type IdentityProviderType 

type IdentityProviderType string
const (
	IdentityProviderTypeAad       IdentityProviderType = "aad"
	IdentityProviderTypeAadBTwoC  IdentityProviderType = "aadB2C"
	IdentityProviderTypeFacebook  IdentityProviderType = "facebook"
	IdentityProviderTypeGoogle    IdentityProviderType = "google"
	IdentityProviderTypeMicrosoft IdentityProviderType = "microsoft"
	IdentityProviderTypeTwitter   IdentityProviderType = "twitter"
)

func (*IdentityProviderType) UnmarshalJSON 

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

type IdentityProviderUpdateParameters 

type IdentityProviderUpdateParameters struct {
	Properties *IdentityProviderUpdateProperties `json:"properties,omitempty"`
}

type IdentityProviderUpdateProperties 

type IdentityProviderUpdateProperties struct {
	AllowedTenants           *[]string             `json:"allowedTenants,omitempty"`
	Authority                *string               `json:"authority,omitempty"`
	ClientId                 *string               `json:"clientId,omitempty"`
	ClientLibrary            *string               `json:"clientLibrary,omitempty"`
	ClientSecret             *string               `json:"clientSecret,omitempty"`
	PasswordResetPolicyName  *string               `json:"passwordResetPolicyName,omitempty"`
	ProfileEditingPolicyName *string               `json:"profileEditingPolicyName,omitempty"`
	SigninPolicyName         *string               `json:"signinPolicyName,omitempty"`
	SigninTenant             *string               `json:"signinTenant,omitempty"`
	SignupPolicyName         *string               `json:"signupPolicyName,omitempty"`
	Type                     *IdentityProviderType `json:"type,omitempty"`
}

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IdentityProviderContract
}

type ListByServiceCustomPager 

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

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IdentityProviderContract
}

type ListSecretsOperationResponse 

type ListSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClientSecretContract
}

type ServiceId 

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult 

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

func (ServiceId) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders 

func (o UpdateOperationOptions) ToHeaders() *client.Headers

func (UpdateOperationOptions) ToOData 

func (o UpdateOperationOptions) ToOData() *odata.Query

func (UpdateOperationOptions) ToQuery 

func (o UpdateOperationOptions) ToQuery() *client.QueryParams

type UpdateOperationResponse 

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

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.