containerappsauthconfigs

package
v0.20241209.1115630 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-02-02-preview/containerappsauthconfigs Documentation

The containerappsauthconfigs SDK allows for interaction with Azure Resource Manager containerapps (API Version 2024-02-02-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/containerapps/2024-02-02-preview/containerappsauthconfigs"

Client Initialization

client := containerappsauthconfigs.NewContainerAppsAuthConfigsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsAuthConfigsClient.CreateOrUpdate

ctx := context.TODO()
id := containerappsauthconfigs.NewAuthConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "authConfigName")

payload := containerappsauthconfigs.AuthConfig{
	// ...
}


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: ContainerAppsAuthConfigsClient.Delete

ctx := context.TODO()
id := containerappsauthconfigs.NewAuthConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "authConfigName")

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: ContainerAppsAuthConfigsClient.Get

ctx := context.TODO()
id := containerappsauthconfigs.NewAuthConfigID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "authConfigName")

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: ContainerAppsAuthConfigsClient.ListByContainerApp

ctx := context.TODO()
id := containerappsauthconfigs.NewContainerAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName")

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

func PossibleValuesForClientCredentialMethod() []string

func PossibleValuesForCookieExpirationConvention 

func PossibleValuesForCookieExpirationConvention() []string

func PossibleValuesForForwardProxyConvention 

func PossibleValuesForForwardProxyConvention() []string

func PossibleValuesForUnauthenticatedClientActionV2 

func PossibleValuesForUnauthenticatedClientActionV2() []string

func ValidateAuthConfigID 

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

ValidateAuthConfigID checks that 'input' can be parsed as a Auth Config ID

func ValidateContainerAppID 

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

ValidateContainerAppID checks that 'input' can be parsed as a Container App ID

Types

type AllowedAudiencesValidation 

type AllowedAudiencesValidation struct {
	AllowedAudiences *[]string `json:"allowedAudiences,omitempty"`
}

type AllowedPrincipals 

type AllowedPrincipals struct {
	Groups     *[]string `json:"groups,omitempty"`
	Identities *[]string `json:"identities,omitempty"`
}

type AppRegistration 

type AppRegistration struct {
	AppId                *string `json:"appId,omitempty"`
	AppSecretSettingName *string `json:"appSecretSettingName,omitempty"`
}

type Apple 

type Apple struct {
	Enabled      *bool              `json:"enabled,omitempty"`
	Login        *LoginScopes       `json:"login,omitempty"`
	Registration *AppleRegistration `json:"registration,omitempty"`
}

type AppleRegistration 

type AppleRegistration struct {
	ClientId                *string `json:"clientId,omitempty"`
	ClientSecretSettingName *string `json:"clientSecretSettingName,omitempty"`
}

type AuthConfig 

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

type AuthConfigId 

type AuthConfigId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	AuthConfigName    string
}

AuthConfigId is a struct representing the Resource ID for a Auth Config

func NewAuthConfigID 

func NewAuthConfigID(subscriptionId string, resourceGroupName string, containerAppName string, authConfigName string) AuthConfigId

NewAuthConfigID returns a new AuthConfigId struct

func ParseAuthConfigID 

func ParseAuthConfigID(input string) (*AuthConfigId, error)

ParseAuthConfigID parses 'input' into a AuthConfigId

func ParseAuthConfigIDInsensitively 

func ParseAuthConfigIDInsensitively(input string) (*AuthConfigId, error)

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

func (*AuthConfigId) FromParseResult 

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

func (AuthConfigId) ID 

func (id AuthConfigId) ID() string

ID returns the formatted Auth Config ID

