armappcontainers

package module
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 10, 2023 License: MIT Imports: 14 Imported by: 2

README

Azure Container Apps Module for Go

PkgGoDev

The armappcontainers module provides operations for working with Azure Container Apps.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Container Apps module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Container Apps. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Container Apps module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armappcontainers.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armappcontainers.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewContainerAppsClient()

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Container Apps label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessMode

type AccessMode string

AccessMode - Access mode for storage

const (
	AccessModeReadOnly  AccessMode = "ReadOnly"
	AccessModeReadWrite AccessMode = "ReadWrite"
)

func PossibleAccessModeValues

func PossibleAccessModeValues() []AccessMode

PossibleAccessModeValues returns the possible values for the AccessMode const type.

type ActiveRevisionsMode

type ActiveRevisionsMode string

ActiveRevisionsMode - ActiveRevisionsMode controls how active revisions are handled for the Container app:Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.

const (
	ActiveRevisionsModeMultiple ActiveRevisionsMode = "Multiple"
	ActiveRevisionsModeSingle   ActiveRevisionsMode = "Single"
)

func PossibleActiveRevisionsModeValues

func PossibleActiveRevisionsModeValues() []ActiveRevisionsMode

PossibleActiveRevisionsModeValues returns the possible values for the ActiveRevisionsMode const type.

type AllowedAudiencesValidation

type AllowedAudiencesValidation struct {
	// The configuration settings of the allowed list of audiences from which to validate the JWT token.
	AllowedAudiences []*string `json:"allowedAudiences,omitempty"`
}

AllowedAudiencesValidation - The configuration settings of the Allowed Audiences validation flow.

func (AllowedAudiencesValidation) MarshalJSON

