README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2023-05-01/containerappsauthconfigs
Documentation
The containerappsauthconfigs
SDK allows for interaction with the Azure Resource Manager Service containerapps
(API Version 2023-05-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/containerapps/2023-05-01/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", "containerAppValue", "authConfigValue")
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", "containerAppValue", "authConfigValue")
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", "containerAppValue", "authConfigValue")
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", "containerAppValue")
// 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 ¶
- func PossibleValuesForClientCredentialMethod() []string
- func PossibleValuesForCookieExpirationConvention() []string
- func PossibleValuesForForwardProxyConvention() []string
- func PossibleValuesForUnauthenticatedClientActionV2() []string
- func ValidateAuthConfigID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateContainerAppID(input interface{}, key string) (warnings []string, errors []error)
- type AllowedAudiencesValidation
- type AllowedPrincipals
- type AppRegistration
- type Apple
- type AppleRegistration
- type AuthConfig
- type AuthConfigId
- type AuthConfigOperationPredicate
- type AuthConfigProperties
- type AuthPlatform
- type AzureActiveDirectory
- type AzureActiveDirectoryLogin
- type AzureActiveDirectoryRegistration
- type AzureActiveDirectoryValidation
- type AzureStaticWebApps
- type AzureStaticWebAppsRegistration
- type ClientCredentialMethod
- type ClientRegistration
- type ContainerAppId
- type ContainerAppsAuthConfigsClient
- func (c ContainerAppsAuthConfigsClient) CreateOrUpdate(ctx context.Context, id AuthConfigId, input AuthConfig) (result CreateOrUpdateOperationResponse, err error)
- func (c ContainerAppsAuthConfigsClient) Delete(ctx context.Context, id AuthConfigId) (result DeleteOperationResponse, err error)
- func (c ContainerAppsAuthConfigsClient) Get(ctx context.Context, id AuthConfigId) (result GetOperationResponse, err error)
- func (c ContainerAppsAuthConfigsClient) ListByContainerApp(ctx context.Context, id ContainerAppId) (result ListByContainerAppOperationResponse, err error)
- func (c ContainerAppsAuthConfigsClient) ListByContainerAppComplete(ctx context.Context, id ContainerAppId) (ListByContainerAppCompleteResult, error)
- func (c ContainerAppsAuthConfigsClient) ListByContainerAppCompleteMatchingPredicate(ctx context.Context, id ContainerAppId, predicate AuthConfigOperationPredicate) (result ListByContainerAppCompleteResult, err error)
- type CookieExpiration
- type CookieExpirationConvention
- type CreateOrUpdateOperationResponse
- type CustomOpenIdConnectProvider
- type DefaultAuthorizationPolicy
- type DeleteOperationResponse
- type Facebook
- type ForwardProxy
- type ForwardProxyConvention
- type GetOperationResponse
- type GitHub
- type GlobalValidation
- type Google
- type HTTPSettings
- type HTTPSettingsRoutes
- type IdentityProviders
- type JwtClaimChecks
- type ListByContainerAppCompleteResult
- type ListByContainerAppCustomPager
- type ListByContainerAppOperationResponse
- type Login
- type LoginRoutes
- type LoginScopes
- type Nonce
- type OpenIdConnectClientCredential
- type OpenIdConnectConfig
- type OpenIdConnectLogin
- type OpenIdConnectRegistration
- type Twitter
- type TwitterRegistration
- type UnauthenticatedClientActionV2
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 ¶
ValidateAuthConfigID checks that 'input' can be parsed as a Auth Config ID
func ValidateContainerAppID ¶
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 AppRegistration ¶
type Apple ¶
type Apple struct { Enabled *bool `json:"enabled,omitempty"` Login *LoginScopes `json:"login,omitempty"` Registration *AppleRegistration `json:"registration,omitempty"` }
type AppleRegistration ¶
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) 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 ¶
func (AuthConfigOperationPredicate) Matches ¶
func (p AuthConfigOperationPredicate) Matches(input AuthConfig) bool
type AuthConfigProperties ¶
type AuthConfigProperties struct { 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 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 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 ClientCredentialMethod ¶
type ClientCredentialMethod string
const (
ClientCredentialMethodClientSecretPost ClientCredentialMethod = "ClientSecretPost"
)
func (*ClientCredentialMethod) UnmarshalJSON ¶ added in v0.20240212.1141705
func (s *ClientCredentialMethod) UnmarshalJSON(bytes []byte) error
type ClientRegistration ¶
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 ¶ added in v0.20240212.1141705
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 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 ¶ added in v0.20240212.1141705
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 ListByContainerAppCompleteResult ¶
type ListByContainerAppCompleteResult struct { LatestHttpResponse *http.Response Items []AuthConfig }
type ListByContainerAppCustomPager ¶ added in v0.20240628.1153531
func (*ListByContainerAppCustomPager) NextPageLink ¶ added in v0.20240628.1153531
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"` }
type LoginRoutes ¶
type LoginRoutes struct {
LogoutEndpoint *string `json:"logoutEndpoint,omitempty"`
}
type LoginScopes ¶
type LoginScopes struct {
Scopes *[]string `json:"scopes,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 OpenIdConnectRegistration ¶
type OpenIdConnectRegistration struct { ClientCredential *OpenIdConnectClientCredential `json:"clientCredential,omitempty"` ClientId *string `json:"clientId,omitempty"` OpenIdConnectConfiguration *OpenIdConnectConfig `json:"openIdConnectConfiguration,omitempty"` }
type Twitter ¶
type Twitter struct { Enabled *bool `json:"enabled,omitempty"` Registration *TwitterRegistration `json:"registration,omitempty"` }
type TwitterRegistration ¶
type UnauthenticatedClientActionV2 ¶
type UnauthenticatedClientActionV2 string
const ( UnauthenticatedClientActionV2AllowAnonymous UnauthenticatedClientActionV2 = "AllowAnonymous" UnauthenticatedClientActionV2RedirectToLoginPage UnauthenticatedClientActionV2 = "RedirectToLoginPage" UnauthenticatedClientActionV2ReturnFourZeroOne UnauthenticatedClientActionV2 = "Return401" UnauthenticatedClientActionV2ReturnFourZeroThree UnauthenticatedClientActionV2 = "Return403" )
func (*UnauthenticatedClientActionV2) UnmarshalJSON ¶ added in v0.20240212.1141705
func (s *UnauthenticatedClientActionV2) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_authconfig.go
- id_containerapp.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_listbycontainerapp.go
- model_allowedaudiencesvalidation.go
- model_allowedprincipals.go
- model_apple.go
- model_appleregistration.go
- model_appregistration.go
- model_authconfig.go
- model_authconfigproperties.go
- model_authplatform.go
- model_azureactivedirectory.go
- model_azureactivedirectorylogin.go
- model_azureactivedirectoryregistration.go
- model_azureactivedirectoryvalidation.go
- model_azurestaticwebapps.go
- model_azurestaticwebappsregistration.go
- model_clientregistration.go
- model_cookieexpiration.go
- model_customopenidconnectprovider.go
- model_defaultauthorizationpolicy.go
- model_facebook.go
- model_forwardproxy.go
- model_github.go
- model_globalvalidation.go
- model_google.go
- model_httpsettings.go
- model_httpsettingsroutes.go
- model_identityproviders.go
- model_jwtclaimchecks.go
- model_login.go
- model_loginroutes.go
- model_loginscopes.go
- model_nonce.go
- model_openidconnectclientcredential.go
- model_openidconnectconfig.go
- model_openidconnectlogin.go
- model_openidconnectregistration.go
- model_twitter.go
- model_twitterregistration.go
- predicates.go
- version.go