func (AuthConfigId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Auth Config ID

func (AuthConfigId) String 

func (id AuthConfigId) String() string

String returns a human-readable description of this Auth Config ID

type AuthConfigOperationPredicate 

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

func (AuthConfigOperationPredicate) Matches 

func (p AuthConfigOperationPredicate) Matches(input AuthConfig) bool

type AuthConfigProperties 

type AuthConfigProperties struct {
	EncryptionSettings *EncryptionSettings `json:"encryptionSettings,omitempty"`
	GlobalValidation   *GlobalValidation   `json:"globalValidation,omitempty"`
	HTTPSettings       *HTTPSettings       `json:"httpSettings,omitempty"`
	IdentityProviders  *IdentityProviders  `json:"identityProviders,omitempty"`
	Login              *Login              `json:"login,omitempty"`
	Platform           *AuthPlatform       `json:"platform,omitempty"`
}

type AuthPlatform 

type AuthPlatform struct {
	Enabled        *bool   `json:"enabled,omitempty"`
	RuntimeVersion *string `json:"runtimeVersion,omitempty"`
}

type AzureActiveDirectory 

type AzureActiveDirectory struct {
	Enabled           *bool                             `json:"enabled,omitempty"`
	IsAutoProvisioned *bool                             `json:"isAutoProvisioned,omitempty"`
	Login             *AzureActiveDirectoryLogin        `json:"login,omitempty"`
	Registration      *AzureActiveDirectoryRegistration `json:"registration,omitempty"`
	Validation        *AzureActiveDirectoryValidation   `json:"validation,omitempty"`
}

type AzureActiveDirectoryLogin 

type AzureActiveDirectoryLogin struct {
	DisableWWWAuthenticate *bool     `json:"disableWWWAuthenticate,omitempty"`
	LoginParameters        *[]string `json:"loginParameters,omitempty"`
}

type AzureActiveDirectoryRegistration 

type AzureActiveDirectoryRegistration struct {
	ClientId                                      *string `json:"clientId,omitempty"`
	ClientSecretCertificateIssuer                 *string `json:"clientSecretCertificateIssuer,omitempty"`
	ClientSecretCertificateSubjectAlternativeName *string `json:"clientSecretCertificateSubjectAlternativeName,omitempty"`
	ClientSecretCertificateThumbprint             *string `json:"clientSecretCertificateThumbprint,omitempty"`
	ClientSecretSettingName                       *string `json:"clientSecretSettingName,omitempty"`
	OpenIdIssuer                                  *string `json:"openIdIssuer,omitempty"`
}

type AzureActiveDirectoryValidation 

type AzureActiveDirectoryValidation struct {
	AllowedAudiences           *[]string                   `json:"allowedAudiences,omitempty"`
	DefaultAuthorizationPolicy *DefaultAuthorizationPolicy `json:"defaultAuthorizationPolicy,omitempty"`
	JwtClaimChecks             *JwtClaimChecks             `json:"jwtClaimChecks,omitempty"`
}

type AzureStaticWebApps 

type AzureStaticWebApps struct {
	Enabled      *bool                           `json:"enabled,omitempty"`
	Registration *AzureStaticWebAppsRegistration `json:"registration,omitempty"`
}

type AzureStaticWebAppsRegistration 

type AzureStaticWebAppsRegistration struct {
	ClientId *string `json:"clientId,omitempty"`
}

type BlobStorageTokenStore 

type BlobStorageTokenStore struct {
	SasURLSettingName string `json:"sasUrlSettingName"`
}

type ClientCredentialMethod 

type ClientCredentialMethod string
const (
	ClientCredentialMethodClientSecretPost ClientCredentialMethod = "ClientSecretPost"
)

func (*ClientCredentialMethod) UnmarshalJSON 

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

type ClientRegistration 

type ClientRegistration struct {
	ClientId                *string `json:"clientId,omitempty"`
	ClientSecretSettingName *string `json:"clientSecretSettingName,omitempty"`
}

type ContainerAppId 

type ContainerAppId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
}

ContainerAppId is a struct representing the Resource ID for a Container App

func NewContainerAppID 