func (a AllowedAudiencesValidation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AllowedAudiencesValidation.

func (*AllowedAudiencesValidation) UnmarshalJSON added in v1.1.0

func (a *AllowedAudiencesValidation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AllowedAudiencesValidation.

type AllowedPrincipals

type AllowedPrincipals struct {
	// The list of the allowed groups.
	Groups []*string `json:"groups,omitempty"`

	// The list of the allowed identities.
	Identities []*string `json:"identities,omitempty"`
}

AllowedPrincipals - The configuration settings of the Azure Active Directory allowed principals.

func (AllowedPrincipals) MarshalJSON

func (a AllowedPrincipals) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AllowedPrincipals.

func (*AllowedPrincipals) UnmarshalJSON added in v1.1.0

func (a *AllowedPrincipals) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AllowedPrincipals.

type AppLogsConfiguration

type AppLogsConfiguration struct {
	// Logs destination
	Destination *string `json:"destination,omitempty"`

	// Log Analytics configuration
	LogAnalyticsConfiguration *LogAnalyticsConfiguration `json:"logAnalyticsConfiguration,omitempty"`
}

AppLogsConfiguration - Configuration of application logs

func (AppLogsConfiguration) MarshalJSON added in v1.1.0

func (a AppLogsConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AppLogsConfiguration.

func (*AppLogsConfiguration) UnmarshalJSON added in v1.1.0

func (a *AppLogsConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AppLogsConfiguration.

type AppProtocol

type AppProtocol string

AppProtocol - Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http

const (
	AppProtocolGrpc AppProtocol = "grpc"
	AppProtocolHTTP AppProtocol = "http"
)

func PossibleAppProtocolValues

func PossibleAppProtocolValues() []AppProtocol

PossibleAppProtocolValues returns the possible values for the AppProtocol const type.

type AppRegistration

type AppRegistration struct {
	// The App ID of the app used for login.
	AppID *string `json:"appId,omitempty"`

	// The app setting name that contains the app secret.
	AppSecretSettingName *string `json:"appSecretSettingName,omitempty"`
}

AppRegistration - The configuration settings of the app registration for providers that have app ids and app secrets

func (AppRegistration) MarshalJSON added in v1.1.0

func (a AppRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AppRegistration.

func (*AppRegistration) UnmarshalJSON added in v1.1.0

func (a *AppRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AppRegistration.

type Apple

type Apple struct {
	// false if the Apple provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The configuration settings of the login flow.
	Login *LoginScopes `json:"login,omitempty"`

	// The configuration settings of the Apple registration.
	Registration *AppleRegistration `json:"registration,omitempty"`
}

Apple - The configuration settings of the Apple provider.

func (Apple) MarshalJSON added in v1.1.0

func (a Apple) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Apple.

func (*Apple) UnmarshalJSON added in v1.1.0

func (a *Apple) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Apple.

type AppleRegistration

type AppleRegistration struct {
	// The Client ID of the app used for login.
	ClientID *string `json:"clientId,omitempty"`

	// The app setting name that contains the client secret.
	ClientSecretSettingName *string `json:"clientSecretSettingName,omitempty"`
}

AppleRegistration - The configuration settings of the registration for the Apple provider

func (AppleRegistration) MarshalJSON added in v1.1.0

func (a AppleRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AppleRegistration.

func (*AppleRegistration) UnmarshalJSON added in v1.1.0

func (a *AppleRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AppleRegistration.

type AuthConfig

type AuthConfig struct {
	// AuthConfig resource specific properties
	Properties *AuthConfigProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

AuthConfig - Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.

func (AuthConfig) MarshalJSON added in v1.1.0

func (a AuthConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthConfig.

func (*AuthConfig) UnmarshalJSON added in v1.1.0

func (a *AuthConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthConfig.

type AuthConfigCollection

type AuthConfigCollection struct {
	// REQUIRED; Collection of resources.
	Value []*AuthConfig `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AuthConfigCollection - AuthConfig collection ARM resource.

func (AuthConfigCollection) MarshalJSON added in v1.1.0

func (a AuthConfigCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthConfigCollection.

func (*AuthConfigCollection) UnmarshalJSON added in v1.1.0

func (a *AuthConfigCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthConfigCollection.

type AuthConfigProperties

type AuthConfigProperties struct {
	// The configuration settings that determines the validation flow of users using Service Authentication/Authorization.
	GlobalValidation *GlobalValidation `json:"globalValidation,omitempty"`

	// The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp
	// Service Authentication/Authorization.
	HTTPSettings *HTTPSettings `json:"httpSettings,omitempty"`

	// The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
	IdentityProviders *IdentityProviders `json:"identityProviders,omitempty"`

	// The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
	Login *Login `json:"login,omitempty"`

	// The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
	Platform *AuthPlatform `json:"platform,omitempty"`
}

AuthConfigProperties - AuthConfig resource specific properties

func (AuthConfigProperties) MarshalJSON added in v1.1.0

func (a AuthConfigProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthConfigProperties.

func (*AuthConfigProperties) UnmarshalJSON added in v1.1.0

func (a *AuthConfigProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthConfigProperties.

type AuthPlatform

type AuthPlatform struct {
	// true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
	Enabled *bool `json:"enabled,omitempty"`

	// The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value
	// can control the behavior of certain features in the Authentication /
	// Authorization module.
	RuntimeVersion *string `json:"runtimeVersion,omitempty"`
}

AuthPlatform - The configuration settings of the platform of ContainerApp Service Authentication/Authorization.

func (AuthPlatform) MarshalJSON added in v1.1.0

func (a AuthPlatform) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthPlatform.

func (*AuthPlatform) UnmarshalJSON added in v1.1.0

func (a *AuthPlatform) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthPlatform.

type AvailableOperations

type AvailableOperations struct {
	// URL client should use to fetch the next page (per server side paging). It's null for now, added for future use.
	NextLink *string `json:"nextLink,omitempty"`

	// Collection of available operation details
	Value []*OperationDetail `json:"value,omitempty"`
}

AvailableOperations - Available operations of the service

func (AvailableOperations) MarshalJSON added in v1.1.0

func (a AvailableOperations) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableOperations.

func (*AvailableOperations) UnmarshalJSON added in v1.1.0

func (a *AvailableOperations) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableOperations.

type AzureActiveDirectory

type AzureActiveDirectory struct {
	// false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal
	// flag primarily intended to support the Azure Management Portal. Users
	// should not read or write to this property.
	IsAutoProvisioned *bool `json:"isAutoProvisioned,omitempty"`

	// The configuration settings of the Azure Active Directory login flow.
	Login *AzureActiveDirectoryLogin `json:"login,omitempty"`

	// The configuration settings of the Azure Active Directory app registration.
	Registration *AzureActiveDirectoryRegistration `json:"registration,omitempty"`

	// The configuration settings of the Azure Active Directory token validation flow.
	Validation *AzureActiveDirectoryValidation `json:"validation,omitempty"`
}

AzureActiveDirectory - The configuration settings of the Azure Active directory provider.

func (AzureActiveDirectory) MarshalJSON added in v1.1.0

func (a AzureActiveDirectory) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureActiveDirectory.

func (*AzureActiveDirectory) UnmarshalJSON added in v1.1.0

func (a *AzureActiveDirectory) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureActiveDirectory.

type AzureActiveDirectoryLogin

type AzureActiveDirectoryLogin struct {
	// true if the www-authenticate provider should be omitted from the request; otherwise, false.
	DisableWWWAuthenticate *bool `json:"disableWWWAuthenticate,omitempty"`

	// Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the
	// form "key=value".
	LoginParameters []*string `json:"loginParameters,omitempty"`
}

AzureActiveDirectoryLogin - The configuration settings of the Azure Active Directory login flow.

func (AzureActiveDirectoryLogin) MarshalJSON

func (a AzureActiveDirectoryLogin) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureActiveDirectoryLogin.

func (*AzureActiveDirectoryLogin) UnmarshalJSON added in v1.1.0

func (a *AzureActiveDirectoryLogin) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureActiveDirectoryLogin.

type AzureActiveDirectoryRegistration

type AzureActiveDirectoryRegistration struct {
	// The Client ID of this relying party application, known as the clientid. This setting is required for enabling OpenID Connection
	// authentication with Azure Active Directory or other 3rd party OpenID
	// Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-10.html
	ClientID *string `json:"clientId,omitempty"`

	// An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property
	// acts as a replacement for the Client Secret Certificate Thumbprint. It is
	// also optional.
	ClientSecretCertificateIssuer *string `json:"clientSecretCertificateIssuer,omitempty"`

	// An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing
	// purposes. This property acts as a replacement for the Client Secret Certificate
	// Thumbprint. It is also optional.
	ClientSecretCertificateSubjectAlternativeName *string `json:"clientSecretCertificateSubjectAlternativeName,omitempty"`

	// An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts
	// as a replacement for the Client Secret. It is also optional.
	ClientSecretCertificateThumbprint *string `json:"clientSecretCertificateThumbprint,omitempty"`

	// The app setting name that contains the client secret of the relying party application.
	ClientSecretSettingName *string `json:"clientSecretSettingName,omitempty"`

	// The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure
	// Active Directory, this value is the URI of the directory tenant, e.g.
	// https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More
	// information on OpenID Connect Discovery:
	// http://openid.net/specs/openid-connect-discovery-1_0.html
	OpenIDIssuer *string `json:"openIdIssuer,omitempty"`
}

AzureActiveDirectoryRegistration - The configuration settings of the Azure Active Directory app registration.

func (AzureActiveDirectoryRegistration) MarshalJSON added in v1.1.0

func (a AzureActiveDirectoryRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureActiveDirectoryRegistration.

func (*AzureActiveDirectoryRegistration) UnmarshalJSON added in v1.1.0

func (a *AzureActiveDirectoryRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureActiveDirectoryRegistration.

type AzureActiveDirectoryValidation

type AzureActiveDirectoryValidation struct {
	// The list of audiences that can make successful authentication/authorization requests.
	AllowedAudiences []*string `json:"allowedAudiences,omitempty"`

	// The configuration settings of the default authorization policy.
	DefaultAuthorizationPolicy *DefaultAuthorizationPolicy `json:"defaultAuthorizationPolicy,omitempty"`

	// The configuration settings of the checks that should be made while validating the JWT Claims.
	JwtClaimChecks *JwtClaimChecks `json:"jwtClaimChecks,omitempty"`
}

AzureActiveDirectoryValidation - The configuration settings of the Azure Active Directory token validation flow.

func (AzureActiveDirectoryValidation) MarshalJSON

func (a AzureActiveDirectoryValidation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureActiveDirectoryValidation.

func (*AzureActiveDirectoryValidation) UnmarshalJSON added in v1.1.0

func (a *AzureActiveDirectoryValidation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureActiveDirectoryValidation.

type AzureCredentials

type AzureCredentials struct {
	// Client Id.
	ClientID *string `json:"clientId,omitempty"`

	// Client Secret.
	ClientSecret *string `json:"clientSecret,omitempty"`

	// Subscription Id.
	SubscriptionID *string `json:"subscriptionId,omitempty"`

	// Tenant Id.
	TenantID *string `json:"tenantId,omitempty"`
}

AzureCredentials - Container App credentials.

func (AzureCredentials) MarshalJSON added in v1.1.0

func (a AzureCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCredentials.

func (*AzureCredentials) UnmarshalJSON added in v1.1.0

func (a *AzureCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCredentials.

type AzureFileProperties

type AzureFileProperties struct {
	// Access mode for storage
	AccessMode *AccessMode `json:"accessMode,omitempty"`

	// Storage account key for azure file.
	AccountKey *string `json:"accountKey,omitempty"`

	// Storage account name for azure file.
	AccountName *string `json:"accountName,omitempty"`

	// Azure file share name.
	ShareName *string `json:"shareName,omitempty"`
}

AzureFileProperties - Azure File Properties.

func (AzureFileProperties) MarshalJSON added in v1.1.0

func (a AzureFileProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFileProperties.

func (*AzureFileProperties) UnmarshalJSON added in v1.1.0

func (a *AzureFileProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFileProperties.

type AzureStaticWebApps

type AzureStaticWebApps struct {
	// false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The configuration settings of the Azure Static Web Apps registration.
	Registration *AzureStaticWebAppsRegistration `json:"registration,omitempty"`
}

AzureStaticWebApps - The configuration settings of the Azure Static Web Apps provider.

func (AzureStaticWebApps) MarshalJSON added in v1.1.0

func (a AzureStaticWebApps) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureStaticWebApps.

func (*AzureStaticWebApps) UnmarshalJSON added in v1.1.0

func (a *AzureStaticWebApps) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureStaticWebApps.

type AzureStaticWebAppsRegistration

type AzureStaticWebAppsRegistration struct {
	// The Client ID of the app used for login.
	ClientID *string `json:"clientId,omitempty"`
}

AzureStaticWebAppsRegistration - The configuration settings of the registration for the Azure Static Web Apps provider

func (AzureStaticWebAppsRegistration) MarshalJSON added in v1.1.0

func (a AzureStaticWebAppsRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureStaticWebAppsRegistration.

func (*AzureStaticWebAppsRegistration) UnmarshalJSON added in v1.1.0

func (a *AzureStaticWebAppsRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureStaticWebAppsRegistration.

type BindingType

type BindingType string

BindingType - Custom Domain binding type.

const (
	BindingTypeDisabled   BindingType = "Disabled"
	BindingTypeSniEnabled BindingType = "SniEnabled"
)

func PossibleBindingTypeValues

func PossibleBindingTypeValues() []BindingType

PossibleBindingTypeValues returns the possible values for the BindingType const type.

type Certificate

type Certificate struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Certificate resource specific properties
	Properties *CertificateProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Certificate used for Custom Domain bindings of Container Apps in a Managed Environment

func (Certificate) MarshalJSON

func (c Certificate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Certificate.

func (*Certificate) UnmarshalJSON added in v1.1.0

func (c *Certificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Certificate.

type CertificateCollection

type CertificateCollection struct {
	// REQUIRED; Collection of resources.
	Value []*Certificate `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

CertificateCollection - Collection of Certificates.

func (CertificateCollection) MarshalJSON added in v1.1.0

func (c CertificateCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateCollection.

func (*CertificateCollection) UnmarshalJSON added in v1.1.0

func (c *CertificateCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateCollection.

type CertificatePatch

type CertificatePatch struct {
	// Application-specific metadata in the form of key-value pairs.
	Tags map[string]*string `json:"tags,omitempty"`
}

CertificatePatch - A certificate to update

func (CertificatePatch) MarshalJSON

func (c CertificatePatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificatePatch.

func (*CertificatePatch) UnmarshalJSON added in v1.1.0

func (c *CertificatePatch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificatePatch.

type CertificateProperties

type CertificateProperties struct {
	// Certificate password.
	Password *string `json:"password,omitempty"`

	// PFX or PEM blob
	Value []byte `json:"value,omitempty"`

	// READ-ONLY; Certificate expiration date.
	ExpirationDate *time.Time `json:"expirationDate,omitempty" azure:"ro"`

	// READ-ONLY; Certificate issue Date.
	IssueDate *time.Time `json:"issueDate,omitempty" azure:"ro"`

	// READ-ONLY; Certificate issuer.
	Issuer *string `json:"issuer,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the certificate.
	ProvisioningState *CertificateProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Public key hash.
	PublicKeyHash *string `json:"publicKeyHash,omitempty" azure:"ro"`

	// READ-ONLY; Subject name of the certificate.
	SubjectName *string `json:"subjectName,omitempty" azure:"ro"`

	// READ-ONLY; Certificate thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`

	// READ-ONLY; Is the certificate valid?.
	Valid *bool `json:"valid,omitempty" azure:"ro"`
}

CertificateProperties - Certificate resource specific properties

func (CertificateProperties) MarshalJSON

func (c CertificateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateProperties.

func (*CertificateProperties) UnmarshalJSON

func (c *CertificateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateProperties.

type CertificateProvisioningState

type CertificateProvisioningState string

CertificateProvisioningState - Provisioning state of the certificate.

const (
	CertificateProvisioningStateCanceled     CertificateProvisioningState = "Canceled"
	CertificateProvisioningStateDeleteFailed CertificateProvisioningState = "DeleteFailed"
	CertificateProvisioningStateFailed       CertificateProvisioningState = "Failed"
	CertificateProvisioningStatePending      CertificateProvisioningState = "Pending"
	CertificateProvisioningStateSucceeded    CertificateProvisioningState = "Succeeded"
)

func PossibleCertificateProvisioningStateValues

func PossibleCertificateProvisioningStateValues() []CertificateProvisioningState

PossibleCertificateProvisioningStateValues returns the possible values for the CertificateProvisioningState const type.

type CertificatesClient

type CertificatesClient struct {
	// contains filtered or unexported fields
}

CertificatesClient contains the methods for the Certificates group. Don't use this type directly, use NewCertificatesClient() instead.

func NewCertificatesClient

func NewCertificatesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CertificatesClient, error)

NewCertificatesClient creates a new instance of CertificatesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*CertificatesClient) CreateOrUpdate

func (client *CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, certificateName string, options *CertificatesClientCreateOrUpdateOptions) (CertificatesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update a Certificate. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • certificateName - Name of the Certificate.
  • options - CertificatesClientCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Certificate_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCertificatesClient().CreateOrUpdate(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", &armappcontainers.CertificatesClientCreateOrUpdateOptions{CertificateEnvelope: &armappcontainers.Certificate{
		Location: to.Ptr("East US"),
		Properties: &armappcontainers.CertificateProperties{
			Password: to.Ptr("private key password"),
			Value:    []byte("PFX-or-PEM-blob"),
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Certificate = armappcontainers.Certificate{
	// 	Type: to.Ptr("Microsoft.App/ManagedEnvironments/Certificates"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappcontainers.CertificateProperties{
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00Z"); return t}()),
	// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00Z"); return t}()),
	// 		Issuer: to.Ptr("Issuer Name"),
	// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 		SubjectName: to.Ptr("my-subject-name.contoso.com"),
	// 		Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 		Valid: to.Ptr(true),
	// 	},
	// }
}
Output:

func (*CertificatesClient) Delete

func (client *CertificatesClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, certificateName string, options *CertificatesClientDeleteOptions) (CertificatesClientDeleteResponse, error)

Delete - Deletes the specified Certificate. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • certificateName - Name of the Certificate.
  • options - CertificatesClientDeleteOptions contains the optional parameters for the CertificatesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Certificate_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewCertificatesClient().Delete(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*CertificatesClient) Get

func (client *CertificatesClient) Get(ctx context.Context, resourceGroupName string, environmentName string, certificateName string, options *CertificatesClientGetOptions) (CertificatesClientGetResponse, error)

Get - Get the specified Certificate. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • certificateName - Name of the Certificate.
  • options - CertificatesClientGetOptions contains the optional parameters for the CertificatesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Certificate_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCertificatesClient().Get(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Certificate = armappcontainers.Certificate{
	// 	Name: to.Ptr("certificate-firendly-name"),
	// 	Type: to.Ptr("Microsoft.App/ManagedEnvironments/Certificates"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappcontainers.CertificateProperties{
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00Z"); return t}()),
	// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00Z"); return t}()),
	// 		Issuer: to.Ptr("Issuer Name"),
	// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 		SubjectName: to.Ptr("my-subject-name.contoso.com"),
	// 		Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 		Valid: to.Ptr(true),
	// 	},
	// }
}
Output:

func (*CertificatesClient) NewListPager

func (client *CertificatesClient) NewListPager(resourceGroupName string, environmentName string, options *CertificatesClientListOptions) *runtime.Pager[CertificatesClientListResponse]

NewListPager - Get the Certificates in a given managed environment.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • options - CertificatesClientListOptions contains the optional parameters for the CertificatesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Certificates_ListByManagedEnvironment.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCertificatesClient().NewListPager("examplerg", "testcontainerenv", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CertificateCollection = armappcontainers.CertificateCollection{
		// 	Value: []*armappcontainers.Certificate{
		// 		{
		// 			Name: to.Ptr("certificate-firendly-name1"),
		// 			Type: to.Ptr("Microsoft.App/ManagedEnvironments/Certificates"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name1"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armappcontainers.CertificateProperties{
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00Z"); return t}()),
		// 				IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00Z"); return t}()),
		// 				Issuer: to.Ptr("Issuer Name"),
		// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
		// 				SubjectName: to.Ptr("my-subject-name1.contoso.com"),
		// 				Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
		// 				Valid: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("certificate-firendly-name2"),
		// 			Type: to.Ptr("Microsoft.App/ManagedEnvironments/Certificates"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name2"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armappcontainers.CertificateProperties{
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00Z"); return t}()),
		// 				IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00Z"); return t}()),
		// 				Issuer: to.Ptr("Issuer Name"),
		// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
		// 				SubjectName: to.Ptr("my-subject-name2.contoso.com"),
		// 				Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
		// 				Valid: to.Ptr(true),
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*CertificatesClient) Update

func (client *CertificatesClient) Update(ctx context.Context, resourceGroupName string, environmentName string, certificateName string, certificateEnvelope CertificatePatch, options *CertificatesClientUpdateOptions) (CertificatesClientUpdateResponse, error)

Update - Patches a certificate. Currently only patching of tags is supported If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • certificateName - Name of the Certificate.
  • certificateEnvelope - Properties of a certificate that need to be updated
  • options - CertificatesClientUpdateOptions contains the optional parameters for the CertificatesClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Certificates_Patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCertificatesClient().Update(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", armappcontainers.CertificatePatch{
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Certificate = armappcontainers.Certificate{
	// 	Type: to.Ptr("Microsoft.App/ManagedEnvironments/Certificates"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armappcontainers.CertificateProperties{
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00Z"); return t}()),
	// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00Z"); return t}()),
	// 		Issuer: to.Ptr("Issuer Name"),
	// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 		SubjectName: to.Ptr("my-subject-name.contoso.com"),
	// 		Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 		Valid: to.Ptr(true),
	// 	},
	// }
}
Output:

type CertificatesClientCreateOrUpdateOptions

type CertificatesClientCreateOrUpdateOptions struct {
	// Certificate to be created or updated
	CertificateEnvelope *Certificate
}

CertificatesClientCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.CreateOrUpdate method.

type CertificatesClientCreateOrUpdateResponse

type CertificatesClientCreateOrUpdateResponse struct {
	Certificate
}

CertificatesClientCreateOrUpdateResponse contains the response from method CertificatesClient.CreateOrUpdate.

type CertificatesClientDeleteOptions

type CertificatesClientDeleteOptions struct {
}

CertificatesClientDeleteOptions contains the optional parameters for the CertificatesClient.Delete method.

type CertificatesClientDeleteResponse

type CertificatesClientDeleteResponse struct {
}

CertificatesClientDeleteResponse contains the response from method CertificatesClient.Delete.

type CertificatesClientGetOptions

type CertificatesClientGetOptions struct {
}

CertificatesClientGetOptions contains the optional parameters for the CertificatesClient.Get method.

type CertificatesClientGetResponse

type CertificatesClientGetResponse struct {
	Certificate
}

CertificatesClientGetResponse contains the response from method CertificatesClient.Get.

type CertificatesClientListOptions

type CertificatesClientListOptions struct {
}

CertificatesClientListOptions contains the optional parameters for the CertificatesClient.NewListPager method.

type CertificatesClientListResponse

type CertificatesClientListResponse struct {
	CertificateCollection
}

CertificatesClientListResponse contains the response from method CertificatesClient.NewListPager.

type CertificatesClientUpdateOptions

type CertificatesClientUpdateOptions struct {
}

CertificatesClientUpdateOptions contains the optional parameters for the CertificatesClient.Update method.

type CertificatesClientUpdateResponse

type CertificatesClientUpdateResponse struct {
	Certificate
}

CertificatesClientUpdateResponse contains the response from method CertificatesClient.Update.

type CheckNameAvailabilityReason

type CheckNameAvailabilityReason string

CheckNameAvailabilityReason - The reason why the given name is not available.

const (
	CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
	CheckNameAvailabilityReasonInvalid       CheckNameAvailabilityReason = "Invalid"
)

func PossibleCheckNameAvailabilityReasonValues

func PossibleCheckNameAvailabilityReasonValues() []CheckNameAvailabilityReason

PossibleCheckNameAvailabilityReasonValues returns the possible values for the CheckNameAvailabilityReason const type.

type CheckNameAvailabilityRequest

type CheckNameAvailabilityRequest struct {
	// The name of the resource for which availability needs to be checked.
	Name *string `json:"name,omitempty"`

	// The resource type.
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityRequest - The check availability request body.

func (CheckNameAvailabilityRequest) MarshalJSON added in v1.1.0

func (c CheckNameAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityRequest.

func (*CheckNameAvailabilityRequest) UnmarshalJSON added in v1.1.0

func (c *CheckNameAvailabilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityRequest.

type CheckNameAvailabilityResponse

type CheckNameAvailabilityResponse struct {
	// Detailed reason why the given name is available.
	Message *string `json:"message,omitempty"`

	// Indicates if the resource name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`

	// The reason why the given name is not available.
	Reason *CheckNameAvailabilityReason `json:"reason,omitempty"`
}

CheckNameAvailabilityResponse - The check availability result.

func (CheckNameAvailabilityResponse) MarshalJSON added in v1.1.0

func (c CheckNameAvailabilityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityResponse.

func (*CheckNameAvailabilityResponse) UnmarshalJSON added in v1.1.0

func (c *CheckNameAvailabilityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityResponse.

type ClientFactory added in v1.1.0

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v1.1.0

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewCertificatesClient added in v1.1.0

func (c *ClientFactory) NewCertificatesClient() *CertificatesClient

func (*ClientFactory) NewContainerAppsAuthConfigsClient added in v1.1.0

func (c *ClientFactory) NewContainerAppsAuthConfigsClient() *ContainerAppsAuthConfigsClient

func (*ClientFactory) NewContainerAppsClient added in v1.1.0

func (c *ClientFactory) NewContainerAppsClient() *ContainerAppsClient

func (*ClientFactory) NewContainerAppsRevisionReplicasClient added in v1.1.0

func (c *ClientFactory) NewContainerAppsRevisionReplicasClient() *ContainerAppsRevisionReplicasClient

func (*ClientFactory) NewContainerAppsRevisionsClient added in v1.1.0

func (c *ClientFactory) NewContainerAppsRevisionsClient() *ContainerAppsRevisionsClient

func (*ClientFactory) NewContainerAppsSourceControlsClient added in v1.1.0

func (c *ClientFactory) NewContainerAppsSourceControlsClient() *ContainerAppsSourceControlsClient

func (*ClientFactory) NewDaprComponentsClient added in v1.1.0

func (c *ClientFactory) NewDaprComponentsClient() *DaprComponentsClient

func (*ClientFactory) NewManagedEnvironmentsClient added in v1.1.0

func (c *ClientFactory) NewManagedEnvironmentsClient() *ManagedEnvironmentsClient

func (*ClientFactory) NewManagedEnvironmentsStoragesClient added in v1.1.0

func (c *ClientFactory) NewManagedEnvironmentsStoragesClient() *ManagedEnvironmentsStoragesClient

func (*ClientFactory) NewNamespacesClient added in v1.1.0

func (c *ClientFactory) NewNamespacesClient() *NamespacesClient

func (*ClientFactory) NewOperationsClient added in v1.1.0

func (c *ClientFactory) NewOperationsClient() *OperationsClient

type ClientRegistration

type ClientRegistration struct {
	// The Client ID of the app used for login.
	ClientID *string `json:"clientId,omitempty"`

	// The app setting name that contains the client secret.
	ClientSecretSettingName *string `json:"clientSecretSettingName,omitempty"`
}

ClientRegistration - The configuration settings of the app registration for providers that have client ids and client secrets

func (ClientRegistration) MarshalJSON added in v1.1.0

func (c ClientRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClientRegistration.

func (*ClientRegistration) UnmarshalJSON added in v1.1.0

func (c *ClientRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientRegistration.

type Configuration

type Configuration struct {
	// ActiveRevisionsMode controls how active revisions are handled for the Container app:Multiple: multiple revisions can be
	// active.Single: Only one revision can be active at a time. Revision weights can
	// not be used in this mode. If no value if provided, this is the default.
	ActiveRevisionsMode *ActiveRevisionsMode `json:"activeRevisionsMode,omitempty"`

	// Dapr configuration for the Container App.
	Dapr *Dapr `json:"dapr,omitempty"`

	// Ingress configurations.
	Ingress *Ingress `json:"ingress,omitempty"`

	// Collection of private container registry credentials for containers used by the Container app
	Registries []*RegistryCredentials `json:"registries,omitempty"`

	// Collection of secrets used by a Container app
	Secrets []*Secret `json:"secrets,omitempty"`
}

Configuration - Non versioned Container App configuration properties that define the mutable settings of a Container app

func (Configuration) MarshalJSON

func (c Configuration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Configuration.

func (*Configuration) UnmarshalJSON added in v1.1.0

func (c *Configuration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Configuration.

type Container

type Container struct {
	// Container start command arguments.
	Args []*string `json:"args,omitempty"`

	// Container start command.
	Command []*string `json:"command,omitempty"`

	// Container environment variables.
	Env []*EnvironmentVar `json:"env,omitempty"`

	// Container image tag.
	Image *string `json:"image,omitempty"`

	// Custom container name.
	Name *string `json:"name,omitempty"`

	// List of probes for the container.
	Probes []*ContainerAppProbe `json:"probes,omitempty"`

	// Container resource requirements.
	Resources *ContainerResources `json:"resources,omitempty"`

	// Container volume mounts.
	VolumeMounts []*VolumeMount `json:"volumeMounts,omitempty"`
}

Container App container definition.

func (Container) MarshalJSON

func (c Container) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Container.

func (*Container) UnmarshalJSON added in v1.1.0

func (c *Container) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Container.

type ContainerApp

type ContainerApp struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials
	// in code.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// ContainerApp resource specific properties
	Properties *ContainerAppProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ContainerApp - Container App.

func (ContainerApp) MarshalJSON

func (c ContainerApp) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerApp.

func (*ContainerApp) UnmarshalJSON added in v1.1.0

func (c *ContainerApp) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerApp.

type ContainerAppCollection

type ContainerAppCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ContainerApp `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ContainerAppCollection - Container App collection ARM resource.

func (ContainerAppCollection) MarshalJSON added in v1.1.0

func (c ContainerAppCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppCollection.

func (*ContainerAppCollection) UnmarshalJSON added in v1.1.0

func (c *ContainerAppCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppCollection.

type ContainerAppProbe

type ContainerAppProbe struct {
	// Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value
	// is 1. Maximum value is 10.
	FailureThreshold *int32 `json:"failureThreshold,omitempty"`

	// HTTPGet specifies the http request to perform.
	HTTPGet *ContainerAppProbeHTTPGet `json:"httpGet,omitempty"`

	// Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value
	// is 60.
	InitialDelaySeconds *int32 `json:"initialDelaySeconds,omitempty"`

	// How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
	PeriodSeconds *int32 `json:"periodSeconds,omitempty"`

	// Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for
	// liveness and startup. Minimum value is 1. Maximum value is 10.
	SuccessThreshold *int32 `json:"successThreshold,omitempty"`

	// TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
	TCPSocket *ContainerAppProbeTCPSocket `json:"tcpSocket,omitempty"`

	// Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration
	// in seconds after the processes running in the pod are sent a termination signal
	// and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup
	// time for your process. If this value is nil, the pod's
	// terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must
	// be non-negative integer. The value zero indicates stop immediately via the
	// kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature
	// gate. Maximum value is 3600 seconds (1 hour)
	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`

	// Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
	TimeoutSeconds *int32 `json:"timeoutSeconds,omitempty"`

	// The type of probe.
	Type *Type `json:"type,omitempty"`
}

ContainerAppProbe - Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

func (ContainerAppProbe) MarshalJSON added in v1.1.0

func (c ContainerAppProbe) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbe.

func (*ContainerAppProbe) UnmarshalJSON added in v1.1.0

func (c *ContainerAppProbe) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppProbe.

type ContainerAppProbeHTTPGet

type ContainerAppProbeHTTPGet struct {
	// REQUIRED; Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an
	// IANASVCNAME.
	Port *int32 `json:"port,omitempty"`

	// Custom headers to set in the request. HTTP allows repeated headers.
	HTTPHeaders []*ContainerAppProbeHTTPGetHTTPHeadersItem `json:"httpHeaders,omitempty"`

	// Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
	Host *string `json:"host,omitempty"`

	// Path to access on the HTTP server.
	Path *string `json:"path,omitempty"`

	// Scheme to use for connecting to the host. Defaults to HTTP.
	Scheme *Scheme `json:"scheme,omitempty"`
}

ContainerAppProbeHTTPGet - HTTPGet specifies the http request to perform.

func (ContainerAppProbeHTTPGet) MarshalJSON

func (c ContainerAppProbeHTTPGet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbeHTTPGet.

func (*ContainerAppProbeHTTPGet) UnmarshalJSON added in v1.1.0

func (c *ContainerAppProbeHTTPGet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppProbeHTTPGet.

type ContainerAppProbeHTTPGetHTTPHeadersItem

type ContainerAppProbeHTTPGetHTTPHeadersItem struct {
	// REQUIRED; The header field name
	Name *string `json:"name,omitempty"`

	// REQUIRED; The header field value
	Value *string `json:"value,omitempty"`
}

ContainerAppProbeHTTPGetHTTPHeadersItem - HTTPHeader describes a custom header to be used in HTTP probes

func (ContainerAppProbeHTTPGetHTTPHeadersItem) MarshalJSON added in v1.1.0

func (c ContainerAppProbeHTTPGetHTTPHeadersItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbeHTTPGetHTTPHeadersItem.

func (*ContainerAppProbeHTTPGetHTTPHeadersItem) UnmarshalJSON added in v1.1.0

func (c *ContainerAppProbeHTTPGetHTTPHeadersItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppProbeHTTPGetHTTPHeadersItem.

type ContainerAppProbeTCPSocket

type ContainerAppProbeTCPSocket struct {
	// REQUIRED; Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an
	// IANASVCNAME.
	Port *int32 `json:"port,omitempty"`

	// Optional: Host name to connect to, defaults to the pod IP.
	Host *string `json:"host,omitempty"`
}

ContainerAppProbeTCPSocket - TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

func (ContainerAppProbeTCPSocket) MarshalJSON added in v1.1.0

func (c ContainerAppProbeTCPSocket) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbeTCPSocket.

func (*ContainerAppProbeTCPSocket) UnmarshalJSON added in v1.1.0

func (c *ContainerAppProbeTCPSocket) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppProbeTCPSocket.

type ContainerAppProperties

type ContainerAppProperties struct {
	// Non versioned Container App configuration properties.
	Configuration *Configuration `json:"configuration,omitempty"`

	// Resource ID of the Container App's environment.
	ManagedEnvironmentID *string `json:"managedEnvironmentId,omitempty"`

	// Container App versioned application definition.
	Template *Template `json:"template,omitempty"`

	// READ-ONLY; Id used to verify domain name ownership
	CustomDomainVerificationID *string `json:"customDomainVerificationId,omitempty" azure:"ro"`

	// READ-ONLY; Fully Qualified Domain Name of the latest revision of the Container App.
	LatestRevisionFqdn *string `json:"latestRevisionFqdn,omitempty" azure:"ro"`

	// READ-ONLY; Name of the latest revision of the Container App.
	LatestRevisionName *string `json:"latestRevisionName,omitempty" azure:"ro"`

	// READ-ONLY; Outbound IP Addresses for container app.
	OutboundIPAddresses []*string `json:"outboundIPAddresses,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the Container App.
	ProvisioningState *ContainerAppProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ContainerAppProperties - ContainerApp resource specific properties

func (ContainerAppProperties) MarshalJSON

func (c ContainerAppProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppProperties.

func (*ContainerAppProperties) UnmarshalJSON added in v1.1.0

func (c *ContainerAppProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppProperties.

type ContainerAppProvisioningState

type ContainerAppProvisioningState string

ContainerAppProvisioningState - Provisioning state of the Container App.

const (
	ContainerAppProvisioningStateCanceled   ContainerAppProvisioningState = "Canceled"
	ContainerAppProvisioningStateFailed     ContainerAppProvisioningState = "Failed"
	ContainerAppProvisioningStateInProgress ContainerAppProvisioningState = "InProgress"
	ContainerAppProvisioningStateSucceeded  ContainerAppProvisioningState = "Succeeded"
)

func PossibleContainerAppProvisioningStateValues

func PossibleContainerAppProvisioningStateValues() []ContainerAppProvisioningState

PossibleContainerAppProvisioningStateValues returns the possible values for the ContainerAppProvisioningState const type.

type ContainerAppSecret

type ContainerAppSecret struct {
	// READ-ONLY; Secret Name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Secret Value.
	Value *string `json:"value,omitempty" azure:"ro"`
}

ContainerAppSecret - Container App Secret.

func (ContainerAppSecret) MarshalJSON added in v1.1.0

func (c ContainerAppSecret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAppSecret.

func (*ContainerAppSecret) UnmarshalJSON added in v1.1.0

func (c *ContainerAppSecret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppSecret.

type ContainerAppsAuthConfigsClient

type ContainerAppsAuthConfigsClient struct {
	// contains filtered or unexported fields
}

ContainerAppsAuthConfigsClient contains the methods for the ContainerAppsAuthConfigs group. Don't use this type directly, use NewContainerAppsAuthConfigsClient() instead.

func NewContainerAppsAuthConfigsClient

func NewContainerAppsAuthConfigsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsAuthConfigsClient, error)

NewContainerAppsAuthConfigsClient creates a new instance of ContainerAppsAuthConfigsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsAuthConfigsClient) CreateOrUpdate

func (client *ContainerAppsAuthConfigsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerAppName string, authConfigName string, authConfigEnvelope AuthConfig, options *ContainerAppsAuthConfigsClientCreateOrUpdateOptions) (ContainerAppsAuthConfigsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update the AuthConfig for a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • authConfigName - Name of the Container App AuthConfig.
  • authConfigEnvelope - Properties used to create a Container App AuthConfig
  • options - ContainerAppsAuthConfigsClientCreateOrUpdateOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/AuthConfigs_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsAuthConfigsClient().CreateOrUpdate(ctx, "workerapps-rg-xj", "testcanadacentral", "current", armappcontainers.AuthConfig{
		Properties: &armappcontainers.AuthConfigProperties{
			GlobalValidation: &armappcontainers.GlobalValidation{
				UnauthenticatedClientAction: to.Ptr(armappcontainers.UnauthenticatedClientActionV2AllowAnonymous),
			},
			IdentityProviders: &armappcontainers.IdentityProviders{
				Facebook: &armappcontainers.Facebook{
					Registration: &armappcontainers.AppRegistration{
						AppID:                to.Ptr("123"),
						AppSecretSettingName: to.Ptr("facebook-secret"),
					},
				},
			},
			Platform: &armappcontainers.AuthPlatform{
				Enabled: to.Ptr(true),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthConfig = armappcontainers.AuthConfig{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.App/containerapps/authconfigs"),
	// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/authconfigs/current"),
	// 	Properties: &armappcontainers.AuthConfigProperties{
	// 		GlobalValidation: &armappcontainers.GlobalValidation{
	// 			UnauthenticatedClientAction: to.Ptr(armappcontainers.UnauthenticatedClientActionV2AllowAnonymous),
	// 		},
	// 		IdentityProviders: &armappcontainers.IdentityProviders{
	// 			Facebook: &armappcontainers.Facebook{
	// 				Registration: &armappcontainers.AppRegistration{
	// 					AppID: to.Ptr("123"),
	// 					AppSecretSettingName: to.Ptr("facebook-secret"),
	// 				},
	// 			},
	// 		},
	// 		Platform: &armappcontainers.AuthPlatform{
	// 			Enabled: to.Ptr(true),
	// 		},
	// 	},
	// }
}
Output:

func (*ContainerAppsAuthConfigsClient) Delete

func (client *ContainerAppsAuthConfigsClient) Delete(ctx context.Context, resourceGroupName string, containerAppName string, authConfigName string, options *ContainerAppsAuthConfigsClientDeleteOptions) (ContainerAppsAuthConfigsClientDeleteResponse, error)

Delete - Delete a Container App AuthConfig. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • authConfigName - Name of the Container App AuthConfig.
  • options - ContainerAppsAuthConfigsClientDeleteOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/AuthConfigs_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewContainerAppsAuthConfigsClient().Delete(ctx, "workerapps-rg-xj", "testcanadacentral", "current", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*ContainerAppsAuthConfigsClient) Get

func (client *ContainerAppsAuthConfigsClient) Get(ctx context.Context, resourceGroupName string, containerAppName string, authConfigName string, options *ContainerAppsAuthConfigsClientGetOptions) (ContainerAppsAuthConfigsClientGetResponse, error)

Get - Get a AuthConfig of a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • authConfigName - Name of the Container App AuthConfig.
  • options - ContainerAppsAuthConfigsClientGetOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/AuthConfigs_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsAuthConfigsClient().Get(ctx, "workerapps-rg-xj", "testcanadacentral", "current", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthConfig = armappcontainers.AuthConfig{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.App/containerapps/authconfigs"),
	// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/authconfigs/current"),
	// 	Properties: &armappcontainers.AuthConfigProperties{
	// 		GlobalValidation: &armappcontainers.GlobalValidation{
	// 			UnauthenticatedClientAction: to.Ptr(armappcontainers.UnauthenticatedClientActionV2AllowAnonymous),
	// 		},
	// 		IdentityProviders: &armappcontainers.IdentityProviders{
	// 			Facebook: &armappcontainers.Facebook{
	// 				Registration: &armappcontainers.AppRegistration{
	// 					AppID: to.Ptr("123"),
	// 					AppSecretSettingName: to.Ptr("facebook-secret"),
	// 				},
	// 			},
	// 		},
	// 		Platform: &armappcontainers.AuthPlatform{
	// 			Enabled: to.Ptr(true),
	// 		},
	// 	},
	// }
}
Output:

func (*ContainerAppsAuthConfigsClient) NewListByContainerAppPager

NewListByContainerAppPager - Get the Container App AuthConfigs in a given resource group.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • options - ContainerAppsAuthConfigsClientListByContainerAppOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.NewListByContainerAppPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/AuthConfigs_ListByContainer.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainerAppsAuthConfigsClient().NewListByContainerAppPager("workerapps-rg-xj", "testcanadacentral", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AuthConfigCollection = armappcontainers.AuthConfigCollection{
		// 	Value: []*armappcontainers.AuthConfig{
		// 		{
		// 			Name: to.Ptr("current"),
		// 			Type: to.Ptr("Microsoft.App/containerapps/authconfigs"),
		// 			ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/authconfigs/current"),
		// 			Properties: &armappcontainers.AuthConfigProperties{
		// 				GlobalValidation: &armappcontainers.GlobalValidation{
		// 					UnauthenticatedClientAction: to.Ptr(armappcontainers.UnauthenticatedClientActionV2AllowAnonymous),
		// 				},
		// 				IdentityProviders: &armappcontainers.IdentityProviders{
		// 					Facebook: &armappcontainers.Facebook{
		// 						Registration: &armappcontainers.AppRegistration{
		// 							AppID: to.Ptr("123"),
		// 							AppSecretSettingName: to.Ptr("facebook-secret"),
		// 						},
		// 					},
		// 				},
		// 				Platform: &armappcontainers.AuthPlatform{
		// 					Enabled: to.Ptr(true),
		// 				},
		// 			},
		// 	}},
		// }
	}
}
Output:

type ContainerAppsAuthConfigsClientCreateOrUpdateOptions

type ContainerAppsAuthConfigsClientCreateOrUpdateOptions struct {
}

ContainerAppsAuthConfigsClientCreateOrUpdateOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.CreateOrUpdate method.

type ContainerAppsAuthConfigsClientCreateOrUpdateResponse

type ContainerAppsAuthConfigsClientCreateOrUpdateResponse struct {
	AuthConfig
}

ContainerAppsAuthConfigsClientCreateOrUpdateResponse contains the response from method ContainerAppsAuthConfigsClient.CreateOrUpdate.

type ContainerAppsAuthConfigsClientDeleteOptions

type ContainerAppsAuthConfigsClientDeleteOptions struct {
}

ContainerAppsAuthConfigsClientDeleteOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.Delete method.

type ContainerAppsAuthConfigsClientDeleteResponse

type ContainerAppsAuthConfigsClientDeleteResponse struct {
}

ContainerAppsAuthConfigsClientDeleteResponse contains the response from method ContainerAppsAuthConfigsClient.Delete.

type ContainerAppsAuthConfigsClientGetOptions

type ContainerAppsAuthConfigsClientGetOptions struct {
}

ContainerAppsAuthConfigsClientGetOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.Get method.

type ContainerAppsAuthConfigsClientGetResponse

type ContainerAppsAuthConfigsClientGetResponse struct {
	AuthConfig
}

ContainerAppsAuthConfigsClientGetResponse contains the response from method ContainerAppsAuthConfigsClient.Get.

type ContainerAppsAuthConfigsClientListByContainerAppOptions

type ContainerAppsAuthConfigsClientListByContainerAppOptions struct {
}

ContainerAppsAuthConfigsClientListByContainerAppOptions contains the optional parameters for the ContainerAppsAuthConfigsClient.NewListByContainerAppPager method.

type ContainerAppsAuthConfigsClientListByContainerAppResponse

type ContainerAppsAuthConfigsClientListByContainerAppResponse struct {
	AuthConfigCollection
}

ContainerAppsAuthConfigsClientListByContainerAppResponse contains the response from method ContainerAppsAuthConfigsClient.NewListByContainerAppPager.

type ContainerAppsClient

type ContainerAppsClient struct {
	// contains filtered or unexported fields
}

ContainerAppsClient contains the methods for the ContainerApps group. Don't use this type directly, use NewContainerAppsClient() instead.

func NewContainerAppsClient

func NewContainerAppsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsClient, error)

NewContainerAppsClient creates a new instance of ContainerAppsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsClient) BeginCreateOrUpdate

func (client *ContainerAppsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, containerAppName string, containerAppEnvelope ContainerApp, options *ContainerAppsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContainerAppsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • containerAppEnvelope - Properties used to create a container app
  • options - ContainerAppsClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainerAppsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainerAppsClient().BeginCreateOrUpdate(ctx, "rg", "testcontainerApp0", armappcontainers.ContainerApp{
		Location: to.Ptr("East US"),
		Properties: &armappcontainers.ContainerAppProperties{
			Configuration: &armappcontainers.Configuration{
				Dapr: &armappcontainers.Dapr{
					AppPort:     to.Ptr[int32](3000),
					AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
					Enabled:     to.Ptr(true),
				},
				Ingress: &armappcontainers.Ingress{
					CustomDomains: []*armappcontainers.CustomDomain{
						{
							Name:          to.Ptr("www.my-name.com"),
							BindingType:   to.Ptr(armappcontainers.BindingTypeSniEnabled),
							CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
						},
						{
							Name:          to.Ptr("www.my-other-name.com"),
							BindingType:   to.Ptr(armappcontainers.BindingTypeSniEnabled),
							CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
						}},
					External:   to.Ptr(true),
					TargetPort: to.Ptr[int32](3000),
					Traffic: []*armappcontainers.TrafficWeight{
						{
							Label:        to.Ptr("production"),
							RevisionName: to.Ptr("testcontainerApp0-ab1234"),
							Weight:       to.Ptr[int32](100),
						}},
				},
			},
			ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
			Template: &armappcontainers.Template{
				Containers: []*armappcontainers.Container{
					{
						Name:  to.Ptr("testcontainerApp0"),
						Image: to.Ptr("repo/testcontainerApp0:v1"),
						Probes: []*armappcontainers.ContainerAppProbe{
							{
								Type: to.Ptr(armappcontainers.TypeLiveness),
								HTTPGet: &armappcontainers.ContainerAppProbeHTTPGet{
									Path: to.Ptr("/health"),
									HTTPHeaders: []*armappcontainers.ContainerAppProbeHTTPGetHTTPHeadersItem{
										{
											Name:  to.Ptr("Custom-Header"),
											Value: to.Ptr("Awesome"),
										}},
									Port: to.Ptr[int32](8080),
								},
								InitialDelaySeconds: to.Ptr[int32](3),
								PeriodSeconds:       to.Ptr[int32](3),
							}},
					}},
				Scale: &armappcontainers.Scale{
					MaxReplicas: to.Ptr[int32](5),
					MinReplicas: to.Ptr[int32](1),
					Rules: []*armappcontainers.ScaleRule{
						{
							Name: to.Ptr("httpscalingrule"),
							Custom: &armappcontainers.CustomScaleRule{
								Type: to.Ptr("http"),
								Metadata: map[string]*string{
									"concurrentRequests": to.Ptr("50"),
								},
							},
						}},
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ContainerApp = armappcontainers.ContainerApp{
	// 	Name: to.Ptr("testcontainerApp0"),
	// 	Type: to.Ptr("Microsoft.App/containerApps"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappcontainers.ContainerAppProperties{
	// 		Configuration: &armappcontainers.Configuration{
	// 			Dapr: &armappcontainers.Dapr{
	// 				AppPort: to.Ptr[int32](3000),
	// 				AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
	// 				Enabled: to.Ptr(true),
	// 			},
	// 			Ingress: &armappcontainers.Ingress{
	// 				CustomDomains: []*armappcontainers.CustomDomain{
	// 					{
	// 						Name: to.Ptr("www.my-name.com"),
	// 						BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
	// 						CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
	// 					},
	// 					{
	// 						Name: to.Ptr("www.my-other-name.com"),
	// 						BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
	// 						CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
	// 				}},
	// 				External: to.Ptr(true),
	// 				Fqdn: to.Ptr("testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 				TargetPort: to.Ptr[int32](3000),
	// 				Traffic: []*armappcontainers.TrafficWeight{
	// 					{
	// 						RevisionName: to.Ptr("testcontainerApp0-ab1234"),
	// 						Weight: to.Ptr[int32](80),
	// 					},
	// 					{
	// 						Label: to.Ptr("staging"),
	// 						RevisionName: to.Ptr("testcontainerApp0-ab4321"),
	// 						Weight: to.Ptr[int32](20),
	// 				}},
	// 				Transport: to.Ptr(armappcontainers.IngressTransportMethodAuto),
	// 			},
	// 		},
	// 		LatestRevisionFqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 		ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 		ProvisioningState: to.Ptr(armappcontainers.ContainerAppProvisioningStateSucceeded),
	// 		Template: &armappcontainers.Template{
	// 			Containers: []*armappcontainers.Container{
	// 				{
	// 					Name: to.Ptr("testcontainerApp0"),
	// 					Image: to.Ptr("repo/testcontainerApp0:v4"),
	// 					Probes: []*armappcontainers.ContainerAppProbe{
	// 						{
	// 							Type: to.Ptr(armappcontainers.TypeLiveness),
	// 							HTTPGet: &armappcontainers.ContainerAppProbeHTTPGet{
	// 								Path: to.Ptr("/health"),
	// 								HTTPHeaders: []*armappcontainers.ContainerAppProbeHTTPGetHTTPHeadersItem{
	// 									{
	// 										Name: to.Ptr("Custom-Header"),
	// 										Value: to.Ptr("Awesome"),
	// 								}},
	// 								Port: to.Ptr[int32](8080),
	// 							},
	// 							InitialDelaySeconds: to.Ptr[int32](3),
	// 							PeriodSeconds: to.Ptr[int32](3),
	// 					}},
	// 					Resources: &armappcontainers.ContainerResources{
	// 						CPU: to.Ptr[float64](0.2),
	// 						Memory: to.Ptr("100Mi"),
	// 					},
	// 			}},
	// 			Scale: &armappcontainers.Scale{
	// 				MaxReplicas: to.Ptr[int32](5),
	// 				MinReplicas: to.Ptr[int32](1),
	// 				Rules: []*armappcontainers.ScaleRule{
	// 					{
	// 						Name: to.Ptr("httpscalingrule"),
	// 						HTTP: &armappcontainers.HTTPScaleRule{
	// 							Metadata: map[string]*string{
	// 								"concurrentRequests": to.Ptr("50"),
	// 							},
	// 						},
	// 				}},
	// 			},
	// 		},
	// 	},
	// }
}
Output:

func (*ContainerAppsClient) BeginDelete

func (client *ContainerAppsClient) BeginDelete(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientBeginDeleteOptions) (*runtime.Poller[ContainerAppsClientDeleteResponse], error)

BeginDelete - Delete a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • options - ContainerAppsClientBeginDeleteOptions contains the optional parameters for the ContainerAppsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainerAppsClient().BeginDelete(ctx, "rg", "testWorkerApp0", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*ContainerAppsClient) BeginUpdate

func (client *ContainerAppsClient) BeginUpdate(ctx context.Context, resourceGroupName string, containerAppName string, containerAppEnvelope ContainerApp, options *ContainerAppsClientBeginUpdateOptions) (*runtime.Poller[ContainerAppsClientUpdateResponse], error)

BeginUpdate - Patches a Container App using JSON Merge Patch If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • containerAppEnvelope - Properties of a Container App that need to be updated
  • options - ContainerAppsClientBeginUpdateOptions contains the optional parameters for the ContainerAppsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainerAppsClient().BeginUpdate(ctx, "rg", "testcontainerApp0", armappcontainers.ContainerApp{
		Location: to.Ptr("East US"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		Properties: &armappcontainers.ContainerAppProperties{
			Configuration: &armappcontainers.Configuration{
				Dapr: &armappcontainers.Dapr{
					AppPort:     to.Ptr[int32](3000),
					AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
					Enabled:     to.Ptr(true),
				},
				Ingress: &armappcontainers.Ingress{
					CustomDomains: []*armappcontainers.CustomDomain{
						{
							Name:          to.Ptr("www.my-name.com"),
							BindingType:   to.Ptr(armappcontainers.BindingTypeSniEnabled),
							CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
						},
						{
							Name:          to.Ptr("www.my-other-name.com"),
							BindingType:   to.Ptr(armappcontainers.BindingTypeSniEnabled),
							CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
						}},
					External:   to.Ptr(true),
					TargetPort: to.Ptr[int32](3000),
					Traffic: []*armappcontainers.TrafficWeight{
						{
							Label:        to.Ptr("production"),
							RevisionName: to.Ptr("testcontainerApp0-ab1234"),
							Weight:       to.Ptr[int32](100),
						}},
				},
			},
			Template: &armappcontainers.Template{
				Containers: []*armappcontainers.Container{
					{
						Name:  to.Ptr("testcontainerApp0"),
						Image: to.Ptr("repo/testcontainerApp0:v1"),
						Probes: []*armappcontainers.ContainerAppProbe{
							{
								Type: to.Ptr(armappcontainers.TypeLiveness),
								HTTPGet: &armappcontainers.ContainerAppProbeHTTPGet{
									Path: to.Ptr("/health"),
									HTTPHeaders: []*armappcontainers.ContainerAppProbeHTTPGetHTTPHeadersItem{
										{
											Name:  to.Ptr("Custom-Header"),
											Value: to.Ptr("Awesome"),
										}},
									Port: to.Ptr[int32](8080),
								},
								InitialDelaySeconds: to.Ptr[int32](3),
								PeriodSeconds:       to.Ptr[int32](3),
							}},
					}},
				Scale: &armappcontainers.Scale{
					MaxReplicas: to.Ptr[int32](5),
					MinReplicas: to.Ptr[int32](1),
					Rules: []*armappcontainers.ScaleRule{
						{
							Name: to.Ptr("httpscalingrule"),
							Custom: &armappcontainers.CustomScaleRule{
								Type: to.Ptr("http"),
								Metadata: map[string]*string{
									"concurrentRequests": to.Ptr("50"),
								},
							},
						}},
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*ContainerAppsClient) Get

func (client *ContainerAppsClient) Get(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientGetOptions) (ContainerAppsClientGetResponse, error)

Get - Get the properties of a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • options - ContainerAppsClientGetOptions contains the optional parameters for the ContainerAppsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsClient().Get(ctx, "rg", "testcontainerApp0", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ContainerApp = armappcontainers.ContainerApp{
	// 	Name: to.Ptr("testcontainerApp0"),
	// 	Type: to.Ptr("Microsoft.App/containerApps"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappcontainers.ContainerAppProperties{
	// 		Configuration: &armappcontainers.Configuration{
	// 			Dapr: &armappcontainers.Dapr{
	// 				AppPort: to.Ptr[int32](3000),
	// 				AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
	// 				Enabled: to.Ptr(true),
	// 			},
	// 			Ingress: &armappcontainers.Ingress{
	// 				CustomDomains: []*armappcontainers.CustomDomain{
	// 					{
	// 						Name: to.Ptr("www.my-name.com"),
	// 						BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
	// 						CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
	// 					},
	// 					{
	// 						Name: to.Ptr("www.my--other-name.com"),
	// 						BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
	// 						CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
	// 				}},
	// 				External: to.Ptr(true),
	// 				Fqdn: to.Ptr("testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 				TargetPort: to.Ptr[int32](3000),
	// 				Traffic: []*armappcontainers.TrafficWeight{
	// 					{
	// 						RevisionName: to.Ptr("testcontainerApp0-ab1234"),
	// 						Weight: to.Ptr[int32](80),
	// 					},
	// 					{
	// 						Label: to.Ptr("staging"),
	// 						RevisionName: to.Ptr("testcontainerApp0-ab4321"),
	// 						Weight: to.Ptr[int32](20),
	// 				}},
	// 				Transport: to.Ptr(armappcontainers.IngressTransportMethodAuto),
	// 			},
	// 		},
	// 		LatestRevisionFqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 		ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 		ProvisioningState: to.Ptr(armappcontainers.ContainerAppProvisioningStateSucceeded),
	// 		Template: &armappcontainers.Template{
	// 			Containers: []*armappcontainers.Container{
	// 				{
	// 					Name: to.Ptr("testcontainerApp0"),
	// 					Image: to.Ptr("repo/testcontainerApp0:v4"),
	// 					Resources: &armappcontainers.ContainerResources{
	// 						CPU: to.Ptr[float64](0.2),
	// 						Memory: to.Ptr("100Mi"),
	// 					},
	// 			}},
	// 			Scale: &armappcontainers.Scale{
	// 				MaxReplicas: to.Ptr[int32](5),
	// 				MinReplicas: to.Ptr[int32](1),
	// 				Rules: []*armappcontainers.ScaleRule{
	// 					{
	// 						Name: to.Ptr("httpscalingrule"),
	// 						HTTP: &armappcontainers.HTTPScaleRule{
	// 							Metadata: map[string]*string{
	// 								"concurrentRequests": to.Ptr("50"),
	// 							},
	// 						},
	// 				}},
	// 			},
	// 		},
	// 	},
	// }
}
Output:

func (*ContainerAppsClient) ListCustomHostNameAnalysis

func (client *ContainerAppsClient) ListCustomHostNameAnalysis(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientListCustomHostNameAnalysisOptions) (ContainerAppsClientListCustomHostNameAnalysisResponse, error)

ListCustomHostNameAnalysis - Analyzes a custom hostname for a Container App If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • options - ContainerAppsClientListCustomHostNameAnalysisOptions contains the optional parameters for the ContainerAppsClient.ListCustomHostNameAnalysis method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysis.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsClient().ListCustomHostNameAnalysis(ctx, "rg", "testcontainerApp0", &armappcontainers.ContainerAppsClientListCustomHostNameAnalysisOptions{CustomHostname: to.Ptr("my.name.corp")})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomHostnameAnalysisResult = armappcontainers.CustomHostnameAnalysisResult{
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0"),
	// 	Properties: &armappcontainers.CustomHostnameAnalysisResultProperties{
	// 		ARecords: []*string{
	// 			to.Ptr("aRecord1"),
	// 			to.Ptr("aRecord2")},
	// 			AlternateCNameRecords: []*string{
	// 				to.Ptr("cNameRecord1"),
	// 				to.Ptr("cNameRecord2")},
	// 				AlternateTxtRecords: []*string{
	// 					to.Ptr("txtRecord1"),
	// 					to.Ptr("txtRecord2")},
	// 					CNameRecords: []*string{
	// 						to.Ptr("cNameRecord1"),
	// 						to.Ptr("cNameRecord2")},
	// 						ConflictingContainerAppResourceID: to.Ptr(""),
	// 						CustomDomainVerificationFailureInfo: &armappcontainers.DefaultErrorResponse{
	// 						},
	// 						CustomDomainVerificationTest: to.Ptr(armappcontainers.DNSVerificationTestResultPassed),
	// 						HasConflictOnManagedEnvironment: to.Ptr(false),
	// 						HostName: to.Ptr("my.name.corp"),
	// 						IsHostnameAlreadyVerified: to.Ptr(true),
	// 						TxtRecords: []*string{
	// 							to.Ptr("txtRecord1"),
	// 							to.Ptr("txtRecord2")},
	// 						},
	// 					}
}
Output:

func (*ContainerAppsClient) ListSecrets

func (client *ContainerAppsClient) ListSecrets(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientListSecretsOptions) (ContainerAppsClientListSecretsResponse, error)

ListSecrets - List secrets for a container app If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • options - ContainerAppsClientListSecretsOptions contains the optional parameters for the ContainerAppsClient.ListSecrets method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListSecrets.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsClient().ListSecrets(ctx, "rg", "testcontainerApp0", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SecretsCollection = armappcontainers.SecretsCollection{
	// 	Value: []*armappcontainers.ContainerAppSecret{
	// 		{
	// 			Name: to.Ptr("secret1"),
	// 		},
	// 		{
	// 			Name: to.Ptr("secret2"),
	// 	}},
	// }
}
Output:

func (*ContainerAppsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Get the Container Apps in a given resource group.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ContainerAppsClientListByResourceGroupOptions contains the optional parameters for the ContainerAppsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainerAppsClient().NewListByResourceGroupPager("rg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContainerAppCollection = armappcontainers.ContainerAppCollection{
		// 	Value: []*armappcontainers.ContainerApp{
		// 		{
		// 			Name: to.Ptr("testcontainerApp0"),
		// 			Type: to.Ptr("Microsoft.App/containerApps"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armappcontainers.ContainerAppProperties{
		// 				Configuration: &armappcontainers.Configuration{
		// 					Dapr: &armappcontainers.Dapr{
		// 						AppPort: to.Ptr[int32](3000),
		// 						AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
		// 						Enabled: to.Ptr(true),
		// 					},
		// 					Ingress: &armappcontainers.Ingress{
		// 						CustomDomains: []*armappcontainers.CustomDomain{
		// 							{
		// 								Name: to.Ptr("www.my-name.com"),
		// 								BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
		// 								CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
		// 							},
		// 							{
		// 								Name: to.Ptr("www.my--other-name.com"),
		// 								BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
		// 								CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
		// 						}},
		// 						External: to.Ptr(true),
		// 						Fqdn: to.Ptr("testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 						TargetPort: to.Ptr[int32](3000),
		// 						Traffic: []*armappcontainers.TrafficWeight{
		// 							{
		// 								RevisionName: to.Ptr("testcontainerApp0-ab1234"),
		// 								Weight: to.Ptr[int32](80),
		// 							},
		// 							{
		// 								Label: to.Ptr("staging"),
		// 								RevisionName: to.Ptr("testcontainerApp0-ab4321"),
		// 								Weight: to.Ptr[int32](20),
		// 						}},
		// 						Transport: to.Ptr(armappcontainers.IngressTransportMethodAuto),
		// 					},
		// 				},
		// 				LatestRevisionFqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 				ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		// 				ProvisioningState: to.Ptr(armappcontainers.ContainerAppProvisioningStateSucceeded),
		// 				Template: &armappcontainers.Template{
		// 					Containers: []*armappcontainers.Container{
		// 						{
		// 							Name: to.Ptr("testcontainerApp0"),
		// 							Image: to.Ptr("repo/testcontainerApp0:v4"),
		// 							Resources: &armappcontainers.ContainerResources{
		// 								CPU: to.Ptr[float64](0.2),
		// 								Memory: to.Ptr("100Mi"),
		// 							},
		// 					}},
		// 					Scale: &armappcontainers.Scale{
		// 						MaxReplicas: to.Ptr[int32](5),
		// 						MinReplicas: to.Ptr[int32](1),
		// 						Rules: []*armappcontainers.ScaleRule{
		// 							{
		// 								Name: to.Ptr("httpscalingrule"),
		// 								HTTP: &armappcontainers.HTTPScaleRule{
		// 									Metadata: map[string]*string{
		// 										"concurrentRequests": to.Ptr("50"),
		// 									},
		// 								},
		// 						}},
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*ContainerAppsClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Get the Container Apps in a given subscription.

Generated from API version 2022-03-01

  • options - ContainerAppsClientListBySubscriptionOptions contains the optional parameters for the ContainerAppsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainerAppsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContainerAppCollection = armappcontainers.ContainerAppCollection{
		// 	Value: []*armappcontainers.ContainerApp{
		// 		{
		// 			Name: to.Ptr("testcontainerApp0"),
		// 			Type: to.Ptr("Microsoft.App/containerApps"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armappcontainers.ContainerAppProperties{
		// 				Configuration: &armappcontainers.Configuration{
		// 					Dapr: &armappcontainers.Dapr{
		// 						AppPort: to.Ptr[int32](3000),
		// 						AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
		// 						Enabled: to.Ptr(true),
		// 					},
		// 					Ingress: &armappcontainers.Ingress{
		// 						CustomDomains: []*armappcontainers.CustomDomain{
		// 							{
		// 								Name: to.Ptr("www.my-name.com"),
		// 								BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
		// 								CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
		// 							},
		// 							{
		// 								Name: to.Ptr("www.my--other-name.com"),
		// 								BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
		// 								CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
		// 						}},
		// 						External: to.Ptr(true),
		// 						Fqdn: to.Ptr("testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 						TargetPort: to.Ptr[int32](3000),
		// 						Traffic: []*armappcontainers.TrafficWeight{
		// 							{
		// 								RevisionName: to.Ptr("testcontainerApp0-ab1234"),
		// 								Weight: to.Ptr[int32](80),
		// 							},
		// 							{
		// 								Label: to.Ptr("staging"),
		// 								RevisionName: to.Ptr("testcontainerApp0-ab4321"),
		// 								Weight: to.Ptr[int32](20),
		// 						}},
		// 						Transport: to.Ptr(armappcontainers.IngressTransportMethodAuto),
		// 					},
		// 				},
		// 				LatestRevisionFqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 				ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		// 				ProvisioningState: to.Ptr(armappcontainers.ContainerAppProvisioningStateSucceeded),
		// 				Template: &armappcontainers.Template{
		// 					Containers: []*armappcontainers.Container{
		// 						{
		// 							Name: to.Ptr("testcontainerApp0"),
		// 							Image: to.Ptr("repo/testcontainerApp0:v4"),
		// 							Resources: &armappcontainers.ContainerResources{
		// 								CPU: to.Ptr[float64](0.2),
		// 								Memory: to.Ptr("100Mi"),
		// 							},
		// 					}},
		// 					Scale: &armappcontainers.Scale{
		// 						MaxReplicas: to.Ptr[int32](5),
		// 						MinReplicas: to.Ptr[int32](1),
		// 						Rules: []*armappcontainers.ScaleRule{
		// 							{
		// 								Name: to.Ptr("httpscalingrule"),
		// 								HTTP: &armappcontainers.HTTPScaleRule{
		// 									Metadata: map[string]*string{
		// 										"concurrentRequests": to.Ptr("50"),
		// 									},
		// 								},
		// 						}},
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}
Output:

type ContainerAppsClientBeginCreateOrUpdateOptions

type ContainerAppsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainerAppsClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainerAppsClient.BeginCreateOrUpdate method.

type ContainerAppsClientBeginDeleteOptions

type ContainerAppsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainerAppsClientBeginDeleteOptions contains the optional parameters for the ContainerAppsClient.BeginDelete method.

type ContainerAppsClientBeginUpdateOptions

type ContainerAppsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainerAppsClientBeginUpdateOptions contains the optional parameters for the ContainerAppsClient.BeginUpdate method.

type ContainerAppsClientCreateOrUpdateResponse

type ContainerAppsClientCreateOrUpdateResponse struct {
	ContainerApp
}

ContainerAppsClientCreateOrUpdateResponse contains the response from method ContainerAppsClient.BeginCreateOrUpdate.

type ContainerAppsClientDeleteResponse

type ContainerAppsClientDeleteResponse struct {
}

ContainerAppsClientDeleteResponse contains the response from method ContainerAppsClient.BeginDelete.

type ContainerAppsClientGetOptions

type ContainerAppsClientGetOptions struct {
}

ContainerAppsClientGetOptions contains the optional parameters for the ContainerAppsClient.Get method.

type ContainerAppsClientGetResponse

type ContainerAppsClientGetResponse struct {
	ContainerApp
}

ContainerAppsClientGetResponse contains the response from method ContainerAppsClient.Get.

type ContainerAppsClientListByResourceGroupOptions

type ContainerAppsClientListByResourceGroupOptions struct {
}

ContainerAppsClientListByResourceGroupOptions contains the optional parameters for the ContainerAppsClient.NewListByResourceGroupPager method.

type ContainerAppsClientListByResourceGroupResponse

type ContainerAppsClientListByResourceGroupResponse struct {
	ContainerAppCollection
}

ContainerAppsClientListByResourceGroupResponse contains the response from method ContainerAppsClient.NewListByResourceGroupPager.

type ContainerAppsClientListBySubscriptionOptions

type ContainerAppsClientListBySubscriptionOptions struct {
}

ContainerAppsClientListBySubscriptionOptions contains the optional parameters for the ContainerAppsClient.NewListBySubscriptionPager method.

type ContainerAppsClientListBySubscriptionResponse

type ContainerAppsClientListBySubscriptionResponse struct {
	ContainerAppCollection
}

ContainerAppsClientListBySubscriptionResponse contains the response from method ContainerAppsClient.NewListBySubscriptionPager.

type ContainerAppsClientListCustomHostNameAnalysisOptions

type ContainerAppsClientListCustomHostNameAnalysisOptions struct {
	// Custom hostname.
	CustomHostname *string
}

ContainerAppsClientListCustomHostNameAnalysisOptions contains the optional parameters for the ContainerAppsClient.ListCustomHostNameAnalysis method.

type ContainerAppsClientListCustomHostNameAnalysisResponse

type ContainerAppsClientListCustomHostNameAnalysisResponse struct {
	CustomHostnameAnalysisResult
}

ContainerAppsClientListCustomHostNameAnalysisResponse contains the response from method ContainerAppsClient.ListCustomHostNameAnalysis.

type ContainerAppsClientListSecretsOptions

type ContainerAppsClientListSecretsOptions struct {
}

ContainerAppsClientListSecretsOptions contains the optional parameters for the ContainerAppsClient.ListSecrets method.

type ContainerAppsClientListSecretsResponse

type ContainerAppsClientListSecretsResponse struct {
	SecretsCollection
}

ContainerAppsClientListSecretsResponse contains the response from method ContainerAppsClient.ListSecrets.

type ContainerAppsClientUpdateResponse

type ContainerAppsClientUpdateResponse struct {
}

ContainerAppsClientUpdateResponse contains the response from method ContainerAppsClient.BeginUpdate.

type ContainerAppsRevisionReplicasClient

type ContainerAppsRevisionReplicasClient struct {
	// contains filtered or unexported fields
}

ContainerAppsRevisionReplicasClient contains the methods for the ContainerAppsRevisionReplicas group. Don't use this type directly, use NewContainerAppsRevisionReplicasClient() instead.

func NewContainerAppsRevisionReplicasClient

func NewContainerAppsRevisionReplicasClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsRevisionReplicasClient, error)

NewContainerAppsRevisionReplicasClient creates a new instance of ContainerAppsRevisionReplicasClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsRevisionReplicasClient) GetReplica

GetReplica - Get a replica for a Container App Revision. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • revisionName - Name of the Container App Revision.
  • replicaName - Name of the Container App Revision Replica.
  • options - ContainerAppsRevisionReplicasClientGetReplicaOptions contains the optional parameters for the ContainerAppsRevisionReplicasClient.GetReplica method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Replicas_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsRevisionReplicasClient().GetReplica(ctx, "workerapps-rg-xj", "myapp", "myapp--0wlqy09", "myapp--0wlqy09-5d9774cff-5wnd8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Replica = armappcontainers.Replica{
	// 	Name: to.Ptr("myapp--0wlqy09-5d9774cff-5wnd8"),
	// 	Type: to.Ptr("Microsoft.Web/containerapps/revisions/replicas"),
	// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8"),
	// 	Properties: &armappcontainers.ReplicaProperties{
	// 		Containers: []*armappcontainers.ReplicaContainer{
	// 			{
	// 				Name: to.Ptr("hello92"),
	// 				ContainerID: to.Ptr("containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54"),
	// 				Ready: to.Ptr(true),
	// 				RestartCount: to.Ptr[int32](0),
	// 				Started: to.Ptr(true),
	// 		}},
	// 		CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-25T19:42:45Z"); return t}()),
	// 	},
	// }
}
Output:

func (*ContainerAppsRevisionReplicasClient) ListReplicas

ListReplicas - List replicas for a Container App Revision. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • revisionName - Name of the Container App Revision.
  • options - ContainerAppsRevisionReplicasClientListReplicasOptions contains the optional parameters for the ContainerAppsRevisionReplicasClient.ListReplicas method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Replicas_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsRevisionReplicasClient().ListReplicas(ctx, "workerapps-rg-xj", "myapp", "myapp--0wlqy09", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReplicaCollection = armappcontainers.ReplicaCollection{
	// 	Value: []*armappcontainers.Replica{
	// 		{
	// 			Name: to.Ptr("myapp--0wlqy09-5d9774cff-5wnd8"),
	// 			Type: to.Ptr("Microsoft.Web/containerapps/revisions/replicas"),
	// 			ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8"),
	// 			Properties: &armappcontainers.ReplicaProperties{
	// 				Containers: []*armappcontainers.ReplicaContainer{
	// 					{
	// 						Name: to.Ptr("hello92"),
	// 						ContainerID: to.Ptr("containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54"),
	// 						Ready: to.Ptr(true),
	// 						RestartCount: to.Ptr[int32](0),
	// 						Started: to.Ptr(true),
	// 				}},
	// 				CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-25T19:42:45Z"); return t}()),
	// 			},
	// 	}},
	// }
}
Output:

type ContainerAppsRevisionReplicasClientGetReplicaOptions

type ContainerAppsRevisionReplicasClientGetReplicaOptions struct {
}

ContainerAppsRevisionReplicasClientGetReplicaOptions contains the optional parameters for the ContainerAppsRevisionReplicasClient.GetReplica method.

type ContainerAppsRevisionReplicasClientGetReplicaResponse

type ContainerAppsRevisionReplicasClientGetReplicaResponse struct {
	Replica
}

ContainerAppsRevisionReplicasClientGetReplicaResponse contains the response from method ContainerAppsRevisionReplicasClient.GetReplica.

type ContainerAppsRevisionReplicasClientListReplicasOptions

type ContainerAppsRevisionReplicasClientListReplicasOptions struct {
}

ContainerAppsRevisionReplicasClientListReplicasOptions contains the optional parameters for the ContainerAppsRevisionReplicasClient.ListReplicas method.

type ContainerAppsRevisionReplicasClientListReplicasResponse

type ContainerAppsRevisionReplicasClientListReplicasResponse struct {
	ReplicaCollection
}

ContainerAppsRevisionReplicasClientListReplicasResponse contains the response from method ContainerAppsRevisionReplicasClient.ListReplicas.

type ContainerAppsRevisionsClient

type ContainerAppsRevisionsClient struct {
	// contains filtered or unexported fields
}

ContainerAppsRevisionsClient contains the methods for the ContainerAppsRevisions group. Don't use this type directly, use NewContainerAppsRevisionsClient() instead.

func NewContainerAppsRevisionsClient

func NewContainerAppsRevisionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsRevisionsClient, error)

NewContainerAppsRevisionsClient creates a new instance of ContainerAppsRevisionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsRevisionsClient) ActivateRevision

ActivateRevision - Activates a revision for a Container App If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • revisionName - Name of the Container App Revision.
  • options - ContainerAppsRevisionsClientActivateRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.ActivateRevision method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Revisions_Activate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewContainerAppsRevisionsClient().ActivateRevision(ctx, "rg", "testcontainerApp0", "testcontainerApp0-pjxhsye", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*ContainerAppsRevisionsClient) DeactivateRevision

DeactivateRevision - Deactivates a revision for a Container App If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • revisionName - Name of the Container App Revision.
  • options - ContainerAppsRevisionsClientDeactivateRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.DeactivateRevision method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Revisions_Deactivate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewContainerAppsRevisionsClient().DeactivateRevision(ctx, "rg", "testcontainerApp0", "testcontainerApp0-pjxhsye", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*ContainerAppsRevisionsClient) GetRevision

func (client *ContainerAppsRevisionsClient) GetRevision(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, options *ContainerAppsRevisionsClientGetRevisionOptions) (ContainerAppsRevisionsClientGetRevisionResponse, error)

GetRevision - Get a revision of a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • revisionName - Name of the Container App Revision.
  • options - ContainerAppsRevisionsClientGetRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.GetRevision method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Revisions_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsRevisionsClient().GetRevision(ctx, "rg", "testcontainerApp0", "testcontainerApp0-pjxhsye", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Revision = armappcontainers.Revision{
	// 	Name: to.Ptr("testcontainerApp0-pjxhsye"),
	// 	Type: to.Ptr("Microsoft.App/containerApps/revisions"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppcontainerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye"),
	// 	Properties: &armappcontainers.RevisionProperties{
	// 		Active: to.Ptr(true),
	// 		CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-24T21:24:22+00:00"); return t}()),
	// 		Fqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
	// 		Replicas: to.Ptr[int32](1),
	// 		Template: &armappcontainers.Template{
	// 			Containers: []*armappcontainers.Container{
	// 				{
	// 					Name: to.Ptr("testcontainerApp0"),
	// 					Image: to.Ptr("repo/testcontainerApp0:v2"),
	// 					Resources: &armappcontainers.ContainerResources{
	// 						CPU: to.Ptr[float64](0.2),
	// 						Memory: to.Ptr("100Mi"),
	// 					},
	// 			}},
	// 			Scale: &armappcontainers.Scale{
	// 				MaxReplicas: to.Ptr[int32](5),
	// 				MinReplicas: to.Ptr[int32](1),
	// 				Rules: []*armappcontainers.ScaleRule{
	// 					{
	// 						Name: to.Ptr("httpscalingrule"),
	// 						HTTP: &armappcontainers.HTTPScaleRule{
	// 							Metadata: map[string]*string{
	// 								"concurrentRequests": to.Ptr("50"),
	// 							},
	// 						},
	// 				}},
	// 			},
	// 		},
	// 	},
	// }
}
Output:

func (*ContainerAppsRevisionsClient) NewListRevisionsPager

NewListRevisionsPager - Get the Revisions for a given Container App.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App for which Revisions are needed.
  • options - ContainerAppsRevisionsClientListRevisionsOptions contains the optional parameters for the ContainerAppsRevisionsClient.NewListRevisionsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Revisions_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainerAppsRevisionsClient().NewListRevisionsPager("rg", "testcontainerApp0", &armappcontainers.ContainerAppsRevisionsClientListRevisionsOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RevisionCollection = armappcontainers.RevisionCollection{
		// 	Value: []*armappcontainers.Revision{
		// 		{
		// 			Name: to.Ptr("testcontainerApp0-pjxhsye"),
		// 			Type: to.Ptr("Microsoft.App/containerApps/revisions"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye"),
		// 			Properties: &armappcontainers.RevisionProperties{
		// 				Active: to.Ptr(true),
		// 				CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-24T21:24:22+00:00"); return t}()),
		// 				Fqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerapps.k4apps.io"),
		// 				Replicas: to.Ptr[int32](1),
		// 				Template: &armappcontainers.Template{
		// 					Containers: []*armappcontainers.Container{
		// 						{
		// 							Name: to.Ptr("testcontainerApp0"),
		// 							Image: to.Ptr("repo/testcontainerApp0:v2"),
		// 							Resources: &armappcontainers.ContainerResources{
		// 								CPU: to.Ptr[float64](0.2),
		// 								Memory: to.Ptr("100Mi"),
		// 							},
		// 					}},
		// 					Scale: &armappcontainers.Scale{
		// 						MaxReplicas: to.Ptr[int32](5),
		// 						MinReplicas: to.Ptr[int32](1),
		// 						Rules: []*armappcontainers.ScaleRule{
		// 							{
		// 								Name: to.Ptr("httpscalingrule"),
		// 								HTTP: &armappcontainers.HTTPScaleRule{
		// 									Metadata: map[string]*string{
		// 										"concurrentRequests": to.Ptr("50"),
		// 									},
		// 								},
		// 						}},
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*ContainerAppsRevisionsClient) RestartRevision

RestartRevision - Restarts a revision for a Container App If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • revisionName - Name of the Container App Revision.
  • options - ContainerAppsRevisionsClientRestartRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.RestartRevision method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Revisions_Restart.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewContainerAppsRevisionsClient().RestartRevision(ctx, "rg", "testStaticSite0", "testcontainerApp0-pjxhsye", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

type ContainerAppsRevisionsClientActivateRevisionOptions

type ContainerAppsRevisionsClientActivateRevisionOptions struct {
}

ContainerAppsRevisionsClientActivateRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.ActivateRevision method.

type ContainerAppsRevisionsClientActivateRevisionResponse

type ContainerAppsRevisionsClientActivateRevisionResponse struct {
}

ContainerAppsRevisionsClientActivateRevisionResponse contains the response from method ContainerAppsRevisionsClient.ActivateRevision.

type ContainerAppsRevisionsClientDeactivateRevisionOptions

type ContainerAppsRevisionsClientDeactivateRevisionOptions struct {
}

ContainerAppsRevisionsClientDeactivateRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.DeactivateRevision method.

type ContainerAppsRevisionsClientDeactivateRevisionResponse

type ContainerAppsRevisionsClientDeactivateRevisionResponse struct {
}

ContainerAppsRevisionsClientDeactivateRevisionResponse contains the response from method ContainerAppsRevisionsClient.DeactivateRevision.

type ContainerAppsRevisionsClientGetRevisionOptions

type ContainerAppsRevisionsClientGetRevisionOptions struct {
}

ContainerAppsRevisionsClientGetRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.GetRevision method.

type ContainerAppsRevisionsClientGetRevisionResponse

type ContainerAppsRevisionsClientGetRevisionResponse struct {
	Revision
}

ContainerAppsRevisionsClientGetRevisionResponse contains the response from method ContainerAppsRevisionsClient.GetRevision.

type ContainerAppsRevisionsClientListRevisionsOptions

type ContainerAppsRevisionsClientListRevisionsOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

ContainerAppsRevisionsClientListRevisionsOptions contains the optional parameters for the ContainerAppsRevisionsClient.NewListRevisionsPager method.

type ContainerAppsRevisionsClientListRevisionsResponse

type ContainerAppsRevisionsClientListRevisionsResponse struct {
	RevisionCollection
}

ContainerAppsRevisionsClientListRevisionsResponse contains the response from method ContainerAppsRevisionsClient.NewListRevisionsPager.

type ContainerAppsRevisionsClientRestartRevisionOptions

type ContainerAppsRevisionsClientRestartRevisionOptions struct {
}

ContainerAppsRevisionsClientRestartRevisionOptions contains the optional parameters for the ContainerAppsRevisionsClient.RestartRevision method.

type ContainerAppsRevisionsClientRestartRevisionResponse

type ContainerAppsRevisionsClientRestartRevisionResponse struct {
}

ContainerAppsRevisionsClientRestartRevisionResponse contains the response from method ContainerAppsRevisionsClient.RestartRevision.

type ContainerAppsSourceControlsClient

type ContainerAppsSourceControlsClient struct {
	// contains filtered or unexported fields
}

ContainerAppsSourceControlsClient contains the methods for the ContainerAppsSourceControls group. Don't use this type directly, use NewContainerAppsSourceControlsClient() instead.

func NewContainerAppsSourceControlsClient

func NewContainerAppsSourceControlsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsSourceControlsClient, error)

NewContainerAppsSourceControlsClient creates a new instance of ContainerAppsSourceControlsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsSourceControlsClient) BeginCreateOrUpdate

func (client *ContainerAppsSourceControlsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, containerAppName string, sourceControlName string, sourceControlEnvelope SourceControl, options *ContainerAppsSourceControlsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContainerAppsSourceControlsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update the SourceControl for a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • sourceControlName - Name of the Container App SourceControl.
  • sourceControlEnvelope - Properties used to create a Container App SourceControl
  • options - ContainerAppsSourceControlsClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainerAppsSourceControlsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/SourceControls_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainerAppsSourceControlsClient().BeginCreateOrUpdate(ctx, "workerapps-rg-xj", "testcanadacentral", "current", armappcontainers.SourceControl{
		Properties: &armappcontainers.SourceControlProperties{
			Branch: to.Ptr("master"),
			GithubActionConfiguration: &armappcontainers.GithubActionConfiguration{
				AzureCredentials: &armappcontainers.AzureCredentials{
					ClientID:     to.Ptr("<clientid>"),
					ClientSecret: to.Ptr("<clientsecret>"),
					TenantID:     to.Ptr("<tenantid>"),
				},
				ContextPath: to.Ptr("./"),
				Image:       to.Ptr("image/tag"),
				RegistryInfo: &armappcontainers.RegistryInfo{
					RegistryPassword: to.Ptr("<registrypassword>"),
					RegistryURL:      to.Ptr("xwang971reg.azurecr.io"),
					RegistryUserName: to.Ptr("xwang971reg"),
				},
			},
			RepoURL: to.Ptr("https://github.com/xwang971/ghatest"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SourceControl = armappcontainers.SourceControl{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.App/containerapps/sourcecontrols"),
	// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/current"),
	// 	Properties: &armappcontainers.SourceControlProperties{
	// 		Branch: to.Ptr("master"),
	// 		GithubActionConfiguration: &armappcontainers.GithubActionConfiguration{
	// 			ContextPath: to.Ptr("./"),
	// 			Image: to.Ptr("image/tag"),
	// 			RegistryInfo: &armappcontainers.RegistryInfo{
	// 				RegistryURL: to.Ptr("xwang971reg.azurecr.io"),
	// 				RegistryUserName: to.Ptr("xwang971reg"),
	// 			},
	// 		},
	// 		OperationState: to.Ptr(armappcontainers.SourceControlOperationStateInProgress),
	// 		RepoURL: to.Ptr("https://github.com/xwang971/ghatest"),
	// 	},
	// }
}
Output:

func (*ContainerAppsSourceControlsClient) BeginDelete

BeginDelete - Delete a Container App SourceControl. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • sourceControlName - Name of the Container App SourceControl.
  • options - ContainerAppsSourceControlsClientBeginDeleteOptions contains the optional parameters for the ContainerAppsSourceControlsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/SourceControls_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewContainerAppsSourceControlsClient().BeginDelete(ctx, "workerapps-rg-xj", "testcanadacentral", "current", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*ContainerAppsSourceControlsClient) Get

Get - Get a SourceControl of a Container App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • sourceControlName - Name of the Container App SourceControl.
  • options - ContainerAppsSourceControlsClientGetOptions contains the optional parameters for the ContainerAppsSourceControlsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/SourceControls_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsSourceControlsClient().Get(ctx, "workerapps-rg-xj", "testcanadacentral", "current", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SourceControl = armappcontainers.SourceControl{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.App/containerapps/sourcecontrols"),
	// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/sourcecontrols/current"),
	// 	Properties: &armappcontainers.SourceControlProperties{
	// 		Branch: to.Ptr("master"),
	// 		GithubActionConfiguration: &armappcontainers.GithubActionConfiguration{
	// 			ContextPath: to.Ptr("./"),
	// 			Image: to.Ptr("image/tag"),
	// 			RegistryInfo: &armappcontainers.RegistryInfo{
	// 				RegistryURL: to.Ptr("xwang971reg.azurecr.io"),
	// 				RegistryUserName: to.Ptr("xwang971reg"),
	// 			},
	// 		},
	// 		RepoURL: to.Ptr("https://github.com/xwang971/ghatest"),
	// 	},
	// }
}
Output:

func (*ContainerAppsSourceControlsClient) NewListByContainerAppPager

NewListByContainerAppPager - Get the Container App SourceControls in a given resource group.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • options - ContainerAppsSourceControlsClientListByContainerAppOptions contains the optional parameters for the ContainerAppsSourceControlsClient.NewListByContainerAppPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/SourceControls_ListByContainer.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainerAppsSourceControlsClient().NewListByContainerAppPager("workerapps-rg-xj", "testcanadacentral", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SourceControlCollection = armappcontainers.SourceControlCollection{
		// 	Value: []*armappcontainers.SourceControl{
		// 		{
		// 			Name: to.Ptr("current"),
		// 			Type: to.Ptr("Microsoft.App/containerapps/sourcecontrols"),
		// 			ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/sourcecontrols/current"),
		// 			Properties: &armappcontainers.SourceControlProperties{
		// 				Branch: to.Ptr("master"),
		// 				GithubActionConfiguration: &armappcontainers.GithubActionConfiguration{
		// 					ContextPath: to.Ptr("./"),
		// 					Image: to.Ptr("image/tag"),
		// 					RegistryInfo: &armappcontainers.RegistryInfo{
		// 						RegistryURL: to.Ptr("xwang971reg.azurecr.io"),
		// 						RegistryUserName: to.Ptr("xwang971reg"),
		// 					},
		// 				},
		// 				RepoURL: to.Ptr("https://github.com/xwang971/ghatest"),
		// 			},
		// 	}},
		// }
	}
}
Output:

type ContainerAppsSourceControlsClientBeginCreateOrUpdateOptions

type ContainerAppsSourceControlsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainerAppsSourceControlsClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainerAppsSourceControlsClient.BeginCreateOrUpdate method.

type ContainerAppsSourceControlsClientBeginDeleteOptions

type ContainerAppsSourceControlsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContainerAppsSourceControlsClientBeginDeleteOptions contains the optional parameters for the ContainerAppsSourceControlsClient.BeginDelete method.

type ContainerAppsSourceControlsClientCreateOrUpdateResponse

type ContainerAppsSourceControlsClientCreateOrUpdateResponse struct {
	SourceControl
}

ContainerAppsSourceControlsClientCreateOrUpdateResponse contains the response from method ContainerAppsSourceControlsClient.BeginCreateOrUpdate.

type ContainerAppsSourceControlsClientDeleteResponse

type ContainerAppsSourceControlsClientDeleteResponse struct {
}

ContainerAppsSourceControlsClientDeleteResponse contains the response from method ContainerAppsSourceControlsClient.BeginDelete.

type ContainerAppsSourceControlsClientGetOptions

type ContainerAppsSourceControlsClientGetOptions struct {
}

ContainerAppsSourceControlsClientGetOptions contains the optional parameters for the ContainerAppsSourceControlsClient.Get method.

type ContainerAppsSourceControlsClientGetResponse

type ContainerAppsSourceControlsClientGetResponse struct {
	SourceControl
}

ContainerAppsSourceControlsClientGetResponse contains the response from method ContainerAppsSourceControlsClient.Get.

type ContainerAppsSourceControlsClientListByContainerAppOptions

type ContainerAppsSourceControlsClientListByContainerAppOptions struct {
}

ContainerAppsSourceControlsClientListByContainerAppOptions contains the optional parameters for the ContainerAppsSourceControlsClient.NewListByContainerAppPager method.

type ContainerAppsSourceControlsClientListByContainerAppResponse

type ContainerAppsSourceControlsClientListByContainerAppResponse struct {
	SourceControlCollection
}

ContainerAppsSourceControlsClientListByContainerAppResponse contains the response from method ContainerAppsSourceControlsClient.NewListByContainerAppPager.

type ContainerResources

type ContainerResources struct {
	// Required CPU in cores, e.g. 0.5
	CPU *float64 `json:"cpu,omitempty"`

	// Required memory, e.g. "250Mb"
	Memory *string `json:"memory,omitempty"`

	// READ-ONLY; Ephemeral Storage, e.g. "1Gi"
	EphemeralStorage *string `json:"ephemeralStorage,omitempty" azure:"ro"`
}

ContainerResources - Container App container resource requirements.

func (ContainerResources) MarshalJSON added in v1.1.0

func (c ContainerResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerResources.

func (*ContainerResources) UnmarshalJSON added in v1.1.0

func (c *ContainerResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerResources.

type CookieExpiration

type CookieExpiration struct {
	// The convention used when determining the session cookie's expiration.
	Convention *CookieExpirationConvention `json:"convention,omitempty"`

	// The time after the request is made when the session cookie should expire.
	TimeToExpiration *string `json:"timeToExpiration,omitempty"`
}

CookieExpiration - The configuration settings of the session cookie's expiration.

func (CookieExpiration) MarshalJSON added in v1.1.0

func (c CookieExpiration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CookieExpiration.

func (*CookieExpiration) UnmarshalJSON added in v1.1.0

func (c *CookieExpiration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CookieExpiration.

type CookieExpirationConvention

type CookieExpirationConvention string

CookieExpirationConvention - The convention used when determining the session cookie's expiration.

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

func PossibleCookieExpirationConventionValues

func PossibleCookieExpirationConventionValues() []CookieExpirationConvention

PossibleCookieExpirationConventionValues returns the possible values for the CookieExpirationConvention const type.

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CustomDomain

type CustomDomain struct {
	// REQUIRED; Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
	CertificateID *string `json:"certificateId,omitempty"`

	// REQUIRED; Hostname.
	Name *string `json:"name,omitempty"`

	// Custom Domain binding type.
	BindingType *BindingType `json:"bindingType,omitempty"`
}

CustomDomain - Custom Domain of a Container App

func (CustomDomain) MarshalJSON added in v1.1.0

func (c CustomDomain) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomDomain.

func (*CustomDomain) UnmarshalJSON added in v1.1.0

func (c *CustomDomain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomain.

type CustomHostnameAnalysisResult

type CustomHostnameAnalysisResult struct {
	// CustomHostnameAnalysisResult resource specific properties
	Properties *CustomHostnameAnalysisResultProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

CustomHostnameAnalysisResult - Custom domain analysis.

func (CustomHostnameAnalysisResult) MarshalJSON added in v1.1.0

func (c CustomHostnameAnalysisResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomHostnameAnalysisResult.

func (*CustomHostnameAnalysisResult) UnmarshalJSON added in v1.1.0

func (c *CustomHostnameAnalysisResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomHostnameAnalysisResult.

type CustomHostnameAnalysisResultProperties

type CustomHostnameAnalysisResultProperties struct {
	// A records visible for this hostname.
	ARecords []*string `json:"aRecords,omitempty"`

	// Alternate CName records visible for this hostname.
	AlternateCNameRecords []*string `json:"alternateCNameRecords,omitempty"`

	// Alternate TXT records visible for this hostname.
	AlternateTxtRecords []*string `json:"alternateTxtRecords,omitempty"`

	// CName records visible for this hostname.
	CNameRecords []*string `json:"cNameRecords,omitempty"`

	// TXT records visible for this hostname.
	TxtRecords []*string `json:"txtRecords,omitempty"`

	// READ-ONLY; Name of the conflicting Container App on the Managed Environment if it's within the same subscription.
	ConflictingContainerAppResourceID *string `json:"conflictingContainerAppResourceId,omitempty" azure:"ro"`

	// READ-ONLY; Raw failure information if DNS verification fails.
	CustomDomainVerificationFailureInfo *DefaultErrorResponse `json:"customDomainVerificationFailureInfo,omitempty" azure:"ro"`

	// READ-ONLY; DNS verification test result.
	CustomDomainVerificationTest *DNSVerificationTestResult `json:"customDomainVerificationTest,omitempty" azure:"ro"`

	// READ-ONLY; true if there is a conflict on the Container App's managed environment; otherwise, false.
	HasConflictOnManagedEnvironment *bool `json:"hasConflictOnManagedEnvironment,omitempty" azure:"ro"`

	// READ-ONLY; Host name that was analyzed
	HostName *string `json:"hostName,omitempty" azure:"ro"`

	// READ-ONLY; true if hostname is already verified; otherwise, false.
	IsHostnameAlreadyVerified *bool `json:"isHostnameAlreadyVerified,omitempty" azure:"ro"`
}

CustomHostnameAnalysisResultProperties - CustomHostnameAnalysisResult resource specific properties

func (CustomHostnameAnalysisResultProperties) MarshalJSON

func (c CustomHostnameAnalysisResultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomHostnameAnalysisResultProperties.

func (*CustomHostnameAnalysisResultProperties) UnmarshalJSON added in v1.1.0

func (c *CustomHostnameAnalysisResultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomHostnameAnalysisResultProperties.

type CustomOpenIDConnectProvider

type CustomOpenIDConnectProvider struct {
	// false if the custom Open ID provider provider should not be enabled; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The configuration settings of the login flow of the custom Open ID Connect provider.
	Login *OpenIDConnectLogin `json:"login,omitempty"`

	// The configuration settings of the app registration for the custom Open ID Connect provider.
	Registration *OpenIDConnectRegistration `json:"registration,omitempty"`
}

CustomOpenIDConnectProvider - The configuration settings of the custom Open ID Connect provider.

func (CustomOpenIDConnectProvider) MarshalJSON added in v1.1.0

func (c CustomOpenIDConnectProvider) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomOpenIDConnectProvider.

func (*CustomOpenIDConnectProvider) UnmarshalJSON added in v1.1.0

func (c *CustomOpenIDConnectProvider) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomOpenIDConnectProvider.

type CustomScaleRule

type CustomScaleRule struct {
	// Authentication secrets for the custom scale rule.
	Auth []*ScaleRuleAuth `json:"auth,omitempty"`

	// Metadata properties to describe custom scale rule.
	Metadata map[string]*string `json:"metadata,omitempty"`

	// Type of the custom scale rule eg: azure-servicebus, redis etc.
	Type *string `json:"type,omitempty"`
}

CustomScaleRule - Container App container Custom scaling rule.

func (CustomScaleRule) MarshalJSON

func (c CustomScaleRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomScaleRule.

func (*CustomScaleRule) UnmarshalJSON added in v1.1.0

func (c *CustomScaleRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomScaleRule.

type DNSVerificationTestResult

type DNSVerificationTestResult string

DNSVerificationTestResult - DNS verification test result.

const (
	DNSVerificationTestResultPassed  DNSVerificationTestResult = "Passed"
	DNSVerificationTestResultFailed  DNSVerificationTestResult = "Failed"
	DNSVerificationTestResultSkipped DNSVerificationTestResult = "Skipped"
)

func PossibleDNSVerificationTestResultValues

func PossibleDNSVerificationTestResultValues() []DNSVerificationTestResult

PossibleDNSVerificationTestResultValues returns the possible values for the DNSVerificationTestResult const type.

type Dapr

type Dapr struct {
	// Dapr application identifier
	AppID *string `json:"appId,omitempty"`

	// Tells Dapr which port your application is listening on
	AppPort *int32 `json:"appPort,omitempty"`

	// Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http
	AppProtocol *AppProtocol `json:"appProtocol,omitempty"`

	// Boolean indicating if the Dapr side car is enabled
	Enabled *bool `json:"enabled,omitempty"`
}

Dapr - Container App Dapr configuration.

func (Dapr) MarshalJSON added in v1.1.0

func (d Dapr) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Dapr.

func (*Dapr) UnmarshalJSON added in v1.1.0

func (d *Dapr) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Dapr.

type DaprComponent

type DaprComponent struct {
	// Dapr Component resource specific properties
	Properties *DaprComponentProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DaprComponent - Dapr Component.

func (DaprComponent) MarshalJSON added in v1.1.0

func (d DaprComponent) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaprComponent.

func (*DaprComponent) UnmarshalJSON added in v1.1.0

func (d *DaprComponent) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponent.

type DaprComponentProperties

type DaprComponentProperties struct {
	// Component type
	ComponentType *string `json:"componentType,omitempty"`

	// Boolean describing if the component errors are ignores
	IgnoreErrors *bool `json:"ignoreErrors,omitempty"`

	// Initialization timeout
	InitTimeout *string `json:"initTimeout,omitempty"`

	// Component metadata
	Metadata []*DaprMetadata `json:"metadata,omitempty"`

	// Names of container apps that can use this Dapr component
	Scopes []*string `json:"scopes,omitempty"`

	// Collection of secrets used by a Dapr component
	Secrets []*Secret `json:"secrets,omitempty"`

	// Component version
	Version *string `json:"version,omitempty"`
}

DaprComponentProperties - Dapr Component resource specific properties

func (DaprComponentProperties) MarshalJSON

func (d DaprComponentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaprComponentProperties.

func (*DaprComponentProperties) UnmarshalJSON added in v1.1.0

func (d *DaprComponentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentProperties.

type DaprComponentsClient

type DaprComponentsClient struct {
	// contains filtered or unexported fields
}

DaprComponentsClient contains the methods for the DaprComponents group. Don't use this type directly, use NewDaprComponentsClient() instead.

func NewDaprComponentsClient

func NewDaprComponentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DaprComponentsClient, error)

NewDaprComponentsClient creates a new instance of DaprComponentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DaprComponentsClient) CreateOrUpdate

func (client *DaprComponentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, componentName string, daprComponentEnvelope DaprComponent, options *DaprComponentsClientCreateOrUpdateOptions) (DaprComponentsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Dapr Component in a Managed Environment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • componentName - Name of the Dapr Component.
  • daprComponentEnvelope - Configuration details of the Dapr Component.
  • options - DaprComponentsClientCreateOrUpdateOptions contains the optional parameters for the DaprComponentsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/DaprComponents_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDaprComponentsClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "reddog", armappcontainers.DaprComponent{
		Properties: &armappcontainers.DaprComponentProperties{
			ComponentType: to.Ptr("state.azure.cosmosdb"),
			IgnoreErrors:  to.Ptr(false),
			InitTimeout:   to.Ptr("50s"),
			Metadata: []*armappcontainers.DaprMetadata{
				{
					Name:  to.Ptr("url"),
					Value: to.Ptr("<COSMOS-URL>"),
				},
				{
					Name:  to.Ptr("database"),
					Value: to.Ptr("itemsDB"),
				},
				{
					Name:  to.Ptr("collection"),
					Value: to.Ptr("items"),
				},
				{
					Name:      to.Ptr("masterkey"),
					SecretRef: to.Ptr("masterkey"),
				}},
			Scopes: []*string{
				to.Ptr("container-app-1"),
				to.Ptr("container-app-2")},
			Secrets: []*armappcontainers.Secret{
				{
					Name:  to.Ptr("masterkey"),
					Value: to.Ptr("keyvalue"),
				}},
			Version: to.Ptr("v1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DaprComponent = armappcontainers.DaprComponent{
	// 	Name: to.Ptr("reddog"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprcomponents"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog"),
	// 	Properties: &armappcontainers.DaprComponentProperties{
	// 		ComponentType: to.Ptr("state.azure.cosmosdb"),
	// 		IgnoreErrors: to.Ptr(false),
	// 		InitTimeout: to.Ptr("50s"),
	// 		Metadata: []*armappcontainers.DaprMetadata{
	// 			{
	// 				Name: to.Ptr("url"),
	// 				Value: to.Ptr("<COSMOS-URL>"),
	// 			},
	// 			{
	// 				Name: to.Ptr("database"),
	// 				Value: to.Ptr("itemsDB"),
	// 			},
	// 			{
	// 				Name: to.Ptr("collection"),
	// 				Value: to.Ptr("items"),
	// 			},
	// 			{
	// 				Name: to.Ptr("masterkey"),
	// 				SecretRef: to.Ptr("masterkey"),
	// 		}},
	// 		Scopes: []*string{
	// 			to.Ptr("container-app-1"),
	// 			to.Ptr("container-app-2")},
	// 			Secrets: []*armappcontainers.Secret{
	// 				{
	// 					Name: to.Ptr("masterkey"),
	// 			}},
	// 			Version: to.Ptr("v1"),
	// 		},
	// 	}
}
Output:

func (*DaprComponentsClient) Delete

func (client *DaprComponentsClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, componentName string, options *DaprComponentsClientDeleteOptions) (DaprComponentsClientDeleteResponse, error)

Delete - Delete a Dapr Component from a Managed Environment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • componentName - Name of the Dapr Component.
  • options - DaprComponentsClientDeleteOptions contains the optional parameters for the DaprComponentsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/DaprComponents_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewDaprComponentsClient().Delete(ctx, "examplerg", "myenvironment", "reddog", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*DaprComponentsClient) Get

func (client *DaprComponentsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, componentName string, options *DaprComponentsClientGetOptions) (DaprComponentsClientGetResponse, error)

Get - Get a dapr component. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • componentName - Name of the Dapr Component.
  • options - DaprComponentsClientGetOptions contains the optional parameters for the DaprComponentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/DaprComponents_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDaprComponentsClient().Get(ctx, "examplerg", "myenvironment", "reddog", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DaprComponent = armappcontainers.DaprComponent{
	// 	Name: to.Ptr("reddog"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprcomponents"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog"),
	// 	Properties: &armappcontainers.DaprComponentProperties{
	// 		ComponentType: to.Ptr("state.azure.cosmosdb"),
	// 		IgnoreErrors: to.Ptr(false),
	// 		InitTimeout: to.Ptr("50s"),
	// 		Metadata: []*armappcontainers.DaprMetadata{
	// 			{
	// 				Name: to.Ptr("url"),
	// 				Value: to.Ptr("<COSMOS-URL>"),
	// 			},
	// 			{
	// 				Name: to.Ptr("database"),
	// 				Value: to.Ptr("itemsDB"),
	// 			},
	// 			{
	// 				Name: to.Ptr("collection"),
	// 				Value: to.Ptr("items"),
	// 			},
	// 			{
	// 				Name: to.Ptr("masterkey"),
	// 				SecretRef: to.Ptr("masterkey"),
	// 		}},
	// 		Scopes: []*string{
	// 			to.Ptr("container-app-1"),
	// 			to.Ptr("container-app-2")},
	// 			Secrets: []*armappcontainers.Secret{
	// 				{
	// 					Name: to.Ptr("masterkey"),
	// 			}},
	// 			Version: to.Ptr("v1"),
	// 		},
	// 	}
}
Output:

func (*DaprComponentsClient) ListSecrets

func (client *DaprComponentsClient) ListSecrets(ctx context.Context, resourceGroupName string, environmentName string, componentName string, options *DaprComponentsClientListSecretsOptions) (DaprComponentsClientListSecretsResponse, error)

ListSecrets - List secrets for a dapr component If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • componentName - Name of the Dapr Component.
  • options - DaprComponentsClientListSecretsOptions contains the optional parameters for the DaprComponentsClient.ListSecrets method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/DaprComponents_ListSecrets.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDaprComponentsClient().ListSecrets(ctx, "examplerg", "myenvironment", "reddog", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DaprSecretsCollection = armappcontainers.DaprSecretsCollection{
	// 	Value: []*armappcontainers.Secret{
	// 		{
	// 			Name: to.Ptr("secret1"),
	// 		},
	// 		{
	// 			Name: to.Ptr("secret2"),
	// 	}},
	// }
}
Output:

func (*DaprComponentsClient) NewListPager

func (client *DaprComponentsClient) NewListPager(resourceGroupName string, environmentName string, options *DaprComponentsClientListOptions) *runtime.Pager[DaprComponentsClientListResponse]

NewListPager - Get the Dapr Components for a managed environment.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • options - DaprComponentsClientListOptions contains the optional parameters for the DaprComponentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/DaprComponents_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDaprComponentsClient().NewListPager("examplerg", "myenvironment", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DaprComponentsCollection = armappcontainers.DaprComponentsCollection{
		// 	Value: []*armappcontainers.DaprComponent{
		// 		{
		// 			Name: to.Ptr("reddog"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments/daprcomponents"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/reddog"),
		// 			Properties: &armappcontainers.DaprComponentProperties{
		// 				ComponentType: to.Ptr("state.azure.cosmosdb"),
		// 				IgnoreErrors: to.Ptr(false),
		// 				InitTimeout: to.Ptr("50s"),
		// 				Metadata: []*armappcontainers.DaprMetadata{
		// 					{
		// 						Name: to.Ptr("url"),
		// 						Value: to.Ptr("<COSMOS-URL>"),
		// 					},
		// 					{
		// 						Name: to.Ptr("database"),
		// 						Value: to.Ptr("itemsDB"),
		// 					},
		// 					{
		// 						Name: to.Ptr("collection"),
		// 						Value: to.Ptr("items"),
		// 					},
		// 					{
		// 						Name: to.Ptr("masterkey"),
		// 						SecretRef: to.Ptr("masterkey"),
		// 				}},
		// 				Scopes: []*string{
		// 					to.Ptr("container-app-1"),
		// 					to.Ptr("container-app-2")},
		// 					Secrets: []*armappcontainers.Secret{
		// 						{
		// 							Name: to.Ptr("masterkey"),
		// 					}},
		// 					Version: to.Ptr("v1"),
		// 				},
		// 		}},
		// 	}
	}
}
Output:

type DaprComponentsClientCreateOrUpdateOptions

type DaprComponentsClientCreateOrUpdateOptions struct {
}

DaprComponentsClientCreateOrUpdateOptions contains the optional parameters for the DaprComponentsClient.CreateOrUpdate method.

type DaprComponentsClientCreateOrUpdateResponse

type DaprComponentsClientCreateOrUpdateResponse struct {
	DaprComponent
}

DaprComponentsClientCreateOrUpdateResponse contains the response from method DaprComponentsClient.CreateOrUpdate.

type DaprComponentsClientDeleteOptions

type DaprComponentsClientDeleteOptions struct {
}

DaprComponentsClientDeleteOptions contains the optional parameters for the DaprComponentsClient.Delete method.

type DaprComponentsClientDeleteResponse

type DaprComponentsClientDeleteResponse struct {
}

DaprComponentsClientDeleteResponse contains the response from method DaprComponentsClient.Delete.

type DaprComponentsClientGetOptions

type DaprComponentsClientGetOptions struct {
}

DaprComponentsClientGetOptions contains the optional parameters for the DaprComponentsClient.Get method.

type DaprComponentsClientGetResponse

type DaprComponentsClientGetResponse struct {
	DaprComponent
}

DaprComponentsClientGetResponse contains the response from method DaprComponentsClient.Get.

type DaprComponentsClientListOptions

type DaprComponentsClientListOptions struct {
}

DaprComponentsClientListOptions contains the optional parameters for the DaprComponentsClient.NewListPager method.

type DaprComponentsClientListResponse

type DaprComponentsClientListResponse struct {
	DaprComponentsCollection
}

DaprComponentsClientListResponse contains the response from method DaprComponentsClient.NewListPager.

type DaprComponentsClientListSecretsOptions

type DaprComponentsClientListSecretsOptions struct {
}

DaprComponentsClientListSecretsOptions contains the optional parameters for the DaprComponentsClient.ListSecrets method.

type DaprComponentsClientListSecretsResponse

type DaprComponentsClientListSecretsResponse struct {
	DaprSecretsCollection
}

DaprComponentsClientListSecretsResponse contains the response from method DaprComponentsClient.ListSecrets.

type DaprComponentsCollection

type DaprComponentsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*DaprComponent `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DaprComponentsCollection - Dapr Components ARM resource.

func (DaprComponentsCollection) MarshalJSON added in v1.1.0

func (d DaprComponentsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaprComponentsCollection.

func (*DaprComponentsCollection) UnmarshalJSON added in v1.1.0

func (d *DaprComponentsCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentsCollection.

type DaprMetadata

type DaprMetadata struct {
	// Metadata property name.
	Name *string `json:"name,omitempty"`

	// Name of the Dapr Component secret from which to pull the metadata property value.
	SecretRef *string `json:"secretRef,omitempty"`

	// Metadata property value.
	Value *string `json:"value,omitempty"`
}

DaprMetadata - Dapr component metadata.

func (DaprMetadata) MarshalJSON added in v1.1.0

func (d DaprMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaprMetadata.

func (*DaprMetadata) UnmarshalJSON added in v1.1.0

func (d *DaprMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaprMetadata.

type DaprSecretsCollection

type DaprSecretsCollection struct {
	// REQUIRED; Collection of secrets used by a Dapr component
	Value []*Secret `json:"value,omitempty"`
}

DaprSecretsCollection - Dapr component Secrets Collection ARM resource.

func (DaprSecretsCollection) MarshalJSON added in v1.1.0

func (d DaprSecretsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaprSecretsCollection.

func (*DaprSecretsCollection) UnmarshalJSON added in v1.1.0

func (d *DaprSecretsCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSecretsCollection.

type DefaultAuthorizationPolicy

type DefaultAuthorizationPolicy struct {
	// The configuration settings of the Azure Active Directory allowed applications.
	AllowedApplications []*string `json:"allowedApplications,omitempty"`

	// The configuration settings of the Azure Active Directory allowed principals.
	AllowedPrincipals *AllowedPrincipals `json:"allowedPrincipals,omitempty"`
}

DefaultAuthorizationPolicy - The configuration settings of the Azure Active Directory default authorization policy.

func (DefaultAuthorizationPolicy) MarshalJSON

func (d DefaultAuthorizationPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultAuthorizationPolicy.

func (*DefaultAuthorizationPolicy) UnmarshalJSON added in v1.1.0

func (d *DefaultAuthorizationPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultAuthorizationPolicy.

type DefaultErrorResponse

type DefaultErrorResponse struct {
	// READ-ONLY; Error model.
	Error *DefaultErrorResponseError `json:"error,omitempty" azure:"ro"`
}

DefaultErrorResponse - App Service error response.

func (DefaultErrorResponse) MarshalJSON added in v1.1.0

func (d DefaultErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultErrorResponse.

func (*DefaultErrorResponse) UnmarshalJSON added in v1.1.0

func (d *DefaultErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultErrorResponse.

type DefaultErrorResponseError

type DefaultErrorResponseError struct {
	// Details or the error
	Details []*DefaultErrorResponseErrorDetailsItem `json:"details,omitempty"`

	// READ-ONLY; Standardized string to programmatically identify the error.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; More information to debug error.
	Innererror *string `json:"innererror,omitempty" azure:"ro"`

	// READ-ONLY; Detailed error description and debugging information.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; Detailed error description and debugging information.
	Target *string `json:"target,omitempty" azure:"ro"`
}

DefaultErrorResponseError - Error model.

func (DefaultErrorResponseError) MarshalJSON

func (d DefaultErrorResponseError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultErrorResponseError.

func (*DefaultErrorResponseError) UnmarshalJSON added in v1.1.0

func (d *DefaultErrorResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultErrorResponseError.

type DefaultErrorResponseErrorDetailsItem

type DefaultErrorResponseErrorDetailsItem struct {
	// READ-ONLY; Standardized string to programmatically identify the error.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Detailed error description and debugging information.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; Detailed error description and debugging information.
	Target *string `json:"target,omitempty" azure:"ro"`
}

DefaultErrorResponseErrorDetailsItem - Detailed errors.

func (DefaultErrorResponseErrorDetailsItem) MarshalJSON added in v1.1.0

func (d DefaultErrorResponseErrorDetailsItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultErrorResponseErrorDetailsItem.

func (*DefaultErrorResponseErrorDetailsItem) UnmarshalJSON added in v1.1.0

func (d *DefaultErrorResponseErrorDetailsItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultErrorResponseErrorDetailsItem.

type EnvironmentProvisioningState

type EnvironmentProvisioningState string

EnvironmentProvisioningState - Provisioning state of the Environment.

const (
	EnvironmentProvisioningStateCanceled                      EnvironmentProvisioningState = "Canceled"
	EnvironmentProvisioningStateFailed                        EnvironmentProvisioningState = "Failed"
	EnvironmentProvisioningStateInfrastructureSetupComplete   EnvironmentProvisioningState = "InfrastructureSetupComplete"
	EnvironmentProvisioningStateInfrastructureSetupInProgress EnvironmentProvisioningState = "InfrastructureSetupInProgress"
	EnvironmentProvisioningStateInitializationInProgress      EnvironmentProvisioningState = "InitializationInProgress"
	EnvironmentProvisioningStateScheduledForDelete            EnvironmentProvisioningState = "ScheduledForDelete"
	EnvironmentProvisioningStateSucceeded                     EnvironmentProvisioningState = "Succeeded"
	EnvironmentProvisioningStateUpgradeFailed                 EnvironmentProvisioningState = "UpgradeFailed"
	EnvironmentProvisioningStateUpgradeRequested              EnvironmentProvisioningState = "UpgradeRequested"
	EnvironmentProvisioningStateWaiting                       EnvironmentProvisioningState = "Waiting"
)

func PossibleEnvironmentProvisioningStateValues

func PossibleEnvironmentProvisioningStateValues() []EnvironmentProvisioningState

PossibleEnvironmentProvisioningStateValues returns the possible values for the EnvironmentProvisioningState const type.

type EnvironmentVar

type EnvironmentVar struct {
	// Environment variable name.
	Name *string `json:"name,omitempty"`

	// Name of the Container App secret from which to pull the environment variable value.
	SecretRef *string `json:"secretRef,omitempty"`

	// Non-secret environment variable value.
	Value *string `json:"value,omitempty"`
}

EnvironmentVar - Container App container environment variable.

func (EnvironmentVar) MarshalJSON added in v1.1.0

func (e EnvironmentVar) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentVar.

func (*EnvironmentVar) UnmarshalJSON added in v1.1.0

func (e *EnvironmentVar) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVar.

type Facebook

type Facebook struct {
	// false if the Facebook provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The version of the Facebook api to be used while logging in.
	GraphAPIVersion *string `json:"graphApiVersion,omitempty"`

	// The configuration settings of the login flow.
	Login *LoginScopes `json:"login,omitempty"`

	// The configuration settings of the app registration for the Facebook provider.
	Registration *AppRegistration `json:"registration,omitempty"`
}

Facebook - The configuration settings of the Facebook provider.

func (Facebook) MarshalJSON added in v1.1.0

func (f Facebook) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Facebook.

func (*Facebook) UnmarshalJSON added in v1.1.0

func (f *Facebook) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Facebook.

type ForwardProxy

type ForwardProxy struct {
	// The convention used to determine the url of the request made.
	Convention *ForwardProxyConvention `json:"convention,omitempty"`

	// The name of the header containing the host of the request.
	CustomHostHeaderName *string `json:"customHostHeaderName,omitempty"`

	// The name of the header containing the scheme of the request.
	CustomProtoHeaderName *string `json:"customProtoHeaderName,omitempty"`
}

ForwardProxy - The configuration settings of a forward proxy used to make the requests.

func (ForwardProxy) MarshalJSON added in v1.1.0

func (f ForwardProxy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForwardProxy.

func (*ForwardProxy) UnmarshalJSON added in v1.1.0

func (f *ForwardProxy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ForwardProxy.

type ForwardProxyConvention

type ForwardProxyConvention string

ForwardProxyConvention - The convention used to determine the url of the request made.

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

func PossibleForwardProxyConventionValues

func PossibleForwardProxyConventionValues() []ForwardProxyConvention

PossibleForwardProxyConventionValues returns the possible values for the ForwardProxyConvention const type.

type GitHub

type GitHub struct {
	// false if the GitHub provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The configuration settings of the login flow.
	Login *LoginScopes `json:"login,omitempty"`

	// The configuration settings of the app registration for the GitHub provider.
	Registration *ClientRegistration `json:"registration,omitempty"`
}

GitHub - The configuration settings of the GitHub provider.

func (GitHub) MarshalJSON added in v1.1.0

func (g GitHub) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GitHub.

func (*GitHub) UnmarshalJSON added in v1.1.0

func (g *GitHub) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GitHub.

type GithubActionConfiguration

type GithubActionConfiguration struct {
	// AzureCredentials configurations.
	AzureCredentials *AzureCredentials `json:"azureCredentials,omitempty"`

	// Context path
	ContextPath *string `json:"contextPath,omitempty"`

	// Image name
	Image *string `json:"image,omitempty"`

	// Operation system
	OS *string `json:"os,omitempty"`

	// Code or Image
	PublishType *string `json:"publishType,omitempty"`

	// Registry configurations.
	RegistryInfo *RegistryInfo `json:"registryInfo,omitempty"`

	// Runtime stack
	RuntimeStack *string `json:"runtimeStack,omitempty"`

	// Runtime version
	RuntimeVersion *string `json:"runtimeVersion,omitempty"`
}

GithubActionConfiguration - Configuration properties that define the mutable settings of a Container App SourceControl

func (GithubActionConfiguration) MarshalJSON added in v1.1.0

func (g GithubActionConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GithubActionConfiguration.

func (*GithubActionConfiguration) UnmarshalJSON added in v1.1.0

func (g *GithubActionConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GithubActionConfiguration.

type GlobalValidation

type GlobalValidation struct {
	// The paths for which unauthenticated flow would not be redirected to the login page.
	ExcludedPaths []*string `json:"excludedPaths,omitempty"`

	// The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple
	// providers are configured and the unauthenticated client action is set to
	// "RedirectToLoginPage".
	RedirectToProvider *string `json:"redirectToProvider,omitempty"`

	// The action to take when an unauthenticated client attempts to access the app.
	UnauthenticatedClientAction *UnauthenticatedClientActionV2 `json:"unauthenticatedClientAction,omitempty"`
}

GlobalValidation - The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.

func (GlobalValidation) MarshalJSON

func (g GlobalValidation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GlobalValidation.

func (*GlobalValidation) UnmarshalJSON added in v1.1.0

func (g *GlobalValidation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GlobalValidation.

type Google

type Google struct {
	// false if the Google provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The configuration settings of the login flow.
	Login *LoginScopes `json:"login,omitempty"`

	// The configuration settings of the app registration for the Google provider.
	Registration *ClientRegistration `json:"registration,omitempty"`

	// The configuration settings of the Azure Active Directory token validation flow.
	Validation *AllowedAudiencesValidation `json:"validation,omitempty"`
}

Google - The configuration settings of the Google provider.

func (Google) MarshalJSON added in v1.1.0

func (g Google) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Google.

func (*Google) UnmarshalJSON added in v1.1.0

func (g *Google) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Google.

type HTTPScaleRule

type HTTPScaleRule struct {
	// Authentication secrets for the custom scale rule.
	Auth []*ScaleRuleAuth `json:"auth,omitempty"`

	// Metadata properties to describe http scale rule.
	Metadata map[string]*string `json:"metadata,omitempty"`
}

HTTPScaleRule - Container App container Custom scaling rule.

func (HTTPScaleRule) MarshalJSON

func (h HTTPScaleRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPScaleRule.

func (*HTTPScaleRule) UnmarshalJSON added in v1.1.0

func (h *HTTPScaleRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPScaleRule.

type HTTPSettings

type HTTPSettings struct {
	// The configuration settings of a forward proxy used to make the requests.
	ForwardProxy *ForwardProxy `json:"forwardProxy,omitempty"`

	// false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.
	RequireHTTPS *bool `json:"requireHttps,omitempty"`

	// The configuration settings of the paths HTTP requests.
	Routes *HTTPSettingsRoutes `json:"routes,omitempty"`
}

HTTPSettings - The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.

func (HTTPSettings) MarshalJSON added in v1.1.0

func (h HTTPSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPSettings.

func (*HTTPSettings) UnmarshalJSON added in v1.1.0

func (h *HTTPSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPSettings.

type HTTPSettingsRoutes

type HTTPSettingsRoutes struct {
	// The prefix that should precede all the authentication/authorization paths.
	APIPrefix *string `json:"apiPrefix,omitempty"`
}

HTTPSettingsRoutes - The configuration settings of the paths HTTP requests.

func (HTTPSettingsRoutes) MarshalJSON added in v1.1.0

func (h HTTPSettingsRoutes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPSettingsRoutes.

func (*HTTPSettingsRoutes) UnmarshalJSON added in v1.1.0

func (h *HTTPSettingsRoutes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPSettingsRoutes.

type IdentityProviders

type IdentityProviders struct {
	// The configuration settings of the Apple provider.
	Apple *Apple `json:"apple,omitempty"`

	// The configuration settings of the Azure Active directory provider.
	AzureActiveDirectory *AzureActiveDirectory `json:"azureActiveDirectory,omitempty"`

	// The configuration settings of the Azure Static Web Apps provider.
	AzureStaticWebApps *AzureStaticWebApps `json:"azureStaticWebApps,omitempty"`

	// The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open
	// ID Connect provider.
	CustomOpenIDConnectProviders map[string]*CustomOpenIDConnectProvider `json:"customOpenIdConnectProviders,omitempty"`

	// The configuration settings of the Facebook provider.
	Facebook *Facebook `json:"facebook,omitempty"`

	// The configuration settings of the GitHub provider.
	GitHub *GitHub `json:"gitHub,omitempty"`

	// The configuration settings of the Google provider.
	Google *Google `json:"google,omitempty"`

	// The configuration settings of the Twitter provider.
	Twitter *Twitter `json:"twitter,omitempty"`
}

IdentityProviders - The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

func (IdentityProviders) MarshalJSON

func (i IdentityProviders) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityProviders.

func (*IdentityProviders) UnmarshalJSON added in v1.1.0

func (i *IdentityProviders) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityProviders.

type Ingress

type Ingress struct {
	// Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS
	// connections
	AllowInsecure *bool `json:"allowInsecure,omitempty"`

	// custom domain bindings for Container Apps' hostnames.
	CustomDomains []*CustomDomain `json:"customDomains,omitempty"`

	// Bool indicating if app exposes an external http endpoint
	External *bool `json:"external,omitempty"`

	// Target Port in containers for traffic from ingress
	TargetPort *int32 `json:"targetPort,omitempty"`

	// Traffic weights for app's revisions
	Traffic []*TrafficWeight `json:"traffic,omitempty"`

	// Ingress transport protocol
	Transport *IngressTransportMethod `json:"transport,omitempty"`

	// READ-ONLY; Hostname.
	Fqdn *string `json:"fqdn,omitempty" azure:"ro"`
}

Ingress - Container App Ingress configuration.

func (Ingress) MarshalJSON

func (i Ingress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Ingress.

func (*Ingress) UnmarshalJSON added in v1.1.0

func (i *Ingress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Ingress.

type IngressTransportMethod

type IngressTransportMethod string

IngressTransportMethod - Ingress transport protocol

const (
	IngressTransportMethodAuto  IngressTransportMethod = "auto"
	IngressTransportMethodHTTP  IngressTransportMethod = "http"
	IngressTransportMethodHTTP2 IngressTransportMethod = "http2"
)

func PossibleIngressTransportMethodValues

func PossibleIngressTransportMethodValues() []IngressTransportMethod

PossibleIngressTransportMethodValues returns the possible values for the IngressTransportMethod const type.

type JwtClaimChecks

type JwtClaimChecks struct {
	// The list of the allowed client applications.
	AllowedClientApplications []*string `json:"allowedClientApplications,omitempty"`

	// The list of the allowed groups.
	AllowedGroups []*string `json:"allowedGroups,omitempty"`
}

JwtClaimChecks - The configuration settings of the checks that should be made while validating the JWT Claims.

func (JwtClaimChecks) MarshalJSON

func (j JwtClaimChecks) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JwtClaimChecks.

func (*JwtClaimChecks) UnmarshalJSON added in v1.1.0

func (j *JwtClaimChecks) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JwtClaimChecks.

type LogAnalyticsConfiguration

type LogAnalyticsConfiguration struct {
	// Log analytics customer id
	CustomerID *string `json:"customerId,omitempty"`

	// Log analytics customer key
	SharedKey *string `json:"sharedKey,omitempty"`
}

LogAnalyticsConfiguration - Log analytics configuration

func (LogAnalyticsConfiguration) MarshalJSON added in v1.1.0

func (l LogAnalyticsConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogAnalyticsConfiguration.

func (*LogAnalyticsConfiguration) UnmarshalJSON added in v1.1.0

func (l *LogAnalyticsConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogAnalyticsConfiguration.

type Login

type Login struct {
	// External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part
	// of the URL is ignored. This is an advanced setting typically only needed by
	// Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
	AllowedExternalRedirectUrls []*string `json:"allowedExternalRedirectUrls,omitempty"`

	// The configuration settings of the session cookie's expiration.
	CookieExpiration *CookieExpiration `json:"cookieExpiration,omitempty"`

	// The configuration settings of the nonce used in the login flow.
	Nonce *Nonce `json:"nonce,omitempty"`

	// true if the fragments from the request are preserved after the login request is made; otherwise, false.
	PreserveURLFragmentsForLogins *bool `json:"preserveUrlFragmentsForLogins,omitempty"`

	// The routes that specify the endpoints used for login and logout requests.
	Routes *LoginRoutes `json:"routes,omitempty"`
}

Login - The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

func (Login) MarshalJSON

func (l Login) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Login.

func (*Login) UnmarshalJSON added in v1.1.0

func (l *Login) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Login.

type LoginRoutes

type LoginRoutes struct {
	// The endpoint at which a logout request should be made.
	LogoutEndpoint *string `json:"logoutEndpoint,omitempty"`
}

LoginRoutes - The routes that specify the endpoints used for login and logout requests.

func (LoginRoutes) MarshalJSON added in v1.1.0

func (l LoginRoutes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoginRoutes.

func (*LoginRoutes) UnmarshalJSON added in v1.1.0

func (l *LoginRoutes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoginRoutes.

type LoginScopes

type LoginScopes struct {
	// A list of the scopes that should be requested while authenticating.
	Scopes []*string `json:"scopes,omitempty"`
}

LoginScopes - The configuration settings of the login flow, including the scopes that should be requested.

func (LoginScopes) MarshalJSON

func (l LoginScopes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoginScopes.

func (*LoginScopes) UnmarshalJSON added in v1.1.0

func (l *LoginScopes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoginScopes.

type ManagedEnvironment

type ManagedEnvironment struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Managed environment resource specific properties
	Properties *ManagedEnvironmentProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ManagedEnvironment - An environment for hosting container apps

func (ManagedEnvironment) MarshalJSON

func (m ManagedEnvironment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironment.

func (*ManagedEnvironment) UnmarshalJSON added in v1.1.0

func (m *ManagedEnvironment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironment.

type ManagedEnvironmentProperties

type ManagedEnvironmentProperties struct {
	// Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics"
	// is supported
	AppLogsConfiguration *AppLogsConfiguration `json:"appLogsConfiguration,omitempty"`

	// Application Insights connection string used by Dapr to export Service to Service communication telemetry
	DaprAIConnectionString *string `json:"daprAIConnectionString,omitempty"`

	// Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
	DaprAIInstrumentationKey *string `json:"daprAIInstrumentationKey,omitempty"`

	// Vnet configuration for the environment
	VnetConfiguration *VnetConfiguration `json:"vnetConfiguration,omitempty"`

	// Whether or not this Managed Environment is zone-redundant.
	ZoneRedundant *bool `json:"zoneRedundant,omitempty"`

	// READ-ONLY; Default Domain Name for the cluster
	DefaultDomain *string `json:"defaultDomain,omitempty" azure:"ro"`

	// READ-ONLY; Any errors that occurred during deployment or deployment validation
	DeploymentErrors *string `json:"deploymentErrors,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the Environment.
	ProvisioningState *EnvironmentProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Static IP of the Environment
	StaticIP *string `json:"staticIp,omitempty" azure:"ro"`
}

ManagedEnvironmentProperties - Managed environment resource specific properties

func (ManagedEnvironmentProperties) MarshalJSON added in v1.1.0

func (m ManagedEnvironmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentProperties.

func (*ManagedEnvironmentProperties) UnmarshalJSON added in v1.1.0

func (m *ManagedEnvironmentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentProperties.

type ManagedEnvironmentStorage

type ManagedEnvironmentStorage struct {
	// Storage properties
	Properties *ManagedEnvironmentStorageProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ManagedEnvironmentStorage - Storage resource for managedEnvironment.

func (ManagedEnvironmentStorage) MarshalJSON added in v1.1.0

func (m ManagedEnvironmentStorage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentStorage.

func (*ManagedEnvironmentStorage) UnmarshalJSON added in v1.1.0

func (m *ManagedEnvironmentStorage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentStorage.

type ManagedEnvironmentStorageProperties

type ManagedEnvironmentStorageProperties struct {
	// Azure file properties
	AzureFile *AzureFileProperties `json:"azureFile,omitempty"`
}

ManagedEnvironmentStorageProperties - Storage properties

func (ManagedEnvironmentStorageProperties) MarshalJSON added in v1.1.0

func (m ManagedEnvironmentStorageProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentStorageProperties.

func (*ManagedEnvironmentStorageProperties) UnmarshalJSON added in v1.1.0

func (m *ManagedEnvironmentStorageProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentStorageProperties.

type ManagedEnvironmentStoragesCollection

type ManagedEnvironmentStoragesCollection struct {
	// REQUIRED; Collection of storage resources.
	Value []*ManagedEnvironmentStorage `json:"value,omitempty"`
}

ManagedEnvironmentStoragesCollection - Collection of Storage for Environments

func (ManagedEnvironmentStoragesCollection) MarshalJSON added in v1.1.0

func (m ManagedEnvironmentStoragesCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentStoragesCollection.

func (*ManagedEnvironmentStoragesCollection) UnmarshalJSON added in v1.1.0

func (m *ManagedEnvironmentStoragesCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentStoragesCollection.

type ManagedEnvironmentsClient

type ManagedEnvironmentsClient struct {
	// contains filtered or unexported fields
}

ManagedEnvironmentsClient contains the methods for the ManagedEnvironments group. Don't use this type directly, use NewManagedEnvironmentsClient() instead.

func NewManagedEnvironmentsClient

func NewManagedEnvironmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedEnvironmentsClient, error)

NewManagedEnvironmentsClient creates a new instance of ManagedEnvironmentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ManagedEnvironmentsClient) BeginCreateOrUpdate

func (client *ManagedEnvironmentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, environmentEnvelope ManagedEnvironment, options *ManagedEnvironmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ManagedEnvironmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a Managed Environment used to host container apps. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • environmentEnvelope - Configuration details of the Environment.
  • options - ManagedEnvironmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedEnvironmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironments_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagedEnvironmentsClient().BeginCreateOrUpdate(ctx, "examplerg", "testcontainerenv", armappcontainers.ManagedEnvironment{
		Location: to.Ptr("East US"),
		Properties: &armappcontainers.ManagedEnvironmentProperties{
			AppLogsConfiguration: &armappcontainers.AppLogsConfiguration{
				LogAnalyticsConfiguration: &armappcontainers.LogAnalyticsConfiguration{
					CustomerID: to.Ptr("string"),
					SharedKey:  to.Ptr("string"),
				},
			},
			DaprAIConnectionString: to.Ptr("InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/"),
			ZoneRedundant:          to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedEnvironment = armappcontainers.ManagedEnvironment{
	// 	Name: to.Ptr("testcontainerenv"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappcontainers.ManagedEnvironmentProperties{
	// 		AppLogsConfiguration: &armappcontainers.AppLogsConfiguration{
	// 			LogAnalyticsConfiguration: &armappcontainers.LogAnalyticsConfiguration{
	// 				CustomerID: to.Ptr("string"),
	// 			},
	// 		},
	// 		DefaultDomain: to.Ptr("testcontainerenv.k4apps.io"),
	// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 		StaticIP: to.Ptr("1.2.3.4"),
	// 		ZoneRedundant: to.Ptr(true),
	// 	},
	// }
}
Output:

func (*ManagedEnvironmentsClient) BeginDelete

BeginDelete - Delete a Managed Environment if it does not have any container apps. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • options - ManagedEnvironmentsClientBeginDeleteOptions contains the optional parameters for the ManagedEnvironmentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironments_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagedEnvironmentsClient().BeginDelete(ctx, "examplerg", "examplekenv", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*ManagedEnvironmentsClient) BeginUpdate

func (client *ManagedEnvironmentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, environmentName string, environmentEnvelope ManagedEnvironment, options *ManagedEnvironmentsClientBeginUpdateOptions) (*runtime.Poller[ManagedEnvironmentsClientUpdateResponse], error)

BeginUpdate - Patches a Managed Environment using JSON Merge Patch If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • environmentEnvelope - Configuration details of the Environment.
  • options - ManagedEnvironmentsClientBeginUpdateOptions contains the optional parameters for the ManagedEnvironmentsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironments_Patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewManagedEnvironmentsClient().BeginUpdate(ctx, "examplerg", "testcontainerenv", armappcontainers.ManagedEnvironment{
		Location: to.Ptr("East US"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*ManagedEnvironmentsClient) Get

Get - Get the properties of a Managed Environment used to host container apps. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • options - ManagedEnvironmentsClientGetOptions contains the optional parameters for the ManagedEnvironmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironments_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedEnvironmentsClient().Get(ctx, "examplerg", "jlaw-demo1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedEnvironment = armappcontainers.ManagedEnvironment{
	// 	Name: to.Ptr("jlaw-demo1"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1"),
	// 	Location: to.Ptr("North Central US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armappcontainers.ManagedEnvironmentProperties{
	// 		DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
	// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 		StaticIP: to.Ptr("20.42.33.145"),
	// 		ZoneRedundant: to.Ptr(true),
	// 	},
	// }
}
Output:

func (*ManagedEnvironmentsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Get all the Managed Environments in a resource group.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ManagedEnvironmentsClientListByResourceGroupOptions contains the optional parameters for the ManagedEnvironmentsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironments_ListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewManagedEnvironmentsClient().NewListByResourceGroupPager("examplerg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ManagedEnvironmentsCollection = armappcontainers.ManagedEnvironmentsCollection{
		// 	Value: []*armappcontainers.ManagedEnvironment{
		// 		{
		// 			Name: to.Ptr("jlaw-demo1"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1"),
		// 			Location: to.Ptr("North Central US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armappcontainers.ManagedEnvironmentProperties{
		// 				DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
		// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
		// 				StaticIP: to.Ptr("20.42.33.145"),
		// 				ZoneRedundant: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("demo1"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/demo1"),
		// 			Location: to.Ptr("North Central US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armappcontainers.ManagedEnvironmentProperties{
		// 				DefaultDomain: to.Ptr("demo1.k4apps.io"),
		// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
		// 				StaticIP: to.Ptr("52.142.21.61"),
		// 				ZoneRedundant: to.Ptr(true),
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*ManagedEnvironmentsClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Get all Managed Environments for a subscription.

Generated from API version 2022-03-01

  • options - ManagedEnvironmentsClientListBySubscriptionOptions contains the optional parameters for the ManagedEnvironmentsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironments_ListBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewManagedEnvironmentsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ManagedEnvironmentsCollection = armappcontainers.ManagedEnvironmentsCollection{
		// 	Value: []*armappcontainers.ManagedEnvironment{
		// 		{
		// 			Name: to.Ptr("jlaw-demo1"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1"),
		// 			Location: to.Ptr("North Central US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armappcontainers.ManagedEnvironmentProperties{
		// 				DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
		// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
		// 				StaticIP: to.Ptr("20.42.33.145"),
		// 				ZoneRedundant: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("demo1"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/managedEnvironments/demo1"),
		// 			Location: to.Ptr("North Central US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armappcontainers.ManagedEnvironmentProperties{
		// 				DefaultDomain: to.Ptr("demo1.k4apps.io"),
		// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
		// 				StaticIP: to.Ptr("52.142.21.61"),
		// 				ZoneRedundant: to.Ptr(true),
		// 			},
		// 	}},
		// }
	}
}
Output:

type ManagedEnvironmentsClientBeginCreateOrUpdateOptions

type ManagedEnvironmentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagedEnvironmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedEnvironmentsClient.BeginCreateOrUpdate method.

type ManagedEnvironmentsClientBeginDeleteOptions

type ManagedEnvironmentsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagedEnvironmentsClientBeginDeleteOptions contains the optional parameters for the ManagedEnvironmentsClient.BeginDelete method.

type ManagedEnvironmentsClientBeginUpdateOptions

type ManagedEnvironmentsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagedEnvironmentsClientBeginUpdateOptions contains the optional parameters for the ManagedEnvironmentsClient.BeginUpdate method.

type ManagedEnvironmentsClientCreateOrUpdateResponse

type ManagedEnvironmentsClientCreateOrUpdateResponse struct {
	ManagedEnvironment
}

ManagedEnvironmentsClientCreateOrUpdateResponse contains the response from method ManagedEnvironmentsClient.BeginCreateOrUpdate.

type ManagedEnvironmentsClientDeleteResponse

type ManagedEnvironmentsClientDeleteResponse struct {
}

ManagedEnvironmentsClientDeleteResponse contains the response from method ManagedEnvironmentsClient.BeginDelete.

type ManagedEnvironmentsClientGetOptions

type ManagedEnvironmentsClientGetOptions struct {
}

ManagedEnvironmentsClientGetOptions contains the optional parameters for the ManagedEnvironmentsClient.Get method.

type ManagedEnvironmentsClientGetResponse

type ManagedEnvironmentsClientGetResponse struct {
	ManagedEnvironment
}

ManagedEnvironmentsClientGetResponse contains the response from method ManagedEnvironmentsClient.Get.

type ManagedEnvironmentsClientListByResourceGroupOptions

type ManagedEnvironmentsClientListByResourceGroupOptions struct {
}

ManagedEnvironmentsClientListByResourceGroupOptions contains the optional parameters for the ManagedEnvironmentsClient.NewListByResourceGroupPager method.

type ManagedEnvironmentsClientListByResourceGroupResponse

type ManagedEnvironmentsClientListByResourceGroupResponse struct {
	ManagedEnvironmentsCollection
}

ManagedEnvironmentsClientListByResourceGroupResponse contains the response from method ManagedEnvironmentsClient.NewListByResourceGroupPager.

type ManagedEnvironmentsClientListBySubscriptionOptions

type ManagedEnvironmentsClientListBySubscriptionOptions struct {
}

ManagedEnvironmentsClientListBySubscriptionOptions contains the optional parameters for the ManagedEnvironmentsClient.NewListBySubscriptionPager method.

type ManagedEnvironmentsClientListBySubscriptionResponse

type ManagedEnvironmentsClientListBySubscriptionResponse struct {
	ManagedEnvironmentsCollection
}

ManagedEnvironmentsClientListBySubscriptionResponse contains the response from method ManagedEnvironmentsClient.NewListBySubscriptionPager.

type ManagedEnvironmentsClientUpdateResponse

type ManagedEnvironmentsClientUpdateResponse struct {
}

ManagedEnvironmentsClientUpdateResponse contains the response from method ManagedEnvironmentsClient.BeginUpdate.

type ManagedEnvironmentsCollection

type ManagedEnvironmentsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ManagedEnvironment `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ManagedEnvironmentsCollection - Collection of Environments

func (ManagedEnvironmentsCollection) MarshalJSON added in v1.1.0

func (m ManagedEnvironmentsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentsCollection.

func (*ManagedEnvironmentsCollection) UnmarshalJSON added in v1.1.0

func (m *ManagedEnvironmentsCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentsCollection.

type ManagedEnvironmentsStoragesClient

type ManagedEnvironmentsStoragesClient struct {
	// contains filtered or unexported fields
}

ManagedEnvironmentsStoragesClient contains the methods for the ManagedEnvironmentsStorages group. Don't use this type directly, use NewManagedEnvironmentsStoragesClient() instead.

func NewManagedEnvironmentsStoragesClient

func NewManagedEnvironmentsStoragesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedEnvironmentsStoragesClient, error)

NewManagedEnvironmentsStoragesClient creates a new instance of ManagedEnvironmentsStoragesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ManagedEnvironmentsStoragesClient) CreateOrUpdate

CreateOrUpdate - Create or update storage for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • storageName - Name of the storage.
  • storageEnvelope - Configuration details of storage.
  • options - ManagedEnvironmentsStoragesClientCreateOrUpdateOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedEnvironmentsStoragesClient().CreateOrUpdate(ctx, "examplerg", "managedEnv", "jlaw-demo1", armappcontainers.ManagedEnvironmentStorage{
		Properties: &armappcontainers.ManagedEnvironmentStorageProperties{
			AzureFile: &armappcontainers.AzureFileProperties{
				AccessMode:  to.Ptr(armappcontainers.AccessModeReadOnly),
				AccountKey:  to.Ptr("key"),
				AccountName: to.Ptr("account1"),
				ShareName:   to.Ptr("share1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedEnvironmentStorage = armappcontainers.ManagedEnvironmentStorage{
	// 	Name: to.Ptr("jlaw-demo1"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments/storages"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1"),
	// 	Properties: &armappcontainers.ManagedEnvironmentStorageProperties{
	// 		AzureFile: &armappcontainers.AzureFileProperties{
	// 			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
	// 			AccountName: to.Ptr("account1"),
	// 			ShareName: to.Ptr("share1"),
	// 		},
	// 	},
	// }
}
Output:

func (*ManagedEnvironmentsStoragesClient) Delete

Delete - Delete storage for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • storageName - Name of the storage.
  • options - ManagedEnvironmentsStoragesClientDeleteOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironmentsStorages_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewManagedEnvironmentsStoragesClient().Delete(ctx, "examplerg", "managedEnv", "jlaw-demo1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*ManagedEnvironmentsStoragesClient) Get

Get - Get storage for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • storageName - Name of the storage.
  • options - ManagedEnvironmentsStoragesClientGetOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironmentsStorages_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedEnvironmentsStoragesClient().Get(ctx, "examplerg", "managedEnv", "jlaw-demo1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedEnvironmentStorage = armappcontainers.ManagedEnvironmentStorage{
	// 	Name: to.Ptr("jlaw-demo1"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments/storages"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1"),
	// 	Properties: &armappcontainers.ManagedEnvironmentStorageProperties{
	// 		AzureFile: &armappcontainers.AzureFileProperties{
	// 			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
	// 			AccountName: to.Ptr("account1"),
	// 			ShareName: to.Ptr("share1"),
	// 		},
	// 	},
	// }
}
Output:

func (*ManagedEnvironmentsStoragesClient) List

List - Get all storages for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • options - ManagedEnvironmentsStoragesClientListOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ManagedEnvironmentsStorages_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedEnvironmentsStoragesClient().List(ctx, "examplerg", "managedEnv", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedEnvironmentStoragesCollection = armappcontainers.ManagedEnvironmentStoragesCollection{
	// 	Value: []*armappcontainers.ManagedEnvironmentStorage{
	// 		{
	// 			Name: to.Ptr("jlaw-demo1"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/storages"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1"),
	// 			Properties: &armappcontainers.ManagedEnvironmentStorageProperties{
	// 				AzureFile: &armappcontainers.AzureFileProperties{
	// 					AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
	// 					AccountName: to.Ptr("account1"),
	// 					ShareName: to.Ptr("share1"),
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type ManagedEnvironmentsStoragesClientCreateOrUpdateOptions

type ManagedEnvironmentsStoragesClientCreateOrUpdateOptions struct {
}

ManagedEnvironmentsStoragesClientCreateOrUpdateOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.CreateOrUpdate method.

type ManagedEnvironmentsStoragesClientCreateOrUpdateResponse

type ManagedEnvironmentsStoragesClientCreateOrUpdateResponse struct {
	ManagedEnvironmentStorage
}

ManagedEnvironmentsStoragesClientCreateOrUpdateResponse contains the response from method ManagedEnvironmentsStoragesClient.CreateOrUpdate.

type ManagedEnvironmentsStoragesClientDeleteOptions

type ManagedEnvironmentsStoragesClientDeleteOptions struct {
}

ManagedEnvironmentsStoragesClientDeleteOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.Delete method.

type ManagedEnvironmentsStoragesClientDeleteResponse

type ManagedEnvironmentsStoragesClientDeleteResponse struct {
}

ManagedEnvironmentsStoragesClientDeleteResponse contains the response from method ManagedEnvironmentsStoragesClient.Delete.

type ManagedEnvironmentsStoragesClientGetOptions

type ManagedEnvironmentsStoragesClientGetOptions struct {
}

ManagedEnvironmentsStoragesClientGetOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.Get method.

type ManagedEnvironmentsStoragesClientGetResponse

type ManagedEnvironmentsStoragesClientGetResponse struct {
	ManagedEnvironmentStorage
}

ManagedEnvironmentsStoragesClientGetResponse contains the response from method ManagedEnvironmentsStoragesClient.Get.

type ManagedEnvironmentsStoragesClientListOptions

type ManagedEnvironmentsStoragesClientListOptions struct {
}

ManagedEnvironmentsStoragesClientListOptions contains the optional parameters for the ManagedEnvironmentsStoragesClient.List method.

type ManagedEnvironmentsStoragesClientListResponse

type ManagedEnvironmentsStoragesClientListResponse struct {
	ManagedEnvironmentStoragesCollection
}

ManagedEnvironmentsStoragesClientListResponse contains the response from method ManagedEnvironmentsStoragesClient.List.

type ManagedServiceIdentity

type ManagedServiceIdentity struct {
	// REQUIRED; Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
	Type *ManagedServiceIdentityType `json:"type,omitempty"`

	// The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
	// The dictionary values can be empty objects ({}) in
	// requests.
	UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)

func (ManagedServiceIdentity) MarshalJSON

func (m ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedServiceIdentity.

func (*ManagedServiceIdentity) UnmarshalJSON added in v1.1.0

func (m *ManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedServiceIdentity.

type ManagedServiceIdentityType

type ManagedServiceIdentityType string

ManagedServiceIdentityType - Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

const (
	ManagedServiceIdentityTypeNone                       ManagedServiceIdentityType = "None"
	ManagedServiceIdentityTypeSystemAssigned             ManagedServiceIdentityType = "SystemAssigned"
	ManagedServiceIdentityTypeSystemAssignedUserAssigned ManagedServiceIdentityType = "SystemAssigned,UserAssigned"
	ManagedServiceIdentityTypeUserAssigned               ManagedServiceIdentityType = "UserAssigned"
)

func PossibleManagedServiceIdentityTypeValues

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

PossibleManagedServiceIdentityTypeValues returns the possible values for the ManagedServiceIdentityType const type.

type NamespacesClient

type NamespacesClient struct {
	// contains filtered or unexported fields
}

NamespacesClient contains the methods for the Namespaces group. Don't use this type directly, use NewNamespacesClient() instead.

func NewNamespacesClient

func NewNamespacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NamespacesClient, error)

NewNamespacesClient creates a new instance of NamespacesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NamespacesClient) CheckNameAvailability

func (client *NamespacesClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, environmentName string, checkNameAvailabilityRequest CheckNameAvailabilityRequest, options *NamespacesClientCheckNameAvailabilityOptions) (NamespacesClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks if resource name is available. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-03-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • checkNameAvailabilityRequest - The check name availability request.
  • options - NamespacesClientCheckNameAvailabilityOptions contains the optional parameters for the NamespacesClient.CheckNameAvailability method.
Example (CertificatesCheckNameAvailability)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Certificates_CheckNameAvailability.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().CheckNameAvailability(ctx, "examplerg", "testcontainerenv", armappcontainers.CheckNameAvailabilityRequest{
		Name: to.Ptr("testcertificatename"),
		Type: to.Ptr("Microsoft.App/managedEnvironments/certificates"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameAvailabilityResponse = armappcontainers.CheckNameAvailabilityResponse{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armappcontainers.CheckNameAvailabilityReason("None")),
	// }
}
Output:

Example (ContainerAppsCheckNameAvailability)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_CheckNameAvailability.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNamespacesClient().CheckNameAvailability(ctx, "examplerg", "testcontainerenv", armappcontainers.CheckNameAvailabilityRequest{
		Name: to.Ptr("testcappname"),
		Type: to.Ptr("Microsoft.App/containerApps"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameAvailabilityResponse = armappcontainers.CheckNameAvailabilityResponse{
	// 	Message: to.Ptr(""),
	// 	NameAvailable: to.Ptr(true),
	// 	Reason: to.Ptr(armappcontainers.CheckNameAvailabilityReason("None")),
	// }
}
Output:

type NamespacesClientCheckNameAvailabilityOptions

type NamespacesClientCheckNameAvailabilityOptions struct {
}

NamespacesClientCheckNameAvailabilityOptions contains the optional parameters for the NamespacesClient.CheckNameAvailability method.

type NamespacesClientCheckNameAvailabilityResponse

type NamespacesClientCheckNameAvailabilityResponse struct {
	CheckNameAvailabilityResponse
}

NamespacesClientCheckNameAvailabilityResponse contains the response from method NamespacesClient.CheckNameAvailability.

type Nonce

type Nonce struct {
	// The time after the request is made when the nonce should expire.
	NonceExpirationInterval *string `json:"nonceExpirationInterval,omitempty"`

	// false if the nonce should not be validated while completing the login flow; otherwise, true.
	ValidateNonce *bool `json:"validateNonce,omitempty"`
}

Nonce - The configuration settings of the nonce used in the login flow.

func (Nonce) MarshalJSON added in v1.1.0

func (n Nonce) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Nonce.

func (*Nonce) UnmarshalJSON added in v1.1.0

func (n *Nonce) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Nonce.

type OpenIDConnectClientCredential

type OpenIDConnectClientCredential struct {
	// The app setting that contains the client secret for the custom Open ID Connect provider.
	ClientSecretSettingName *string `json:"clientSecretSettingName,omitempty"`

	// The method that should be used to authenticate the user.
	Method *string `json:"method,omitempty"`
}

OpenIDConnectClientCredential - The authentication client credentials of the custom Open ID Connect provider.

func (OpenIDConnectClientCredential) MarshalJSON added in v1.1.0

func (o OpenIDConnectClientCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectClientCredential.

func (*OpenIDConnectClientCredential) UnmarshalJSON added in v1.1.0

func (o *OpenIDConnectClientCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenIDConnectClientCredential.

type OpenIDConnectConfig

type OpenIDConnectConfig struct {
	// The endpoint to be used to make an authorization request.
	AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`

	// The endpoint that provides the keys necessary to validate the token.
	CertificationURI *string `json:"certificationUri,omitempty"`

	// The endpoint that issues the token.
	Issuer *string `json:"issuer,omitempty"`

	// The endpoint to be used to request a token.
	TokenEndpoint *string `json:"tokenEndpoint,omitempty"`

	// The endpoint that contains all the configuration endpoints for the provider.
	WellKnownOpenIDConfiguration *string `json:"wellKnownOpenIdConfiguration,omitempty"`
}

OpenIDConnectConfig - The configuration settings of the endpoints used for the custom Open ID Connect provider.

func (OpenIDConnectConfig) MarshalJSON added in v1.1.0

func (o OpenIDConnectConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectConfig.

func (*OpenIDConnectConfig) UnmarshalJSON added in v1.1.0

func (o *OpenIDConnectConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenIDConnectConfig.

type OpenIDConnectLogin

type OpenIDConnectLogin struct {
	// The name of the claim that contains the users name.
	NameClaimType *string `json:"nameClaimType,omitempty"`

	// A list of the scopes that should be requested while authenticating.
	Scopes []*string `json:"scopes,omitempty"`
}

OpenIDConnectLogin - The configuration settings of the login flow of the custom Open ID Connect provider.

func (OpenIDConnectLogin) MarshalJSON

func (o OpenIDConnectLogin) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectLogin.

func (*OpenIDConnectLogin) UnmarshalJSON added in v1.1.0

func (o *OpenIDConnectLogin) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenIDConnectLogin.

type OpenIDConnectRegistration

type OpenIDConnectRegistration struct {
	// The authentication credentials of the custom Open ID Connect provider.
	ClientCredential *OpenIDConnectClientCredential `json:"clientCredential,omitempty"`

	// The client id of the custom Open ID Connect provider.
	ClientID *string `json:"clientId,omitempty"`

	// The configuration settings of the endpoints used for the custom Open ID Connect provider.
	OpenIDConnectConfiguration *OpenIDConnectConfig `json:"openIdConnectConfiguration,omitempty"`
}

OpenIDConnectRegistration - The configuration settings of the app registration for the custom Open ID Connect provider.

func (OpenIDConnectRegistration) MarshalJSON added in v1.1.0

func (o OpenIDConnectRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectRegistration.

func (*OpenIDConnectRegistration) UnmarshalJSON added in v1.1.0

func (o *OpenIDConnectRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenIDConnectRegistration.

type OperationDetail

type OperationDetail struct {
	// Display of the operation
	Display *OperationDisplay `json:"display,omitempty"`

	// Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Name of the operation
	Name *string `json:"name,omitempty"`

	// Origin of the operation
	Origin *string `json:"origin,omitempty"`
}

OperationDetail - Operation detail payload

func (OperationDetail) MarshalJSON added in v1.1.0

func (o OperationDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDetail.

func (*OperationDetail) UnmarshalJSON added in v1.1.0

func (o *OperationDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDetail.

type OperationDisplay

type OperationDisplay struct {
	// Localized friendly description for the operation
	Description *string `json:"description,omitempty"`

	// Localized friendly name for the operation
	Operation *string `json:"operation,omitempty"`

	// Resource provider of the operation
	Provider *string `json:"provider,omitempty"`

	// Resource of the operation
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Operation display payload

func (OperationDisplay) MarshalJSON added in v1.1.0

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON added in v1.1.0

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationsClient

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager

NewListPager - Lists all of the available RP operations.

Generated from API version 2022-03-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9a65970ef1837c0af1800c906aa365ba95871b26/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/Operations_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AvailableOperations = armappcontainers.AvailableOperations{
		// 	Value: []*armappcontainers.OperationDetail{
		// 		{
		// 			Name: to.Ptr("Microsoft.App/containerApps/Read"),
		// 			Display: &armappcontainers.OperationDisplay{
		// 				Description: to.Ptr("Get the properties of a Container App"),
		// 				Operation: to.Ptr("Get Container App"),
		// 				Provider: to.Ptr("Microsoft Apps"),
		// 				Resource: to.Ptr("Container App"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 	}},
		// }
	}
}
Output:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	AvailableOperations
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type ProxyResource

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON added in v1.1.0

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON added in v1.1.0

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type QueueScaleRule

type QueueScaleRule struct {
	// Authentication secrets for the queue scale rule.
	Auth []*ScaleRuleAuth `json:"auth,omitempty"`

	// Queue length.
	QueueLength *int32 `json:"queueLength,omitempty"`

	// Queue name.
	QueueName *string `json:"queueName,omitempty"`
}

QueueScaleRule - Container App container Azure Queue based scaling rule.

func (QueueScaleRule) MarshalJSON

func (q QueueScaleRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueueScaleRule.

func (*QueueScaleRule) UnmarshalJSON added in v1.1.0

func (q *QueueScaleRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueueScaleRule.

type RegistryCredentials

type RegistryCredentials struct {
	// A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned
	// identity Resource ID. For system-assigned identities, use 'system'
	Identity *string `json:"identity,omitempty"`

	// The name of the Secret that contains the registry login password
	PasswordSecretRef *string `json:"passwordSecretRef,omitempty"`

	// Container Registry Server
	Server *string `json:"server,omitempty"`

	// Container Registry Username
	Username *string `json:"username,omitempty"`
}

RegistryCredentials - Container App Private Registry

func (RegistryCredentials) MarshalJSON added in v1.1.0

func (r RegistryCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegistryCredentials.

func (*RegistryCredentials) UnmarshalJSON added in v1.1.0

func (r *RegistryCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegistryCredentials.

type RegistryInfo

type RegistryInfo struct {
	// registry secret.
	RegistryPassword *string `json:"registryPassword,omitempty"`

	// registry server Url.
	RegistryURL *string `json:"registryUrl,omitempty"`

	// registry username.
	RegistryUserName *string `json:"registryUserName,omitempty"`
}

RegistryInfo - Container App registry information.

func (RegistryInfo) MarshalJSON added in v1.1.0

func (r RegistryInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegistryInfo.

func (*RegistryInfo) UnmarshalJSON added in v1.1.0

func (r *RegistryInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegistryInfo.

type Replica

type Replica struct {
	// Replica resource specific properties
	Properties *ReplicaProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Replica - Container App Revision Replica.

func (Replica) MarshalJSON added in v1.1.0

func (r Replica) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Replica.

func (*Replica) UnmarshalJSON added in v1.1.0

func (r *Replica) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Replica.

type ReplicaCollection

type ReplicaCollection struct {
	// REQUIRED; Collection of resources.
	Value []*Replica `json:"value,omitempty"`
}

ReplicaCollection - Container App Revision Replicas collection ARM resource.

func (ReplicaCollection) MarshalJSON added in v1.1.0

func (r ReplicaCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicaCollection.

func (*ReplicaCollection) UnmarshalJSON added in v1.1.0

func (r *ReplicaCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicaCollection.

type ReplicaContainer

type ReplicaContainer struct {
	// The Id of the Container
	ContainerID *string `json:"containerId,omitempty"`

	// The Name of the Container
	Name *string `json:"name,omitempty"`

	// The container ready status
	Ready *bool `json:"ready,omitempty"`

	// The container restart count
	RestartCount *int32 `json:"restartCount,omitempty"`

	// The container start status
	Started *bool `json:"started,omitempty"`
}

ReplicaContainer - Container object under Container App Revision Replica.

func (ReplicaContainer) MarshalJSON added in v1.1.0

func (r ReplicaContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicaContainer.

func (*ReplicaContainer) UnmarshalJSON added in v1.1.0

func (r *ReplicaContainer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicaContainer.

type ReplicaProperties

type ReplicaProperties struct {
	// The containers collection under a replica.
	Containers []*ReplicaContainer `json:"containers,omitempty"`

	// READ-ONLY; Timestamp describing when the pod was created by controller
	CreatedTime *time.Time `json:"createdTime,omitempty" azure:"ro"`
}

ReplicaProperties - Replica resource specific properties

func (ReplicaProperties) MarshalJSON

func (r ReplicaProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicaProperties.

func (*ReplicaProperties) UnmarshalJSON

func (r *ReplicaProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicaProperties.

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON added in v1.1.0

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v1.1.0

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type Revision

type Revision struct {
	// Revision resource specific properties
	Properties *RevisionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Revision - Container App Revision.

func (Revision) MarshalJSON added in v1.1.0

func (r Revision) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Revision.

func (*Revision) UnmarshalJSON added in v1.1.0

func (r *Revision) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Revision.

type RevisionCollection

type RevisionCollection struct {
	// REQUIRED; Collection of resources.
	Value []*Revision `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

RevisionCollection - Container App Revisions collection ARM resource.

func (RevisionCollection) MarshalJSON added in v1.1.0

func (r RevisionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RevisionCollection.

func (*RevisionCollection) UnmarshalJSON added in v1.1.0

func (r *RevisionCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RevisionCollection.

type RevisionHealthState

type RevisionHealthState string

RevisionHealthState - Current health State of the revision

const (
	RevisionHealthStateHealthy   RevisionHealthState = "Healthy"
	RevisionHealthStateNone      RevisionHealthState = "None"
	RevisionHealthStateUnhealthy RevisionHealthState = "Unhealthy"
)

func PossibleRevisionHealthStateValues

func PossibleRevisionHealthStateValues() []RevisionHealthState

PossibleRevisionHealthStateValues returns the possible values for the RevisionHealthState const type.

type RevisionProperties

type RevisionProperties struct {
	// READ-ONLY; Boolean describing if the Revision is Active
	Active *bool `json:"active,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp describing when the revision was created by controller
	CreatedTime *time.Time `json:"createdTime,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified domain name of the revision
	Fqdn *string `json:"fqdn,omitempty" azure:"ro"`

	// READ-ONLY; Current health State of the revision
	HealthState *RevisionHealthState `json:"healthState,omitempty" azure:"ro"`

	// READ-ONLY; Optional Field - Platform Error Message
	ProvisioningError *string `json:"provisioningError,omitempty" azure:"ro"`

	// READ-ONLY; Current provisioning State of the revision
	ProvisioningState *RevisionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Number of pods currently running for this revision
	Replicas *int32 `json:"replicas,omitempty" azure:"ro"`

	// READ-ONLY; Container App Revision Template with all possible settings and the defaults if user did not provide them. The
	// defaults are populated as they were at the creation time
	Template *Template `json:"template,omitempty" azure:"ro"`

	// READ-ONLY; Traffic weight assigned to this revision
	TrafficWeight *int32 `json:"trafficWeight,omitempty" azure:"ro"`
}

RevisionProperties - Revision resource specific properties

func (RevisionProperties) MarshalJSON

func (r RevisionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RevisionProperties.

func (*RevisionProperties) UnmarshalJSON

func (r *RevisionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RevisionProperties.

type RevisionProvisioningState

type RevisionProvisioningState string

RevisionProvisioningState - Current provisioning State of the revision

const (
	RevisionProvisioningStateDeprovisioned  RevisionProvisioningState = "Deprovisioned"
	RevisionProvisioningStateDeprovisioning RevisionProvisioningState = "Deprovisioning"
	RevisionProvisioningStateFailed         RevisionProvisioningState = "Failed"
	RevisionProvisioningStateProvisioned    RevisionProvisioningState = "Provisioned"
	RevisionProvisioningStateProvisioning   RevisionProvisioningState = "Provisioning"
)

func PossibleRevisionProvisioningStateValues

func PossibleRevisionProvisioningStateValues() []RevisionProvisioningState

PossibleRevisionProvisioningStateValues returns the possible values for the RevisionProvisioningState const type.

type Scale

type Scale struct {
	// Optional. Maximum number of container replicas. Defaults to 10 if not set.
	MaxReplicas *int32 `json:"maxReplicas,omitempty"`

	// Optional. Minimum number of container replicas.
	MinReplicas *int32 `json:"minReplicas,omitempty"`

	// Scaling rules.
	Rules []*ScaleRule `json:"rules,omitempty"`
}

Scale - Container App scaling configurations.

func (Scale) MarshalJSON

func (s Scale) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Scale.

func (*Scale) UnmarshalJSON added in v1.1.0

func (s *Scale) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Scale.

type ScaleRule

type ScaleRule struct {
	// Azure Queue based scaling.
	AzureQueue *QueueScaleRule `json:"azureQueue,omitempty"`

	// Custom scale rule.
	Custom *CustomScaleRule `json:"custom,omitempty"`

	// HTTP requests based scaling.
	HTTP *HTTPScaleRule `json:"http,omitempty"`

	// Scale Rule Name
	Name *string `json:"name,omitempty"`
}

ScaleRule - Container App container scaling rule.

func (ScaleRule) MarshalJSON added in v1.1.0

func (s ScaleRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScaleRule.

func (*ScaleRule) UnmarshalJSON added in v1.1.0

func (s *ScaleRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScaleRule.

type ScaleRuleAuth

type ScaleRuleAuth struct {
	// Name of the Container App secret from which to pull the auth params.
	SecretRef *string `json:"secretRef,omitempty"`

	// Trigger Parameter that uses the secret
	TriggerParameter *string `json:"triggerParameter,omitempty"`
}

ScaleRuleAuth - Auth Secrets for Container App Scale Rule

func (ScaleRuleAuth) MarshalJSON added in v1.1.0

func (s ScaleRuleAuth) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScaleRuleAuth.

func (*ScaleRuleAuth) UnmarshalJSON added in v1.1.0

func (s *ScaleRuleAuth) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScaleRuleAuth.

type Scheme

type Scheme string

Scheme - Scheme to use for connecting to the host. Defaults to HTTP.

const (
	SchemeHTTP  Scheme = "HTTP"
	SchemeHTTPS Scheme = "HTTPS"
)

func PossibleSchemeValues

func PossibleSchemeValues() []Scheme

PossibleSchemeValues returns the possible values for the Scheme const type.

type Secret

type Secret struct {
	// Secret Name.
	Name *string `json:"name,omitempty"`

	// Secret Value.
	Value *string `json:"value,omitempty"`
}

Secret definition.

func (Secret) MarshalJSON added in v1.1.0

func (s Secret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Secret.

func (*Secret) UnmarshalJSON added in v1.1.0

func (s *Secret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Secret.

type SecretsCollection

type SecretsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ContainerAppSecret `json:"value,omitempty"`
}

SecretsCollection - Container App Secrets Collection ARM resource.

func (SecretsCollection) MarshalJSON added in v1.1.0

func (s SecretsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretsCollection.

func (*SecretsCollection) UnmarshalJSON added in v1.1.0

func (s *SecretsCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretsCollection.

type SourceControl

type SourceControl struct {
	// SourceControl resource specific properties
	Properties *SourceControlProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SourceControl - Container App SourceControl.

func (SourceControl) MarshalJSON added in v1.1.0

func (s SourceControl) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControl.

func (*SourceControl) UnmarshalJSON added in v1.1.0

func (s *SourceControl) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControl.

type SourceControlCollection

type SourceControlCollection struct {
	// REQUIRED; Collection of resources.
	Value []*SourceControl `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SourceControlCollection - SourceControl collection ARM resource.

func (SourceControlCollection) MarshalJSON added in v1.1.0

func (s SourceControlCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlCollection.

func (*SourceControlCollection) UnmarshalJSON added in v1.1.0

func (s *SourceControlCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlCollection.

type SourceControlOperationState

type SourceControlOperationState string

SourceControlOperationState - Current provisioning State of the operation

const (
	SourceControlOperationStateCanceled   SourceControlOperationState = "Canceled"
	SourceControlOperationStateFailed     SourceControlOperationState = "Failed"
	SourceControlOperationStateInProgress SourceControlOperationState = "InProgress"
	SourceControlOperationStateSucceeded  SourceControlOperationState = "Succeeded"
)

func PossibleSourceControlOperationStateValues

func PossibleSourceControlOperationStateValues() []SourceControlOperationState

PossibleSourceControlOperationStateValues returns the possible values for the SourceControlOperationState const type.

type SourceControlProperties

type SourceControlProperties struct {
	// The branch which will trigger the auto deployment
	Branch *string `json:"branch,omitempty"`

	// Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults
	// are populated as they were at the creation time
	GithubActionConfiguration *GithubActionConfiguration `json:"githubActionConfiguration,omitempty"`

	// The repo url which will be integrated to ContainerApp.
	RepoURL *string `json:"repoUrl,omitempty"`

	// READ-ONLY; Current provisioning State of the operation
	OperationState *SourceControlOperationState `json:"operationState,omitempty" azure:"ro"`
}

SourceControlProperties - SourceControl resource specific properties

func (SourceControlProperties) MarshalJSON added in v1.1.0

func (s SourceControlProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlProperties.

func (*SourceControlProperties) UnmarshalJSON added in v1.1.0

func (s *SourceControlProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlProperties.

type StorageType

type StorageType string

StorageType - Storage type for the volume. If not provided, use EmptyDir.

const (
	StorageTypeAzureFile StorageType = "AzureFile"
	StorageTypeEmptyDir  StorageType = "EmptyDir"
)

func PossibleStorageTypeValues

func PossibleStorageTypeValues() []StorageType

PossibleStorageTypeValues returns the possible values for the StorageType const type.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type Template

type Template struct {
	// List of container definitions for the Container App.
	Containers []*Container `json:"containers,omitempty"`

	// User friendly suffix that is appended to the revision name
	RevisionSuffix *string `json:"revisionSuffix,omitempty"`

	// Scaling properties for the Container App.
	Scale *Scale `json:"scale,omitempty"`

	// List of volume definitions for the Container App.
	Volumes []*Volume `json:"volumes,omitempty"`
}

Template - Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created

func (Template) MarshalJSON

func (t Template) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Template.

func (*Template) UnmarshalJSON added in v1.1.0

func (t *Template) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Template.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON added in v1.1.0

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type TrafficWeight

type TrafficWeight struct {
	// Associates a traffic label with a revision
	Label *string `json:"label,omitempty"`

	// Indicates that the traffic weight belongs to a latest stable revision
	LatestRevision *bool `json:"latestRevision,omitempty"`

	// Name of a revision
	RevisionName *string `json:"revisionName,omitempty"`

	// Traffic weight assigned to a revision
	Weight *int32 `json:"weight,omitempty"`
}

TrafficWeight - Traffic weight assigned to a revision

func (TrafficWeight) MarshalJSON added in v1.1.0

func (t TrafficWeight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrafficWeight.

func (*TrafficWeight) UnmarshalJSON added in v1.1.0

func (t *TrafficWeight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrafficWeight.

type Twitter

type Twitter struct {
	// false if the Twitter provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool `json:"enabled,omitempty"`

	// The configuration settings of the app registration for the Twitter provider.
	Registration *TwitterRegistration `json:"registration,omitempty"`
}

Twitter - The configuration settings of the Twitter provider.

func (Twitter) MarshalJSON added in v1.1.0

func (t Twitter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Twitter.

func (*Twitter) UnmarshalJSON added in v1.1.0

func (t *Twitter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Twitter.

type TwitterRegistration

type TwitterRegistration struct {
	// The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter
	// Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
	ConsumerKey *string `json:"consumerKey,omitempty"`

	// The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
	ConsumerSecretSettingName *string `json:"consumerSecretSettingName,omitempty"`
}

TwitterRegistration - The configuration settings of the app registration for the Twitter provider.

func (TwitterRegistration) MarshalJSON added in v1.1.0

func (t TwitterRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TwitterRegistration.

func (*TwitterRegistration) UnmarshalJSON added in v1.1.0

func (t *TwitterRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TwitterRegistration.

type Type

type Type string

Type - The type of probe.

const (
	TypeLiveness  Type = "Liveness"
	TypeReadiness Type = "Readiness"
	TypeStartup   Type = "Startup"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UnauthenticatedClientActionV2

type UnauthenticatedClientActionV2 string

UnauthenticatedClientActionV2 - The action to take when an unauthenticated client attempts to access the app.

const (
	UnauthenticatedClientActionV2RedirectToLoginPage UnauthenticatedClientActionV2 = "RedirectToLoginPage"
	UnauthenticatedClientActionV2AllowAnonymous      UnauthenticatedClientActionV2 = "AllowAnonymous"
	UnauthenticatedClientActionV2Return401           UnauthenticatedClientActionV2 = "Return401"
	UnauthenticatedClientActionV2Return403           UnauthenticatedClientActionV2 = "Return403"
)

func PossibleUnauthenticatedClientActionV2Values

func PossibleUnauthenticatedClientActionV2Values() []UnauthenticatedClientActionV2

PossibleUnauthenticatedClientActionV2Values returns the possible values for the UnauthenticatedClientActionV2 const type.

type UserAssignedIdentity

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON added in v1.1.0

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON added in v1.1.0

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

type VnetConfiguration

type VnetConfiguration struct {
	// CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.
	DockerBridgeCidr *string `json:"dockerBridgeCidr,omitempty"`

	// Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId.
	// Must not overlap with any other provided IP ranges.
	InfrastructureSubnetID *string `json:"infrastructureSubnetId,omitempty"`

	// Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP
	// resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if
	// enabling this property
	Internal *bool `json:"internal,omitempty"`

	// IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other
	// provided IP ranges.
	PlatformReservedCidr *string `json:"platformReservedCidr,omitempty"`

	// An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.
	PlatformReservedDNSIP *string `json:"platformReservedDnsIP,omitempty"`

	// Resource ID of a subnet that Container App containers are injected into. This subnet must be in the same VNET as the subnet
	// defined in infrastructureSubnetId. Must not overlap with any other provided
	// IP ranges.
	RuntimeSubnetID *string `json:"runtimeSubnetId,omitempty"`
}

VnetConfiguration - Configuration properties for apps environment to join a Virtual Network

func (VnetConfiguration) MarshalJSON added in v1.1.0

func (v VnetConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VnetConfiguration.

func (*VnetConfiguration) UnmarshalJSON added in v1.1.0

func (v *VnetConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VnetConfiguration.

type Volume

type Volume struct {
	// Volume name.
	Name *string `json:"name,omitempty"`

	// Name of storage resource. No need to provide for EmptyDir.
	StorageName *string `json:"storageName,omitempty"`

	// Storage type for the volume. If not provided, use EmptyDir.
	StorageType *StorageType `json:"storageType,omitempty"`
}

Volume definitions for the Container App.

func (Volume) MarshalJSON added in v1.1.0

func (v Volume) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Volume.

func (*Volume) UnmarshalJSON added in v1.1.0

func (v *Volume) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Volume.

type VolumeMount

type VolumeMount struct {
	// Path within the container at which the volume should be mounted.Must not contain ':'.
	MountPath *string `json:"mountPath,omitempty"`

	// This must match the Name of a Volume.
	VolumeName *string `json:"volumeName,omitempty"`
}

VolumeMount - Volume mount for the Container App.

func (VolumeMount) MarshalJSON added in v1.1.0

func (v VolumeMount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeMount.

func (*VolumeMount) UnmarshalJSON added in v1.1.0

func (v *VolumeMount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeMount.

Jump to

Keyboard shortcuts

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