func NewContainerAppID(subscriptionId string, resourceGroupName string, containerAppName string) ContainerAppId

NewContainerAppID returns a new ContainerAppId struct

func ParseContainerAppID 

func ParseContainerAppID(input string) (*ContainerAppId, error)

ParseContainerAppID parses 'input' into a ContainerAppId

func ParseContainerAppIDInsensitively 

func ParseContainerAppIDInsensitively(input string) (*ContainerAppId, error)

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

func (*ContainerAppId) FromParseResult 

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

func (ContainerAppId) ID 

func (id ContainerAppId) ID() string

ID returns the formatted Container App ID

func (ContainerAppId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Container App ID

func (ContainerAppId) String 

func (id ContainerAppId) String() string

String returns a human-readable description of this Container App ID

type ContainerAppsAuthConfigsClient 

type ContainerAppsAuthConfigsClient struct {
	Client *resourcemanager.Client
}

func NewContainerAppsAuthConfigsClientWithBaseURI 

func NewContainerAppsAuthConfigsClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsAuthConfigsClient, error)

func (ContainerAppsAuthConfigsClient) CreateOrUpdate 

func (c ContainerAppsAuthConfigsClient) CreateOrUpdate(ctx context.Context, id AuthConfigId, input AuthConfig) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ContainerAppsAuthConfigsClient) Delete 

func (c ContainerAppsAuthConfigsClient) Delete(ctx context.Context, id AuthConfigId) (result DeleteOperationResponse, err error)

Delete ...

func (ContainerAppsAuthConfigsClient) Get 

func (c ContainerAppsAuthConfigsClient) Get(ctx context.Context, id AuthConfigId) (result GetOperationResponse, err error)

Get ...

func (ContainerAppsAuthConfigsClient) ListByContainerApp 

func (c ContainerAppsAuthConfigsClient) ListByContainerApp(ctx context.Context, id ContainerAppId) (result ListByContainerAppOperationResponse, err error)

ListByContainerApp ...

func (ContainerAppsAuthConfigsClient) ListByContainerAppComplete 

func (c ContainerAppsAuthConfigsClient) ListByContainerAppComplete(ctx context.Context, id ContainerAppId) (ListByContainerAppCompleteResult, error)

ListByContainerAppComplete retrieves all the results into a single object

func (ContainerAppsAuthConfigsClient) ListByContainerAppCompleteMatchingPredicate 

func (c ContainerAppsAuthConfigsClient) ListByContainerAppCompleteMatchingPredicate(ctx context.Context, id ContainerAppId, predicate AuthConfigOperationPredicate) (result ListByContainerAppCompleteResult, err error)

ListByContainerAppCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CookieExpiration 

type CookieExpiration struct {
	Convention       *CookieExpirationConvention `json:"convention,omitempty"`
	TimeToExpiration *string                     `json:"timeToExpiration,omitempty"`
}

type CookieExpirationConvention 

type CookieExpirationConvention string
const (
	CookieExpirationConventionFixedTime               CookieExpirationConvention = "FixedTime"
	CookieExpirationConventionIdentityProviderDerived CookieExpirationConvention = "IdentityProviderDerived"
)

func (*CookieExpirationConvention) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type CustomOpenIdConnectProvider 

type CustomOpenIdConnectProvider struct {
	Enabled      *bool                      `json:"enabled,omitempty"`
	Login        *OpenIdConnectLogin        `json:"login,omitempty"`
	Registration *OpenIdConnectRegistration `json:"registration,omitempty"`
}

type DefaultAuthorizationPolicy 

type DefaultAuthorizationPolicy struct {
	AllowedApplications *[]string          `json:"allowedApplications,omitempty"`
	AllowedPrincipals   *AllowedPrincipals `json:"allowedPrincipals,omitempty"`
}

type DeleteOperationResponse 

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

type EncryptionSettings 

type EncryptionSettings struct {
	ContainerAppAuthEncryptionSecretName *string `json:"containerAppAuthEncryptionSecretName,omitempty"`
	ContainerAppAuthSigningSecretName    *string `json:"containerAppAuthSigningSecretName,omitempty"`
}

type Facebook 

type Facebook struct {
	Enabled         *bool            `json:"enabled,omitempty"`
	GraphApiVersion *string          `json:"graphApiVersion,omitempty"`
	Login           *LoginScopes     `json:"login,omitempty"`
	Registration    *AppRegistration `json:"registration,omitempty"`
}

type ForwardProxy 

type ForwardProxy struct {
	Convention            *ForwardProxyConvention `json:"convention,omitempty"`
	CustomHostHeaderName  *string                 `json:"customHostHeaderName,omitempty"`
	CustomProtoHeaderName *string                 `json:"customProtoHeaderName,omitempty"`
}

type ForwardProxyConvention 

type ForwardProxyConvention string
const (
	ForwardProxyConventionCustom   ForwardProxyConvention = "Custom"
	ForwardProxyConventionNoProxy  ForwardProxyConvention = "NoProxy"
	ForwardProxyConventionStandard ForwardProxyConvention = "Standard"
)

func (*ForwardProxyConvention) UnmarshalJSON 

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

type GetOperationResponse 

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

type GitHub 

type GitHub struct {
	Enabled      *bool               `json:"enabled,omitempty"`
	Login        *LoginScopes        `json:"login,omitempty"`
	Registration *ClientRegistration `json:"registration,omitempty"`
}

type GlobalValidation 

type GlobalValidation struct {
	ExcludedPaths               *[]string                      `json:"excludedPaths,omitempty"`
	RedirectToProvider          *string                        `json:"redirectToProvider,omitempty"`
	UnauthenticatedClientAction *UnauthenticatedClientActionV2 `json:"unauthenticatedClientAction,omitempty"`
}

type Google 

type Google struct {
	Enabled      *bool                       `json:"enabled,omitempty"`
	Login        *LoginScopes                `json:"login,omitempty"`
	Registration *ClientRegistration         `json:"registration,omitempty"`
	Validation   *AllowedAudiencesValidation `json:"validation,omitempty"`
}

type HTTPSettings 

type HTTPSettings struct {
	ForwardProxy *ForwardProxy       `json:"forwardProxy,omitempty"`
	RequireHTTPS *bool               `json:"requireHttps,omitempty"`
	Routes       *HTTPSettingsRoutes `json:"routes,omitempty"`
}

type HTTPSettingsRoutes 

type HTTPSettingsRoutes struct {
	ApiPrefix *string `json:"apiPrefix,omitempty"`
}

type IdentityProviders 

type IdentityProviders struct {
	Apple                        *Apple                                  `json:"apple,omitempty"`
	AzureActiveDirectory         *AzureActiveDirectory                   `json:"azureActiveDirectory,omitempty"`
	AzureStaticWebApps           *AzureStaticWebApps                     `json:"azureStaticWebApps,omitempty"`
	CustomOpenIdConnectProviders *map[string]CustomOpenIdConnectProvider `json:"customOpenIdConnectProviders,omitempty"`
	Facebook                     *Facebook                               `json:"facebook,omitempty"`
	GitHub                       *GitHub                                 `json:"gitHub,omitempty"`
	Google                       *Google                                 `json:"google,omitempty"`
	Twitter                      *Twitter                                `json:"twitter,omitempty"`
}

type JwtClaimChecks 

type JwtClaimChecks struct {
	AllowedClientApplications *[]string `json:"allowedClientApplications,omitempty"`
	AllowedGroups             *[]string `json:"allowedGroups,omitempty"`
}

type ListByContainerAppCompleteResult 

type ListByContainerAppCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AuthConfig
}

type ListByContainerAppCustomPager 

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

type ListByContainerAppOperationResponse 

type ListByContainerAppOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AuthConfig
}

type Login 

type Login struct {
	AllowedExternalRedirectURLs   *[]string         `json:"allowedExternalRedirectUrls,omitempty"`
	CookieExpiration              *CookieExpiration `json:"cookieExpiration,omitempty"`
	Nonce                         *Nonce            `json:"nonce,omitempty"`
	PreserveURLFragmentsForLogins *bool             `json:"preserveUrlFragmentsForLogins,omitempty"`
	Routes                        *LoginRoutes      `json:"routes,omitempty"`
	TokenStore                    *TokenStore       `json:"tokenStore,omitempty"`
}

type LoginRoutes 

type LoginRoutes struct {
	LogoutEndpoint *string `json:"logoutEndpoint,omitempty"`
}

type LoginScopes 

type LoginScopes struct {
	Scopes *[]string `json:"scopes,omitempty"`
}

type Nonce 

type Nonce struct {
	NonceExpirationInterval *string `json:"nonceExpirationInterval,omitempty"`
	ValidateNonce           *bool   `json:"validateNonce,omitempty"`
}

type OpenIdConnectClientCredential 

type OpenIdConnectClientCredential struct {
	ClientSecretSettingName *string                 `json:"clientSecretSettingName,omitempty"`
	Method                  *ClientCredentialMethod `json:"method,omitempty"`
}

type OpenIdConnectConfig 

type OpenIdConnectConfig struct {
	AuthorizationEndpoint        *string `json:"authorizationEndpoint,omitempty"`
	CertificationUri             *string `json:"certificationUri,omitempty"`
	Issuer                       *string `json:"issuer,omitempty"`
	TokenEndpoint                *string `json:"tokenEndpoint,omitempty"`
	WellKnownOpenIdConfiguration *string `json:"wellKnownOpenIdConfiguration,omitempty"`
}

type OpenIdConnectLogin 

type OpenIdConnectLogin struct {
	NameClaimType *string   `json:"nameClaimType,omitempty"`
	Scopes        *[]string `json:"scopes,omitempty"`
}

type OpenIdConnectRegistration 

type OpenIdConnectRegistration struct {
	ClientCredential           *OpenIdConnectClientCredential `json:"clientCredential,omitempty"`
	ClientId                   *string                        `json:"clientId,omitempty"`
	OpenIdConnectConfiguration *OpenIdConnectConfig           `json:"openIdConnectConfiguration,omitempty"`
}

type TokenStore 

type TokenStore struct {
	AzureBlobStorage           *BlobStorageTokenStore `json:"azureBlobStorage,omitempty"`
	Enabled                    *bool                  `json:"enabled,omitempty"`
	TokenRefreshExtensionHours *float64               `json:"tokenRefreshExtensionHours,omitempty"`
}

type Twitter 

type Twitter struct {
	Enabled      *bool                `json:"enabled,omitempty"`
	Registration *TwitterRegistration `json:"registration,omitempty"`
}

type TwitterRegistration 

type TwitterRegistration struct {
	ConsumerKey               *string `json:"consumerKey,omitempty"`
	ConsumerSecretSettingName *string `json:"consumerSecretSettingName,omitempty"`
}

type UnauthenticatedClientActionV2 

type UnauthenticatedClientActionV2 string
const (
	UnauthenticatedClientActionV2AllowAnonymous      UnauthenticatedClientActionV2 = "AllowAnonymous"
	UnauthenticatedClientActionV2RedirectToLoginPage UnauthenticatedClientActionV2 = "RedirectToLoginPage"
	UnauthenticatedClientActionV2ReturnFourZeroOne   UnauthenticatedClientActionV2 = "Return401"
	UnauthenticatedClientActionV2ReturnFourZeroThree UnauthenticatedClientActionV2 = "Return403"
)

func (*UnauthenticatedClientActionV2) UnmarshalJSON 

func (s *UnauthenticatedClientActionV2) 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.