armappcontainers

package module
v3.0.0-beta.1 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MIT Imports: 14 Imported by: 3

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/v3

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.NewAppResiliencyClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

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 Action 

type Action string

Action - Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny 

const (
	ActionAllow Action = "Allow"
	ActionDeny  Action = "Deny"
)

func PossibleActionValues 

func PossibleActionValues() []Action

PossibleActionValues returns the possible values for the Action 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 Affinity 

type Affinity string

Affinity - Sticky Session Affinity 

const (
	AffinityNone   Affinity = "none"
	AffinitySticky Affinity = "sticky"
)

func PossibleAffinityValues 

func PossibleAffinityValues() []Affinity

PossibleAffinityValues returns the possible values for the Affinity 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
}

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 

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

	// The list of the allowed identities.
	Identities []*string
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AllowedPrincipals.

type AppInsightsConfiguration 

type AppInsightsConfiguration struct {
	// Application Insights connection string
	ConnectionString *string
}

AppInsightsConfiguration - Configuration of Application Insights

func (AppInsightsConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppInsightsConfiguration.

func (*AppInsightsConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppInsightsConfiguration.

type AppLogsConfiguration 

type AppLogsConfiguration struct {
	// Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'
	Destination *string

	// Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'
	LogAnalyticsConfiguration *LogAnalyticsConfiguration
}

AppLogsConfiguration - Configuration of application logs

func (AppLogsConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppLogsConfiguration.

func (*AppLogsConfiguration) UnmarshalJSON 

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

	// The app setting name that contains the app secret.
	AppSecretSettingName *string
}

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

func (AppRegistration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppRegistration.

func (*AppRegistration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppRegistration.

type AppResiliency 

type AppResiliency struct {
	// App Resiliency resource specific properties
	Properties *AppResiliencyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AppResiliency - Configuration to setup App Resiliency

func (AppResiliency) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppResiliency.

func (*AppResiliency) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResiliency.

type AppResiliencyClient 

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

AppResiliencyClient contains the methods for the AppResiliency group. Don't use this type directly, use NewAppResiliencyClient() instead.

func NewAppResiliencyClient 

func NewAppResiliencyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AppResiliencyClient, error)

NewAppResiliencyClient creates a new instance of AppResiliencyClient with the specified values.

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

func (*AppResiliencyClient) CreateOrUpdate 

func (client *AppResiliencyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, appName string, name string, resiliencyEnvelope AppResiliency, options *AppResiliencyClientCreateOrUpdateOptions) (AppResiliencyClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update container app resiliency policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • appName - Name of the Container App.
  • name - Name of the resiliency policy.
  • resiliencyEnvelope - The resiliency policy to create or update.
  • options - AppResiliencyClientCreateOrUpdateOptions contains the optional parameters for the AppResiliencyClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AppResiliency_CreateOrUpdate.json 

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.NewAppResiliencyClient().CreateOrUpdate(ctx, "rg", "testcontainerApp0", "resiliency-policy-1", armappcontainers.AppResiliency{
	Properties: &armappcontainers.AppResiliencyProperties{
		CircuitBreakerPolicy: &armappcontainers.CircuitBreakerPolicy{
			ConsecutiveErrors:  to.Ptr[int32](5),
			IntervalInSeconds:  to.Ptr[int32](10),
			MaxEjectionPercent: to.Ptr[int32](50),
		},
		HTTPConnectionPool: &armappcontainers.HTTPConnectionPool{
			HTTP1MaxPendingRequests: to.Ptr[int32](1024),
			HTTP2MaxRequests:        to.Ptr[int32](1024),
		},
		HTTPRetryPolicy: &armappcontainers.HTTPRetryPolicy{
			Matches: &armappcontainers.HTTPRetryPolicyMatches{
				Errors: []*string{
					to.Ptr("5xx"),
					to.Ptr("connect-failure"),
					to.Ptr("reset"),
					to.Ptr("retriable-headers"),
					to.Ptr("retriable-status-codes")},
				Headers: []*armappcontainers.HeaderMatch{
					{
						Header: to.Ptr("X-Content-Type"),
						Match: &armappcontainers.HeaderMatchMatch{
							PrefixMatch: to.Ptr("GOATS"),
						},
					}},
				HTTPStatusCodes: []*int32{
					to.Ptr[int32](502),
					to.Ptr[int32](503)},
			},
			MaxRetries: to.Ptr[int32](5),
			RetryBackOff: &armappcontainers.HTTPRetryPolicyRetryBackOff{
				InitialDelayInMilliseconds: to.Ptr[int64](1000),
				MaxIntervalInMilliseconds:  to.Ptr[int64](10000),
			},
		},
		TCPConnectionPool: &armappcontainers.TCPConnectionPool{
			MaxConnections: to.Ptr[int32](100),
		},
		TCPRetryPolicy: &armappcontainers.TCPRetryPolicy{
			MaxConnectAttempts: to.Ptr[int32](3),
		},
		TimeoutPolicy: &armappcontainers.TimeoutPolicy{
			ConnectionTimeoutInSeconds: to.Ptr[int32](5),
			ResponseTimeoutInSeconds:   to.Ptr[int32](15),
		},
	},
}, 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.AppResiliency = armappcontainers.AppResiliency{
// 	Name: to.Ptr("resiliency-policy-1"),
// 	Type: to.Ptr("Microsoft.App/containerApps/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1"),
// 	Properties: &armappcontainers.AppResiliencyProperties{
// 		CircuitBreakerPolicy: &armappcontainers.CircuitBreakerPolicy{
// 			ConsecutiveErrors: to.Ptr[int32](5),
// 			IntervalInSeconds: to.Ptr[int32](10),
// 			MaxEjectionPercent: to.Ptr[int32](50),
// 		},
// 		HTTPConnectionPool: &armappcontainers.HTTPConnectionPool{
// 			HTTP1MaxPendingRequests: to.Ptr[int32](1024),
// 			HTTP2MaxRequests: to.Ptr[int32](1024),
// 		},
// 		HTTPRetryPolicy: &armappcontainers.HTTPRetryPolicy{
// 			Matches: &armappcontainers.HTTPRetryPolicyMatches{
// 				Errors: []*string{
// 					to.Ptr("5xx"),
// 					to.Ptr("connect-failure"),
// 					to.Ptr("reset"),
// 					to.Ptr("retriable-headers"),
// 					to.Ptr("retriable-status-codes")},
// 					Headers: []*armappcontainers.HeaderMatch{
// 						{
// 							Header: to.Ptr("X-Content-Type"),
// 							Match: &armappcontainers.HeaderMatchMatch{
// 								PrefixMatch: to.Ptr("GOATS"),
// 							},
// 					}},
// 					HTTPStatusCodes: []*int32{
// 						to.Ptr[int32](502),
// 						to.Ptr[int32](503)},
// 					},
// 					MaxRetries: to.Ptr[int32](5),
// 					RetryBackOff: &armappcontainers.HTTPRetryPolicyRetryBackOff{
// 						InitialDelayInMilliseconds: to.Ptr[int64](1000),
// 						MaxIntervalInMilliseconds: to.Ptr[int64](10000),
// 					},
// 				},
// 				TCPConnectionPool: &armappcontainers.TCPConnectionPool{
// 					MaxConnections: to.Ptr[int32](100),
// 				},
// 				TCPRetryPolicy: &armappcontainers.TCPRetryPolicy{
// 					MaxConnectAttempts: to.Ptr[int32](3),
// 				},
// 				TimeoutPolicy: &armappcontainers.TimeoutPolicy{
// 					ConnectionTimeoutInSeconds: to.Ptr[int32](5),
// 					ResponseTimeoutInSeconds: to.Ptr[int32](15),
// 				},
// 			},
// 		}

Output:

func (*AppResiliencyClient) Delete 

func (client *AppResiliencyClient) Delete(ctx context.Context, resourceGroupName string, appName string, name string, options *AppResiliencyClientDeleteOptions) (AppResiliencyClientDeleteResponse, error)

Delete - Delete container app resiliency policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • appName - Name of the Container App.
  • name - Name of the resiliency policy.
  • options - AppResiliencyClientDeleteOptions contains the optional parameters for the AppResiliencyClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AppResiliency_Delete.json 

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.NewAppResiliencyClient().Delete(ctx, "rg", "testcontainerApp0", "resiliency-policy-1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*AppResiliencyClient) Get 

func (client *AppResiliencyClient) Get(ctx context.Context, resourceGroupName string, appName string, name string, options *AppResiliencyClientGetOptions) (AppResiliencyClientGetResponse, error)

Get - Get container app resiliency policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • appName - Name of the Container App.
  • name - Name of the resiliency policy.
  • options - AppResiliencyClientGetOptions contains the optional parameters for the AppResiliencyClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AppResiliency_Get.json 

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.NewAppResiliencyClient().Get(ctx, "rg", "testcontainerApp0", "resiliency-policy-1", 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.AppResiliency = armappcontainers.AppResiliency{
// 	Name: to.Ptr("resiliency-policy-1"),
// 	Type: to.Ptr("Microsoft.App/containerApps/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1"),
// 	Properties: &armappcontainers.AppResiliencyProperties{
// 		CircuitBreakerPolicy: &armappcontainers.CircuitBreakerPolicy{
// 			ConsecutiveErrors: to.Ptr[int32](5),
// 			IntervalInSeconds: to.Ptr[int32](10),
// 			MaxEjectionPercent: to.Ptr[int32](50),
// 		},
// 		HTTPConnectionPool: &armappcontainers.HTTPConnectionPool{
// 			HTTP1MaxPendingRequests: to.Ptr[int32](1024),
// 			HTTP2MaxRequests: to.Ptr[int32](1024),
// 		},
// 		HTTPRetryPolicy: &armappcontainers.HTTPRetryPolicy{
// 			Matches: &armappcontainers.HTTPRetryPolicyMatches{
// 				Errors: []*string{
// 					to.Ptr("5xx"),
// 					to.Ptr("connect-failure"),
// 					to.Ptr("reset"),
// 					to.Ptr("retriable-headers"),
// 					to.Ptr("retriable-status-codes")},
// 					Headers: []*armappcontainers.HeaderMatch{
// 						{
// 							Header: to.Ptr("X-Content-Type"),
// 							Match: &armappcontainers.HeaderMatchMatch{
// 								PrefixMatch: to.Ptr("GOATS"),
// 							},
// 					}},
// 					HTTPStatusCodes: []*int32{
// 						to.Ptr[int32](502),
// 						to.Ptr[int32](503)},
// 					},
// 					MaxRetries: to.Ptr[int32](5),
// 					RetryBackOff: &armappcontainers.HTTPRetryPolicyRetryBackOff{
// 						InitialDelayInMilliseconds: to.Ptr[int64](1000),
// 						MaxIntervalInMilliseconds: to.Ptr[int64](10000),
// 					},
// 				},
// 				TCPConnectionPool: &armappcontainers.TCPConnectionPool{
// 					MaxConnections: to.Ptr[int32](100),
// 				},
// 				TCPRetryPolicy: &armappcontainers.TCPRetryPolicy{
// 					MaxConnectAttempts: to.Ptr[int32](3),
// 				},
// 				TimeoutPolicy: &armappcontainers.TimeoutPolicy{
// 					ConnectionTimeoutInSeconds: to.Ptr[int32](5),
// 					ResponseTimeoutInSeconds: to.Ptr[int32](15),
// 				},
// 			},
// 		}

Output:

func (*AppResiliencyClient) NewListPager 

func (client *AppResiliencyClient) NewListPager(resourceGroupName string, appName string, options *AppResiliencyClientListOptions) *runtime.Pager[AppResiliencyClientListResponse]

NewListPager - List container app resiliency policies.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • appName - Name of the Container App.
  • options - AppResiliencyClientListOptions contains the optional parameters for the AppResiliencyClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AppResiliency_List.json 

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.NewAppResiliencyClient().NewListPager("rg", "testcontainerApp0", 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.AppResiliencyCollection = armappcontainers.AppResiliencyCollection{
	// 	Value: []*armappcontainers.AppResiliency{
	// 		{
	// 			Name: to.Ptr("resiliency-policy-1"),
	// 			Type: to.Ptr("Microsoft.App/containerApps/resiliencyPolicies"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1"),
	// 			Properties: &armappcontainers.AppResiliencyProperties{
	// 				CircuitBreakerPolicy: &armappcontainers.CircuitBreakerPolicy{
	// 					ConsecutiveErrors: to.Ptr[int32](5),
	// 					IntervalInSeconds: to.Ptr[int32](10),
	// 					MaxEjectionPercent: to.Ptr[int32](50),
	// 				},
	// 				HTTPConnectionPool: &armappcontainers.HTTPConnectionPool{
	// 					HTTP1MaxPendingRequests: to.Ptr[int32](1024),
	// 					HTTP2MaxRequests: to.Ptr[int32](1024),
	// 				},
	// 				HTTPRetryPolicy: &armappcontainers.HTTPRetryPolicy{
	// 					Matches: &armappcontainers.HTTPRetryPolicyMatches{
	// 						Errors: []*string{
	// 							to.Ptr("5xx"),
	// 							to.Ptr("connect-failure"),
	// 							to.Ptr("reset"),
	// 							to.Ptr("retriable-headers"),
	// 							to.Ptr("retriable-status-codes")},
	// 							Headers: []*armappcontainers.HeaderMatch{
	// 								{
	// 									Header: to.Ptr("X-Content-Type"),
	// 									Match: &armappcontainers.HeaderMatchMatch{
	// 										PrefixMatch: to.Ptr("GOATS"),
	// 									},
	// 							}},
	// 							HTTPStatusCodes: []*int32{
	// 								to.Ptr[int32](502),
	// 								to.Ptr[int32](503)},
	// 							},
	// 							MaxRetries: to.Ptr[int32](5),
	// 							RetryBackOff: &armappcontainers.HTTPRetryPolicyRetryBackOff{
	// 								InitialDelayInMilliseconds: to.Ptr[int64](1000),
	// 								MaxIntervalInMilliseconds: to.Ptr[int64](10000),
	// 							},
	// 						},
	// 						TCPConnectionPool: &armappcontainers.TCPConnectionPool{
	// 							MaxConnections: to.Ptr[int32](100),
	// 						},
	// 						TCPRetryPolicy: &armappcontainers.TCPRetryPolicy{
	// 							MaxConnectAttempts: to.Ptr[int32](3),
	// 						},
	// 						TimeoutPolicy: &armappcontainers.TimeoutPolicy{
	// 							ConnectionTimeoutInSeconds: to.Ptr[int32](5),
	// 							ResponseTimeoutInSeconds: to.Ptr[int32](15),
	// 						},
	// 					},
	// 			}},
	// 		}
}

Output:

func (*AppResiliencyClient) Update 

func (client *AppResiliencyClient) Update(ctx context.Context, resourceGroupName string, appName string, name string, resiliencyEnvelope AppResiliency, options *AppResiliencyClientUpdateOptions) (AppResiliencyClientUpdateResponse, error)

Update - Update container app resiliency policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • appName - Name of the Container App.
  • name - Name of the resiliency policy.
  • resiliencyEnvelope - The resiliency policy to update.
  • options - AppResiliencyClientUpdateOptions contains the optional parameters for the AppResiliencyClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AppResiliency_Patch.json 

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.NewAppResiliencyClient().Update(ctx, "rg", "testcontainerApp0", "resiliency-policy-1", armappcontainers.AppResiliency{
	Properties: &armappcontainers.AppResiliencyProperties{
		TimeoutPolicy: &armappcontainers.TimeoutPolicy{
			ConnectionTimeoutInSeconds: to.Ptr[int32](40),
			ResponseTimeoutInSeconds:   to.Ptr[int32](30),
		},
	},
}, 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.AppResiliency = armappcontainers.AppResiliency{
// 	Name: to.Ptr("resiliency-policy-1"),
// 	Type: to.Ptr("Microsoft.App/containerApps/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1"),
// 	Properties: &armappcontainers.AppResiliencyProperties{
// 		CircuitBreakerPolicy: &armappcontainers.CircuitBreakerPolicy{
// 			ConsecutiveErrors: to.Ptr[int32](5),
// 			IntervalInSeconds: to.Ptr[int32](10),
// 			MaxEjectionPercent: to.Ptr[int32](50),
// 		},
// 		HTTPConnectionPool: &armappcontainers.HTTPConnectionPool{
// 			HTTP1MaxPendingRequests: to.Ptr[int32](1024),
// 			HTTP2MaxRequests: to.Ptr[int32](1024),
// 		},
// 		HTTPRetryPolicy: &armappcontainers.HTTPRetryPolicy{
// 			Matches: &armappcontainers.HTTPRetryPolicyMatches{
// 				Errors: []*string{
// 					to.Ptr("5xx"),
// 					to.Ptr("connect-failure"),
// 					to.Ptr("reset"),
// 					to.Ptr("retriable-headers"),
// 					to.Ptr("retriable-status-codes")},
// 					Headers: []*armappcontainers.HeaderMatch{
// 						{
// 							Header: to.Ptr("X-Content-Type"),
// 							Match: &armappcontainers.HeaderMatchMatch{
// 								PrefixMatch: to.Ptr("GOATS"),
// 							},
// 					}},
// 					HTTPStatusCodes: []*int32{
// 						to.Ptr[int32](502),
// 						to.Ptr[int32](503)},
// 					},
// 					MaxRetries: to.Ptr[int32](5),
// 					RetryBackOff: &armappcontainers.HTTPRetryPolicyRetryBackOff{
// 						InitialDelayInMilliseconds: to.Ptr[int64](1000),
// 						MaxIntervalInMilliseconds: to.Ptr[int64](10000),
// 					},
// 				},
// 				TCPConnectionPool: &armappcontainers.TCPConnectionPool{
// 					MaxConnections: to.Ptr[int32](100),
// 				},
// 				TCPRetryPolicy: &armappcontainers.TCPRetryPolicy{
// 					MaxConnectAttempts: to.Ptr[int32](3),
// 				},
// 				TimeoutPolicy: &armappcontainers.TimeoutPolicy{
// 					ConnectionTimeoutInSeconds: to.Ptr[int32](40),
// 					ResponseTimeoutInSeconds: to.Ptr[int32](30),
// 				},
// 			},
// 		}

Output:

type AppResiliencyClientCreateOrUpdateOptions 

type AppResiliencyClientCreateOrUpdateOptions struct {
}

AppResiliencyClientCreateOrUpdateOptions contains the optional parameters for the AppResiliencyClient.CreateOrUpdate method.

type AppResiliencyClientCreateOrUpdateResponse 

type AppResiliencyClientCreateOrUpdateResponse struct {
	// Configuration to setup App Resiliency
	AppResiliency
}

AppResiliencyClientCreateOrUpdateResponse contains the response from method AppResiliencyClient.CreateOrUpdate.

type AppResiliencyClientDeleteOptions 

type AppResiliencyClientDeleteOptions struct {
}

AppResiliencyClientDeleteOptions contains the optional parameters for the AppResiliencyClient.Delete method.

type AppResiliencyClientDeleteResponse 

type AppResiliencyClientDeleteResponse struct {
}

AppResiliencyClientDeleteResponse contains the response from method AppResiliencyClient.Delete.

type AppResiliencyClientGetOptions 

type AppResiliencyClientGetOptions struct {
}

AppResiliencyClientGetOptions contains the optional parameters for the AppResiliencyClient.Get method.

type AppResiliencyClientGetResponse 

type AppResiliencyClientGetResponse struct {
	// Configuration to setup App Resiliency
	AppResiliency
}

AppResiliencyClientGetResponse contains the response from method AppResiliencyClient.Get.

type AppResiliencyClientListOptions 

type AppResiliencyClientListOptions struct {
}

AppResiliencyClientListOptions contains the optional parameters for the AppResiliencyClient.NewListPager method.

type AppResiliencyClientListResponse 

type AppResiliencyClientListResponse struct {
	// Collection of AppResiliency policies
	AppResiliencyCollection
}

AppResiliencyClientListResponse contains the response from method AppResiliencyClient.NewListPager.

type AppResiliencyClientUpdateOptions 

type AppResiliencyClientUpdateOptions struct {
}

AppResiliencyClientUpdateOptions contains the optional parameters for the AppResiliencyClient.Update method.

type AppResiliencyClientUpdateResponse 

type AppResiliencyClientUpdateResponse struct {
	// Configuration to setup App Resiliency
	AppResiliency
}

AppResiliencyClientUpdateResponse contains the response from method AppResiliencyClient.Update.

type AppResiliencyCollection 

type AppResiliencyCollection struct {
	// REQUIRED; Collection of resources.
	Value []*AppResiliency

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

AppResiliencyCollection - Collection of AppResiliency policies

func (AppResiliencyCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppResiliencyCollection.

func (*AppResiliencyCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResiliencyCollection.

type AppResiliencyProperties 

type AppResiliencyProperties struct {
	// Policy that defines circuit breaker conditions
	CircuitBreakerPolicy *CircuitBreakerPolicy

	// Defines parameters for http connection pooling
	HTTPConnectionPool *HTTPConnectionPool

	// Policy that defines http request retry conditions
	HTTPRetryPolicy *HTTPRetryPolicy

	// Defines parameters for tcp connection pooling
	TCPConnectionPool *TCPConnectionPool

	// Policy that defines tcp request retry conditions
	TCPRetryPolicy *TCPRetryPolicy

	// Policy to set request timeouts
	TimeoutPolicy *TimeoutPolicy
}

AppResiliencyProperties - App Resiliency resource specific properties

func (AppResiliencyProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppResiliencyProperties.

func (*AppResiliencyProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResiliencyProperties.

type Apple 

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

	// The configuration settings of the login flow.
	Login *LoginScopes

	// The configuration settings of the Apple registration.
	Registration *AppleRegistration
}

Apple - The configuration settings of the Apple provider.

func (Apple) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Apple.

func (*Apple) UnmarshalJSON 

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

	// The app setting name that contains the client secret.
	ClientSecretSettingName *string
}

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

func (AppleRegistration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppleRegistration.

func (*AppleRegistration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppleRegistration.

type Applicability 

type Applicability string

Applicability - indicates whether the profile is default for the location. 

const (
	ApplicabilityCustom          Applicability = "Custom"
	ApplicabilityLocationDefault Applicability = "LocationDefault"
)

func PossibleApplicabilityValues 

func PossibleApplicabilityValues() []Applicability

PossibleApplicabilityValues returns the possible values for the Applicability const type.

type AuthConfig 

type AuthConfig struct {
	// AuthConfig resource specific properties
	Properties *AuthConfigProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

func (AuthConfig) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AuthConfig.

func (*AuthConfig) UnmarshalJSON 

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

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

AuthConfigCollection - AuthConfig collection ARM resource.

func (AuthConfigCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AuthConfigCollection.

func (*AuthConfigCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AuthConfigCollection.

type AuthConfigProperties 

type AuthConfigProperties struct {
	// The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.
	EncryptionSettings *EncryptionSettings

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

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

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

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

	// The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
	Platform *AuthPlatform
}

AuthConfigProperties - AuthConfig resource specific properties

func (AuthConfigProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AuthConfigProperties.

func (*AuthConfigProperties) UnmarshalJSON 

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

	// 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
}

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

func (AuthPlatform) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AuthPlatform.

func (*AuthPlatform) UnmarshalJSON 

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

	// Collection of available operation details
	Value []*OperationDetail
}

AvailableOperations - Available operations of the service

func (AvailableOperations) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableOperations.

func (*AvailableOperations) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableOperations.

type AvailableWorkloadProfile 

type AvailableWorkloadProfile struct {
	// Region of the workload profile.
	Location *string

	// Revision resource specific properties
	Properties *AvailableWorkloadProfileProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AvailableWorkloadProfile - A workload profile with specific hardware configure to run container apps.

func (AvailableWorkloadProfile) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableWorkloadProfile.

func (*AvailableWorkloadProfile) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableWorkloadProfile.

type AvailableWorkloadProfileProperties 

type AvailableWorkloadProfileProperties struct {
	// indicates whether the profile is default for the location.
	Applicability *Applicability

	// Used to categorize workload profiles.
	Category *string

	// Number of cores in CPU.
	Cores *int32

	// The everyday name of the workload profile.
	DisplayName *string

	// Number of GPUs.
	Gpus *int32

	// Memory in GiB.
	MemoryGiB *int32
}

AvailableWorkloadProfileProperties - Revision resource specific properties

func (AvailableWorkloadProfileProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableWorkloadProfileProperties.

func (*AvailableWorkloadProfileProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableWorkloadProfileProperties.

type AvailableWorkloadProfilesClient 

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

AvailableWorkloadProfilesClient contains the methods for the AvailableWorkloadProfiles group. Don't use this type directly, use NewAvailableWorkloadProfilesClient() instead.

func NewAvailableWorkloadProfilesClient 

func NewAvailableWorkloadProfilesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AvailableWorkloadProfilesClient, error)

NewAvailableWorkloadProfilesClient creates a new instance of AvailableWorkloadProfilesClient with the specified values.

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

func (*AvailableWorkloadProfilesClient) NewGetPager 

func (client *AvailableWorkloadProfilesClient) NewGetPager(location string, options *AvailableWorkloadProfilesClientGetOptions) *runtime.Pager[AvailableWorkloadProfilesClientGetResponse]

NewGetPager - Get all available workload profiles for a location.

Generated from API version 2023-11-02-preview

  • location - The name of Azure region.
  • options - AvailableWorkloadProfilesClientGetOptions contains the optional parameters for the AvailableWorkloadProfilesClient.NewGetPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AvailableWorkloadProfiles_Get.json 

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.NewAvailableWorkloadProfilesClient().NewGetPager("East US", 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.AvailableWorkloadProfilesCollection = armappcontainers.AvailableWorkloadProfilesCollection{
	// 	Value: []*armappcontainers.AvailableWorkloadProfile{
	// 		{
	// 			Name: to.Ptr("Dedicated-D4"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D4"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityLocationDefault),
	// 				Category: to.Ptr("General purpose D-series"),
	// 				Cores: to.Ptr[int32](4),
	// 				DisplayName: to.Ptr("Dedicated-D4"),
	// 				MemoryGiB: to.Ptr[int32](16),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-D4"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D8"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("General purpose D-series"),
	// 				Cores: to.Ptr[int32](8),
	// 				DisplayName: to.Ptr("Dedicated-D8"),
	// 				MemoryGiB: to.Ptr[int32](32),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-D16"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D16"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("General purpose D-series"),
	// 				Cores: to.Ptr[int32](16),
	// 				DisplayName: to.Ptr("Dedicated-D16"),
	// 				MemoryGiB: to.Ptr[int32](64),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-E4"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E4"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Memory optimized E-series"),
	// 				Cores: to.Ptr[int32](4),
	// 				DisplayName: to.Ptr("Dedicated-E4"),
	// 				MemoryGiB: to.Ptr[int32](32),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-E8"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E8"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Memory optimized E-series"),
	// 				Cores: to.Ptr[int32](8),
	// 				DisplayName: to.Ptr("Dedicated-E8"),
	// 				MemoryGiB: to.Ptr[int32](64),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-E16"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E16"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Memory optimized E-series"),
	// 				Cores: to.Ptr[int32](16),
	// 				DisplayName: to.Ptr("Dedicated-E16"),
	// 				MemoryGiB: to.Ptr[int32](128),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-F4"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F4"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Compute optimized F-series"),
	// 				Cores: to.Ptr[int32](4),
	// 				DisplayName: to.Ptr("Dedicated-F4"),
	// 				MemoryGiB: to.Ptr[int32](8),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-F8"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F8"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Compute optimized F-series"),
	// 				Cores: to.Ptr[int32](8),
	// 				DisplayName: to.Ptr("Dedicated-F8"),
	// 				MemoryGiB: to.Ptr[int32](16),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Dedicated-F16"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F16"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Compute optimized F-series"),
	// 				Cores: to.Ptr[int32](16),
	// 				DisplayName: to.Ptr("Dedicated-F16"),
	// 				MemoryGiB: to.Ptr[int32](32),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("NC48-A100"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/NC48-A100"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("GPU-NC-A100"),
	// 				Cores: to.Ptr[int32](48),
	// 				DisplayName: to.Ptr("Dedicated-NC48-A100"),
	// 				Gpus: to.Ptr[int32](2),
	// 				MemoryGiB: to.Ptr[int32](440),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Consumption"),
	// 			Type: to.Ptr("Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Consumption"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.AvailableWorkloadProfileProperties{
	// 				Applicability: to.Ptr(armappcontainers.ApplicabilityCustom),
	// 				Category: to.Ptr("Consumption"),
	// 				Cores: to.Ptr[int32](3),
	// 				DisplayName: to.Ptr("Consumption"),
	// 				MemoryGiB: to.Ptr[int32](3),
	// 			},
	// 	}},
	// }
}

Output:

type AvailableWorkloadProfilesClientGetOptions 

type AvailableWorkloadProfilesClientGetOptions struct {
}

AvailableWorkloadProfilesClientGetOptions contains the optional parameters for the AvailableWorkloadProfilesClient.NewGetPager method.

type AvailableWorkloadProfilesClientGetResponse 

type AvailableWorkloadProfilesClientGetResponse struct {
	// Collection of available workload profiles in the location.
	AvailableWorkloadProfilesCollection
}

AvailableWorkloadProfilesClientGetResponse contains the response from method AvailableWorkloadProfilesClient.NewGetPager.

type AvailableWorkloadProfilesCollection 

type AvailableWorkloadProfilesCollection struct {
	// REQUIRED; Collection of workload profiles.
	Value []*AvailableWorkloadProfile

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

AvailableWorkloadProfilesCollection - Collection of available workload profiles in the location.

func (AvailableWorkloadProfilesCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableWorkloadProfilesCollection.

func (*AvailableWorkloadProfilesCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableWorkloadProfilesCollection.

type AzureActiveDirectory 

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

	// 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

	// The configuration settings of the Azure Active Directory login flow.
	Login *AzureActiveDirectoryLogin

	// The configuration settings of the Azure Active Directory app registration.
	Registration *AzureActiveDirectoryRegistration

	// The configuration settings of the Azure Active Directory token validation flow.
	Validation *AzureActiveDirectoryValidation
}

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

func (AzureActiveDirectory) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureActiveDirectory.

func (*AzureActiveDirectory) UnmarshalJSON 

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

	// 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
}

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 

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

	// 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

	// 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

	// 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

	// The app setting name that contains the client secret of the relying party application.
	ClientSecretSettingName *string

	// 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
}

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

func (AzureActiveDirectoryRegistration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureActiveDirectoryRegistration.

func (*AzureActiveDirectoryRegistration) UnmarshalJSON 

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

	// The configuration settings of the default authorization policy.
	DefaultAuthorizationPolicy *DefaultAuthorizationPolicy

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

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 

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

	// Client Secret.
	ClientSecret *string

	// Kind of auth github does for deploying the template
	Kind *string

	// Subscription Id.
	SubscriptionID *string

	// Tenant Id.
	TenantID *string
}

AzureCredentials - Container App credentials.

func (AzureCredentials) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureCredentials.

func (*AzureCredentials) UnmarshalJSON 

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

	// Storage account key for azure file.
	AccountKey *string

	// Storage account name for azure file.
	AccountName *string

	// Azure file share name.
	ShareName *string
}

AzureFileProperties - Azure File Properties.

func (AzureFileProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureFileProperties.

func (*AzureFileProperties) UnmarshalJSON 

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

	// The configuration settings of the Azure Static Web Apps registration.
	Registration *AzureStaticWebAppsRegistration
}

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

func (AzureStaticWebApps) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureStaticWebApps.

func (*AzureStaticWebApps) UnmarshalJSON 

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
}

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

func (AzureStaticWebAppsRegistration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureStaticWebAppsRegistration.

func (*AzureStaticWebAppsRegistration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureStaticWebAppsRegistration.

type BaseContainer 

type BaseContainer struct {
	// Container start command arguments.
	Args []*string

	// Container start command.
	Command []*string

	// Container environment variables.
	Env []*EnvironmentVar

	// Container image tag.
	Image *string

	// Custom container name.
	Name *string

	// Container resource requirements.
	Resources *ContainerResources

	// Container volume mounts.
	VolumeMounts []*VolumeMount
}

BaseContainer - Container App base container definition.

func (BaseContainer) MarshalJSON 

func (b BaseContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseContainer.

func (*BaseContainer) UnmarshalJSON 

func (b *BaseContainer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseContainer.

type BillingMeter 

type BillingMeter struct {
	// Region for the billing meter.
	Location *string

	// Revision resource specific properties
	Properties *BillingMeterProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

BillingMeter - Billing meter.

func (BillingMeter) MarshalJSON 

func (b BillingMeter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BillingMeter.

func (*BillingMeter) UnmarshalJSON 

func (b *BillingMeter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BillingMeter.

type BillingMeterCollection 

type BillingMeterCollection struct {
	// REQUIRED; Collection of billing meters.
	Value []*BillingMeter
}

BillingMeterCollection - Collection of billing meters.

func (BillingMeterCollection) MarshalJSON 

func (b BillingMeterCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BillingMeterCollection.

func (*BillingMeterCollection) UnmarshalJSON 

func (b *BillingMeterCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BillingMeterCollection.

type BillingMeterProperties 

type BillingMeterProperties struct {
	// Used to categorize billing meters.
	Category *string

	// The everyday name of the billing meter.
	DisplayName *string

	// Billing meter type.
	MeterType *string
}

BillingMeterProperties - Revision resource specific properties

func (BillingMeterProperties) MarshalJSON 

func (b BillingMeterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BillingMeterProperties.

func (*BillingMeterProperties) UnmarshalJSON 

func (b *BillingMeterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BillingMeterProperties.

type BillingMetersClient 

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

BillingMetersClient contains the methods for the BillingMeters group. Don't use this type directly, use NewBillingMetersClient() instead.

func NewBillingMetersClient 

func NewBillingMetersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BillingMetersClient, error)

NewBillingMetersClient creates a new instance of BillingMetersClient with the specified values.

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

func (*BillingMetersClient) Get 

func (client *BillingMetersClient) Get(ctx context.Context, location string, options *BillingMetersClientGetOptions) (BillingMetersClientGetResponse, error)

Get - Get all billingMeters for a location. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • location - The name of Azure region.
  • options - BillingMetersClientGetOptions contains the optional parameters for the BillingMetersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/BillingMeters_Get.json 

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.NewBillingMetersClient().Get(ctx, "East US", 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.BillingMeterCollection = armappcontainers.BillingMeterCollection{
// 	Value: []*armappcontainers.BillingMeter{
// 		{
// 			Name: to.Ptr("GeneralPurposeDseriesCPU"),
// 			Type: to.Ptr("Microsoft.App/billingMeters"),
// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralPurposeDseriesCPU"),
// 			Location: to.Ptr("East US"),
// 			Properties: &armappcontainers.BillingMeterProperties{
// 				Category: to.Ptr("General purpose D-series"),
// 				DisplayName: to.Ptr("General Purpose Cores per Second"),
// 				MeterType: to.Ptr("CPU"),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("GeneralPurposeDseriesMemory"),
// 			Type: to.Ptr("Microsoft.App/billingMeters"),
// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralPurposeDseriesMemory"),
// 			Location: to.Ptr("East US"),
// 			Properties: &armappcontainers.BillingMeterProperties{
// 				Category: to.Ptr("General purpose D-series"),
// 				DisplayName: to.Ptr("General Purpose Memory GiB per Second"),
// 				MeterType: to.Ptr("Memory"),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("MemoryOptimizedEseriesCPU"),
// 			Type: to.Ptr("Microsoft.App/billingMeters"),
// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/MemoryOptimizedEseriesCPU"),
// 			Location: to.Ptr("East US"),
// 			Properties: &armappcontainers.BillingMeterProperties{
// 				Category: to.Ptr("Memory optimized E-series"),
// 				DisplayName: to.Ptr("Memory Optimized Cores per Second"),
// 				MeterType: to.Ptr("CPU"),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("MemoryOptimizedEseriesMemory"),
// 			Type: to.Ptr("Microsoft.App/billingMeters"),
// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/MemoryOptimizedEseriesMemory"),
// 			Location: to.Ptr("East US"),
// 			Properties: &armappcontainers.BillingMeterProperties{
// 				Category: to.Ptr("Memory optimized E-series"),
// 				DisplayName: to.Ptr("Memory Optimized Memory GiB per Second"),
// 				MeterType: to.Ptr("Memory"),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("ComputeOptimizedFseriesCPU"),
// 			Type: to.Ptr("Microsoft.App/billingMeters"),
// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/ComputeOptimizedFseriesCPU"),
// 			Location: to.Ptr("East US"),
// 			Properties: &armappcontainers.BillingMeterProperties{
// 				Category: to.Ptr("Compute optimized F-series"),
// 				DisplayName: to.Ptr("Compute Optimized Cores per Second"),
// 				MeterType: to.Ptr("CPU"),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("GeneralComputeMemory"),
// 			Type: to.Ptr("Microsoft.App/billingMeters"),
// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralComputeMemory"),
// 			Location: to.Ptr("East US"),
// 			Properties: &armappcontainers.BillingMeterProperties{
// 				Category: to.Ptr("Compute optimized F-series"),
// 				DisplayName: to.Ptr("Compute Optimized Memory GiB per Second"),
// 				MeterType: to.Ptr("Memory"),
// 			},
// 	}},
// }

Output:

type BillingMetersClientGetOptions 

type BillingMetersClientGetOptions struct {
}

BillingMetersClientGetOptions contains the optional parameters for the BillingMetersClient.Get method.

type BillingMetersClientGetResponse 

type BillingMetersClientGetResponse struct {
	// Collection of billing meters.
	BillingMeterCollection
}

BillingMetersClientGetResponse contains the response from method BillingMetersClient.Get.

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 BlobStorageTokenStore 

type BlobStorageTokenStore struct {
	// REQUIRED; The name of the app secrets containing the SAS URL of the blob storage containing the tokens.
	SasURLSettingName *string
}

BlobStorageTokenStore - The configuration settings of the storage of the tokens if blob storage is used.

func (BlobStorageTokenStore) MarshalJSON 

func (b BlobStorageTokenStore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobStorageTokenStore.

func (*BlobStorageTokenStore) UnmarshalJSON 

func (b *BlobStorageTokenStore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobStorageTokenStore.

type BuildAuthTokenClient 

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

BuildAuthTokenClient contains the methods for the BuildAuthToken group. Don't use this type directly, use NewBuildAuthTokenClient() instead.

func NewBuildAuthTokenClient 

func NewBuildAuthTokenClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildAuthTokenClient, error)

NewBuildAuthTokenClient creates a new instance of BuildAuthTokenClient with the specified values.

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

func (*BuildAuthTokenClient) List 

func (client *BuildAuthTokenClient) List(ctx context.Context, resourceGroupName string, builderName string, buildName string, options *BuildAuthTokenClientListOptions) (BuildAuthTokenClientListResponse, error)

List - Gets the token used to connect to the endpoint where source code can be uploaded for a build. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • buildName - The name of a build.
  • options - BuildAuthTokenClientListOptions contains the optional parameters for the BuildAuthTokenClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builds_ListAuthToken.json 

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.NewBuildAuthTokenClient().List(ctx, "rg", "testBuilder", "testBuild", 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.BuildToken = armappcontainers.BuildToken{
// 	Expires: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-14T19:22:50.308Z"); return t}()),
// 	Token: to.Ptr("foobartoken"),
// }

Output:

type BuildAuthTokenClientListOptions 

type BuildAuthTokenClientListOptions struct {
}

BuildAuthTokenClientListOptions contains the optional parameters for the BuildAuthTokenClient.List method.

type BuildAuthTokenClientListResponse 

type BuildAuthTokenClientListResponse struct {
	// Build Auth Token.
	BuildToken
}

BuildAuthTokenClientListResponse contains the response from method BuildAuthTokenClient.List.

type BuildCollection 

type BuildCollection struct {
	// REQUIRED; The BuildResource items on this page
	Value []*BuildResource

	// The link to the next page of items
	NextLink *string
}

BuildCollection - The response of a BuildResource list operation.

func (BuildCollection) MarshalJSON 

func (b BuildCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuildCollection.

func (*BuildCollection) UnmarshalJSON 

func (b *BuildCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuildCollection.

type BuildConfiguration 

type BuildConfiguration struct {
	// Base OS used to build and run the app.
	BaseOs *string

	// List of environment variables to be passed to the build, secrets should not be used in environment variable.
	EnvironmentVariables []*EnvironmentVariable

	// Platform to be used to build and run the app.
	Platform *string

	// Platform version to be used to build and run the app.
	PlatformVersion *string

	// List of steps to perform before the build.
	PreBuildSteps []*PreBuildStep
}

BuildConfiguration - Configuration of the build.

func (BuildConfiguration) MarshalJSON 

func (b BuildConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuildConfiguration.

func (*BuildConfiguration) UnmarshalJSON 

func (b *BuildConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuildConfiguration.

type BuildProperties 

type BuildProperties struct {
	// Configuration of the build.
	Configuration *BuildConfiguration

	// Container registry that the final image will be uploaded to.
	DestinationContainerRegistry *ContainerRegistryWithCustomImage

	// READ-ONLY; Status of the build once it has been provisioned.
	BuildStatus *BuildStatus

	// READ-ONLY; Endpoint from which the build logs can be streamed.
	LogStreamEndpoint *string

	// READ-ONLY; Build provisioning state.
	ProvisioningState *BuildProvisioningState

	// READ-ONLY; Endpoint to use to retrieve an authentication token for log streaming and uploading source code.
	TokenEndpoint *string

	// READ-ONLY; Endpoint to which the source code should be uploaded.
	UploadEndpoint *string
}

BuildProperties - The build properties.

func (BuildProperties) MarshalJSON 

func (b BuildProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuildProperties.

func (*BuildProperties) UnmarshalJSON 

func (b *BuildProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuildProperties.

type BuildProvisioningState 

type BuildProvisioningState string

BuildProvisioningState - Resource instance provisioning state. 

const (
	BuildProvisioningStateCanceled  BuildProvisioningState = "Canceled"
	BuildProvisioningStateCreating  BuildProvisioningState = "Creating"
	BuildProvisioningStateDeleting  BuildProvisioningState = "Deleting"
	BuildProvisioningStateFailed    BuildProvisioningState = "Failed"
	BuildProvisioningStateSucceeded BuildProvisioningState = "Succeeded"
	BuildProvisioningStateUpdating  BuildProvisioningState = "Updating"
)

func PossibleBuildProvisioningStateValues 

func PossibleBuildProvisioningStateValues() []BuildProvisioningState

PossibleBuildProvisioningStateValues returns the possible values for the BuildProvisioningState const type.

type BuildResource 

type BuildResource struct {
	// The resource-specific properties for this resource.
	Properties *BuildProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

BuildResource - Information pertaining to an individual build.

func (BuildResource) MarshalJSON 

func (b BuildResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuildResource.

func (*BuildResource) UnmarshalJSON 

func (b *BuildResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResource.

type BuildStatus 

type BuildStatus string

BuildStatus - Status of the build once it has been provisioned. 

const (
	BuildStatusCanceled   BuildStatus = "Canceled"
	BuildStatusFailed     BuildStatus = "Failed"
	BuildStatusInProgress BuildStatus = "InProgress"
	BuildStatusNotStarted BuildStatus = "NotStarted"
	BuildStatusSucceeded  BuildStatus = "Succeeded"
)

func PossibleBuildStatusValues 

func PossibleBuildStatusValues() []BuildStatus

PossibleBuildStatusValues returns the possible values for the BuildStatus const type.

type BuildToken 

type BuildToken struct {
	// READ-ONLY; Token expiration date.
	Expires *time.Time

	// READ-ONLY; Authentication token.
	Token *string
}

BuildToken - Build Auth Token.

func (BuildToken) MarshalJSON 

func (b BuildToken) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuildToken.

func (*BuildToken) UnmarshalJSON 

func (b *BuildToken) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuildToken.

type BuilderCollection 

type BuilderCollection struct {
	// REQUIRED; The BuilderResource items on this page
	Value []*BuilderResource

	// The link to the next page of items
	NextLink *string
}

BuilderCollection - The response of a BuilderResource list operation.

func (BuilderCollection) MarshalJSON 

func (b BuilderCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuilderCollection.

func (*BuilderCollection) UnmarshalJSON 

func (b *BuilderCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuilderCollection.

type BuilderProperties 

type BuilderProperties struct {
	// REQUIRED; Resource ID of the container apps environment that the builder is associated with.
	EnvironmentID *string

	// List of mappings of container registries and the managed identity used to connect to it.
	ContainerRegistries []*ContainerRegistry

	// READ-ONLY; Provisioning state of a builder resource.
	ProvisioningState *BuilderProvisioningState
}

BuilderProperties - The builder properties.

func (BuilderProperties) MarshalJSON 

func (b BuilderProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuilderProperties.

func (*BuilderProperties) UnmarshalJSON 

func (b *BuilderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuilderProperties.

type BuilderProvisioningState 

type BuilderProvisioningState string

BuilderProvisioningState - Resource instance provisioning state. 

const (
	BuilderProvisioningStateCanceled  BuilderProvisioningState = "Canceled"
	BuilderProvisioningStateCreating  BuilderProvisioningState = "Creating"
	BuilderProvisioningStateDeleting  BuilderProvisioningState = "Deleting"
	BuilderProvisioningStateFailed    BuilderProvisioningState = "Failed"
	BuilderProvisioningStateSucceeded BuilderProvisioningState = "Succeeded"
	BuilderProvisioningStateUpdating  BuilderProvisioningState = "Updating"
)

func PossibleBuilderProvisioningStateValues 

func PossibleBuilderProvisioningStateValues() []BuilderProvisioningState

PossibleBuilderProvisioningStateValues returns the possible values for the BuilderProvisioningState const type.

type BuilderResource 

type BuilderResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The managed service identities assigned to this resource.
	Identity *ManagedServiceIdentity

	// The resource-specific properties for this resource.
	Properties *BuilderProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

BuilderResource - Information about the SourceToCloud builder resource.

func (BuilderResource) MarshalJSON 

func (b BuilderResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuilderResource.

func (*BuilderResource) UnmarshalJSON 

func (b *BuilderResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuilderResource.

type BuilderResourceUpdate 

type BuilderResourceUpdate struct {
	// The managed service identities assigned to this resource.
	Identity *ManagedServiceIdentity

	// The updatable properties of the BuilderResource.
	Properties *BuilderResourceUpdateProperties

	// Resource tags.
	Tags map[string]*string
}

BuilderResourceUpdate - The type used for update operations of the BuilderResource.

func (BuilderResourceUpdate) MarshalJSON 

func (b BuilderResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuilderResourceUpdate.

func (*BuilderResourceUpdate) UnmarshalJSON 

func (b *BuilderResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuilderResourceUpdate.

type BuilderResourceUpdateProperties 

type BuilderResourceUpdateProperties struct {
	// Resource ID of the container apps environment that the builder is associated with.
	EnvironmentID *string
}

BuilderResourceUpdateProperties - The updatable properties of the BuilderResource.

func (BuilderResourceUpdateProperties) MarshalJSON 

func (b BuilderResourceUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BuilderResourceUpdateProperties.

func (*BuilderResourceUpdateProperties) UnmarshalJSON 

func (b *BuilderResourceUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BuilderResourceUpdateProperties.

type BuildersClient 

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

BuildersClient contains the methods for the Builders group. Don't use this type directly, use NewBuildersClient() instead.

func NewBuildersClient 

func NewBuildersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildersClient, error)

NewBuildersClient creates a new instance of BuildersClient with the specified values.

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

func (*BuildersClient) BeginCreateOrUpdate 

func (client *BuildersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, builderName string, builderEnvelope BuilderResource, options *BuildersClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildersClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • builderEnvelope - Resource create parameters.
  • options - BuildersClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builders_CreateOrUpdate.json 

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.NewBuildersClient().BeginCreateOrUpdate(ctx, "rg", "testBuilder", armappcontainers.BuilderResource{
	Location: to.Ptr("eastus"),
	Tags: map[string]*string{
		"company": to.Ptr("Microsoft"),
	},
	Identity: &armappcontainers.ManagedServiceIdentity{
		Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {},
		},
	},
	Properties: &armappcontainers.BuilderProperties{
		ContainerRegistries: []*armappcontainers.ContainerRegistry{
			{
				ContainerRegistryServer: to.Ptr("test.azurecr.io"),
				IdentityResourceID:      to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
			},
			{
				ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
				IdentityResourceID:      to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
			}},
		EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
	},
}, 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.BuilderResource = armappcontainers.BuilderResource{
// 	Name: to.Ptr("testBuilder"),
// 	Type: to.Ptr("Microsoft.App/builders"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder"),
// 	SystemData: &armappcontainers.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		CreatedBy: to.Ptr("sample@microsoft.com"),
// 		CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"company": to.Ptr("Microsoft"),
// 	},
// 	Identity: &armappcontainers.ManagedServiceIdentity{
// 		Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	Properties: &armappcontainers.BuilderProperties{
// 		ContainerRegistries: []*armappcontainers.ContainerRegistry{
// 			{
// 				ContainerRegistryServer: to.Ptr("test.azurecr.io"),
// 				IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
// 			},
// 			{
// 				ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
// 				IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
// 		}},
// 		EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
// 		ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
// 	},
// }

Output:

func (*BuildersClient) BeginDelete 

func (client *BuildersClient) BeginDelete(ctx context.Context, resourceGroupName string, builderName string, options *BuildersClientBeginDeleteOptions) (*runtime.Poller[BuildersClientDeleteResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • options - BuildersClientBeginDeleteOptions contains the optional parameters for the BuildersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builders_Delete.json 

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.NewBuildersClient().BeginDelete(ctx, "rg", "testBuilder", 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 (*BuildersClient) BeginUpdate 

func (client *BuildersClient) BeginUpdate(ctx context.Context, resourceGroupName string, builderName string, builderEnvelope BuilderResourceUpdate, options *BuildersClientBeginUpdateOptions) (*runtime.Poller[BuildersClientUpdateResponse], error)

BeginUpdate - Update a BuilderResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • builderEnvelope - The resource properties to be updated.
  • options - BuildersClientBeginUpdateOptions contains the optional parameters for the BuildersClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builders_Update.json 

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.NewBuildersClient().BeginUpdate(ctx, "rg", "testBuilder", armappcontainers.BuilderResourceUpdate{
	Tags: map[string]*string{
		"mytag1": to.Ptr("myvalue1"),
	},
}, 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.BuilderResource = armappcontainers.BuilderResource{
// 	Name: to.Ptr("testBuilder"),
// 	Type: to.Ptr("Microsoft.App/builders"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder"),
// 	SystemData: &armappcontainers.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		CreatedBy: to.Ptr("sample@microsoft.com"),
// 		CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"mytag1": to.Ptr("myvalue1"),
// 	},
// 	Identity: &armappcontainers.ManagedServiceIdentity{
// 		Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	Properties: &armappcontainers.BuilderProperties{
// 		ContainerRegistries: []*armappcontainers.ContainerRegistry{
// 			{
// 				ContainerRegistryServer: to.Ptr("test.azurecr.io"),
// 				IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
// 			},
// 			{
// 				ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
// 				IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
// 		}},
// 		EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
// 		ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
// 	},
// }

Output:

func (*BuildersClient) Get 

func (client *BuildersClient) Get(ctx context.Context, resourceGroupName string, builderName string, options *BuildersClientGetOptions) (BuildersClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • options - BuildersClientGetOptions contains the optional parameters for the BuildersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builders_Get.json 

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.NewBuildersClient().Get(ctx, "rg", "testBuilder", 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.BuilderResource = armappcontainers.BuilderResource{
// 	Name: to.Ptr("testBuilder"),
// 	Type: to.Ptr("Microsoft.App/builders"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder"),
// 	SystemData: &armappcontainers.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		CreatedBy: to.Ptr("sample@microsoft.com"),
// 		CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"key": to.Ptr("value"),
// 	},
// 	Identity: &armappcontainers.ManagedServiceIdentity{
// 		Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	Properties: &armappcontainers.BuilderProperties{
// 		ContainerRegistries: []*armappcontainers.ContainerRegistry{
// 			{
// 				ContainerRegistryServer: to.Ptr("test.azurecr.io"),
// 				IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
// 			},
// 			{
// 				ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
// 				IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
// 		}},
// 		EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
// 		ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
// 	},
// }

Output:

func (*BuildersClient) NewListByResourceGroupPager 

func (client *BuildersClient) NewListByResourceGroupPager(resourceGroupName string, options *BuildersClientListByResourceGroupOptions) *runtime.Pager[BuildersClientListByResourceGroupResponse]

NewListByResourceGroupPager - List BuilderResource resources by resource group

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builders_ListByResourceGroup.json 

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.NewBuildersClient().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.BuilderCollection = armappcontainers.BuilderCollection{
	// 	Value: []*armappcontainers.BuilderResource{
	// 		{
	// 			Name: to.Ptr("testBuilder1"),
	// 			Type: to.Ptr("Microsoft.App/builders"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder1"),
	// 			SystemData: &armappcontainers.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample@microsoft.com"),
	// 				CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"key": to.Ptr("value"),
	// 			},
	// 			Identity: &armappcontainers.ManagedServiceIdentity{
	// 				Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
	// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			Properties: &armappcontainers.BuilderProperties{
	// 				ContainerRegistries: []*armappcontainers.ContainerRegistry{
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 					},
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 				}},
	// 				EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
	// 				ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testBuilder2"),
	// 			Type: to.Ptr("Microsoft.App/builders"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder2"),
	// 			SystemData: &armappcontainers.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample@microsoft.com"),
	// 				CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"key": to.Ptr("value"),
	// 			},
	// 			Identity: &armappcontainers.ManagedServiceIdentity{
	// 				Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
	// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			Properties: &armappcontainers.BuilderProperties{
	// 				ContainerRegistries: []*armappcontainers.ContainerRegistry{
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 					},
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 				}},
	// 				EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
	// 				ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*BuildersClient) NewListBySubscriptionPager 

func (client *BuildersClient) NewListBySubscriptionPager(options *BuildersClientListBySubscriptionOptions) *runtime.Pager[BuildersClientListBySubscriptionResponse]

NewListBySubscriptionPager - List BuilderResource resources by subscription ID

Generated from API version 2023-11-02-preview

  • options - BuildersClientListBySubscriptionOptions contains the optional parameters for the BuildersClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builders_ListBySubscription.json 

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.NewBuildersClient().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.BuilderCollection = armappcontainers.BuilderCollection{
	// 	Value: []*armappcontainers.BuilderResource{
	// 		{
	// 			Name: to.Ptr("testBuilder1"),
	// 			Type: to.Ptr("Microsoft.App/builders"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.App/builders/testBuilder1"),
	// 			SystemData: &armappcontainers.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample@microsoft.com"),
	// 				CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"key": to.Ptr("value"),
	// 			},
	// 			Identity: &armappcontainers.ManagedServiceIdentity{
	// 				Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
	// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			Properties: &armappcontainers.BuilderProperties{
	// 				ContainerRegistries: []*armappcontainers.ContainerRegistry{
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 					},
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 				}},
	// 				EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
	// 				ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testBuilder2"),
	// 			Type: to.Ptr("Microsoft.App/builders"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg2/providers/Microsoft.App/builders/testBuilder2"),
	// 			SystemData: &armappcontainers.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample@microsoft.com"),
	// 				CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"key": to.Ptr("value"),
	// 			},
	// 			Identity: &armappcontainers.ManagedServiceIdentity{
	// 				Type: to.Ptr(armappcontainers.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
	// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": &armappcontainers.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			Properties: &armappcontainers.BuilderProperties{
	// 				ContainerRegistries: []*armappcontainers.ContainerRegistry{
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 					},
	// 					{
	// 						ContainerRegistryServer: to.Ptr("test2.azurecr.io"),
	// 						IdentityResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"),
	// 				}},
	// 				EnvironmentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv"),
	// 				ProvisioningState: to.Ptr(armappcontainers.BuilderProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type BuildersClientBeginCreateOrUpdateOptions 

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

BuildersClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildersClient.BeginCreateOrUpdate method.

type BuildersClientBeginDeleteOptions 

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

BuildersClientBeginDeleteOptions contains the optional parameters for the BuildersClient.BeginDelete method.

type BuildersClientBeginUpdateOptions 

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

BuildersClientBeginUpdateOptions contains the optional parameters for the BuildersClient.BeginUpdate method.

type BuildersClientCreateOrUpdateResponse 

type BuildersClientCreateOrUpdateResponse struct {
	// Information about the SourceToCloud builder resource.
	BuilderResource
}

BuildersClientCreateOrUpdateResponse contains the response from method BuildersClient.BeginCreateOrUpdate.

type BuildersClientDeleteResponse 

type BuildersClientDeleteResponse struct {
}

BuildersClientDeleteResponse contains the response from method BuildersClient.BeginDelete.

type BuildersClientGetOptions 

type BuildersClientGetOptions struct {
}

BuildersClientGetOptions contains the optional parameters for the BuildersClient.Get method.

type BuildersClientGetResponse 

type BuildersClientGetResponse struct {
	// Information about the SourceToCloud builder resource.
	BuilderResource
}

BuildersClientGetResponse contains the response from method BuildersClient.Get.

type BuildersClientListByResourceGroupOptions 

type BuildersClientListByResourceGroupOptions struct {
}

BuildersClientListByResourceGroupOptions contains the optional parameters for the BuildersClient.NewListByResourceGroupPager method.

type BuildersClientListByResourceGroupResponse 

type BuildersClientListByResourceGroupResponse struct {
	// The response of a BuilderResource list operation.
	BuilderCollection
}

BuildersClientListByResourceGroupResponse contains the response from method BuildersClient.NewListByResourceGroupPager.

type BuildersClientListBySubscriptionOptions 

type BuildersClientListBySubscriptionOptions struct {
}

BuildersClientListBySubscriptionOptions contains the optional parameters for the BuildersClient.NewListBySubscriptionPager method.

type BuildersClientListBySubscriptionResponse 

type BuildersClientListBySubscriptionResponse struct {
	// The response of a BuilderResource list operation.
	BuilderCollection
}

BuildersClientListBySubscriptionResponse contains the response from method BuildersClient.NewListBySubscriptionPager.

type BuildersClientUpdateResponse 

type BuildersClientUpdateResponse struct {
	// Information about the SourceToCloud builder resource.
	BuilderResource
}

BuildersClientUpdateResponse contains the response from method BuildersClient.BeginUpdate.

type BuildsByBuilderResourceClient 

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

BuildsByBuilderResourceClient contains the methods for the BuildsByBuilderResource group. Don't use this type directly, use NewBuildsByBuilderResourceClient() instead.

func NewBuildsByBuilderResourceClient 

func NewBuildsByBuilderResourceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildsByBuilderResourceClient, error)

NewBuildsByBuilderResourceClient creates a new instance of BuildsByBuilderResourceClient with the specified values.

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

func (*BuildsByBuilderResourceClient) NewListPager 

func (client *BuildsByBuilderResourceClient) NewListPager(resourceGroupName string, builderName string, options *BuildsByBuilderResourceClientListOptions) *runtime.Pager[BuildsByBuilderResourceClientListResponse]

NewListPager - List BuildResource resources by BuilderResource

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • options - BuildsByBuilderResourceClientListOptions contains the optional parameters for the BuildsByBuilderResourceClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builds_ListByBuilderResource.json 

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.NewBuildsByBuilderResourceClient().NewListPager("rg", "testBuilder", 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.BuildCollection = armappcontainers.BuildCollection{
	// 	Value: []*armappcontainers.BuildResource{
	// 		{
	// 			Name: to.Ptr("testBuild1"),
	// 			Type: to.Ptr("Microsoft.App/builders/builds"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild1"),
	// 			SystemData: &armappcontainers.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample@microsoft.com"),
	// 				CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 			},
	// 			Properties: &armappcontainers.BuildProperties{
	// 				BuildStatus: to.Ptr(armappcontainers.BuildStatusInProgress),
	// 				Configuration: &armappcontainers.BuildConfiguration{
	// 					BaseOs: to.Ptr("DebianBullseye"),
	// 					EnvironmentVariables: []*armappcontainers.EnvironmentVariable{
	// 						{
	// 							Name: to.Ptr("foo1"),
	// 							Value: to.Ptr("bar1"),
	// 						},
	// 						{
	// 							Name: to.Ptr("foo2"),
	// 							Value: to.Ptr("bar2"),
	// 					}},
	// 					Platform: to.Ptr("dotnetcore"),
	// 					PlatformVersion: to.Ptr("7.0"),
	// 					PreBuildSteps: []*armappcontainers.PreBuildStep{
	// 						{
	// 							Description: to.Ptr("First pre build step."),
	// 							HTTPGet: &armappcontainers.HTTPGet{
	// 								FileName: to.Ptr("output.txt"),
	// 								Headers: []*string{
	// 									to.Ptr("foo"),
	// 									to.Ptr("bar")},
	// 									URL: to.Ptr("https://microsoft.com"),
	// 								},
	// 								Scripts: []*string{
	// 									to.Ptr("echo 'hello'"),
	// 									to.Ptr("echo 'world'")},
	// 								},
	// 								{
	// 									Description: to.Ptr("Second pre build step."),
	// 									HTTPGet: &armappcontainers.HTTPGet{
	// 										FileName: to.Ptr("output.txt"),
	// 										Headers: []*string{
	// 											to.Ptr("foo")},
	// 											URL: to.Ptr("https://microsoft.com"),
	// 										},
	// 										Scripts: []*string{
	// 											to.Ptr("echo 'hello'"),
	// 											to.Ptr("echo 'again'")},
	// 									}},
	// 								},
	// 								DestinationContainerRegistry: &armappcontainers.ContainerRegistryWithCustomImage{
	// 									Image: to.Ptr("test.azurecr.io/repo:tag"),
	// 									Server: to.Ptr("test.azurecr.io"),
	// 								},
	// 								LogStreamEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/logstream"),
	// 								ProvisioningState: to.Ptr(armappcontainers.BuildProvisioningStateSucceeded),
	// 								TokenEndpoint: to.Ptr("https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"),
	// 								UploadEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/upload"),
	// 							},
	// 						},
	// 						{
	// 							Name: to.Ptr("testBuild2"),
	// 							Type: to.Ptr("Microsoft.App/builders/builds"),
	// 							ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild2"),
	// 							SystemData: &armappcontainers.SystemData{
	// 								CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 								CreatedBy: to.Ptr("sample@microsoft.com"),
	// 								CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 								LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
	// 								LastModifiedBy: to.Ptr("sample@microsoft.com"),
	// 								LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
	// 							},
	// 							Properties: &armappcontainers.BuildProperties{
	// 								BuildStatus: to.Ptr(armappcontainers.BuildStatusInProgress),
	// 								Configuration: &armappcontainers.BuildConfiguration{
	// 									BaseOs: to.Ptr("DebianBullseye"),
	// 									EnvironmentVariables: []*armappcontainers.EnvironmentVariable{
	// 										{
	// 											Name: to.Ptr("foo1"),
	// 											Value: to.Ptr("bar1"),
	// 										},
	// 										{
	// 											Name: to.Ptr("foo2"),
	// 											Value: to.Ptr("bar2"),
	// 									}},
	// 									Platform: to.Ptr("dotnetcore"),
	// 									PlatformVersion: to.Ptr("7.0"),
	// 									PreBuildSteps: []*armappcontainers.PreBuildStep{
	// 										{
	// 											Description: to.Ptr("First pre build step."),
	// 											HTTPGet: &armappcontainers.HTTPGet{
	// 												FileName: to.Ptr("output.txt"),
	// 												Headers: []*string{
	// 													to.Ptr("foo"),
	// 													to.Ptr("bar")},
	// 													URL: to.Ptr("https://microsoft.com"),
	// 												},
	// 												Scripts: []*string{
	// 													to.Ptr("echo 'hello'"),
	// 													to.Ptr("echo 'world'")},
	// 												},
	// 												{
	// 													Description: to.Ptr("Second pre build step."),
	// 													HTTPGet: &armappcontainers.HTTPGet{
	// 														FileName: to.Ptr("output.txt"),
	// 														Headers: []*string{
	// 															to.Ptr("foo")},
	// 															URL: to.Ptr("https://microsoft.com"),
	// 														},
	// 														Scripts: []*string{
	// 															to.Ptr("echo 'hello'"),
	// 															to.Ptr("echo 'again'")},
	// 													}},
	// 												},
	// 												DestinationContainerRegistry: &armappcontainers.ContainerRegistryWithCustomImage{
	// 													Image: to.Ptr("test.azurecr.io/repo:tag"),
	// 													Server: to.Ptr("test.azurecr.io"),
	// 												},
	// 												LogStreamEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/logstream"),
	// 												ProvisioningState: to.Ptr(armappcontainers.BuildProvisioningStateSucceeded),
	// 												TokenEndpoint: to.Ptr("https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"),
	// 												UploadEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/upload"),
	// 											},
	// 									}},
	// 								}
}

Output:

type BuildsByBuilderResourceClientListOptions 

type BuildsByBuilderResourceClientListOptions struct {
}

BuildsByBuilderResourceClientListOptions contains the optional parameters for the BuildsByBuilderResourceClient.NewListPager method.

type BuildsByBuilderResourceClientListResponse 

type BuildsByBuilderResourceClientListResponse struct {
	// The response of a BuildResource list operation.
	BuildCollection
}

BuildsByBuilderResourceClientListResponse contains the response from method BuildsByBuilderResourceClient.NewListPager.

type BuildsClient 

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

BuildsClient contains the methods for the Builds group. Don't use this type directly, use NewBuildsClient() instead.

func NewBuildsClient 

func NewBuildsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildsClient, error)

NewBuildsClient creates a new instance of BuildsClient with the specified values.

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

func (*BuildsClient) BeginCreateOrUpdate 

func (client *BuildsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, builderName string, buildName string, buildEnvelope BuildResource, options *BuildsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a BuildResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • buildName - The name of a build.
  • buildEnvelope - Resource create or update parameters.
  • options - BuildsClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildsClient.BeginCreateOrUpdate method.
Example (BuildsCreateOrUpdateNoConfig)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json 

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.NewBuildsClient().BeginCreateOrUpdate(ctx, "rg", "testBuilder", "testBuild", armappcontainers.BuildResource{}, 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.BuildResource = armappcontainers.BuildResource{
// 	Name: to.Ptr("testBuild"),
// 	Type: to.Ptr("Microsoft.App/builders/builds"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild"),
// 	SystemData: &armappcontainers.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		CreatedBy: to.Ptr("sample@microsoft.com"),
// 		CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 	},
// 	Properties: &armappcontainers.BuildProperties{
// 		BuildStatus: to.Ptr(armappcontainers.BuildStatusInProgress),
// 		LogStreamEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/logstream"),
// 		ProvisioningState: to.Ptr(armappcontainers.BuildProvisioningStateSucceeded),
// 		TokenEndpoint: to.Ptr("https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"),
// 		UploadEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/upload"),
// 	},
// }

Output:
Example (BuildsCreateOrUpdateWithConfig)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builds_CreateOrUpdate.json 

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.NewBuildsClient().BeginCreateOrUpdate(ctx, "rg", "testBuilder", "testBuild-123456789az", armappcontainers.BuildResource{
	Properties: &armappcontainers.BuildProperties{
		Configuration: &armappcontainers.BuildConfiguration{
			BaseOs: to.Ptr("DebianBullseye"),
			EnvironmentVariables: []*armappcontainers.EnvironmentVariable{
				{
					Name:  to.Ptr("foo1"),
					Value: to.Ptr("bar1"),
				},
				{
					Name:  to.Ptr("foo2"),
					Value: to.Ptr("bar2"),
				}},
			Platform:        to.Ptr("dotnetcore"),
			PlatformVersion: to.Ptr("7.0"),
			PreBuildSteps: []*armappcontainers.PreBuildStep{
				{
					Description: to.Ptr("First pre build step."),
					HTTPGet: &armappcontainers.HTTPGet{
						FileName: to.Ptr("output.txt"),
						Headers: []*string{
							to.Ptr("foo"),
							to.Ptr("bar")},
						URL: to.Ptr("https://microsoft.com"),
					},
					Scripts: []*string{
						to.Ptr("echo 'hello'"),
						to.Ptr("echo 'world'")},
				},
				{
					Description: to.Ptr("Second pre build step."),
					HTTPGet: &armappcontainers.HTTPGet{
						FileName: to.Ptr("output.txt"),
						Headers: []*string{
							to.Ptr("foo")},
						URL: to.Ptr("https://microsoft.com"),
					},
					Scripts: []*string{
						to.Ptr("echo 'hello'"),
						to.Ptr("echo 'again'")},
				}},
		},
		DestinationContainerRegistry: &armappcontainers.ContainerRegistryWithCustomImage{
			Image:  to.Ptr("test.azurecr.io/repo:tag"),
			Server: to.Ptr("test.azurecr.io"),
		},
	},
}, 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.BuildResource = armappcontainers.BuildResource{
// 	Name: to.Ptr("testBuild-123456789az"),
// 	Type: to.Ptr("Microsoft.App/builders/builds"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild-123456789az"),
// 	SystemData: &armappcontainers.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		CreatedBy: to.Ptr("sample@microsoft.com"),
// 		CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 	},
// 	Properties: &armappcontainers.BuildProperties{
// 		BuildStatus: to.Ptr(armappcontainers.BuildStatusInProgress),
// 		Configuration: &armappcontainers.BuildConfiguration{
// 			BaseOs: to.Ptr("DebianBullseye"),
// 			EnvironmentVariables: []*armappcontainers.EnvironmentVariable{
// 				{
// 					Name: to.Ptr("foo1"),
// 					Value: to.Ptr("bar1"),
// 				},
// 				{
// 					Name: to.Ptr("foo2"),
// 					Value: to.Ptr("bar2"),
// 			}},
// 			Platform: to.Ptr("dotnetcore"),
// 			PlatformVersion: to.Ptr("7.0"),
// 			PreBuildSteps: []*armappcontainers.PreBuildStep{
// 				{
// 					Description: to.Ptr("First pre build step."),
// 					HTTPGet: &armappcontainers.HTTPGet{
// 						FileName: to.Ptr("output.txt"),
// 						Headers: []*string{
// 							to.Ptr("foo"),
// 							to.Ptr("bar")},
// 							URL: to.Ptr("https://microsoft.com"),
// 						},
// 						Scripts: []*string{
// 							to.Ptr("echo 'hello'"),
// 							to.Ptr("echo 'world'")},
// 						},
// 						{
// 							Description: to.Ptr("Second pre build step."),
// 							HTTPGet: &armappcontainers.HTTPGet{
// 								FileName: to.Ptr("output.txt"),
// 								Headers: []*string{
// 									to.Ptr("foo")},
// 									URL: to.Ptr("https://microsoft.com"),
// 								},
// 								Scripts: []*string{
// 									to.Ptr("echo 'hello'"),
// 									to.Ptr("echo 'again'")},
// 							}},
// 						},
// 						DestinationContainerRegistry: &armappcontainers.ContainerRegistryWithCustomImage{
// 							Image: to.Ptr("test.azurecr.io/repo:tag"),
// 							Server: to.Ptr("test.azurecr.io"),
// 						},
// 						LogStreamEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/logstream"),
// 						ProvisioningState: to.Ptr(armappcontainers.BuildProvisioningStateSucceeded),
// 						TokenEndpoint: to.Ptr("https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"),
// 						UploadEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/upload"),
// 					},
// 				}

Output:

func (*BuildsClient) BeginDelete 

func (client *BuildsClient) BeginDelete(ctx context.Context, resourceGroupName string, builderName string, buildName string, options *BuildsClientBeginDeleteOptions) (*runtime.Poller[BuildsClientDeleteResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • buildName - The name of a build.
  • options - BuildsClientBeginDeleteOptions contains the optional parameters for the BuildsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builds_Delete.json 

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.NewBuildsClient().BeginDelete(ctx, "rg", "testBuilder", "testBuild", 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 (*BuildsClient) Get 

func (client *BuildsClient) Get(ctx context.Context, resourceGroupName string, builderName string, buildName string, options *BuildsClientGetOptions) (BuildsClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • builderName - The name of the builder.
  • buildName - The name of a build.
  • options - BuildsClientGetOptions contains the optional parameters for the BuildsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Builds_Get.json 

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.NewBuildsClient().Get(ctx, "rg", "testBuilder", "testBuild", 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.BuildResource = armappcontainers.BuildResource{
// 	Name: to.Ptr("testBuild"),
// 	Type: to.Ptr("Microsoft.App/builders/builds"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild"),
// 	SystemData: &armappcontainers.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		CreatedBy: to.Ptr("sample@microsoft.com"),
// 		CreatedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-11T11:05:51.494Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armappcontainers.CreatedByTypeUser),
// 	},
// 	Properties: &armappcontainers.BuildProperties{
// 		BuildStatus: to.Ptr(armappcontainers.BuildStatusInProgress),
// 		Configuration: &armappcontainers.BuildConfiguration{
// 			BaseOs: to.Ptr("DebianBullseye"),
// 			EnvironmentVariables: []*armappcontainers.EnvironmentVariable{
// 				{
// 					Name: to.Ptr("foo1"),
// 					Value: to.Ptr("bar1"),
// 				},
// 				{
// 					Name: to.Ptr("foo2"),
// 					Value: to.Ptr("bar2"),
// 			}},
// 			Platform: to.Ptr("dotnetcore"),
// 			PlatformVersion: to.Ptr("7.0"),
// 			PreBuildSteps: []*armappcontainers.PreBuildStep{
// 				{
// 					Description: to.Ptr("First pre build step."),
// 					HTTPGet: &armappcontainers.HTTPGet{
// 						FileName: to.Ptr("output.txt"),
// 						Headers: []*string{
// 							to.Ptr("foo"),
// 							to.Ptr("bar")},
// 							URL: to.Ptr("https://microsoft.com"),
// 						},
// 						Scripts: []*string{
// 							to.Ptr("echo 'hello'"),
// 							to.Ptr("echo 'world'")},
// 						},
// 						{
// 							Description: to.Ptr("Second pre build step."),
// 							HTTPGet: &armappcontainers.HTTPGet{
// 								FileName: to.Ptr("output.txt"),
// 								Headers: []*string{
// 									to.Ptr("foo")},
// 									URL: to.Ptr("https://microsoft.com"),
// 								},
// 								Scripts: []*string{
// 									to.Ptr("echo 'hello'"),
// 									to.Ptr("echo 'again'")},
// 							}},
// 						},
// 						DestinationContainerRegistry: &armappcontainers.ContainerRegistryWithCustomImage{
// 							Image: to.Ptr("test.azurecr.io/repo:tag"),
// 							Server: to.Ptr("test.azurecr.io"),
// 						},
// 						LogStreamEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/logstream"),
// 						ProvisioningState: to.Ptr(armappcontainers.BuildProvisioningStateSucceeded),
// 						TokenEndpoint: to.Ptr("https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"),
// 						UploadEndpoint: to.Ptr("https://foo.azurecontainerapps.dev/upload"),
// 					},
// 				}

Output:

type BuildsClientBeginCreateOrUpdateOptions 

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

BuildsClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildsClient.BeginCreateOrUpdate method.

type BuildsClientBeginDeleteOptions 

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

BuildsClientBeginDeleteOptions contains the optional parameters for the BuildsClient.BeginDelete method.

type BuildsClientCreateOrUpdateResponse 

type BuildsClientCreateOrUpdateResponse struct {
	// Information pertaining to an individual build.
	BuildResource
}

BuildsClientCreateOrUpdateResponse contains the response from method BuildsClient.BeginCreateOrUpdate.

type BuildsClientDeleteResponse 

type BuildsClientDeleteResponse struct {
}

BuildsClientDeleteResponse contains the response from method BuildsClient.BeginDelete.

type BuildsClientGetOptions 

type BuildsClientGetOptions struct {
}

BuildsClientGetOptions contains the optional parameters for the BuildsClient.Get method.

type BuildsClientGetResponse 

type BuildsClientGetResponse struct {
	// Information pertaining to an individual build.
	BuildResource
}

BuildsClientGetResponse contains the response from method BuildsClient.Get.

type Certificate 

type Certificate struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Certificate resource specific properties
	Properties *CertificateProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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 

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

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

CertificateCollection - Collection of Certificates.

func (CertificateCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateCollection.

func (*CertificateCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateCollection.

type CertificateKeyVaultProperties 

type CertificateKeyVaultProperties struct {
	// Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.
	Identity *string

	// URL pointing to the Azure Key Vault secret that holds the certificate.
	KeyVaultURL *string
}

CertificateKeyVaultProperties - Properties for a certificate stored in a Key Vault.

func (CertificateKeyVaultProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateKeyVaultProperties.

func (*CertificateKeyVaultProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateKeyVaultProperties.

type CertificatePatch 

type CertificatePatch struct {
	// Application-specific metadata in the form of key-value pairs.
	Tags map[string]*string
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificatePatch.

type CertificateProperties 

type CertificateProperties struct {
	// Properties for a certificate stored in a Key Vault.
	CertificateKeyVaultProperties *CertificateKeyVaultProperties

	// The type of the certificate. Allowed values are ServerSSLCertificate and ImagePullTrustedCA
	CertificateType *CertificateType

	// Certificate password.
	Password *string

	// PFX or PEM blob
	Value []byte

	// READ-ONLY; Certificate expiration date.
	ExpirationDate *time.Time

	// READ-ONLY; Certificate issue Date.
	IssueDate *time.Time

	// READ-ONLY; Certificate issuer.
	Issuer *string

	// READ-ONLY; Provisioning state of the certificate.
	ProvisioningState *CertificateProvisioningState

	// READ-ONLY; Public key hash.
	PublicKeyHash *string

	// READ-ONLY; Subject alternative names the certificate applies to.
	SubjectAlternativeNames []*string

	// READ-ONLY; Subject name of the certificate.
	SubjectName *string

	// READ-ONLY; Certificate thumbprint.
	Thumbprint *string

	// READ-ONLY; Is the certificate valid?.
	Valid *bool
}

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 CertificateType 

type CertificateType string

CertificateType - The type of the certificate. Allowed values are ServerSSLCertificate and ImagePullTrustedCA 

const (
	CertificateTypeImagePullTrustedCA   CertificateType = "ImagePullTrustedCA"
	CertificateTypeServerSSLCertificate CertificateType = "ServerSSLCertificate"
)

func PossibleCertificateTypeValues 

func PossibleCertificateTypeValues() []CertificateType

PossibleCertificateTypeValues returns the possible values for the CertificateType 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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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 (CreateOrUpdateCertificate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificate_CreateOrUpdate.json 

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{
		CertificateType: to.Ptr(armappcontainers.CertificateTypeImagePullTrustedCA),
		Password:        to.Ptr("private key password"),
		Value:           []byte("Y2VydA=="),
	},
},
})
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/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.CertificateProperties{
// 		CertificateType: to.Ptr(armappcontainers.CertificateTypeImagePullTrustedCA),
// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 			Valid: to.Ptr(true),
// 		},
// 	}

Output:
Example (CreateOrUpdateCertificateUsingManagedIdentity)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json 

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{
		CertificateKeyVaultProperties: &armappcontainers.CertificateKeyVaultProperties{
			Identity:    to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"),
			KeyVaultURL: to.Ptr("https://xxxxxxxx.vault.azure.net/certificates/certName"),
		},
		CertificateType: to.Ptr(armappcontainers.CertificateTypeServerSSLCertificate),
	},
},
})
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/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.CertificateProperties{
// 		CertificateKeyVaultProperties: &armappcontainers.CertificateKeyVaultProperties{
// 			Identity: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"),
// 			KeyVaultURL: to.Ptr("https://xxxxxxxx.vault.azure.net/certificates/certName"),
// 		},
// 		CertificateType: to.Ptr(armappcontainers.CertificateTypeServerSSLCertificate),
// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificate_Delete.json 

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificate_Get.json 

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/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.CertificateProperties{
// 		CertificateType: to.Ptr(armappcontainers.CertificateTypeServerSSLCertificate),
// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificates_ListByManagedEnvironment.json 

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-name"),
	// 			Type: to.Ptr("Microsoft.App/ManagedEnvironments/Certificates"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificate-firendly-name"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.CertificateProperties{
	// 				CertificateType: to.Ptr(armappcontainers.CertificateTypeImagePullTrustedCA),
	// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 				IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
	// 				Issuer: to.Ptr("Issuer Name"),
	// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 				SubjectAlternativeNames: []*string{
	// 					to.Ptr("CN=my-subject-name.com")},
	// 					SubjectName: to.Ptr("my-subject-name.company.country.net"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 					Valid: to.Ptr(true),
	// 				},
	// 			},
	// 			{
	// 				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/certificate-firendly-name"),
	// 				Location: to.Ptr("East US"),
	// 				Properties: &armappcontainers.CertificateProperties{
	// 					CertificateType: to.Ptr(armappcontainers.CertificateTypeServerSSLCertificate),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
	// 					Issuer: to.Ptr("Issuer Name"),
	// 					ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 					SubjectAlternativeNames: []*string{
	// 						to.Ptr("CN=my-subject-name.com")},
	// 						SubjectName: to.Ptr("my-subject-name.company.country.net"),
	// 						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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificates_Patch.json 

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/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armappcontainers.CertificateProperties{
// 		CertificateType: to.Ptr(armappcontainers.CertificateTypeServerSSLCertificate),
// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			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 used for Custom Domain bindings of Container Apps in a Managed Environment
	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 used for Custom Domain bindings of Container Apps in a Managed Environment
	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 {
	// Collection of Certificates.
	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 used for Custom Domain bindings of Container Apps in a Managed Environment
	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

	// The resource type.
	Type *string
}

CheckNameAvailabilityRequest - The check availability request body.

func (CheckNameAvailabilityRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityRequest.

func (*CheckNameAvailabilityRequest) UnmarshalJSON 

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

	// Indicates if the resource name is available.
	NameAvailable *bool

	// The reason why the given name is not available.
	Reason *CheckNameAvailabilityReason
}

CheckNameAvailabilityResponse - The check availability result.

func (CheckNameAvailabilityResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityResponse.

func (*CheckNameAvailabilityResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityResponse.

type CircuitBreakerPolicy 

type CircuitBreakerPolicy struct {
	// Number of consecutive errors before the circuit breaker opens
	ConsecutiveErrors *int32

	// The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails
	// as well as closing the circuit breaker if the check succeeds. Defaults to 10s.
	IntervalInSeconds *int32

	// Maximum percentage of hosts that will be ejected after failure threshold has been met
	MaxEjectionPercent *int32
}

CircuitBreakerPolicy - Policy that defines circuit breaker conditions

func (CircuitBreakerPolicy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CircuitBreakerPolicy.

func (*CircuitBreakerPolicy) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CircuitBreakerPolicy.

type ClientFactory 

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 

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. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAppResiliencyClient 

func (c *ClientFactory) NewAppResiliencyClient() *AppResiliencyClient

NewAppResiliencyClient creates a new instance of AppResiliencyClient.

func (*ClientFactory) NewAvailableWorkloadProfilesClient 

func (c *ClientFactory) NewAvailableWorkloadProfilesClient() *AvailableWorkloadProfilesClient

NewAvailableWorkloadProfilesClient creates a new instance of AvailableWorkloadProfilesClient.

func (*ClientFactory) NewBillingMetersClient 

func (c *ClientFactory) NewBillingMetersClient() *BillingMetersClient

NewBillingMetersClient creates a new instance of BillingMetersClient.

func (*ClientFactory) NewBuildAuthTokenClient 

func (c *ClientFactory) NewBuildAuthTokenClient() *BuildAuthTokenClient

NewBuildAuthTokenClient creates a new instance of BuildAuthTokenClient.

func (*ClientFactory) NewBuildersClient 

func (c *ClientFactory) NewBuildersClient() *BuildersClient

NewBuildersClient creates a new instance of BuildersClient.

func (*ClientFactory) NewBuildsByBuilderResourceClient 

func (c *ClientFactory) NewBuildsByBuilderResourceClient() *BuildsByBuilderResourceClient

NewBuildsByBuilderResourceClient creates a new instance of BuildsByBuilderResourceClient.

func (*ClientFactory) NewBuildsClient 

func (c *ClientFactory) NewBuildsClient() *BuildsClient

NewBuildsClient creates a new instance of BuildsClient.

func (*ClientFactory) NewCertificatesClient 

func (c *ClientFactory) NewCertificatesClient() *CertificatesClient

NewCertificatesClient creates a new instance of CertificatesClient.

func (*ClientFactory) NewConnectedEnvironmentsCertificatesClient 

func (c *ClientFactory) NewConnectedEnvironmentsCertificatesClient() *ConnectedEnvironmentsCertificatesClient

NewConnectedEnvironmentsCertificatesClient creates a new instance of ConnectedEnvironmentsCertificatesClient.

func (*ClientFactory) NewConnectedEnvironmentsClient 

func (c *ClientFactory) NewConnectedEnvironmentsClient() *ConnectedEnvironmentsClient

NewConnectedEnvironmentsClient creates a new instance of ConnectedEnvironmentsClient.

func (*ClientFactory) NewConnectedEnvironmentsDaprComponentsClient 

func (c *ClientFactory) NewConnectedEnvironmentsDaprComponentsClient() *ConnectedEnvironmentsDaprComponentsClient

NewConnectedEnvironmentsDaprComponentsClient creates a new instance of ConnectedEnvironmentsDaprComponentsClient.

func (*ClientFactory) NewConnectedEnvironmentsStoragesClient 

func (c *ClientFactory) NewConnectedEnvironmentsStoragesClient() *ConnectedEnvironmentsStoragesClient

NewConnectedEnvironmentsStoragesClient creates a new instance of ConnectedEnvironmentsStoragesClient.

func (*ClientFactory) NewContainerAppsAPIClient 

func (c *ClientFactory) NewContainerAppsAPIClient() *ContainerAppsAPIClient

NewContainerAppsAPIClient creates a new instance of ContainerAppsAPIClient.

func (*ClientFactory) NewContainerAppsAuthConfigsClient 

func (c *ClientFactory) NewContainerAppsAuthConfigsClient() *ContainerAppsAuthConfigsClient

NewContainerAppsAuthConfigsClient creates a new instance of ContainerAppsAuthConfigsClient.

func (*ClientFactory) NewContainerAppsClient 

func (c *ClientFactory) NewContainerAppsClient() *ContainerAppsClient

NewContainerAppsClient creates a new instance of ContainerAppsClient.

func (*ClientFactory) NewContainerAppsDiagnosticsClient 

func (c *ClientFactory) NewContainerAppsDiagnosticsClient() *ContainerAppsDiagnosticsClient

NewContainerAppsDiagnosticsClient creates a new instance of ContainerAppsDiagnosticsClient.

func (*ClientFactory) NewContainerAppsRevisionReplicasClient 

func (c *ClientFactory) NewContainerAppsRevisionReplicasClient() *ContainerAppsRevisionReplicasClient

NewContainerAppsRevisionReplicasClient creates a new instance of ContainerAppsRevisionReplicasClient.

func (*ClientFactory) NewContainerAppsRevisionsClient 

func (c *ClientFactory) NewContainerAppsRevisionsClient() *ContainerAppsRevisionsClient

NewContainerAppsRevisionsClient creates a new instance of ContainerAppsRevisionsClient.

func (*ClientFactory) NewContainerAppsSourceControlsClient 

func (c *ClientFactory) NewContainerAppsSourceControlsClient() *ContainerAppsSourceControlsClient

NewContainerAppsSourceControlsClient creates a new instance of ContainerAppsSourceControlsClient.

func (*ClientFactory) NewDaprComponentResiliencyPoliciesClient 

func (c *ClientFactory) NewDaprComponentResiliencyPoliciesClient() *DaprComponentResiliencyPoliciesClient

NewDaprComponentResiliencyPoliciesClient creates a new instance of DaprComponentResiliencyPoliciesClient.

func (*ClientFactory) NewDaprComponentsClient 

func (c *ClientFactory) NewDaprComponentsClient() *DaprComponentsClient

NewDaprComponentsClient creates a new instance of DaprComponentsClient.

func (*ClientFactory) NewDaprSubscriptionsClient 

func (c *ClientFactory) NewDaprSubscriptionsClient() *DaprSubscriptionsClient

NewDaprSubscriptionsClient creates a new instance of DaprSubscriptionsClient.

func (*ClientFactory) NewDotNetComponentsClient 

func (c *ClientFactory) NewDotNetComponentsClient() *DotNetComponentsClient

NewDotNetComponentsClient creates a new instance of DotNetComponentsClient.

func (*ClientFactory) NewJavaComponentsClient 

func (c *ClientFactory) NewJavaComponentsClient() *JavaComponentsClient

NewJavaComponentsClient creates a new instance of JavaComponentsClient.

func (*ClientFactory) NewJobsClient 

func (c *ClientFactory) NewJobsClient() *JobsClient

NewJobsClient creates a new instance of JobsClient.

func (*ClientFactory) NewJobsExecutionsClient 

func (c *ClientFactory) NewJobsExecutionsClient() *JobsExecutionsClient

NewJobsExecutionsClient creates a new instance of JobsExecutionsClient.

func (*ClientFactory) NewManagedCertificatesClient 

func (c *ClientFactory) NewManagedCertificatesClient() *ManagedCertificatesClient

NewManagedCertificatesClient creates a new instance of ManagedCertificatesClient.

func (*ClientFactory) NewManagedEnvironmentDiagnosticsClient 

func (c *ClientFactory) NewManagedEnvironmentDiagnosticsClient() *ManagedEnvironmentDiagnosticsClient

NewManagedEnvironmentDiagnosticsClient creates a new instance of ManagedEnvironmentDiagnosticsClient.

func (*ClientFactory) NewManagedEnvironmentUsagesClient 

func (c *ClientFactory) NewManagedEnvironmentUsagesClient() *ManagedEnvironmentUsagesClient

NewManagedEnvironmentUsagesClient creates a new instance of ManagedEnvironmentUsagesClient.

func (*ClientFactory) NewManagedEnvironmentsClient 

func (c *ClientFactory) NewManagedEnvironmentsClient() *ManagedEnvironmentsClient

NewManagedEnvironmentsClient creates a new instance of ManagedEnvironmentsClient.

func (*ClientFactory) NewManagedEnvironmentsDiagnosticsClient 

func (c *ClientFactory) NewManagedEnvironmentsDiagnosticsClient() *ManagedEnvironmentsDiagnosticsClient

NewManagedEnvironmentsDiagnosticsClient creates a new instance of ManagedEnvironmentsDiagnosticsClient.

func (*ClientFactory) NewManagedEnvironmentsStoragesClient 

func (c *ClientFactory) NewManagedEnvironmentsStoragesClient() *ManagedEnvironmentsStoragesClient

NewManagedEnvironmentsStoragesClient creates a new instance of ManagedEnvironmentsStoragesClient.

func (*ClientFactory) NewNamespacesClient 

func (c *ClientFactory) NewNamespacesClient() *NamespacesClient

NewNamespacesClient creates a new instance of NamespacesClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewUsagesClient 

func (c *ClientFactory) NewUsagesClient() *UsagesClient

NewUsagesClient creates a new instance of UsagesClient.

type ClientRegistration 

type ClientRegistration struct {
	// The Client ID of the app used for login.
	ClientID *string

	// The app setting name that contains the client secret.
	ClientSecretSettingName *string
}

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

func (ClientRegistration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClientRegistration.

func (*ClientRegistration) UnmarshalJSON 

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

	// Dapr configuration for the Container App.
	Dapr *Dapr

	// Ingress configurations.
	Ingress *Ingress

	// Optional. Max inactive revisions a Container App can have.
	MaxInactiveRevisions *int32

	// Collection of private container registry credentials for containers used by the Container app
	Registries []*RegistryCredentials

	// Collection of secrets used by a Container app
	Secrets []*Secret

	// Container App to be a dev Container App Service
	Service *Service
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Configuration.

type ConnectedEnvironment 

type ConnectedEnvironment struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The complex type of the extended location.
	ExtendedLocation *ExtendedLocation

	// ConnectedEnvironment resource specific properties
	Properties *ConnectedEnvironmentProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ConnectedEnvironment - An environment for Kubernetes cluster specialized for web workloads by Azure App Service

func (ConnectedEnvironment) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectedEnvironment.

func (*ConnectedEnvironment) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedEnvironment.

type ConnectedEnvironmentCollection 

type ConnectedEnvironmentCollection struct {
	// Collection of resources.
	Value []*ConnectedEnvironment

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

ConnectedEnvironmentCollection - Collection of connectedEnvironments

func (ConnectedEnvironmentCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectedEnvironmentCollection.

func (*ConnectedEnvironmentCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedEnvironmentCollection.

type ConnectedEnvironmentProperties 

type ConnectedEnvironmentProperties struct {
	// Custom domain configuration for the environment
	CustomDomainConfiguration *CustomDomainConfiguration

	// Application Insights connection string used by Dapr to export Service to Service communication telemetry
	DaprAIConnectionString *string

	// Static IP of the connectedEnvironment
	StaticIP *string

	// READ-ONLY; Default Domain Name for the cluster
	DefaultDomain *string

	// READ-ONLY; Any errors that occurred during deployment or deployment validation
	DeploymentErrors *string

	// READ-ONLY; Provisioning state of the Kubernetes Environment.
	ProvisioningState *ConnectedEnvironmentProvisioningState
}

ConnectedEnvironmentProperties - ConnectedEnvironment resource specific properties

func (ConnectedEnvironmentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectedEnvironmentProperties.

func (*ConnectedEnvironmentProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedEnvironmentProperties.

type ConnectedEnvironmentProvisioningState 

type ConnectedEnvironmentProvisioningState string

ConnectedEnvironmentProvisioningState - Provisioning state of the Kubernetes Environment. 

const (
	ConnectedEnvironmentProvisioningStateCanceled                      ConnectedEnvironmentProvisioningState = "Canceled"
	ConnectedEnvironmentProvisioningStateFailed                        ConnectedEnvironmentProvisioningState = "Failed"
	ConnectedEnvironmentProvisioningStateInfrastructureSetupComplete   ConnectedEnvironmentProvisioningState = "InfrastructureSetupComplete"
	ConnectedEnvironmentProvisioningStateInfrastructureSetupInProgress ConnectedEnvironmentProvisioningState = "InfrastructureSetupInProgress"
	ConnectedEnvironmentProvisioningStateInitializationInProgress      ConnectedEnvironmentProvisioningState = "InitializationInProgress"
	ConnectedEnvironmentProvisioningStateScheduledForDelete            ConnectedEnvironmentProvisioningState = "ScheduledForDelete"
	ConnectedEnvironmentProvisioningStateSucceeded                     ConnectedEnvironmentProvisioningState = "Succeeded"
	ConnectedEnvironmentProvisioningStateWaiting                       ConnectedEnvironmentProvisioningState = "Waiting"
)

func PossibleConnectedEnvironmentProvisioningStateValues 

func PossibleConnectedEnvironmentProvisioningStateValues() []ConnectedEnvironmentProvisioningState

PossibleConnectedEnvironmentProvisioningStateValues returns the possible values for the ConnectedEnvironmentProvisioningState const type.

type ConnectedEnvironmentStorage 

type ConnectedEnvironmentStorage struct {
	// Storage properties
	Properties *ConnectedEnvironmentStorageProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ConnectedEnvironmentStorage - Storage resource for connectedEnvironment.

func (ConnectedEnvironmentStorage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectedEnvironmentStorage.

func (*ConnectedEnvironmentStorage) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedEnvironmentStorage.

type ConnectedEnvironmentStorageProperties 

type ConnectedEnvironmentStorageProperties struct {
	// Azure file properties
	AzureFile *AzureFileProperties
}

ConnectedEnvironmentStorageProperties - Storage properties

func (ConnectedEnvironmentStorageProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectedEnvironmentStorageProperties.

func (*ConnectedEnvironmentStorageProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedEnvironmentStorageProperties.

type ConnectedEnvironmentStoragesCollection 

type ConnectedEnvironmentStoragesCollection struct {
	// REQUIRED; Collection of storage resources.
	Value []*ConnectedEnvironmentStorage
}

ConnectedEnvironmentStoragesCollection - Collection of Storage for Environments

func (ConnectedEnvironmentStoragesCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectedEnvironmentStoragesCollection.

func (*ConnectedEnvironmentStoragesCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedEnvironmentStoragesCollection.

type ConnectedEnvironmentsCertificatesClient 

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

ConnectedEnvironmentsCertificatesClient contains the methods for the ConnectedEnvironmentsCertificates group. Don't use this type directly, use NewConnectedEnvironmentsCertificatesClient() instead.

func NewConnectedEnvironmentsCertificatesClient 

func NewConnectedEnvironmentsCertificatesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectedEnvironmentsCertificatesClient, error)

NewConnectedEnvironmentsCertificatesClient creates a new instance of ConnectedEnvironmentsCertificatesClient with the specified values.

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

func (*ConnectedEnvironmentsCertificatesClient) CreateOrUpdate 

func (client *ConnectedEnvironmentsCertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, certificateName string, options *ConnectedEnvironmentsCertificatesClientCreateOrUpdateOptions) (ConnectedEnvironmentsCertificatesClientCreateOrUpdateResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Connected Environment.
  • certificateName - Name of the Certificate.
  • options - ConnectedEnvironmentsCertificatesClientCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json 

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.NewConnectedEnvironmentsCertificatesClient().CreateOrUpdate(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", &armappcontainers.ConnectedEnvironmentsCertificatesClientCreateOrUpdateOptions{CertificateEnvelope: &armappcontainers.Certificate{
	Location: to.Ptr("East US"),
	Properties: &armappcontainers.CertificateProperties{
		Password: to.Ptr("private key password"),
		Value:    []byte("Y2VydA=="),
	},
},
})
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/ConnectedEnvironments/Certificates"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/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:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 			Valid: to.Ptr(true),
// 		},
// 	}

Output:

func (*ConnectedEnvironmentsCertificatesClient) Delete 

func (client *ConnectedEnvironmentsCertificatesClient) Delete(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, certificateName string, options *ConnectedEnvironmentsCertificatesClientDeleteOptions) (ConnectedEnvironmentsCertificatesClientDeleteResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Connected Environment.
  • certificateName - Name of the Certificate.
  • options - ConnectedEnvironmentsCertificatesClientDeleteOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json 

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.NewConnectedEnvironmentsCertificatesClient().Delete(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*ConnectedEnvironmentsCertificatesClient) Get 

func (client *ConnectedEnvironmentsCertificatesClient) Get(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, certificateName string, options *ConnectedEnvironmentsCertificatesClientGetOptions) (ConnectedEnvironmentsCertificatesClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Connected Environment.
  • certificateName - Name of the Certificate.
  • options - ConnectedEnvironmentsCertificatesClientGetOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json 

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.NewConnectedEnvironmentsCertificatesClient().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/ConnectedEnvironments/Certificates"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/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:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 			Valid: to.Ptr(true),
// 		},
// 	}

Output:

func (*ConnectedEnvironmentsCertificatesClient) NewListPager 

func (client *ConnectedEnvironmentsCertificatesClient) NewListPager(resourceGroupName string, connectedEnvironmentName string, options *ConnectedEnvironmentsCertificatesClientListOptions) *runtime.Pager[ConnectedEnvironmentsCertificatesClientListResponse]

NewListPager - Get the Certificates in a given connected environment.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Connected Environment.
  • options - ConnectedEnvironmentsCertificatesClientListOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json 

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.NewConnectedEnvironmentsCertificatesClient().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-name"),
	// 			Type: to.Ptr("Microsoft.App/ConnectedEnvironments/Certificates"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/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:00.000Z"); return t}()),
	// 				IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
	// 				Issuer: to.Ptr("Issuer Name"),
	// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 				SubjectAlternativeNames: []*string{
	// 					to.Ptr("CN=my-subject-name.com")},
	// 					SubjectName: to.Ptr("my-subject-name.company.country.net"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 					Valid: to.Ptr(true),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("certificate-firendly-name"),
	// 				Type: to.Ptr("Microsoft.App/ConnectedEnvironments/Certificates"),
	// 				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/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:00.000Z"); return t}()),
	// 					IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
	// 					Issuer: to.Ptr("Issuer Name"),
	// 					ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 					SubjectAlternativeNames: []*string{
	// 						to.Ptr("CN=my-subject-name.com")},
	// 						SubjectName: to.Ptr("my-subject-name.company.country.net"),
	// 						Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 						Valid: to.Ptr(true),
	// 					},
	// 			}},
	// 		}
}

Output:

func (*ConnectedEnvironmentsCertificatesClient) Update 

func (client *ConnectedEnvironmentsCertificatesClient) Update(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, certificateName string, certificateEnvelope CertificatePatch, options *ConnectedEnvironmentsCertificatesClientUpdateOptions) (ConnectedEnvironmentsCertificatesClientUpdateResponse, 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 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json 

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.NewConnectedEnvironmentsCertificatesClient().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/ConnectedEnvironments/Certificates"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/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:00.000Z"); return t}()),
// 		IssueDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-06T04:00:00.000Z"); return t}()),
// 		Issuer: to.Ptr("Issuer Name"),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectAlternativeNames: []*string{
// 			to.Ptr("CN=my-subject-name.com")},
// 			SubjectName: to.Ptr("my-subject-name.company.country.net"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 			Valid: to.Ptr(true),
// 		},
// 	}

Output:

type ConnectedEnvironmentsCertificatesClientCreateOrUpdateOptions 

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

ConnectedEnvironmentsCertificatesClientCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.CreateOrUpdate method.

type ConnectedEnvironmentsCertificatesClientCreateOrUpdateResponse 

type ConnectedEnvironmentsCertificatesClientCreateOrUpdateResponse struct {
	// Certificate used for Custom Domain bindings of Container Apps in a Managed Environment
	Certificate
}

ConnectedEnvironmentsCertificatesClientCreateOrUpdateResponse contains the response from method ConnectedEnvironmentsCertificatesClient.CreateOrUpdate.

type ConnectedEnvironmentsCertificatesClientDeleteOptions 

type ConnectedEnvironmentsCertificatesClientDeleteOptions struct {
}

ConnectedEnvironmentsCertificatesClientDeleteOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.Delete method.

type ConnectedEnvironmentsCertificatesClientDeleteResponse 

type ConnectedEnvironmentsCertificatesClientDeleteResponse struct {
}

ConnectedEnvironmentsCertificatesClientDeleteResponse contains the response from method ConnectedEnvironmentsCertificatesClient.Delete.

type ConnectedEnvironmentsCertificatesClientGetOptions 

type ConnectedEnvironmentsCertificatesClientGetOptions struct {
}

ConnectedEnvironmentsCertificatesClientGetOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.Get method.

type ConnectedEnvironmentsCertificatesClientGetResponse 

type ConnectedEnvironmentsCertificatesClientGetResponse struct {
	// Certificate used for Custom Domain bindings of Container Apps in a Managed Environment
	Certificate
}

ConnectedEnvironmentsCertificatesClientGetResponse contains the response from method ConnectedEnvironmentsCertificatesClient.Get.

type ConnectedEnvironmentsCertificatesClientListOptions 

type ConnectedEnvironmentsCertificatesClientListOptions struct {
}

ConnectedEnvironmentsCertificatesClientListOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.NewListPager method.

type ConnectedEnvironmentsCertificatesClientListResponse 

type ConnectedEnvironmentsCertificatesClientListResponse struct {
	// Collection of Certificates.
	CertificateCollection
}

ConnectedEnvironmentsCertificatesClientListResponse contains the response from method ConnectedEnvironmentsCertificatesClient.NewListPager.

type ConnectedEnvironmentsCertificatesClientUpdateOptions 

type ConnectedEnvironmentsCertificatesClientUpdateOptions struct {
}

ConnectedEnvironmentsCertificatesClientUpdateOptions contains the optional parameters for the ConnectedEnvironmentsCertificatesClient.Update method.

type ConnectedEnvironmentsCertificatesClientUpdateResponse 

type ConnectedEnvironmentsCertificatesClientUpdateResponse struct {
	// Certificate used for Custom Domain bindings of Container Apps in a Managed Environment
	Certificate
}

ConnectedEnvironmentsCertificatesClientUpdateResponse contains the response from method ConnectedEnvironmentsCertificatesClient.Update.

type ConnectedEnvironmentsClient 

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

ConnectedEnvironmentsClient contains the methods for the ConnectedEnvironments group. Don't use this type directly, use NewConnectedEnvironmentsClient() instead.

func NewConnectedEnvironmentsClient 

func NewConnectedEnvironmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectedEnvironmentsClient, error)

NewConnectedEnvironmentsClient creates a new instance of ConnectedEnvironmentsClient with the specified values.

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

func (*ConnectedEnvironmentsClient) BeginCreateOrUpdate 

func (client *ConnectedEnvironmentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, environmentEnvelope ConnectedEnvironment, options *ConnectedEnvironmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConnectedEnvironmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an connectedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connectedEnvironment.
  • environmentEnvelope - Configuration details of the connectedEnvironment.
  • options - ConnectedEnvironmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json 

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.NewConnectedEnvironmentsClient().BeginCreateOrUpdate(ctx, "examplerg", "testenv", armappcontainers.ConnectedEnvironment{
	Location: to.Ptr("East US"),
	Properties: &armappcontainers.ConnectedEnvironmentProperties{
		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
			CertificatePassword: to.Ptr("private key password"),
			CertificateValue:    []byte("Y2VydA=="),
			DNSSuffix:           to.Ptr("www.my-name.com"),
		},
		DaprAIConnectionString: to.Ptr("InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/"),
		StaticIP:               to.Ptr("1.2.3.4"),
	},
}, 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.ConnectedEnvironment = armappcontainers.ConnectedEnvironment{
// 	Name: to.Ptr("testenv"),
// 	Type: to.Ptr("Microsoft.App/connectedEnvironments"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv"),
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 	},
// 	ExtendedLocation: &armappcontainers.ExtendedLocation{
// 		Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
// 		Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
// 	},
// 	Properties: &armappcontainers.ConnectedEnvironmentProperties{
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DefaultDomain: to.Ptr("testenv.k4apps.io"),
// 		ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("1.2.3.4"),
// 	},
// }

Output:

func (*ConnectedEnvironmentsClient) BeginDelete 

func (client *ConnectedEnvironmentsClient) BeginDelete(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, options *ConnectedEnvironmentsClientBeginDeleteOptions) (*runtime.Poller[ConnectedEnvironmentsClientDeleteResponse], error)

BeginDelete - Delete an connectedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connectedEnvironment.
  • options - ConnectedEnvironmentsClientBeginDeleteOptions contains the optional parameters for the ConnectedEnvironmentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironments_Delete.json 

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.NewConnectedEnvironmentsClient().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 (*ConnectedEnvironmentsClient) CheckNameAvailability 

func (client *ConnectedEnvironmentsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, checkNameAvailabilityRequest CheckNameAvailabilityRequest, options *ConnectedEnvironmentsClientCheckNameAvailabilityOptions) (ConnectedEnvironmentsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks if resource connectedEnvironmentName is available. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Managed Environment.
  • checkNameAvailabilityRequest - The check connectedEnvironmentName availability request.
  • options - ConnectedEnvironmentsClientCheckNameAvailabilityOptions contains the optional parameters for the ConnectedEnvironmentsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json 

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.NewConnectedEnvironmentsClient().CheckNameAvailability(ctx, "examplerg", "testcontainerenv", armappcontainers.CheckNameAvailabilityRequest{
	Name: to.Ptr("testcertificatename"),
	Type: to.Ptr("Microsoft.App/connectedEnvironments/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:

func (*ConnectedEnvironmentsClient) Get 

func (client *ConnectedEnvironmentsClient) Get(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, options *ConnectedEnvironmentsClientGetOptions) (ConnectedEnvironmentsClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connectedEnvironment.
  • options - ConnectedEnvironmentsClientGetOptions contains the optional parameters for the ConnectedEnvironmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironments_Get.json 

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.NewConnectedEnvironmentsClient().Get(ctx, "examplerg", "examplekenv", 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.ConnectedEnvironment = armappcontainers.ConnectedEnvironment{
// 	Name: to.Ptr("examplekenv"),
// 	Type: to.Ptr("Microsoft.App/connectedEnvironments"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/examplekenv"),
// 	Location: to.Ptr("North Central US"),
// 	Tags: map[string]*string{
// 	},
// 	ExtendedLocation: &armappcontainers.ExtendedLocation{
// 		Name: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
// 		Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
// 	},
// 	Properties: &armappcontainers.ConnectedEnvironmentProperties{
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DefaultDomain: to.Ptr("examplekenv.k4apps.io"),
// 		ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("20.42.33.145"),
// 	},
// }

Output:

func (*ConnectedEnvironmentsClient) NewListByResourceGroupPager 

func (client *ConnectedEnvironmentsClient) NewListByResourceGroupPager(resourceGroupName string, options *ConnectedEnvironmentsClientListByResourceGroupOptions) *runtime.Pager[ConnectedEnvironmentsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Get all connectedEnvironments in a resource group.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json 

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.NewConnectedEnvironmentsClient().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.ConnectedEnvironmentCollection = armappcontainers.ConnectedEnvironmentCollection{
	// 	Value: []*armappcontainers.ConnectedEnvironment{
	// 		{
	// 			Name: to.Ptr("sample1"),
	// 			Type: to.Ptr("Microsoft.App/connectedEnvironments"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1"),
	// 			Location: to.Ptr("North Central US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			ExtendedLocation: &armappcontainers.ExtendedLocation{
	// 				Name: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
	// 				Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
	// 			},
	// 			Properties: &armappcontainers.ConnectedEnvironmentProperties{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("sample1.k4apps.io"),
	// 				ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("20.42.33.145"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("sample2"),
	// 			Type: to.Ptr("Microsoft.App/connectedEnvironments"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample2"),
	// 			Location: to.Ptr("North Central US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			ExtendedLocation: &armappcontainers.ExtendedLocation{
	// 				Name: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
	// 				Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
	// 			},
	// 			Properties: &armappcontainers.ConnectedEnvironmentProperties{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name2.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name2.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("sample2.k4apps.io"),
	// 				ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("52.142.21.61"),
	// 			},
	// 	}},
	// }
}

Output:

func (*ConnectedEnvironmentsClient) NewListBySubscriptionPager 

func (client *ConnectedEnvironmentsClient) NewListBySubscriptionPager(options *ConnectedEnvironmentsClientListBySubscriptionOptions) *runtime.Pager[ConnectedEnvironmentsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Get all connectedEnvironments for a subscription.

Generated from API version 2023-11-02-preview

  • options - ConnectedEnvironmentsClientListBySubscriptionOptions contains the optional parameters for the ConnectedEnvironmentsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironments_ListBySubscription.json 

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.NewConnectedEnvironmentsClient().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.ConnectedEnvironmentCollection = armappcontainers.ConnectedEnvironmentCollection{
	// 	Value: []*armappcontainers.ConnectedEnvironment{
	// 		{
	// 			Name: to.Ptr("sample1"),
	// 			Type: to.Ptr("Microsoft.App/connectedEnvironments"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1"),
	// 			Location: to.Ptr("North Central US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armappcontainers.ConnectedEnvironmentProperties{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("sample1.k4apps.io"),
	// 				ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("20.42.33.145"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("sample2"),
	// 			Type: to.Ptr("Microsoft.App/connectedEnvironments"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/connectedEnvironments/sample2"),
	// 			Location: to.Ptr("North Central US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armappcontainers.ConnectedEnvironmentProperties{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name2.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name2.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("sample2.k4apps.io"),
	// 				ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("52.142.21.61"),
	// 			},
	// 	}},
	// }
}

Output:

func (*ConnectedEnvironmentsClient) Update 

func (client *ConnectedEnvironmentsClient) Update(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, options *ConnectedEnvironmentsClientUpdateOptions) (ConnectedEnvironmentsClientUpdateResponse, error)

Update - Patches a Managed Environment. Only patching of tags is supported currently If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connectedEnvironment.
  • options - ConnectedEnvironmentsClientUpdateOptions contains the optional parameters for the ConnectedEnvironmentsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironments_Patch.json 

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.NewConnectedEnvironmentsClient().Update(ctx, "examplerg", "testenv", 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.ConnectedEnvironment = armappcontainers.ConnectedEnvironment{
// 	Name: to.Ptr("testenv"),
// 	Type: to.Ptr("Microsoft.App/connectedEnvironments"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv"),
// 	Location: to.Ptr("East US"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armappcontainers.ConnectedEnvironmentProperties{
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DefaultDomain: to.Ptr("testenv.k4apps.io"),
// 		ProvisioningState: to.Ptr(armappcontainers.ConnectedEnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("20.42.33.145"),
// 	},
// }

Output:

type ConnectedEnvironmentsClientBeginCreateOrUpdateOptions 

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

ConnectedEnvironmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsClient.BeginCreateOrUpdate method.

type ConnectedEnvironmentsClientBeginDeleteOptions 

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

ConnectedEnvironmentsClientBeginDeleteOptions contains the optional parameters for the ConnectedEnvironmentsClient.BeginDelete method.

type ConnectedEnvironmentsClientCheckNameAvailabilityOptions 

type ConnectedEnvironmentsClientCheckNameAvailabilityOptions struct {
}

ConnectedEnvironmentsClientCheckNameAvailabilityOptions contains the optional parameters for the ConnectedEnvironmentsClient.CheckNameAvailability method.

type ConnectedEnvironmentsClientCheckNameAvailabilityResponse 

type ConnectedEnvironmentsClientCheckNameAvailabilityResponse struct {
	// The check availability result.
	CheckNameAvailabilityResponse
}

ConnectedEnvironmentsClientCheckNameAvailabilityResponse contains the response from method ConnectedEnvironmentsClient.CheckNameAvailability.

type ConnectedEnvironmentsClientCreateOrUpdateResponse 

type ConnectedEnvironmentsClientCreateOrUpdateResponse struct {
	// An environment for Kubernetes cluster specialized for web workloads by Azure App Service
	ConnectedEnvironment
}

ConnectedEnvironmentsClientCreateOrUpdateResponse contains the response from method ConnectedEnvironmentsClient.BeginCreateOrUpdate.

type ConnectedEnvironmentsClientDeleteResponse 

type ConnectedEnvironmentsClientDeleteResponse struct {
}

ConnectedEnvironmentsClientDeleteResponse contains the response from method ConnectedEnvironmentsClient.BeginDelete.

type ConnectedEnvironmentsClientGetOptions 

type ConnectedEnvironmentsClientGetOptions struct {
}

ConnectedEnvironmentsClientGetOptions contains the optional parameters for the ConnectedEnvironmentsClient.Get method.

type ConnectedEnvironmentsClientGetResponse 

type ConnectedEnvironmentsClientGetResponse struct {
	// An environment for Kubernetes cluster specialized for web workloads by Azure App Service
	ConnectedEnvironment
}

ConnectedEnvironmentsClientGetResponse contains the response from method ConnectedEnvironmentsClient.Get.

type ConnectedEnvironmentsClientListByResourceGroupOptions 

type ConnectedEnvironmentsClientListByResourceGroupOptions struct {
}

ConnectedEnvironmentsClientListByResourceGroupOptions contains the optional parameters for the ConnectedEnvironmentsClient.NewListByResourceGroupPager method.

type ConnectedEnvironmentsClientListByResourceGroupResponse 

type ConnectedEnvironmentsClientListByResourceGroupResponse struct {
	// Collection of connectedEnvironments
	ConnectedEnvironmentCollection
}

ConnectedEnvironmentsClientListByResourceGroupResponse contains the response from method ConnectedEnvironmentsClient.NewListByResourceGroupPager.

type ConnectedEnvironmentsClientListBySubscriptionOptions 

type ConnectedEnvironmentsClientListBySubscriptionOptions struct {
}

ConnectedEnvironmentsClientListBySubscriptionOptions contains the optional parameters for the ConnectedEnvironmentsClient.NewListBySubscriptionPager method.

type ConnectedEnvironmentsClientListBySubscriptionResponse 

type ConnectedEnvironmentsClientListBySubscriptionResponse struct {
	// Collection of connectedEnvironments
	ConnectedEnvironmentCollection
}

ConnectedEnvironmentsClientListBySubscriptionResponse contains the response from method ConnectedEnvironmentsClient.NewListBySubscriptionPager.

type ConnectedEnvironmentsClientUpdateOptions 

type ConnectedEnvironmentsClientUpdateOptions struct {
}

ConnectedEnvironmentsClientUpdateOptions contains the optional parameters for the ConnectedEnvironmentsClient.Update method.

type ConnectedEnvironmentsClientUpdateResponse 

type ConnectedEnvironmentsClientUpdateResponse struct {
	// An environment for Kubernetes cluster specialized for web workloads by Azure App Service
	ConnectedEnvironment
}

ConnectedEnvironmentsClientUpdateResponse contains the response from method ConnectedEnvironmentsClient.Update.

type ConnectedEnvironmentsDaprComponentsClient 

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

ConnectedEnvironmentsDaprComponentsClient contains the methods for the ConnectedEnvironmentsDaprComponents group. Don't use this type directly, use NewConnectedEnvironmentsDaprComponentsClient() instead.

func NewConnectedEnvironmentsDaprComponentsClient 

func NewConnectedEnvironmentsDaprComponentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectedEnvironmentsDaprComponentsClient, error)

NewConnectedEnvironmentsDaprComponentsClient creates a new instance of ConnectedEnvironmentsDaprComponentsClient with the specified values.

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

func (*ConnectedEnvironmentsDaprComponentsClient) CreateOrUpdate 

func (client *ConnectedEnvironmentsDaprComponentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, componentName string, daprComponentEnvelope DaprComponent, options *ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateOptions) (ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connected environment.
  • componentName - Name of the Dapr Component.
  • daprComponentEnvelope - Configuration details of the Dapr Component.
  • options - ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json 

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.NewConnectedEnvironmentsDaprComponentsClient().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"),
			}},
		ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
			{
				Name: to.Ptr("statestore"),
				Metadata: &armappcontainers.DaprServiceBindMetadata{
					Name:  to.Ptr("daprcomponentBind"),
					Value: to.Ptr("redis-bind"),
				},
				ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
			}},
		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/connectedEnvironments/daprcomponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/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"),
// 			}},
// 			ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
// 				{
// 					Name: to.Ptr("statestore"),
// 					Metadata: &armappcontainers.DaprServiceBindMetadata{
// 						Name: to.Ptr("daprcomponentBind"),
// 						Value: to.Ptr("redis-bind"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
// 			}},
// 			Version: to.Ptr("v1"),
// 		},
// 	}

Output:

func (*ConnectedEnvironmentsDaprComponentsClient) Delete 

func (client *ConnectedEnvironmentsDaprComponentsClient) Delete(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, componentName string, options *ConnectedEnvironmentsDaprComponentsClientDeleteOptions) (ConnectedEnvironmentsDaprComponentsClientDeleteResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connected environment.
  • componentName - Name of the Dapr Component.
  • options - ConnectedEnvironmentsDaprComponentsClientDeleteOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json 

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.NewConnectedEnvironmentsDaprComponentsClient().Delete(ctx, "examplerg", "myenvironment", "reddog", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*ConnectedEnvironmentsDaprComponentsClient) Get 

func (client *ConnectedEnvironmentsDaprComponentsClient) Get(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, componentName string, options *ConnectedEnvironmentsDaprComponentsClientGetOptions) (ConnectedEnvironmentsDaprComponentsClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connected environment.
  • componentName - Name of the Dapr Component.
  • options - ConnectedEnvironmentsDaprComponentsClientGetOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json 

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.NewConnectedEnvironmentsDaprComponentsClient().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/connectedEnvironments/daprcomponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/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"),
// 			}},
// 			ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
// 				{
// 					Name: to.Ptr("statestore"),
// 					Metadata: &armappcontainers.DaprServiceBindMetadata{
// 						Name: to.Ptr("daprcomponentBind"),
// 						Value: to.Ptr("redis-bind"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
// 			}},
// 			Version: to.Ptr("v1"),
// 		},
// 	}

Output:

func (*ConnectedEnvironmentsDaprComponentsClient) ListSecrets 

func (client *ConnectedEnvironmentsDaprComponentsClient) ListSecrets(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, componentName string, options *ConnectedEnvironmentsDaprComponentsClientListSecretsOptions) (ConnectedEnvironmentsDaprComponentsClientListSecretsResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connected environment.
  • componentName - Name of the Dapr Component.
  • options - ConnectedEnvironmentsDaprComponentsClientListSecretsOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.ListSecrets method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json 

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.NewConnectedEnvironmentsDaprComponentsClient().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.DaprSecret{
// 		{
// 			Name: to.Ptr("secret1"),
// 			Value: to.Ptr("value1"),
// 		},
// 		{
// 			Name: to.Ptr("secret2"),
// 			Value: to.Ptr("value2"),
// 	}},
// }

Output:

func (*ConnectedEnvironmentsDaprComponentsClient) NewListPager 

func (client *ConnectedEnvironmentsDaprComponentsClient) NewListPager(resourceGroupName string, connectedEnvironmentName string, options *ConnectedEnvironmentsDaprComponentsClientListOptions) *runtime.Pager[ConnectedEnvironmentsDaprComponentsClientListResponse]

NewListPager - Get the Dapr Components for a connected environment.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the connected environment.
  • options - ConnectedEnvironmentsDaprComponentsClientListOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json 

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.NewConnectedEnvironmentsDaprComponentsClient().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/connectedEnvironments/daprcomponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/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"),
	// 					}},
	// 					ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
	// 						{
	// 							Name: to.Ptr("statestore"),
	// 							Metadata: &armappcontainers.DaprServiceBindMetadata{
	// 								Name: to.Ptr("daprcomponentBind"),
	// 								Value: to.Ptr("redis-bind"),
	// 							},
	// 							ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
	// 					}},
	// 					Version: to.Ptr("v1"),
	// 				},
	// 		}},
	// 	}
}

Output:

type ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateOptions 

type ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateOptions struct {
}

ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.CreateOrUpdate method.

type ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateResponse 

type ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateResponse struct {
	// Dapr Component.
	DaprComponent
}

ConnectedEnvironmentsDaprComponentsClientCreateOrUpdateResponse contains the response from method ConnectedEnvironmentsDaprComponentsClient.CreateOrUpdate.

type ConnectedEnvironmentsDaprComponentsClientDeleteOptions 

type ConnectedEnvironmentsDaprComponentsClientDeleteOptions struct {
}

ConnectedEnvironmentsDaprComponentsClientDeleteOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.Delete method.

type ConnectedEnvironmentsDaprComponentsClientDeleteResponse 

type ConnectedEnvironmentsDaprComponentsClientDeleteResponse struct {
}

ConnectedEnvironmentsDaprComponentsClientDeleteResponse contains the response from method ConnectedEnvironmentsDaprComponentsClient.Delete.

type ConnectedEnvironmentsDaprComponentsClientGetOptions 

type ConnectedEnvironmentsDaprComponentsClientGetOptions struct {
}

ConnectedEnvironmentsDaprComponentsClientGetOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.Get method.

type ConnectedEnvironmentsDaprComponentsClientGetResponse 

type ConnectedEnvironmentsDaprComponentsClientGetResponse struct {
	// Dapr Component.
	DaprComponent
}

ConnectedEnvironmentsDaprComponentsClientGetResponse contains the response from method ConnectedEnvironmentsDaprComponentsClient.Get.

type ConnectedEnvironmentsDaprComponentsClientListOptions 

type ConnectedEnvironmentsDaprComponentsClientListOptions struct {
}

ConnectedEnvironmentsDaprComponentsClientListOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.NewListPager method.

type ConnectedEnvironmentsDaprComponentsClientListResponse 

type ConnectedEnvironmentsDaprComponentsClientListResponse struct {
	// Dapr Components ARM resource.
	DaprComponentsCollection
}

ConnectedEnvironmentsDaprComponentsClientListResponse contains the response from method ConnectedEnvironmentsDaprComponentsClient.NewListPager.

type ConnectedEnvironmentsDaprComponentsClientListSecretsOptions 

type ConnectedEnvironmentsDaprComponentsClientListSecretsOptions struct {
}

ConnectedEnvironmentsDaprComponentsClientListSecretsOptions contains the optional parameters for the ConnectedEnvironmentsDaprComponentsClient.ListSecrets method.

type ConnectedEnvironmentsDaprComponentsClientListSecretsResponse 

type ConnectedEnvironmentsDaprComponentsClientListSecretsResponse struct {
	// Dapr component Secrets Collection for ListSecrets Action.
	DaprSecretsCollection
}

ConnectedEnvironmentsDaprComponentsClientListSecretsResponse contains the response from method ConnectedEnvironmentsDaprComponentsClient.ListSecrets.

type ConnectedEnvironmentsStoragesClient 

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

ConnectedEnvironmentsStoragesClient contains the methods for the ConnectedEnvironmentsStorages group. Don't use this type directly, use NewConnectedEnvironmentsStoragesClient() instead.

func NewConnectedEnvironmentsStoragesClient 

func NewConnectedEnvironmentsStoragesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectedEnvironmentsStoragesClient, error)

NewConnectedEnvironmentsStoragesClient creates a new instance of ConnectedEnvironmentsStoragesClient with the specified values.

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

func (*ConnectedEnvironmentsStoragesClient) CreateOrUpdate 

func (client *ConnectedEnvironmentsStoragesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, storageName string, storageEnvelope ConnectedEnvironmentStorage, options *ConnectedEnvironmentsStoragesClientCreateOrUpdateOptions) (ConnectedEnvironmentsStoragesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update storage for a connectedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Environment.
  • storageName - Name of the storage.
  • storageEnvelope - Configuration details of storage.
  • options - ConnectedEnvironmentsStoragesClientCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json 

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.NewConnectedEnvironmentsStoragesClient().CreateOrUpdate(ctx, "examplerg", "env", "jlaw-demo1", armappcontainers.ConnectedEnvironmentStorage{
	Properties: &armappcontainers.ConnectedEnvironmentStorageProperties{
		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.ConnectedEnvironmentStorage = armappcontainers.ConnectedEnvironmentStorage{
// 	Name: to.Ptr("jlaw-demo1"),
// 	Type: to.Ptr("Microsoft.App/connectedEnvironments/storages"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/env/storages/jlaw-demo1"),
// 	Properties: &armappcontainers.ConnectedEnvironmentStorageProperties{
// 		AzureFile: &armappcontainers.AzureFileProperties{
// 			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
// 			AccountName: to.Ptr("account1"),
// 			ShareName: to.Ptr("share1"),
// 		},
// 	},
// }

Output:

func (*ConnectedEnvironmentsStoragesClient) Delete 

func (client *ConnectedEnvironmentsStoragesClient) Delete(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, storageName string, options *ConnectedEnvironmentsStoragesClientDeleteOptions) (ConnectedEnvironmentsStoragesClientDeleteResponse, error)

Delete - Delete storage for a connectedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Environment.
  • storageName - Name of the storage.
  • options - ConnectedEnvironmentsStoragesClientDeleteOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json 

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.NewConnectedEnvironmentsStoragesClient().Delete(ctx, "examplerg", "env", "jlaw-demo1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*ConnectedEnvironmentsStoragesClient) Get 

func (client *ConnectedEnvironmentsStoragesClient) Get(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, storageName string, options *ConnectedEnvironmentsStoragesClientGetOptions) (ConnectedEnvironmentsStoragesClientGetResponse, error)

Get - Get storage for a connectedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Environment.
  • storageName - Name of the storage.
  • options - ConnectedEnvironmentsStoragesClientGetOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsStorages_Get.json 

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.NewConnectedEnvironmentsStoragesClient().Get(ctx, "examplerg", "env", "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.ConnectedEnvironmentStorage = armappcontainers.ConnectedEnvironmentStorage{
// 	Name: to.Ptr("jlaw-demo1"),
// 	Type: to.Ptr("Microsoft.App/connectedEnvironments/storages"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/env/storages/jlaw-demo1"),
// 	Properties: &armappcontainers.ConnectedEnvironmentStorageProperties{
// 		AzureFile: &armappcontainers.AzureFileProperties{
// 			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
// 			AccountName: to.Ptr("account1"),
// 			ShareName: to.Ptr("share1"),
// 		},
// 	},
// }

Output:

func (*ConnectedEnvironmentsStoragesClient) List 

func (client *ConnectedEnvironmentsStoragesClient) List(ctx context.Context, resourceGroupName string, connectedEnvironmentName string, options *ConnectedEnvironmentsStoragesClientListOptions) (ConnectedEnvironmentsStoragesClientListResponse, error)

List - Get all storages for a connectedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • connectedEnvironmentName - Name of the Environment.
  • options - ConnectedEnvironmentsStoragesClientListOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ConnectedEnvironmentsStorages_List.json 

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.NewConnectedEnvironmentsStoragesClient().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.ConnectedEnvironmentStoragesCollection = armappcontainers.ConnectedEnvironmentStoragesCollection{
// 	Value: []*armappcontainers.ConnectedEnvironmentStorage{
// 		{
// 			Name: to.Ptr("jlaw-demo1"),
// 			Type: to.Ptr("Microsoft.App/connectedEnvironments/storages"),
// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/managedEnv/storages/jlaw-demo1"),
// 			Properties: &armappcontainers.ConnectedEnvironmentStorageProperties{
// 				AzureFile: &armappcontainers.AzureFileProperties{
// 					AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
// 					AccountName: to.Ptr("account1"),
// 					ShareName: to.Ptr("share1"),
// 				},
// 			},
// 	}},
// }

Output:

type ConnectedEnvironmentsStoragesClientCreateOrUpdateOptions 

type ConnectedEnvironmentsStoragesClientCreateOrUpdateOptions struct {
}

ConnectedEnvironmentsStoragesClientCreateOrUpdateOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.CreateOrUpdate method.

type ConnectedEnvironmentsStoragesClientCreateOrUpdateResponse 

type ConnectedEnvironmentsStoragesClientCreateOrUpdateResponse struct {
	// Storage resource for connectedEnvironment.
	ConnectedEnvironmentStorage
}

ConnectedEnvironmentsStoragesClientCreateOrUpdateResponse contains the response from method ConnectedEnvironmentsStoragesClient.CreateOrUpdate.

type ConnectedEnvironmentsStoragesClientDeleteOptions 

type ConnectedEnvironmentsStoragesClientDeleteOptions struct {
}

ConnectedEnvironmentsStoragesClientDeleteOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.Delete method.

type ConnectedEnvironmentsStoragesClientDeleteResponse 

type ConnectedEnvironmentsStoragesClientDeleteResponse struct {
}

ConnectedEnvironmentsStoragesClientDeleteResponse contains the response from method ConnectedEnvironmentsStoragesClient.Delete.

type ConnectedEnvironmentsStoragesClientGetOptions 

type ConnectedEnvironmentsStoragesClientGetOptions struct {
}

ConnectedEnvironmentsStoragesClientGetOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.Get method.

type ConnectedEnvironmentsStoragesClientGetResponse 

type ConnectedEnvironmentsStoragesClientGetResponse struct {
	// Storage resource for connectedEnvironment.
	ConnectedEnvironmentStorage
}

ConnectedEnvironmentsStoragesClientGetResponse contains the response from method ConnectedEnvironmentsStoragesClient.Get.

type ConnectedEnvironmentsStoragesClientListOptions 

type ConnectedEnvironmentsStoragesClientListOptions struct {
}

ConnectedEnvironmentsStoragesClientListOptions contains the optional parameters for the ConnectedEnvironmentsStoragesClient.List method.

type ConnectedEnvironmentsStoragesClientListResponse 

type ConnectedEnvironmentsStoragesClientListResponse struct {
	// Collection of Storage for Environments
	ConnectedEnvironmentStoragesCollection
}

ConnectedEnvironmentsStoragesClientListResponse contains the response from method ConnectedEnvironmentsStoragesClient.List.

type Container 

type Container struct {
	// Container start command arguments.
	Args []*string

	// Container start command.
	Command []*string

	// Container environment variables.
	Env []*EnvironmentVar

	// Container image tag.
	Image *string

	// Custom container name.
	Name *string

	// List of probes for the container.
	Probes []*ContainerAppProbe

	// Container resource requirements.
	Resources *ContainerResources

	// Container volume mounts.
	VolumeMounts []*VolumeMount
}

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 

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

	// The complex type of the extended location.
	ExtendedLocation *ExtendedLocation

	// managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials
	// in code.
	Identity *ManagedServiceIdentity

	// The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another
	// Azure resource. If this is present, complete mode deployment will not
	// delete the resource if it is removed from the template since it is managed by another resource.
	ManagedBy *string

	// ContainerApp resource specific properties
	Properties *ContainerAppProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ContainerApp - Container App.

func (ContainerApp) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerApp.

func (*ContainerApp) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerApp.

type ContainerAppAuthToken 

type ContainerAppAuthToken struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Container App auth token resource specific properties
	Properties *ContainerAppAuthTokenProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ContainerAppAuthToken - Container App Auth Token.

func (ContainerAppAuthToken) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppAuthToken.

func (*ContainerAppAuthToken) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppAuthToken.

type ContainerAppAuthTokenProperties 

type ContainerAppAuthTokenProperties struct {
	// READ-ONLY; Token expiration date.
	Expires *time.Time

	// READ-ONLY; Auth token value.
	Token *string
}

ContainerAppAuthTokenProperties - Container App auth token resource specific properties

func (ContainerAppAuthTokenProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppAuthTokenProperties.

func (*ContainerAppAuthTokenProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppAuthTokenProperties.

type ContainerAppCollection 

type ContainerAppCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ContainerApp

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

ContainerAppCollection - Container App collection ARM resource.

func (ContainerAppCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppCollection.

func (*ContainerAppCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppCollection.

type ContainerAppContainerRunningState 

type ContainerAppContainerRunningState string

ContainerAppContainerRunningState - Current running state of the container 

const (
	ContainerAppContainerRunningStateRunning    ContainerAppContainerRunningState = "Running"
	ContainerAppContainerRunningStateTerminated ContainerAppContainerRunningState = "Terminated"
	ContainerAppContainerRunningStateWaiting    ContainerAppContainerRunningState = "Waiting"
)

func PossibleContainerAppContainerRunningStateValues 

func PossibleContainerAppContainerRunningStateValues() []ContainerAppContainerRunningState

PossibleContainerAppContainerRunningStateValues returns the possible values for the ContainerAppContainerRunningState const type.

type ContainerAppJobExecutions 

type ContainerAppJobExecutions struct {
	// REQUIRED; Collection of resources.
	Value []*JobExecution

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

ContainerAppJobExecutions - Container App executions collection ARM resource.

func (ContainerAppJobExecutions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppJobExecutions.

func (*ContainerAppJobExecutions) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppJobExecutions.

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

	// HTTPGet specifies the http request to perform.
	HTTPGet *ContainerAppProbeHTTPGet

	// Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value
	// is 60.
	InitialDelaySeconds *int32

	// How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
	PeriodSeconds *int32

	// 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

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

	// 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

	// Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
	TimeoutSeconds *int32

	// The type of probe.
	Type *Type
}

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 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbe.

func (*ContainerAppProbe) UnmarshalJSON 

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

	// Custom headers to set in the request. HTTP allows repeated headers.
	HTTPHeaders []*ContainerAppProbeHTTPGetHTTPHeadersItem

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

	// Path to access on the HTTP server.
	Path *string

	// Scheme to use for connecting to the host. Defaults to HTTP.
	Scheme *Scheme
}

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 

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

	// REQUIRED; The header field value
	Value *string
}

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

func (ContainerAppProbeHTTPGetHTTPHeadersItem) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbeHTTPGetHTTPHeadersItem.

func (*ContainerAppProbeHTTPGetHTTPHeadersItem) UnmarshalJSON 

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

	// Optional: Host name to connect to, defaults to the pod IP.
	Host *string
}

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

func (ContainerAppProbeTCPSocket) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppProbeTCPSocket.

func (*ContainerAppProbeTCPSocket) UnmarshalJSON 

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

	// Resource ID of environment.
	EnvironmentID *string

	// Deprecated. Resource ID of the Container App's environment.
	ManagedEnvironmentID *string

	// Container App versioned application definition.
	Template *Template

	// Workload profile name to pin for container app execution.
	WorkloadProfileName *string

	// READ-ONLY; Id used to verify domain name ownership
	CustomDomainVerificationID *string

	// READ-ONLY; The endpoint of the eventstream of the container app.
	EventStreamEndpoint *string

	// READ-ONLY; Name of the latest ready revision of the Container App.
	LatestReadyRevisionName *string

	// READ-ONLY; Fully Qualified Domain Name of the latest revision of the Container App.
	LatestRevisionFqdn *string

	// READ-ONLY; Name of the latest revision of the Container App.
	LatestRevisionName *string

	// READ-ONLY; Outbound IP Addresses for container app.
	OutboundIPAddresses []*string

	// READ-ONLY; Provisioning state of the Container App.
	ProvisioningState *ContainerAppProvisioningState
}

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 

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"
	ContainerAppProvisioningStateDeleting   ContainerAppProvisioningState = "Deleting"
	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 ContainerAppReplicaRunningState 

type ContainerAppReplicaRunningState string

ContainerAppReplicaRunningState - Current running state of the replica 

const (
	ContainerAppReplicaRunningStateNotRunning ContainerAppReplicaRunningState = "NotRunning"
	ContainerAppReplicaRunningStateRunning    ContainerAppReplicaRunningState = "Running"
	ContainerAppReplicaRunningStateUnknown    ContainerAppReplicaRunningState = "Unknown"
)

func PossibleContainerAppReplicaRunningStateValues 

func PossibleContainerAppReplicaRunningStateValues() []ContainerAppReplicaRunningState

PossibleContainerAppReplicaRunningStateValues returns the possible values for the ContainerAppReplicaRunningState const type.

type ContainerAppSecret 

type ContainerAppSecret struct {
	// READ-ONLY; Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.
	Identity *string

	// READ-ONLY; Azure Key Vault URL pointing to the secret referenced by the container app.
	KeyVaultURL *string

	// READ-ONLY; Secret Name.
	Name *string

	// READ-ONLY; Secret Value.
	Value *string
}

ContainerAppSecret - Container App Secret.

func (ContainerAppSecret) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerAppSecret.

func (*ContainerAppSecret) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAppSecret.

type ContainerAppsAPIClient 

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

ContainerAppsAPIClient contains the methods for the ContainerAppsAPIClient group. Don't use this type directly, use NewContainerAppsAPIClient() instead.

func NewContainerAppsAPIClient 

func NewContainerAppsAPIClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsAPIClient, error)

NewContainerAppsAPIClient creates a new instance of ContainerAppsAPIClient with the specified values.

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

func (*ContainerAppsAPIClient) GetCustomDomainVerificationID 

func (client *ContainerAppsAPIClient) GetCustomDomainVerificationID(ctx context.Context, options *ContainerAppsAPIClientGetCustomDomainVerificationIDOptions) (ContainerAppsAPIClientGetCustomDomainVerificationIDResponse, error)

GetCustomDomainVerificationID - Get the verification id of a subscription used for verifying custom domains If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • options - ContainerAppsAPIClientGetCustomDomainVerificationIDOptions contains the optional parameters for the ContainerAppsAPIClient.GetCustomDomainVerificationID method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json 

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.NewContainerAppsAPIClient().GetCustomDomainVerificationID(ctx, 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.Value = "5B406D5E790BBD224468CE0AA814C396203C7CE755F135A80E35D41865E51967"

Output:

func (*ContainerAppsAPIClient) JobExecution 

func (client *ContainerAppsAPIClient) JobExecution(ctx context.Context, resourceGroupName string, jobName string, jobExecutionName string, options *ContainerAppsAPIClientJobExecutionOptions) (ContainerAppsAPIClientJobExecutionResponse, error)

JobExecution - Get details of a single job execution If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • jobExecutionName - Job execution name.
  • options - ContainerAppsAPIClientJobExecutionOptions contains the optional parameters for the ContainerAppsAPIClient.JobExecution method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Execution_Get.json 

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.NewContainerAppsAPIClient().JobExecution(ctx, "rg", "testcontainerAppsJob0", "jobExecution1", 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.JobExecution = armappcontainers.JobExecution{
// 	Name: to.Ptr("jobExecution1"),
// 	Properties: &armappcontainers.JobExecutionProperties{
// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T20:47:30.000Z"); return t}()),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T20:37:30.000Z"); return t}()),
// 		Status: to.Ptr(armappcontainers.JobExecutionRunningStateRunning),
// 		Template: &armappcontainers.JobExecutionTemplate{
// 			Containers: []*armappcontainers.JobExecutionContainer{
// 				{
// 					Name: to.Ptr("testcontainerappsjob0"),
// 					Image: to.Ptr("repo/testcontainerappsjob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.5),
// 						Memory: to.Ptr("1Gi"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.JobExecutionContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Args: []*string{
// 						to.Ptr("-c"),
// 						to.Ptr("while true; do echo hello; sleep 10;done")},
// 						Command: []*string{
// 							to.Ptr("/bin/sh")},
// 							Image: to.Ptr("repo/testcontainerappsjob0:v4"),
// 							Resources: &armappcontainers.ContainerResources{
// 								CPU: to.Ptr[float64](0.5),
// 								Memory: to.Ptr("1Gi"),
// 							},
// 					}},
// 				},
// 			},
// 		}

Output:

type ContainerAppsAPIClientGetCustomDomainVerificationIDOptions 

type ContainerAppsAPIClientGetCustomDomainVerificationIDOptions struct {
}

ContainerAppsAPIClientGetCustomDomainVerificationIDOptions contains the optional parameters for the ContainerAppsAPIClient.GetCustomDomainVerificationID method.

type ContainerAppsAPIClientGetCustomDomainVerificationIDResponse 

type ContainerAppsAPIClientGetCustomDomainVerificationIDResponse struct {
	// Custom domain verification Id of a subscription
	Value *string
}

ContainerAppsAPIClientGetCustomDomainVerificationIDResponse contains the response from method ContainerAppsAPIClient.GetCustomDomainVerificationID.

type ContainerAppsAPIClientJobExecutionOptions 

type ContainerAppsAPIClientJobExecutionOptions struct {
}

ContainerAppsAPIClientJobExecutionOptions contains the optional parameters for the ContainerAppsAPIClient.JobExecution method.

type ContainerAppsAPIClientJobExecutionResponse 

type ContainerAppsAPIClientJobExecutionResponse struct {
	// Container Apps Job execution.
	JobExecution
}

ContainerAppsAPIClientJobExecutionResponse contains the response from method ContainerAppsAPIClient.JobExecution.

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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AuthConfigs_CreateOrUpdate.json 

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{
		EncryptionSettings: &armappcontainers.EncryptionSettings{
			ContainerAppAuthEncryptionSecretName: to.Ptr("testEncryptionSecretName"),
			ContainerAppAuthSigningSecretName:    to.Ptr("testSigningSecretName"),
		},
		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{
// 		EncryptionSettings: &armappcontainers.EncryptionSettings{
// 			ContainerAppAuthEncryptionSecretName: to.Ptr("testEncryptionSecretName"),
// 			ContainerAppAuthSigningSecretName: to.Ptr("testSigningSecretName"),
// 		},
// 		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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AuthConfigs_Delete.json 

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AuthConfigs_Get.json 

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{
// 		EncryptionSettings: &armappcontainers.EncryptionSettings{
// 			ContainerAppAuthEncryptionSecretName: to.Ptr("testEncryptionSecretName"),
// 			ContainerAppAuthSigningSecretName: to.Ptr("testSigningSecretName"),
// 		},
// 		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 

func (client *ContainerAppsAuthConfigsClient) NewListByContainerAppPager(resourceGroupName string, containerAppName string, options *ContainerAppsAuthConfigsClientListByContainerAppOptions) *runtime.Pager[ContainerAppsAuthConfigsClientListByContainerAppResponse]

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/AuthConfigs_ListByContainer.json 

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{
	// 				EncryptionSettings: &armappcontainers.EncryptionSettings{
	// 					ContainerAppAuthEncryptionSecretName: to.Ptr("testEncryptionSecretName"),
	// 					ContainerAppAuthSigningSecretName: to.Ptr("testSigningSecretName"),
	// 				},
	// 				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 {
	// Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.
	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 {
	// Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.
	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 {
	// AuthConfig collection ARM resource.
	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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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 (CreateOrUpdateAppOnAConnectedEnvironment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json 

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"),
	ExtendedLocation: &armappcontainers.ExtendedLocation{
		Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
		Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
	},
	Properties: &armappcontainers.ContainerAppProperties{
		Configuration: &armappcontainers.Configuration{
			Dapr: &armappcontainers.Dapr{
				AppPort:            to.Ptr[int32](3000),
				AppProtocol:        to.Ptr(armappcontainers.AppProtocolHTTP),
				EnableAPILogging:   to.Ptr(true),
				Enabled:            to.Ptr(true),
				HTTPMaxRequestSize: to.Ptr[int32](10),
				HTTPReadBufferSize: to.Ptr[int32](30),
				LogLevel:           to.Ptr(armappcontainers.LogLevelDebug),
			},
			Ingress: &armappcontainers.Ingress{
				AdditionalPortMappings: []*armappcontainers.IngressPortMapping{
					{
						External:   to.Ptr(true),
						TargetPort: to.Ptr[int32](1234),
					},
					{
						ExposedPort: to.Ptr[int32](3456),
						External:    to.Ptr(false),
						TargetPort:  to.Ptr[int32](2345),
					}},
				ClientCertificateMode: to.Ptr(armappcontainers.IngressClientCertificateModeAccept),
				CorsPolicy: &armappcontainers.CorsPolicy{
					AllowCredentials: to.Ptr(true),
					AllowedHeaders: []*string{
						to.Ptr("HEADER1"),
						to.Ptr("HEADER2")},
					AllowedMethods: []*string{
						to.Ptr("GET"),
						to.Ptr("POST")},
					AllowedOrigins: []*string{
						to.Ptr("https://a.test.com"),
						to.Ptr("https://b.test.com")},
					ExposeHeaders: []*string{
						to.Ptr("HEADER3"),
						to.Ptr("HEADER4")},
					MaxAge: to.Ptr[int32](1234),
				},
				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/connectedEnvironments/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/connectedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
					}},
				External: to.Ptr(true),
				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
					{
						Name:           to.Ptr("Allow work IP A subnet"),
						Description:    to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
						Action:         to.Ptr(armappcontainers.ActionAllow),
						IPAddressRange: to.Ptr("192.168.1.1/32"),
					},
					{
						Name:           to.Ptr("Allow work IP B subnet"),
						Description:    to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
						Action:         to.Ptr(armappcontainers.ActionAllow),
						IPAddressRange: to.Ptr("192.168.1.1/8"),
					}},
				StickySessions: &armappcontainers.IngressStickySessions{
					Affinity: to.Ptr(armappcontainers.AffinitySticky),
				},
				TargetPort: to.Ptr[int32](3000),
				Traffic: []*armappcontainers.TrafficWeight{
					{
						Label:        to.Ptr("production"),
						RevisionName: to.Ptr("testcontainerApp0-ab1234"),
						Weight:       to.Ptr[int32](100),
					}},
			},
			MaxInactiveRevisions: to.Ptr[int32](10),
		},
		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/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),
						}},
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name: to.Ptr("testinitcontainerApp0"),
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					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"),
						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"),
// 	ExtendedLocation: &armappcontainers.ExtendedLocation{
// 		Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
// 		Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
// 	},
// 	Properties: &armappcontainers.ContainerAppProperties{
// 		Configuration: &armappcontainers.Configuration{
// 			Dapr: &armappcontainers.Dapr{
// 				AppPort: to.Ptr[int32](3000),
// 				AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
// 				Enabled: to.Ptr(true),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 			},
// 			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/connectedEnvironments/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/connectedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
// 				}},
// 				External: to.Ptr(true),
// 				Fqdn: to.Ptr("testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				StickySessions: &armappcontainers.IngressStickySessions{
// 					Affinity: to.Ptr(armappcontainers.AffinitySticky),
// 				},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		LatestRevisionFqdn: to.Ptr("testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
// 		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"),
// 					},
// 					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),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					Args: []*string{
// 						to.Ptr("-c"),
// 						to.Ptr("while true; do echo hello; sleep 10;done")},
// 						Command: []*string{
// 							to.Ptr("/bin/sh")},
// 							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:
Example (CreateOrUpdateContainerApp)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_CreateOrUpdate.json 

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),
				EnableAPILogging:   to.Ptr(true),
				Enabled:            to.Ptr(true),
				HTTPMaxRequestSize: to.Ptr[int32](10),
				HTTPReadBufferSize: to.Ptr[int32](30),
				LogLevel:           to.Ptr(armappcontainers.LogLevelDebug),
			},
			Ingress: &armappcontainers.Ingress{
				AdditionalPortMappings: []*armappcontainers.IngressPortMapping{
					{
						External:   to.Ptr(true),
						TargetPort: to.Ptr[int32](1234),
					},
					{
						ExposedPort: to.Ptr[int32](3456),
						External:    to.Ptr(false),
						TargetPort:  to.Ptr[int32](2345),
					}},
				ClientCertificateMode: to.Ptr(armappcontainers.IngressClientCertificateModeAccept),
				CorsPolicy: &armappcontainers.CorsPolicy{
					AllowCredentials: to.Ptr(true),
					AllowedHeaders: []*string{
						to.Ptr("HEADER1"),
						to.Ptr("HEADER2")},
					AllowedMethods: []*string{
						to.Ptr("GET"),
						to.Ptr("POST")},
					AllowedOrigins: []*string{
						to.Ptr("https://a.test.com"),
						to.Ptr("https://b.test.com")},
					ExposeHeaders: []*string{
						to.Ptr("HEADER3"),
						to.Ptr("HEADER4")},
					MaxAge: to.Ptr[int32](1234),
				},
				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),
				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
					{
						Name:           to.Ptr("Allow work IP A subnet"),
						Description:    to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
						Action:         to.Ptr(armappcontainers.ActionAllow),
						IPAddressRange: to.Ptr("192.168.1.1/32"),
					},
					{
						Name:           to.Ptr("Allow work IP B subnet"),
						Description:    to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
						Action:         to.Ptr(armappcontainers.ActionAllow),
						IPAddressRange: to.Ptr("192.168.1.1/8"),
					}},
				StickySessions: &armappcontainers.IngressStickySessions{
					Affinity: to.Ptr(armappcontainers.AffinitySticky),
				},
				TargetPort: to.Ptr[int32](3000),
				Traffic: []*armappcontainers.TrafficWeight{
					{
						Label:        to.Ptr("production"),
						RevisionName: to.Ptr("testcontainerApp0-ab1234"),
						Weight:       to.Ptr[int32](100),
					}},
			},
			MaxInactiveRevisions: to.Ptr[int32](10),
			Service: &armappcontainers.Service{
				Type: to.Ptr("redis"),
			},
		},
		EnvironmentID: 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"),
					VolumeMounts: []*armappcontainers.VolumeMount{
						{
							MountPath:  to.Ptr("/mnt/path1"),
							SubPath:    to.Ptr("subPath1"),
							VolumeName: to.Ptr("azurefile"),
						},
						{
							MountPath:  to.Ptr("/mnt/path2"),
							SubPath:    to.Ptr("subPath2"),
							VolumeName: to.Ptr("nfsazurefile"),
						}},
					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),
						}},
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name: to.Ptr("testinitcontainerApp0"),
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					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"),
						Custom: &armappcontainers.CustomScaleRule{
							Type: to.Ptr("http"),
							Metadata: map[string]*string{
								"concurrentRequests": to.Ptr("50"),
							},
						},
					}},
			},
			ServiceBinds: []*armappcontainers.ServiceBind{
				{
					Name:       to.Ptr("redisService"),
					ClientType: to.Ptr("dotnet"),
					CustomizedKeys: map[string]*string{
						"DesiredKey": to.Ptr("defaultKey"),
					},
					ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/redisService"),
				}},
			Volumes: []*armappcontainers.Volume{
				{
					Name:        to.Ptr("azurefile"),
					StorageName: to.Ptr("storage"),
					StorageType: to.Ptr(armappcontainers.StorageTypeAzureFile),
				},
				{
					Name:        to.Ptr("nfsazurefile"),
					StorageName: to.Ptr("nfsStorage"),
					StorageType: to.Ptr(armappcontainers.StorageTypeNfsAzureFile),
				}},
		},
		WorkloadProfileName: to.Ptr("My-GP-01"),
	},
}, 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),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 			},
// 			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"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				StickySessions: &armappcontainers.IngressStickySessions{
// 					Affinity: to.Ptr(armappcontainers.AffinitySticky),
// 				},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 		},
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		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"),
// 					},
// 					VolumeMounts: []*armappcontainers.VolumeMount{
// 						{
// 							MountPath: to.Ptr("/mnt/path1"),
// 							SubPath: to.Ptr("subPath1"),
// 							VolumeName: to.Ptr("azurefile"),
// 						},
// 						{
// 							MountPath: to.Ptr("/mnt/path2"),
// 							SubPath: to.Ptr("subPath2"),
// 							VolumeName: to.Ptr("nfsazurefile"),
// 					}},
// 					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),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					Args: []*string{
// 						to.Ptr("-c"),
// 						to.Ptr("while true; do echo hello; sleep 10;done")},
// 						Command: []*string{
// 							to.Ptr("/bin/sh")},
// 							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"),
// 									},
// 								},
// 						}},
// 					},
// 					Volumes: []*armappcontainers.Volume{
// 						{
// 							Name: to.Ptr("azurefile"),
// 							StorageName: to.Ptr("storage"),
// 							StorageType: to.Ptr(armappcontainers.StorageTypeAzureFile),
// 						},
// 						{
// 							Name: to.Ptr("nfsazurefile"),
// 							StorageName: to.Ptr("nfsStorage"),
// 							StorageType: to.Ptr(armappcontainers.StorageTypeNfsAzureFile),
// 					}},
// 				},
// 				WorkloadProfileName: to.Ptr("My-GP-01"),
// 			},
// 		}

Output:
Example (CreateOrUpdateManagedByApp)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json 

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", "testcontainerAppManagedBy", armappcontainers.ContainerApp{
	Location:  to.Ptr("East US"),
	ManagedBy: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp"),
	Properties: &armappcontainers.ContainerAppProperties{
		Configuration: &armappcontainers.Configuration{
			Ingress: &armappcontainers.Ingress{
				ExposedPort: to.Ptr[int32](4000),
				External:    to.Ptr(true),
				TargetPort:  to.Ptr[int32](3000),
				Traffic: []*armappcontainers.TrafficWeight{
					{
						RevisionName: to.Ptr("testcontainerAppManagedBy-ab1234"),
						Weight:       to.Ptr[int32](100),
					}},
				Transport: to.Ptr(armappcontainers.IngressTransportMethodTCP),
			},
		},
		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		Template: &armappcontainers.Template{
			Containers: []*armappcontainers.Container{
				{
					Name:  to.Ptr("testcontainerAppManagedBy"),
					Image: to.Ptr("repo/testcontainerAppManagedBy:v1"),
					Probes: []*armappcontainers.ContainerAppProbe{
						{
							Type:                to.Ptr(armappcontainers.TypeLiveness),
							InitialDelaySeconds: to.Ptr[int32](3),
							PeriodSeconds:       to.Ptr[int32](3),
							TCPSocket: &armappcontainers.ContainerAppProbeTCPSocket{
								Port: to.Ptr[int32](8080),
							},
						}},
				}},
			Scale: &armappcontainers.Scale{
				MaxReplicas: to.Ptr[int32](5),
				MinReplicas: to.Ptr[int32](1),
				Rules: []*armappcontainers.ScaleRule{
					{
						Name: to.Ptr("tcpscalingrule"),
						TCP: &armappcontainers.TCPScaleRule{
							Metadata: map[string]*string{
								"concurrentConnections": 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("testcontainerAppManagedBy"),
// 	Type: to.Ptr("Microsoft.App/containerApps"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy"),
// 	Location: to.Ptr("East US"),
// 	ManagedBy: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp"),
// 	Properties: &armappcontainers.ContainerAppProperties{
// 		Configuration: &armappcontainers.Configuration{
// 			Ingress: &armappcontainers.Ingress{
// 				ExposedPort: to.Ptr[int32](4000),
// 				External: to.Ptr(true),
// 				Fqdn: to.Ptr("testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
// 				TargetPort: to.Ptr[int32](3000),
// 				Traffic: []*armappcontainers.TrafficWeight{
// 					{
// 						RevisionName: to.Ptr("testcontainerAppManagedBy-ab1234"),
// 						Weight: to.Ptr[int32](80),
// 					},
// 					{
// 						RevisionName: to.Ptr("testcontainerAppManagedBy-ab4321"),
// 						Weight: to.Ptr[int32](20),
// 				}},
// 				Transport: to.Ptr(armappcontainers.IngressTransportMethodTCP),
// 			},
// 		},
// 		LatestReadyRevisionName: to.Ptr("testcontainerAppManagedBy-pjxhsye"),
// 		LatestRevisionFqdn: to.Ptr("testcontainerAppManagedBy-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("testcontainerAppManagedBy"),
// 					Image: to.Ptr("repo/testcontainerAppManagedBy:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 					Probes: []*armappcontainers.ContainerAppProbe{
// 						{
// 							Type: to.Ptr(armappcontainers.TypeLiveness),
// 							InitialDelaySeconds: to.Ptr[int32](3),
// 							PeriodSeconds: to.Ptr[int32](3),
// 							TCPSocket: &armappcontainers.ContainerAppProbeTCPSocket{
// 								Port: to.Ptr[int32](8080),
// 							},
// 					}},
// 			}},
// 			Scale: &armappcontainers.Scale{
// 				MaxReplicas: to.Ptr[int32](5),
// 				MinReplicas: to.Ptr[int32](1),
// 				Rules: []*armappcontainers.ScaleRule{
// 					{
// 						Name: to.Ptr("tcpscalingrule"),
// 						TCP: &armappcontainers.TCPScaleRule{
// 							Metadata: map[string]*string{
// 								"concurrentConnections": to.Ptr("50"),
// 							},
// 						},
// 				}},
// 			},
// 		},
// 	},
// }

Output:
Example (CreateOrUpdateTcpApp)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json 

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", "testcontainerAppTcp", armappcontainers.ContainerApp{
	Location: to.Ptr("East US"),
	Properties: &armappcontainers.ContainerAppProperties{
		Configuration: &armappcontainers.Configuration{
			Ingress: &armappcontainers.Ingress{
				ExposedPort: to.Ptr[int32](4000),
				External:    to.Ptr(true),
				TargetPort:  to.Ptr[int32](3000),
				Traffic: []*armappcontainers.TrafficWeight{
					{
						RevisionName: to.Ptr("testcontainerAppTcp-ab1234"),
						Weight:       to.Ptr[int32](100),
					}},
				Transport: to.Ptr(armappcontainers.IngressTransportMethodTCP),
			},
		},
		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		Template: &armappcontainers.Template{
			Containers: []*armappcontainers.Container{
				{
					Name:  to.Ptr("testcontainerAppTcp"),
					Image: to.Ptr("repo/testcontainerAppTcp:v1"),
					Probes: []*armappcontainers.ContainerAppProbe{
						{
							Type:                to.Ptr(armappcontainers.TypeLiveness),
							InitialDelaySeconds: to.Ptr[int32](3),
							PeriodSeconds:       to.Ptr[int32](3),
							TCPSocket: &armappcontainers.ContainerAppProbeTCPSocket{
								Port: to.Ptr[int32](8080),
							},
						}},
				}},
			Scale: &armappcontainers.Scale{
				MaxReplicas: to.Ptr[int32](5),
				MinReplicas: to.Ptr[int32](1),
				Rules: []*armappcontainers.ScaleRule{
					{
						Name: to.Ptr("tcpscalingrule"),
						TCP: &armappcontainers.TCPScaleRule{
							Metadata: map[string]*string{
								"concurrentConnections": 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("testcontainerAppTcp"),
// 	Type: to.Ptr("Microsoft.App/containerApps"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.ContainerAppProperties{
// 		Configuration: &armappcontainers.Configuration{
// 			Ingress: &armappcontainers.Ingress{
// 				ExposedPort: to.Ptr[int32](4000),
// 				External: to.Ptr(true),
// 				Fqdn: to.Ptr("testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
// 				TargetPort: to.Ptr[int32](3000),
// 				Traffic: []*armappcontainers.TrafficWeight{
// 					{
// 						RevisionName: to.Ptr("testcontainerAppTcp-ab1234"),
// 						Weight: to.Ptr[int32](80),
// 					},
// 					{
// 						RevisionName: to.Ptr("testcontainerAppTcp-ab4321"),
// 						Weight: to.Ptr[int32](20),
// 				}},
// 				Transport: to.Ptr(armappcontainers.IngressTransportMethodTCP),
// 			},
// 		},
// 		LatestReadyRevisionName: to.Ptr("testcontainerAppTcp-pjxhsye"),
// 		LatestRevisionFqdn: to.Ptr("testcontainerAppTcp-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("testcontainerAppTcp"),
// 					Image: to.Ptr("repo/testcontainerAppTcp:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 					Probes: []*armappcontainers.ContainerAppProbe{
// 						{
// 							Type: to.Ptr(armappcontainers.TypeLiveness),
// 							InitialDelaySeconds: to.Ptr[int32](3),
// 							PeriodSeconds: to.Ptr[int32](3),
// 							TCPSocket: &armappcontainers.ContainerAppProbeTCPSocket{
// 								Port: to.Ptr[int32](8080),
// 							},
// 					}},
// 			}},
// 			Scale: &armappcontainers.Scale{
// 				MaxReplicas: to.Ptr[int32](5),
// 				MinReplicas: to.Ptr[int32](1),
// 				Rules: []*armappcontainers.ScaleRule{
// 					{
// 						Name: to.Ptr("tcpscalingrule"),
// 						TCP: &armappcontainers.TCPScaleRule{
// 							Metadata: map[string]*string{
// 								"concurrentConnections": 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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_Delete.json 

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

func (client *ContainerAppsClient) BeginStart(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientBeginStartOptions) (*runtime.Poller[ContainerAppsClientStartResponse], error)

BeginStart - Start a container app If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_Start.json 

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().BeginStart(ctx, "rg", "testWorkerApp0", 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),
// 				EnableAPILogging: to.Ptr(true),
// 				Enabled: to.Ptr(true),
// 				HTTPMaxRequestSize: to.Ptr[int32](10),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 				LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
// 			},
// 			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"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 			MaxInactiveRevisions: to.Ptr[int32](10),
// 		},
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		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"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					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"),
// 							},
// 						},
// 				}},
// 			},
// 		},
// 		WorkloadProfileName: to.Ptr("My-GP-01"),
// 	},
// }

Output:

func (*ContainerAppsClient) BeginStop 

func (client *ContainerAppsClient) BeginStop(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientBeginStopOptions) (*runtime.Poller[ContainerAppsClientStopResponse], error)

BeginStop - Stop a container app If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_Stop.json 

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().BeginStop(ctx, "rg", "testWorkerApp0", 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),
// 				EnableAPILogging: to.Ptr(true),
// 				Enabled: to.Ptr(true),
// 				HTTPMaxRequestSize: to.Ptr[int32](10),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 				LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
// 			},
// 			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"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 			MaxInactiveRevisions: to.Ptr[int32](10),
// 		},
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		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"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					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"),
// 							},
// 						},
// 				}},
// 			},
// 		},
// 		WorkloadProfileName: to.Ptr("My-GP-01"),
// 	},
// }

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_Patch.json 

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),
				EnableAPILogging:   to.Ptr(true),
				Enabled:            to.Ptr(true),
				HTTPMaxRequestSize: to.Ptr[int32](10),
				HTTPReadBufferSize: to.Ptr[int32](30),
				LogLevel:           to.Ptr(armappcontainers.LogLevelDebug),
			},
			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),
				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
					{
						Name:           to.Ptr("Allow work IP A subnet"),
						Description:    to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
						Action:         to.Ptr(armappcontainers.ActionAllow),
						IPAddressRange: to.Ptr("192.168.1.1/32"),
					},
					{
						Name:           to.Ptr("Allow work IP B subnet"),
						Description:    to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
						Action:         to.Ptr(armappcontainers.ActionAllow),
						IPAddressRange: to.Ptr("192.168.1.1/8"),
					}},
				StickySessions: &armappcontainers.IngressStickySessions{
					Affinity: to.Ptr(armappcontainers.AffinitySticky),
				},
				TargetPort: to.Ptr[int32](3000),
				Traffic: []*armappcontainers.TrafficWeight{
					{
						Label:        to.Ptr("production"),
						RevisionName: to.Ptr("testcontainerApp0-ab1234"),
						Weight:       to.Ptr[int32](100),
					}},
			},
			MaxInactiveRevisions: to.Ptr[int32](10),
			Service: &armappcontainers.Service{
				Type: to.Ptr("redis"),
			},
		},
		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),
						}},
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name:  to.Ptr("testinitcontainerApp0"),
					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"),
						Custom: &armappcontainers.CustomScaleRule{
							Type: to.Ptr("http"),
							Metadata: map[string]*string{
								"concurrentRequests": to.Ptr("50"),
							},
						},
					}},
			},
			ServiceBinds: []*armappcontainers.ServiceBind{
				{
					Name:       to.Ptr("service"),
					ClientType: to.Ptr("dotnet"),
					CustomizedKeys: map[string]*string{
						"DesiredKey": to.Ptr("defaultKey"),
					},
					ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service"),
				}},
		},
	},
}, 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),
// 				EnableAPILogging: to.Ptr(true),
// 				Enabled: to.Ptr(true),
// 				HTTPMaxRequestSize: to.Ptr[int32](10),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 				LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
// 			},
// 			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"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 			MaxInactiveRevisions: to.Ptr[int32](10),
// 		},
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		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"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					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"),
// 							},
// 						},
// 				}},
// 			},
// 		},
// 		WorkloadProfileName: to.Ptr("My-GP-01"),
// 	},
// }

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_Get.json 

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),
// 				EnableAPILogging: to.Ptr(true),
// 				Enabled: to.Ptr(true),
// 				HTTPMaxRequestSize: to.Ptr[int32](10),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 				LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
// 			},
// 			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"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				StickySessions: &armappcontainers.IngressStickySessions{
// 					Affinity: to.Ptr(armappcontainers.AffinitySticky),
// 				},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 			MaxInactiveRevisions: to.Ptr[int32](10),
// 			Service: &armappcontainers.Service{
// 				Type: to.Ptr("redis"),
// 			},
// 		},
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		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"),
// 					},
// 					VolumeMounts: []*armappcontainers.VolumeMount{
// 						{
// 							MountPath: to.Ptr("/mnt/path1"),
// 							SubPath: to.Ptr("subPath1"),
// 							VolumeName: to.Ptr("azurefile"),
// 						},
// 						{
// 							MountPath: to.Ptr("/mnt/path2"),
// 							SubPath: to.Ptr("subPath2"),
// 							VolumeName: to.Ptr("nfsazurefile"),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					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"),
// 							},
// 						},
// 				}},
// 			},
// 			ServiceBinds: []*armappcontainers.ServiceBind{
// 				{
// 					Name: to.Ptr("service"),
// 					ClientType: to.Ptr("dotnet"),
// 					CustomizedKeys: map[string]*string{
// 						"DesiredKey": to.Ptr("defaultKey"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service"),
// 			}},
// 			Volumes: []*armappcontainers.Volume{
// 				{
// 					Name: to.Ptr("azurefile"),
// 					StorageName: to.Ptr("storage"),
// 					StorageType: to.Ptr(armappcontainers.StorageTypeAzureFile),
// 				},
// 				{
// 					Name: to.Ptr("nfsazurefile"),
// 					StorageName: to.Ptr("nfsStorage"),
// 					StorageType: to.Ptr(armappcontainers.StorageTypeNfsAzureFile),
// 			}},
// 		},
// 		WorkloadProfileName: to.Ptr("My-GP-01"),
// 	},
// }

Output:

func (*ContainerAppsClient) GetAuthToken 

func (client *ContainerAppsClient) GetAuthToken(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsClientGetAuthTokenOptions) (ContainerAppsClientGetAuthTokenResponse, error)

GetAuthToken - Get auth token for a container app If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_GetAuthToken.json 

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().GetAuthToken(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.ContainerAppAuthToken = armappcontainers.ContainerAppAuthToken{
// 	Name: to.Ptr("testcontainerApp0"),
// 	Type: to.Ptr("Microsoft.App/containerApps/accesstoken"),
// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.ContainerAppAuthTokenProperties{
// 		Expires: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-14T19:22:50.308Z"); return t}()),
// 		Token: to.Ptr("testToken"),
// 	},
// }

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json 

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{
// 	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.CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo{
// 					},
// 					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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_ListSecrets.json 

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 

func (client *ContainerAppsClient) NewListByResourceGroupPager(resourceGroupName string, options *ContainerAppsClientListByResourceGroupOptions) *runtime.Pager[ContainerAppsClientListByResourceGroupResponse]

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_ListByResourceGroup.json 

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),
	// 						EnableAPILogging: to.Ptr(true),
	// 						Enabled: to.Ptr(true),
	// 						HTTPMaxRequestSize: to.Ptr[int32](10),
	// 						HTTPReadBufferSize: to.Ptr[int32](30),
	// 						LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
	// 					},
	// 					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"),
	// 						IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
	// 							{
	// 								Name: to.Ptr("Allow work IP A subnet"),
	// 								Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
	// 								Action: to.Ptr(armappcontainers.ActionAllow),
	// 								IPAddressRange: to.Ptr("192.168.1.1/32"),
	// 							},
	// 							{
	// 								Name: to.Ptr("Allow work IP B subnet"),
	// 								Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
	// 								Action: to.Ptr(armappcontainers.ActionAllow),
	// 								IPAddressRange: to.Ptr("192.168.1.1/8"),
	// 						}},
	// 						StickySessions: &armappcontainers.IngressStickySessions{
	// 							Affinity: to.Ptr(armappcontainers.AffinitySticky),
	// 						},
	// 						TargetPort: to.Ptr[int32](3000),
	// 						TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
	// 						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),
	// 					},
	// 					MaxInactiveRevisions: to.Ptr[int32](10),
	// 				},
	// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 				LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
	// 				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"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.InitContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerApp0"),
	// 							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"),
	// 									},
	// 								},
	// 						}},
	// 					},
	// 				},
	// 				WorkloadProfileName: to.Ptr("My-GP-01"),
	// 			},
	// 	}},
	// }
}

Output:

func (*ContainerAppsClient) NewListBySubscriptionPager 

func (client *ContainerAppsClient) NewListBySubscriptionPager(options *ContainerAppsClientListBySubscriptionOptions) *runtime.Pager[ContainerAppsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Get the Container Apps in a given subscription.

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_ListBySubscription.json 

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),
	// 						EnableAPILogging: to.Ptr(true),
	// 						Enabled: to.Ptr(true),
	// 						HTTPMaxRequestSize: to.Ptr[int32](10),
	// 						HTTPReadBufferSize: to.Ptr[int32](30),
	// 						LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
	// 					},
	// 					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"),
	// 						IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
	// 							{
	// 								Name: to.Ptr("Allow work IP A subnet"),
	// 								Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
	// 								Action: to.Ptr(armappcontainers.ActionAllow),
	// 								IPAddressRange: to.Ptr("192.168.1.1/32"),
	// 							},
	// 							{
	// 								Name: to.Ptr("Allow work IP B subnet"),
	// 								Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
	// 								Action: to.Ptr(armappcontainers.ActionAllow),
	// 								IPAddressRange: to.Ptr("192.168.1.1/8"),
	// 						}},
	// 						StickySessions: &armappcontainers.IngressStickySessions{
	// 							Affinity: to.Ptr(armappcontainers.AffinitySticky),
	// 						},
	// 						TargetPort: to.Ptr[int32](3000),
	// 						TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
	// 						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),
	// 					},
	// 					MaxInactiveRevisions: to.Ptr[int32](10),
	// 					Service: &armappcontainers.Service{
	// 						Type: to.Ptr("redis"),
	// 					},
	// 				},
	// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 				LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
	// 				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"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.InitContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerApp0"),
	// 							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"),
	// 									},
	// 								},
	// 						}},
	// 					},
	// 					ServiceBinds: []*armappcontainers.ServiceBind{
	// 						{
	// 							Name: to.Ptr("service"),
	// 							ClientType: to.Ptr("dotnet"),
	// 							CustomizedKeys: map[string]*string{
	// 								"DesiredKey": to.Ptr("defaultKey"),
	// 							},
	// 							ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service"),
	// 					}},
	// 				},
	// 				WorkloadProfileName: to.Ptr("My-GP-01"),
	// 			},
	// 	}},
	// }
}

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 ContainerAppsClientBeginStartOptions 

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

ContainerAppsClientBeginStartOptions contains the optional parameters for the ContainerAppsClient.BeginStart method.

type ContainerAppsClientBeginStopOptions 

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

ContainerAppsClientBeginStopOptions contains the optional parameters for the ContainerAppsClient.BeginStop 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 {
	// Container App.
	ContainerApp
}

ContainerAppsClientCreateOrUpdateResponse contains the response from method ContainerAppsClient.BeginCreateOrUpdate.

type ContainerAppsClientDeleteResponse 

type ContainerAppsClientDeleteResponse struct {
}

ContainerAppsClientDeleteResponse contains the response from method ContainerAppsClient.BeginDelete.

type ContainerAppsClientGetAuthTokenOptions 

type ContainerAppsClientGetAuthTokenOptions struct {
}

ContainerAppsClientGetAuthTokenOptions contains the optional parameters for the ContainerAppsClient.GetAuthToken method.

type ContainerAppsClientGetAuthTokenResponse 

type ContainerAppsClientGetAuthTokenResponse struct {
	// Container App Auth Token.
	ContainerAppAuthToken
}

ContainerAppsClientGetAuthTokenResponse contains the response from method ContainerAppsClient.GetAuthToken.

type ContainerAppsClientGetOptions 

type ContainerAppsClientGetOptions struct {
}

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

type ContainerAppsClientGetResponse 

type ContainerAppsClientGetResponse struct {
	// Container App.
	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 {
	// Container App collection ARM resource.
	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 {
	// Container App collection ARM resource.
	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 {
	// Custom domain analysis.
	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 {
	// Container App Secrets Collection ARM resource.
	SecretsCollection
}

ContainerAppsClientListSecretsResponse contains the response from method ContainerAppsClient.ListSecrets.

type ContainerAppsClientStartResponse 

type ContainerAppsClientStartResponse struct {
	// Container App.
	ContainerApp
}

ContainerAppsClientStartResponse contains the response from method ContainerAppsClient.BeginStart.

type ContainerAppsClientStopResponse 

type ContainerAppsClientStopResponse struct {
	// Container App.
	ContainerApp
}

ContainerAppsClientStopResponse contains the response from method ContainerAppsClient.BeginStop.

type ContainerAppsClientUpdateResponse 

type ContainerAppsClientUpdateResponse struct {
	// Container App.
	ContainerApp
}

ContainerAppsClientUpdateResponse contains the response from method ContainerAppsClient.BeginUpdate.

type ContainerAppsDiagnosticsClient 

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

ContainerAppsDiagnosticsClient contains the methods for the ContainerAppsDiagnostics group. Don't use this type directly, use NewContainerAppsDiagnosticsClient() instead.

func NewContainerAppsDiagnosticsClient 

func NewContainerAppsDiagnosticsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerAppsDiagnosticsClient, error)

NewContainerAppsDiagnosticsClient creates a new instance of ContainerAppsDiagnosticsClient with the specified values.

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

func (*ContainerAppsDiagnosticsClient) GetDetector 

func (client *ContainerAppsDiagnosticsClient) GetDetector(ctx context.Context, resourceGroupName string, containerAppName string, detectorName string, options *ContainerAppsDiagnosticsClientGetDetectorOptions) (ContainerAppsDiagnosticsClientGetDetectorResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App.
  • detectorName - Name of the Container App Detector.
  • options - ContainerAppsDiagnosticsClientGetDetectorOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.GetDetector method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerAppsDiagnostics_Get.json 

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.NewContainerAppsDiagnosticsClient().GetDetector(ctx, "mikono-workerapp-test-rg", "mikono-capp-stage1", "cappcontainerappnetworkIO", 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.Diagnostics = armappcontainers.Diagnostics{
// 	Name: to.Ptr("cappcontainerappnetworkIO"),
// 	Type: to.Ptr("Microsoft.App/containerapps/detectors"),
// 	ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/containerApps/mikono-capp-stage1/detectors/cappcontainerappnetworkIO"),
// 	Properties: &armappcontainers.DiagnosticsProperties{
// 		Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
// 			{
// 				RenderingProperties: &armappcontainers.DiagnosticRendering{
// 					Type: to.Ptr[int32](8),
// 					Description: to.Ptr(""),
// 					IsVisible: to.Ptr(true),
// 					Title: to.Ptr("Container Apps Network Inbound "),
// 				},
// 				Table: &armappcontainers.DiagnosticDataTableResponseObject{
// 					Columns: []*armappcontainers.DiagnosticDataTableResponseColumn{
// 						{
// 							ColumnName: to.Ptr("TimeStamp"),
// 							DataType: to.Ptr("DateTime"),
// 						},
// 						{
// 							ColumnName: to.Ptr("Metric"),
// 							DataType: to.Ptr("String"),
// 						},
// 						{
// 							ColumnName: to.Ptr("Average"),
// 							DataType: to.Ptr("Double"),
// 					}},
// 					Rows: []any{
// 						[]any{
// 							"2022-03-15T21:35:00",
// 							"RxBytes",
// 							float64(0),
// 					}},
// 					TableName: to.Ptr(""),
// 				},
// 		}},
// 		Metadata: &armappcontainers.DiagnosticsDefinition{
// 			Name: to.Ptr("Container App Network Inbound and Outbound"),
// 			Type: to.Ptr("Detector"),
// 			Description: to.Ptr("This detector shows the Container App Network Inbound and Outbound."),
// 			Author: to.Ptr(""),
// 			Category: to.Ptr("Availability and Performance"),
// 			ID: to.Ptr("cappcontainerappnetworkIO"),
// 			Score: to.Ptr[float32](0),
// 			SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
// 			},
// 		},
// 		Status: &armappcontainers.DiagnosticsStatus{
// 			StatusID: to.Ptr[int32](3),
// 		},
// 	},
// }

Output:

func (*ContainerAppsDiagnosticsClient) GetRevision 

func (client *ContainerAppsDiagnosticsClient) GetRevision(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, options *ContainerAppsDiagnosticsClientGetRevisionOptions) (ContainerAppsDiagnosticsClientGetRevisionResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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 - ContainerAppsDiagnosticsClientGetRevisionOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.GetRevision method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_Get.json 

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.NewContainerAppsDiagnosticsClient().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.000Z"); return t}()),
// 		Fqdn: to.Ptr("testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io"),
// 		LastActiveTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-24T21:24:22.000Z"); return t}()),
// 		Replicas: to.Ptr[int32](1),
// 		RunningState: to.Ptr(armappcontainers.RevisionRunningStateRunning),
// 		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"),
// 							},
// 						},
// 				}},
// 			},
// 		},
// 		TrafficWeight: to.Ptr[int32](80),
// 	},
// }

Output:

func (*ContainerAppsDiagnosticsClient) GetRoot 

func (client *ContainerAppsDiagnosticsClient) GetRoot(ctx context.Context, resourceGroupName string, containerAppName string, options *ContainerAppsDiagnosticsClientGetRootOptions) (ContainerAppsDiagnosticsClientGetRootResponse, error)

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

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_Get.json 

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.NewContainerAppsDiagnosticsClient().GetRoot(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),
// 				EnableAPILogging: to.Ptr(true),
// 				Enabled: to.Ptr(true),
// 				HTTPMaxRequestSize: to.Ptr[int32](10),
// 				HTTPReadBufferSize: to.Ptr[int32](30),
// 				LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
// 			},
// 			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"),
// 				IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
// 					{
// 						Name: to.Ptr("Allow work IP A subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/32"),
// 					},
// 					{
// 						Name: to.Ptr("Allow work IP B subnet"),
// 						Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
// 						Action: to.Ptr(armappcontainers.ActionAllow),
// 						IPAddressRange: to.Ptr("192.168.1.1/8"),
// 				}},
// 				StickySessions: &armappcontainers.IngressStickySessions{
// 					Affinity: to.Ptr(armappcontainers.AffinitySticky),
// 				},
// 				TargetPort: to.Ptr[int32](3000),
// 				TargetPortHTTPScheme: to.Ptr(armappcontainers.IngressTargetPortHTTPSchemeHTTP),
// 				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),
// 			},
// 			MaxInactiveRevisions: to.Ptr[int32](10),
// 			Service: &armappcontainers.Service{
// 				Type: to.Ptr("redis"),
// 			},
// 		},
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		LatestReadyRevisionName: to.Ptr("testcontainerApp0-pjxhsye"),
// 		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"),
// 					},
// 					VolumeMounts: []*armappcontainers.VolumeMount{
// 						{
// 							MountPath: to.Ptr("/mnt/path1"),
// 							SubPath: to.Ptr("subPath1"),
// 							VolumeName: to.Ptr("azurefile"),
// 						},
// 						{
// 							MountPath: to.Ptr("/mnt/path2"),
// 							SubPath: to.Ptr("subPath2"),
// 							VolumeName: to.Ptr("nfsazurefile"),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerApp0"),
// 					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"),
// 							},
// 						},
// 				}},
// 			},
// 			ServiceBinds: []*armappcontainers.ServiceBind{
// 				{
// 					Name: to.Ptr("service"),
// 					ClientType: to.Ptr("dotnet"),
// 					CustomizedKeys: map[string]*string{
// 						"DesiredKey": to.Ptr("defaultKey"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service"),
// 			}},
// 			Volumes: []*armappcontainers.Volume{
// 				{
// 					Name: to.Ptr("azurefile"),
// 					StorageName: to.Ptr("storage"),
// 					StorageType: to.Ptr(armappcontainers.StorageTypeAzureFile),
// 				},
// 				{
// 					Name: to.Ptr("nfsazurefile"),
// 					StorageName: to.Ptr("nfsStorage"),
// 					StorageType: to.Ptr(armappcontainers.StorageTypeNfsAzureFile),
// 			}},
// 		},
// 		WorkloadProfileName: to.Ptr("My-GP-01"),
// 	},
// }

Output:

func (*ContainerAppsDiagnosticsClient) NewListDetectorsPager 

func (client *ContainerAppsDiagnosticsClient) NewListDetectorsPager(resourceGroupName string, containerAppName string, options *ContainerAppsDiagnosticsClientListDetectorsOptions) *runtime.Pager[ContainerAppsDiagnosticsClientListDetectorsResponse]

NewListDetectorsPager - Get the list of diagnostics for a given Container App.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • containerAppName - Name of the Container App for which detector info is needed.
  • options - ContainerAppsDiagnosticsClientListDetectorsOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.NewListDetectorsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerAppsDiagnostics_List.json 

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.NewContainerAppsDiagnosticsClient().NewListDetectorsPager("mikono-workerapp-test-rg", "mikono-capp-stage1", 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.DiagnosticsCollection = armappcontainers.DiagnosticsCollection{
	// 	Value: []*armappcontainers.Diagnostics{
	// 		{
	// 			Name: to.Ptr("cappContainerAppAvailabilityMetrics"),
	// 			Type: to.Ptr("Microsoft.App/containerapps/detectors"),
	// 			ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/containerApps/mikono-capp-stage1/detectors/cappContainerAppAvailabilityMetrics"),
	// 			Properties: &armappcontainers.DiagnosticsProperties{
	// 				Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
	// 				},
	// 				Metadata: &armappcontainers.DiagnosticsDefinition{
	// 					Name: to.Ptr("Availability Metrics for Container Apps"),
	// 					Type: to.Ptr("Analysis"),
	// 					Author: to.Ptr(""),
	// 					Category: to.Ptr("Availability and Performance"),
	// 					ID: to.Ptr("cappContainerAppAvailabilityMetrics"),
	// 					Score: to.Ptr[float32](0),
	// 					SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
	// 					},
	// 				},
	// 				Status: &armappcontainers.DiagnosticsStatus{
	// 					StatusID: to.Ptr[int32](4),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*ContainerAppsDiagnosticsClient) NewListRevisionsPager 

func (client *ContainerAppsDiagnosticsClient) NewListRevisionsPager(resourceGroupName string, containerAppName string, options *ContainerAppsDiagnosticsClientListRevisionsOptions) *runtime.Pager[ContainerAppsDiagnosticsClientListRevisionsResponse]

NewListRevisionsPager - Get the Revisions for a given Container App.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_List.json 

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.NewContainerAppsDiagnosticsClient().NewListRevisionsPager("rg", "testcontainerApp0", &armappcontainers.ContainerAppsDiagnosticsClientListRevisionsOptions{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.000Z"); return t}()),
	// 				Fqdn: to.Ptr("testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io"),
	// 				LastActiveTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-24T21:24:22.000Z"); return t}()),
	// 				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"),
	// 									},
	// 								},
	// 						}},
	// 					},
	// 				},
	// 				TrafficWeight: to.Ptr[int32](80),
	// 			},
	// 	}},
	// }
}

Output:

type ContainerAppsDiagnosticsClientGetDetectorOptions 

type ContainerAppsDiagnosticsClientGetDetectorOptions struct {
}

ContainerAppsDiagnosticsClientGetDetectorOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.GetDetector method.

type ContainerAppsDiagnosticsClientGetDetectorResponse 

type ContainerAppsDiagnosticsClientGetDetectorResponse struct {
	// Diagnostics data for a resource.
	Diagnostics
}

ContainerAppsDiagnosticsClientGetDetectorResponse contains the response from method ContainerAppsDiagnosticsClient.GetDetector.

type ContainerAppsDiagnosticsClientGetRevisionOptions 

type ContainerAppsDiagnosticsClientGetRevisionOptions struct {
}

ContainerAppsDiagnosticsClientGetRevisionOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.GetRevision method.

type ContainerAppsDiagnosticsClientGetRevisionResponse 

type ContainerAppsDiagnosticsClientGetRevisionResponse struct {
	// Container App Revision.
	Revision
}

ContainerAppsDiagnosticsClientGetRevisionResponse contains the response from method ContainerAppsDiagnosticsClient.GetRevision.

type ContainerAppsDiagnosticsClientGetRootOptions 

type ContainerAppsDiagnosticsClientGetRootOptions struct {
}

ContainerAppsDiagnosticsClientGetRootOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.GetRoot method.

type ContainerAppsDiagnosticsClientGetRootResponse 

type ContainerAppsDiagnosticsClientGetRootResponse struct {
	// Container App.
	ContainerApp
}

ContainerAppsDiagnosticsClientGetRootResponse contains the response from method ContainerAppsDiagnosticsClient.GetRoot.

type ContainerAppsDiagnosticsClientListDetectorsOptions 

type ContainerAppsDiagnosticsClientListDetectorsOptions struct {
}

ContainerAppsDiagnosticsClientListDetectorsOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.NewListDetectorsPager method.

type ContainerAppsDiagnosticsClientListDetectorsResponse 

type ContainerAppsDiagnosticsClientListDetectorsResponse struct {
	// Diagnostics data collection for a resource.
	DiagnosticsCollection
}

ContainerAppsDiagnosticsClientListDetectorsResponse contains the response from method ContainerAppsDiagnosticsClient.NewListDetectorsPager.

type ContainerAppsDiagnosticsClientListRevisionsOptions 

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

ContainerAppsDiagnosticsClientListRevisionsOptions contains the optional parameters for the ContainerAppsDiagnosticsClient.NewListRevisionsPager method.

type ContainerAppsDiagnosticsClientListRevisionsResponse 

type ContainerAppsDiagnosticsClientListRevisionsResponse struct {
	// Container App Revisions collection ARM resource.
	RevisionCollection
}

ContainerAppsDiagnosticsClientListRevisionsResponse contains the response from method ContainerAppsDiagnosticsClient.NewListRevisionsPager.

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. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsRevisionReplicasClient) GetReplica 

func (client *ContainerAppsRevisionReplicasClient) GetReplica(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, replicaName string, options *ContainerAppsRevisionReplicasClientGetReplicaOptions) (ContainerAppsRevisionReplicasClientGetReplicaResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Replicas_Get.json 

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"),
// 				ExecEndpoint: to.Ptr("testExecEndpoint"),
// 				LogStreamEndpoint: to.Ptr("testLogStreamEndpoint"),
// 				Ready: to.Ptr(true),
// 				RestartCount: to.Ptr[int32](0),
// 				RunningState: to.Ptr(armappcontainers.ContainerAppContainerRunningStateRunning),
// 				RunningStateDetails: to.Ptr("testDetail"),
// 				Started: to.Ptr(true),
// 		}},
// 		CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-25T19:42:45.000Z"); return t}()),
// 		InitContainers: []*armappcontainers.ReplicaContainer{
// 		},
// 		RunningState: to.Ptr(armappcontainers.ContainerAppReplicaRunningStateRunning),
// 		RunningStateDetails: to.Ptr("testDetail"),
// 	},
// }

Output:

func (*ContainerAppsRevisionReplicasClient) ListReplicas 

func (client *ContainerAppsRevisionReplicasClient) ListReplicas(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, options *ContainerAppsRevisionReplicasClientListReplicasOptions) (ContainerAppsRevisionReplicasClientListReplicasResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Replicas_List.json 

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"),
// 						ExecEndpoint: to.Ptr("testExecEndpoint"),
// 						LogStreamEndpoint: to.Ptr("testLogStreamEndpoint"),
// 						Ready: to.Ptr(true),
// 						RestartCount: to.Ptr[int32](0),
// 						RunningState: to.Ptr(armappcontainers.ContainerAppContainerRunningStateRunning),
// 						RunningStateDetails: to.Ptr("testDetail"),
// 						Started: to.Ptr(true),
// 				}},
// 				CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-25T19:42:45.000Z"); return t}()),
// 				InitContainers: []*armappcontainers.ReplicaContainer{
// 				},
// 				RunningState: to.Ptr(armappcontainers.ContainerAppReplicaRunningStateRunning),
// 				RunningStateDetails: to.Ptr("testDetail"),
// 			},
// 	}},
// }

Output:

type ContainerAppsRevisionReplicasClientGetReplicaOptions 

type ContainerAppsRevisionReplicasClientGetReplicaOptions struct {
}

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

type ContainerAppsRevisionReplicasClientGetReplicaResponse 

type ContainerAppsRevisionReplicasClientGetReplicaResponse struct {
	// Container App Revision Replica.
	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 {
	// Container App Revision Replicas collection ARM resource.
	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. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerAppsRevisionsClient) ActivateRevision 

func (client *ContainerAppsRevisionsClient) ActivateRevision(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, options *ContainerAppsRevisionsClientActivateRevisionOptions) (ContainerAppsRevisionsClientActivateRevisionResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_Activate.json 

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 

func (client *ContainerAppsRevisionsClient) DeactivateRevision(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, options *ContainerAppsRevisionsClientDeactivateRevisionOptions) (ContainerAppsRevisionsClientDeactivateRevisionResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_Deactivate.json 

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_Get.json 

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.000Z"); return t}()),
// 		Fqdn: to.Ptr("testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io"),
// 		LastActiveTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-24T21:24:22.000Z"); return t}()),
// 		Replicas: to.Ptr[int32](1),
// 		RunningState: to.Ptr(armappcontainers.RevisionRunningStateRunning),
// 		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"),
// 							},
// 						},
// 				}},
// 			},
// 		},
// 		TrafficWeight: to.Ptr[int32](80),
// 	},
// }

Output:

func (*ContainerAppsRevisionsClient) NewListRevisionsPager 

func (client *ContainerAppsRevisionsClient) NewListRevisionsPager(resourceGroupName string, containerAppName string, options *ContainerAppsRevisionsClientListRevisionsOptions) *runtime.Pager[ContainerAppsRevisionsClientListRevisionsResponse]

NewListRevisionsPager - Get the Revisions for a given Container App.

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_List.json 

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.000Z"); return t}()),
	// 				Fqdn: to.Ptr("testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io"),
	// 				LastActiveTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-24T21:24:22.000Z"); return t}()),
	// 				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"),
	// 									},
	// 								},
	// 						}},
	// 					},
	// 				},
	// 				TrafficWeight: to.Ptr[int32](80),
	// 			},
	// 	}},
	// }
}

Output:

func (*ContainerAppsRevisionsClient) RestartRevision 

func (client *ContainerAppsRevisionsClient) RestartRevision(ctx context.Context, resourceGroupName string, containerAppName string, revisionName string, options *ContainerAppsRevisionsClientRestartRevisionOptions) (ContainerAppsRevisionsClientRestartRevisionResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Revisions_Restart.json 

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 {
	// Container App Revision.
	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 {
	// Container App Revisions collection ARM resource.
	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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/SourceControls_CreateOrUpdate.json 

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>"),
				Kind:         to.Ptr("feaderated"),
				TenantID:     to.Ptr("<tenantid>"),
			},
			BuildEnvironmentVariables: []*armappcontainers.EnvironmentVariable{
				{
					Name:  to.Ptr("foo1"),
					Value: to.Ptr("bar1"),
				},
				{
					Name:  to.Ptr("foo2"),
					Value: to.Ptr("bar2"),
				}},
			ContextPath:               to.Ptr("./"),
			GithubPersonalAccessToken: to.Ptr("test"),
			Image:                     to.Ptr("image/tag"),
			RegistryInfo: &armappcontainers.RegistryInfo{
				RegistryPassword: to.Ptr("<registrypassword>"),
				RegistryURL:      to.Ptr("test-registry.azurecr.io"),
				RegistryUserName: to.Ptr("test-registry"),
			},
		},
		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{
// 			BuildEnvironmentVariables: []*armappcontainers.EnvironmentVariable{
// 				{
// 					Name: to.Ptr("foo1"),
// 					Value: to.Ptr("bar1"),
// 				},
// 				{
// 					Name: to.Ptr("foo2"),
// 					Value: to.Ptr("bar2"),
// 			}},
// 			ContextPath: to.Ptr("./"),
// 			Image: to.Ptr("image/tag"),
// 			RegistryInfo: &armappcontainers.RegistryInfo{
// 				RegistryURL: to.Ptr("test-registry.azurecr.io"),
// 				RegistryUserName: to.Ptr("testreg"),
// 			},
// 		},
// 		OperationState: to.Ptr(armappcontainers.SourceControlOperationStateInProgress),
// 		RepoURL: to.Ptr("https://github.com/xwang971/ghatest"),
// 	},
// }

Output:

func (*ContainerAppsSourceControlsClient) BeginDelete 

func (client *ContainerAppsSourceControlsClient) BeginDelete(ctx context.Context, resourceGroupName string, containerAppName string, sourceControlName string, options *ContainerAppsSourceControlsClientBeginDeleteOptions) (*runtime.Poller[ContainerAppsSourceControlsClientDeleteResponse], error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/SourceControls_Delete.json 

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 

func (client *ContainerAppsSourceControlsClient) Get(ctx context.Context, resourceGroupName string, containerAppName string, sourceControlName string, options *ContainerAppsSourceControlsClientGetOptions) (ContainerAppsSourceControlsClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/SourceControls_Get.json 

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{
// 			BuildEnvironmentVariables: []*armappcontainers.EnvironmentVariable{
// 				{
// 					Name: to.Ptr("foo1"),
// 					Value: to.Ptr("bar1"),
// 				},
// 				{
// 					Name: to.Ptr("foo2"),
// 					Value: to.Ptr("bar2"),
// 			}},
// 			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 

func (client *ContainerAppsSourceControlsClient) NewListByContainerAppPager(resourceGroupName string, containerAppName string, options *ContainerAppsSourceControlsClientListByContainerAppOptions) *runtime.Pager[ContainerAppsSourceControlsClientListByContainerAppResponse]

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/SourceControls_ListByContainer.json 

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{
	// 					BuildEnvironmentVariables: []*armappcontainers.EnvironmentVariable{
	// 						{
	// 							Name: to.Ptr("foo1"),
	// 							Value: to.Ptr("bar1"),
	// 						},
	// 						{
	// 							Name: to.Ptr("foo2"),
	// 							Value: to.Ptr("bar2"),
	// 					}},
	// 					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 {
	// Container App SourceControl.
	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 {
	// Container App SourceControl.
	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 {
	// SourceControl collection ARM resource.
	SourceControlCollection
}

ContainerAppsSourceControlsClientListByContainerAppResponse contains the response from method ContainerAppsSourceControlsClient.NewListByContainerAppPager.

type ContainerRegistry 

type ContainerRegistry struct {
	// REQUIRED; Login server of the container registry.
	ContainerRegistryServer *string

	// REQUIRED; Resource ID of the managed identity.
	IdentityResourceID *string
}

ContainerRegistry - Model representing a mapping from a container registry to the identity used to connect to it.

func (ContainerRegistry) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistry.

func (*ContainerRegistry) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistry.

type ContainerRegistryWithCustomImage 

type ContainerRegistryWithCustomImage struct {
	// REQUIRED; Login server of the container registry that the final image should be uploaded to. Builder resource needs to
	// have this container registry defined along with an identity to use to access it.
	Server *string

	// Full name that the final image should be uploaded as, including both image name and tag.
	Image *string
}

ContainerRegistryWithCustomImage - Container registry that the final image will be uploaded to.

func (ContainerRegistryWithCustomImage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryWithCustomImage.

func (*ContainerRegistryWithCustomImage) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryWithCustomImage.

type ContainerResources 

type ContainerResources struct {
	// Required CPU in cores, e.g. 0.5
	CPU *float64

	// Required memory, e.g. "250Mb"
	Memory *string

	// READ-ONLY; Ephemeral Storage, e.g. "1Gi"
	EphemeralStorage *string
}

ContainerResources - Container App container resource requirements.

func (ContainerResources) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerResources.

func (*ContainerResources) UnmarshalJSON 

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

	// The time after the request is made when the session cookie should expire.
	TimeToExpiration *string
}

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

func (CookieExpiration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CookieExpiration.

func (*CookieExpiration) UnmarshalJSON 

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 CorsPolicy 

type CorsPolicy struct {
	// REQUIRED; Specifies the content for the access-control-allow-origins header
	AllowedOrigins []*string

	// Specifies whether the resource allows credentials
	AllowCredentials *bool

	// Specifies the content for the access-control-allow-headers header
	AllowedHeaders []*string

	// Specifies the content for the access-control-allow-methods header
	AllowedMethods []*string

	// Specifies the content for the access-control-expose-headers header
	ExposeHeaders []*string

	// Specifies the content for the access-control-max-age header
	MaxAge *int32
}

CorsPolicy - Cross-Origin-Resource-Sharing policy

func (CorsPolicy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CorsPolicy.

func (*CorsPolicy) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CorsPolicy.

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; Hostname.
	Name *string

	// Custom Domain binding type.
	BindingType *BindingType

	// Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
	CertificateID *string
}

CustomDomain - Custom Domain of a Container App

func (CustomDomain) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomain.

func (*CustomDomain) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomain.

type CustomDomainConfiguration 

type CustomDomainConfiguration struct {
	// Certificate stored in Azure Key Vault.
	CertificateKeyVaultProperties *CertificateKeyVaultProperties

	// Certificate password
	CertificatePassword *string

	// PFX or PEM blob
	CertificateValue []byte

	// Dns suffix for the environment domain
	DNSSuffix *string

	// READ-ONLY; Id used to verify domain name ownership
	CustomDomainVerificationID *string

	// READ-ONLY; Certificate expiration date.
	ExpirationDate *time.Time

	// READ-ONLY; Subject name of the certificate.
	SubjectName *string

	// READ-ONLY; Certificate thumbprint.
	Thumbprint *string
}

CustomDomainConfiguration - Configuration properties for apps environment custom domain

func (CustomDomainConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainConfiguration.

func (*CustomDomainConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomainConfiguration.

type CustomHostnameAnalysisResult 

type CustomHostnameAnalysisResult struct {
	// A records visible for this hostname.
	ARecords []*string

	// Alternate CName records visible for this hostname.
	AlternateCNameRecords []*string

	// Alternate TXT records visible for this hostname.
	AlternateTxtRecords []*string

	// CName records visible for this hostname.
	CNameRecords []*string

	// TXT records visible for this hostname.
	TxtRecords []*string

	// READ-ONLY; true if there is a conflict on the Container App's managed environment level custom domain; otherwise, false.
	ConflictWithEnvironmentCustomDomain *bool

	// READ-ONLY; Name of the conflicting Container App on the Managed Environment if it's within the same subscription.
	ConflictingContainerAppResourceID *string

	// READ-ONLY; Raw failure information if DNS verification fails.
	CustomDomainVerificationFailureInfo *CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo

	// READ-ONLY; DNS verification test result.
	CustomDomainVerificationTest *DNSVerificationTestResult

	// READ-ONLY; true if there is a conflict on the Container App's managed environment; otherwise, false.
	HasConflictOnManagedEnvironment *bool

	// READ-ONLY; Host name that was analyzed
	HostName *string

	// READ-ONLY; true if hostname is already verified; otherwise, false.
	IsHostnameAlreadyVerified *bool
}

CustomHostnameAnalysisResult - Custom domain analysis.

func (CustomHostnameAnalysisResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomHostnameAnalysisResult.

func (*CustomHostnameAnalysisResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomHostnameAnalysisResult.

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo 

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo struct {
	// Details or the error
	Details []*CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem

	// READ-ONLY; Standardized string to programmatically identify the error.
	Code *string

	// READ-ONLY; Detailed error description and debugging information.
	Message *string

	// READ-ONLY; Detailed error description and debugging information.
	Target *string
}

CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo - Raw failure information if DNS verification fails.

func (CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo.

func (*CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo.

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem 

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem struct {
	// READ-ONLY; Standardized string to programmatically identify the error.
	Code *string

	// READ-ONLY; Detailed error description and debugging information.
	Message *string

	// READ-ONLY; Detailed error description and debugging information.
	Target *string
}

CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem - Detailed errors.

func (CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem.

func (*CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem.

type CustomOpenIDConnectProvider 

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

	// The configuration settings of the login flow of the custom Open ID Connect provider.
	Login *OpenIDConnectLogin

	// The configuration settings of the app registration for the custom Open ID Connect provider.
	Registration *OpenIDConnectRegistration
}

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

func (CustomOpenIDConnectProvider) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomOpenIDConnectProvider.

func (*CustomOpenIDConnectProvider) UnmarshalJSON 

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

	// Metadata properties to describe custom scale rule.
	Metadata map[string]*string

	// Type of the custom scale rule eg: azure-servicebus, redis etc.
	Type *string
}

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 

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 (
	DNSVerificationTestResultFailed  DNSVerificationTestResult = "Failed"
	DNSVerificationTestResultPassed  DNSVerificationTestResult = "Passed"
	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

	// Tells Dapr which port your application is listening on
	AppPort *int32

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

	// Enables API logging for the Dapr sidecar
	EnableAPILogging *bool

	// Boolean indicating if the Dapr side car is enabled
	Enabled *bool

	// Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is
	// 4 MB.
	HTTPMaxRequestSize *int32

	// Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.
	HTTPReadBufferSize *int32

	// Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
	LogLevel *LogLevel
}

Dapr - Container App Dapr configuration.

func (Dapr) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Dapr.

func (*Dapr) UnmarshalJSON 

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DaprComponent - Dapr Component.

func (DaprComponent) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponent.

func (*DaprComponent) UnmarshalJSON 

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

	// Boolean describing if the component errors are ignores
	IgnoreErrors *bool

	// Initialization timeout
	InitTimeout *string

	// Component metadata
	Metadata []*DaprMetadata

	// Names of container apps that can use this Dapr component
	Scopes []*string

	// Name of a Dapr component to retrieve component secrets from
	SecretStoreComponent *string

	// Collection of secrets used by a Dapr component
	Secrets []*Secret

	// List of container app services that are bound to the Dapr component
	ServiceComponentBind []*DaprComponentServiceBinding

	// Component version
	Version *string
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentProperties.

type DaprComponentResiliencyPoliciesClient 

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

DaprComponentResiliencyPoliciesClient contains the methods for the DaprComponentResiliencyPolicies group. Don't use this type directly, use NewDaprComponentResiliencyPoliciesClient() instead.

func NewDaprComponentResiliencyPoliciesClient 

func NewDaprComponentResiliencyPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DaprComponentResiliencyPoliciesClient, error)

NewDaprComponentResiliencyPoliciesClient creates a new instance of DaprComponentResiliencyPoliciesClient with the specified values.

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

func (*DaprComponentResiliencyPoliciesClient) CreateOrUpdate 

func (client *DaprComponentResiliencyPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, componentName string, name string, daprComponentResiliencyPolicyEnvelope DaprComponentResiliencyPolicy, options *DaprComponentResiliencyPoliciesClientCreateOrUpdateOptions) (DaprComponentResiliencyPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a resiliency policy for a Dapr component. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • componentName - Name of the Dapr Component.
  • name - Name of the Dapr Component Resiliency Policy.
  • daprComponentResiliencyPolicyEnvelope - Configuration details of the Dapr Component Resiliency Policy.
  • options - DaprComponentResiliencyPoliciesClientCreateOrUpdateOptions contains the optional parameters for the DaprComponentResiliencyPoliciesClient.CreateOrUpdate method.
Example (CreateOrUpdateDaprComponentResiliencyPolicyWithAllOptions)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json 

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.NewDaprComponentResiliencyPoliciesClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "mydaprcomponent", "myresiliencypolicy", armappcontainers.DaprComponentResiliencyPolicy{
	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
		InboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
				ConsecutiveErrors: to.Ptr[int32](5),
				IntervalInSeconds: to.Ptr[int32](4),
				TimeoutInSeconds:  to.Ptr[int32](10),
			},
			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
				MaxRetries: to.Ptr[int32](15),
				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
					InitialDelayInMilliseconds: to.Ptr[int32](2000),
					MaxIntervalInMilliseconds:  to.Ptr[int32](5500),
				},
			},
			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
				ResponseTimeoutInSeconds: to.Ptr[int32](30),
			},
		},
		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
				ConsecutiveErrors: to.Ptr[int32](3),
				IntervalInSeconds: to.Ptr[int32](60),
				TimeoutInSeconds:  to.Ptr[int32](20),
			},
			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
				MaxRetries: to.Ptr[int32](5),
				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
					InitialDelayInMilliseconds: to.Ptr[int32](100),
					MaxIntervalInMilliseconds:  to.Ptr[int32](30000),
				},
			},
			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
				ResponseTimeoutInSeconds: to.Ptr[int32](12),
			},
		},
	},
}, 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.DaprComponentResiliencyPolicy = armappcontainers.DaprComponentResiliencyPolicy{
// 	Name: to.Ptr("myresiliencypolicy"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy"),
// 	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
// 		InboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
// 				ConsecutiveErrors: to.Ptr[int32](5),
// 				IntervalInSeconds: to.Ptr[int32](4),
// 				TimeoutInSeconds: to.Ptr[int32](10),
// 			},
// 			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
// 				MaxRetries: to.Ptr[int32](15),
// 				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
// 					InitialDelayInMilliseconds: to.Ptr[int32](2000),
// 					MaxIntervalInMilliseconds: to.Ptr[int32](5500),
// 				},
// 			},
// 			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
// 				ResponseTimeoutInSeconds: to.Ptr[int32](30),
// 			},
// 		},
// 		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
// 				ConsecutiveErrors: to.Ptr[int32](3),
// 				IntervalInSeconds: to.Ptr[int32](60),
// 				TimeoutInSeconds: to.Ptr[int32](20),
// 			},
// 			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
// 				MaxRetries: to.Ptr[int32](5),
// 				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
// 					InitialDelayInMilliseconds: to.Ptr[int32](100),
// 					MaxIntervalInMilliseconds: to.Ptr[int32](30000),
// 				},
// 			},
// 			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
// 				ResponseTimeoutInSeconds: to.Ptr[int32](12),
// 			},
// 		},
// 	},
// }

Output:
Example (CreateOrUpdateDaprComponentResiliencyPolicyWithOutboundPolicyOnly)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json 

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.NewDaprComponentResiliencyPoliciesClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "mydaprcomponent", "myresiliencypolicy", armappcontainers.DaprComponentResiliencyPolicy{
	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
				ConsecutiveErrors: to.Ptr[int32](3),
				IntervalInSeconds: to.Ptr[int32](60),
				TimeoutInSeconds:  to.Ptr[int32](20),
			},
			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
				MaxRetries: to.Ptr[int32](5),
				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
					InitialDelayInMilliseconds: to.Ptr[int32](100),
					MaxIntervalInMilliseconds:  to.Ptr[int32](30000),
				},
			},
			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
				ResponseTimeoutInSeconds: to.Ptr[int32](12),
			},
		},
	},
}, 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.DaprComponentResiliencyPolicy = armappcontainers.DaprComponentResiliencyPolicy{
// 	Name: to.Ptr("myresiliencypolicy"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy"),
// 	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
// 		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
// 				ConsecutiveErrors: to.Ptr[int32](3),
// 				IntervalInSeconds: to.Ptr[int32](60),
// 				TimeoutInSeconds: to.Ptr[int32](20),
// 			},
// 			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
// 				MaxRetries: to.Ptr[int32](5),
// 				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
// 					InitialDelayInMilliseconds: to.Ptr[int32](100),
// 					MaxIntervalInMilliseconds: to.Ptr[int32](30000),
// 				},
// 			},
// 			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
// 				ResponseTimeoutInSeconds: to.Ptr[int32](12),
// 			},
// 		},
// 	},
// }

Output:
Example (CreateOrUpdateDaprComponentResiliencyPolicyWithSparseOptions)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json 

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.NewDaprComponentResiliencyPoliciesClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "mydaprcomponent", "myresiliencypolicy", armappcontainers.DaprComponentResiliencyPolicy{
	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
		InboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
				ConsecutiveErrors: to.Ptr[int32](3),
				TimeoutInSeconds:  to.Ptr[int32](20),
			},
			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
				MaxRetries: to.Ptr[int32](5),
				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
					InitialDelayInMilliseconds: to.Ptr[int32](2000),
					MaxIntervalInMilliseconds:  to.Ptr[int32](5500),
				},
			},
		},
		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
				ResponseTimeoutInSeconds: to.Ptr[int32](12),
			},
		},
	},
}, 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.DaprComponentResiliencyPolicy = armappcontainers.DaprComponentResiliencyPolicy{
// 	Name: to.Ptr("myresiliencypolicy"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy"),
// 	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
// 		InboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
// 				ConsecutiveErrors: to.Ptr[int32](3),
// 				TimeoutInSeconds: to.Ptr[int32](20),
// 			},
// 			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
// 				MaxRetries: to.Ptr[int32](5),
// 				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
// 					InitialDelayInMilliseconds: to.Ptr[int32](2000),
// 					MaxIntervalInMilliseconds: to.Ptr[int32](5500),
// 				},
// 			},
// 		},
// 		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
// 				ResponseTimeoutInSeconds: to.Ptr[int32](12),
// 			},
// 		},
// 	},
// }

Output:

func (*DaprComponentResiliencyPoliciesClient) Delete 

func (client *DaprComponentResiliencyPoliciesClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, componentName string, name string, options *DaprComponentResiliencyPoliciesClientDeleteOptions) (DaprComponentResiliencyPoliciesClientDeleteResponse, error)

Delete - Delete a resiliency policy for a Dapr component. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json 

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.NewDaprComponentResiliencyPoliciesClient().Delete(ctx, "examplerg", "myenvironment", "mydaprcomponent", "myresiliencypolicy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*DaprComponentResiliencyPoliciesClient) Get 

func (client *DaprComponentResiliencyPoliciesClient) Get(ctx context.Context, resourceGroupName string, environmentName string, componentName string, name string, options *DaprComponentResiliencyPoliciesClientGetOptions) (DaprComponentResiliencyPoliciesClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponentResiliencyPolicies_Get.json 

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.NewDaprComponentResiliencyPoliciesClient().Get(ctx, "examplerg", "myenvironment", "mydaprcomponent", "myresiliencypolicy", 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.DaprComponentResiliencyPolicy = armappcontainers.DaprComponentResiliencyPolicy{
// 	Name: to.Ptr("myresiliencypolicy"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy"),
// 	Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
// 		InboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
// 				ConsecutiveErrors: to.Ptr[int32](5),
// 				TimeoutInSeconds: to.Ptr[int32](10),
// 			},
// 			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
// 				MaxRetries: to.Ptr[int32](15),
// 				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
// 					InitialDelayInMilliseconds: to.Ptr[int32](2000),
// 					MaxIntervalInMilliseconds: to.Ptr[int32](5500),
// 				},
// 			},
// 			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
// 				ResponseTimeoutInSeconds: to.Ptr[int32](30),
// 			},
// 		},
// 		OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
// 			CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
// 				ConsecutiveErrors: to.Ptr[int32](3),
// 				IntervalInSeconds: to.Ptr[int32](60),
// 				TimeoutInSeconds: to.Ptr[int32](20),
// 			},
// 			HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
// 				MaxRetries: to.Ptr[int32](5),
// 				RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
// 					InitialDelayInMilliseconds: to.Ptr[int32](100),
// 					MaxIntervalInMilliseconds: to.Ptr[int32](30000),
// 				},
// 			},
// 			TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
// 				ResponseTimeoutInSeconds: to.Ptr[int32](12),
// 			},
// 		},
// 	},
// }

Output:

func (*DaprComponentResiliencyPoliciesClient) NewListPager 

func (client *DaprComponentResiliencyPoliciesClient) NewListPager(resourceGroupName string, environmentName string, componentName string, options *DaprComponentResiliencyPoliciesClientListOptions) *runtime.Pager[DaprComponentResiliencyPoliciesClientListResponse]

NewListPager - Get the resiliency policies for a Dapr component.

Generated from API version 2023-11-02-preview

  • 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 - DaprComponentResiliencyPoliciesClientListOptions contains the optional parameters for the DaprComponentResiliencyPoliciesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponentResiliencyPolicies_List.json 

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.NewDaprComponentResiliencyPoliciesClient().NewListPager("examplerg", "myenvironment", "mydaprcomponent", 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.DaprComponentResiliencyPoliciesCollection = armappcontainers.DaprComponentResiliencyPoliciesCollection{
	// 	Value: []*armappcontainers.DaprComponentResiliencyPolicy{
	// 		{
	// 			Name: to.Ptr("something"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy"),
	// 			Properties: &armappcontainers.DaprComponentResiliencyPolicyProperties{
	// 				InboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
	// 					CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
	// 						ConsecutiveErrors: to.Ptr[int32](5),
	// 						TimeoutInSeconds: to.Ptr[int32](10),
	// 					},
	// 					HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
	// 						MaxRetries: to.Ptr[int32](15),
	// 						RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
	// 							InitialDelayInMilliseconds: to.Ptr[int32](2000),
	// 							MaxIntervalInMilliseconds: to.Ptr[int32](5500),
	// 						},
	// 					},
	// 					TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
	// 						ResponseTimeoutInSeconds: to.Ptr[int32](30),
	// 					},
	// 				},
	// 				OutboundPolicy: &armappcontainers.DaprComponentResiliencyPolicyConfiguration{
	// 					CircuitBreakerPolicy: &armappcontainers.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration{
	// 						ConsecutiveErrors: to.Ptr[int32](3),
	// 						IntervalInSeconds: to.Ptr[int32](60),
	// 						TimeoutInSeconds: to.Ptr[int32](20),
	// 					},
	// 					HTTPRetryPolicy: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration{
	// 						MaxRetries: to.Ptr[int32](5),
	// 						RetryBackOff: &armappcontainers.DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration{
	// 							InitialDelayInMilliseconds: to.Ptr[int32](100),
	// 							MaxIntervalInMilliseconds: to.Ptr[int32](30000),
	// 						},
	// 					},
	// 					TimeoutPolicy: &armappcontainers.DaprComponentResiliencyPolicyTimeoutPolicyConfiguration{
	// 						ResponseTimeoutInSeconds: to.Ptr[int32](12),
	// 					},
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type DaprComponentResiliencyPoliciesClientCreateOrUpdateOptions 

type DaprComponentResiliencyPoliciesClientCreateOrUpdateOptions struct {
}

DaprComponentResiliencyPoliciesClientCreateOrUpdateOptions contains the optional parameters for the DaprComponentResiliencyPoliciesClient.CreateOrUpdate method.

type DaprComponentResiliencyPoliciesClientCreateOrUpdateResponse 

type DaprComponentResiliencyPoliciesClientCreateOrUpdateResponse struct {
	// Dapr Component Resiliency Policy.
	DaprComponentResiliencyPolicy
}

DaprComponentResiliencyPoliciesClientCreateOrUpdateResponse contains the response from method DaprComponentResiliencyPoliciesClient.CreateOrUpdate.

type DaprComponentResiliencyPoliciesClientDeleteOptions 

type DaprComponentResiliencyPoliciesClientDeleteOptions struct {
}

DaprComponentResiliencyPoliciesClientDeleteOptions contains the optional parameters for the DaprComponentResiliencyPoliciesClient.Delete method.

type DaprComponentResiliencyPoliciesClientDeleteResponse 

type DaprComponentResiliencyPoliciesClientDeleteResponse struct {
}

DaprComponentResiliencyPoliciesClientDeleteResponse contains the response from method DaprComponentResiliencyPoliciesClient.Delete.

type DaprComponentResiliencyPoliciesClientGetOptions 

type DaprComponentResiliencyPoliciesClientGetOptions struct {
}

DaprComponentResiliencyPoliciesClientGetOptions contains the optional parameters for the DaprComponentResiliencyPoliciesClient.Get method.

type DaprComponentResiliencyPoliciesClientGetResponse 

type DaprComponentResiliencyPoliciesClientGetResponse struct {
	// Dapr Component Resiliency Policy.
	DaprComponentResiliencyPolicy
}

DaprComponentResiliencyPoliciesClientGetResponse contains the response from method DaprComponentResiliencyPoliciesClient.Get.

type DaprComponentResiliencyPoliciesClientListOptions 

type DaprComponentResiliencyPoliciesClientListOptions struct {
}

DaprComponentResiliencyPoliciesClientListOptions contains the optional parameters for the DaprComponentResiliencyPoliciesClient.NewListPager method.

type DaprComponentResiliencyPoliciesClientListResponse 

type DaprComponentResiliencyPoliciesClientListResponse struct {
	// Dapr Component Resiliency Policies ARM resource.
	DaprComponentResiliencyPoliciesCollection
}

DaprComponentResiliencyPoliciesClientListResponse contains the response from method DaprComponentResiliencyPoliciesClient.NewListPager.

type DaprComponentResiliencyPoliciesCollection 

type DaprComponentResiliencyPoliciesCollection struct {
	// REQUIRED; Collection of resources.
	Value []*DaprComponentResiliencyPolicy

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

DaprComponentResiliencyPoliciesCollection - Dapr Component Resiliency Policies ARM resource.

func (DaprComponentResiliencyPoliciesCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPoliciesCollection.

func (*DaprComponentResiliencyPoliciesCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPoliciesCollection.

type DaprComponentResiliencyPolicy 

type DaprComponentResiliencyPolicy struct {
	// Dapr Component Resiliency Policy resource specific properties
	Properties *DaprComponentResiliencyPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DaprComponentResiliencyPolicy - Dapr Component Resiliency Policy.

func (DaprComponentResiliencyPolicy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicy.

func (*DaprComponentResiliencyPolicy) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicy.

type DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration 

type DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration struct {
	// The number of consecutive errors before the circuit is opened.
	ConsecutiveErrors *int32

	// The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified,
	// the timeoutInSeconds value will be used.
	IntervalInSeconds *int32

	// The interval in seconds until a retry attempt is made after the circuit is opened.
	TimeoutInSeconds *int32
}

DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration - Dapr Component Resiliency Policy Circuit Breaker Policy Configuration.

func (DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration.

func (*DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration.

type DaprComponentResiliencyPolicyConfiguration 

type DaprComponentResiliencyPolicyConfiguration struct {
	// The optional circuit breaker policy configuration
	CircuitBreakerPolicy *DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration

	// The optional HTTP retry policy configuration
	HTTPRetryPolicy *DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration

	// The optional timeout policy configuration
	TimeoutPolicy *DaprComponentResiliencyPolicyTimeoutPolicyConfiguration
}

DaprComponentResiliencyPolicyConfiguration - Dapr Component Resiliency Policy Configuration.

func (DaprComponentResiliencyPolicyConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicyConfiguration.

func (*DaprComponentResiliencyPolicyConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicyConfiguration.

type DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration 

type DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration struct {
	// The optional initial delay in milliseconds before an operation is retried
	InitialDelayInMilliseconds *int32

	// The optional maximum time interval in milliseconds between retry attempts
	MaxIntervalInMilliseconds *int32
}

DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration - Dapr Component Resiliency Policy HTTP Retry Backoff Configuration.

func (DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration.

func (*DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration.

type DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration 

type DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration struct {
	// The optional maximum number of retries
	MaxRetries *int32

	// The optional retry backoff configuration
	RetryBackOff *DaprComponentResiliencyPolicyHTTPRetryBackOffConfiguration
}

DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration - Dapr Component Resiliency Policy HTTP Retry Policy Configuration.

func (DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration.

func (*DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicyHTTPRetryPolicyConfiguration.

type DaprComponentResiliencyPolicyProperties 

type DaprComponentResiliencyPolicyProperties struct {
	// The optional inbound component resiliency policy configuration
	InboundPolicy *DaprComponentResiliencyPolicyConfiguration

	// The optional outbound component resiliency policy configuration
	OutboundPolicy *DaprComponentResiliencyPolicyConfiguration
}

DaprComponentResiliencyPolicyProperties - Dapr Component Resiliency Policy resource specific properties

func (DaprComponentResiliencyPolicyProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicyProperties.

func (*DaprComponentResiliencyPolicyProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicyProperties.

type DaprComponentResiliencyPolicyTimeoutPolicyConfiguration 

type DaprComponentResiliencyPolicyTimeoutPolicyConfiguration struct {
	// The optional response timeout in seconds
	ResponseTimeoutInSeconds *int32
}

DaprComponentResiliencyPolicyTimeoutPolicyConfiguration - Dapr Component Resiliency Policy Timeout Policy Configuration.

func (DaprComponentResiliencyPolicyTimeoutPolicyConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentResiliencyPolicyTimeoutPolicyConfiguration.

func (*DaprComponentResiliencyPolicyTimeoutPolicyConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentResiliencyPolicyTimeoutPolicyConfiguration.

type DaprComponentServiceBinding 

type DaprComponentServiceBinding struct {
	// Service bind metadata
	Metadata *DaprServiceBindMetadata

	// Name of the service bind
	Name *string

	// Resource id of the target service
	ServiceID *string
}

DaprComponentServiceBinding - Configuration to bind a Dapr Component to a dev ContainerApp Service

func (DaprComponentServiceBinding) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentServiceBinding.

func (*DaprComponentServiceBinding) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentServiceBinding.

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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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 (CreateOrUpdateDaprComponentWithSecretStoreComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json 

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")},
		SecretStoreComponent: to.Ptr("my-secret-store"),
		ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
			{
				Name: to.Ptr("statestore"),
				Metadata: &armappcontainers.DaprServiceBindMetadata{
					Name:  to.Ptr("daprcomponentBind"),
					Value: to.Ptr("redis-bind"),
				},
				ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
			}},
		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")},
// 			SecretStoreComponent: to.Ptr("my-secret-store"),
// 			ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
// 				{
// 					Name: to.Ptr("statestore"),
// 					Metadata: &armappcontainers.DaprServiceBindMetadata{
// 						Name: to.Ptr("daprcomponentBind"),
// 						Value: to.Ptr("redis-bind"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
// 			}},
// 			Version: to.Ptr("v1"),
// 		},
// 	}

Output:
Example (CreateOrUpdateDaprComponentWithSecrets)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json 

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"),
			}},
		ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
			{
				Name: to.Ptr("statestore"),
				Metadata: &armappcontainers.DaprServiceBindMetadata{
					Name:  to.Ptr("daprcomponentBind"),
					Value: to.Ptr("redis-bind"),
				},
				ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
			}},
		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"),
// 			}},
// 			ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
// 				{
// 					Name: to.Ptr("statestore"),
// 					Metadata: &armappcontainers.DaprServiceBindMetadata{
// 						Name: to.Ptr("daprcomponentBind"),
// 						Value: to.Ptr("redis-bind"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
// 			}},
// 			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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_Delete.json 

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 2023-11-02-preview

  • 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 (GetDaprComponentWithSecretStoreComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json 

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")},
// 			SecretStoreComponent: to.Ptr("my-secret-store"),
// 			ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
// 				{
// 					Name: to.Ptr("statestore"),
// 					Metadata: &armappcontainers.DaprServiceBindMetadata{
// 						Name: to.Ptr("daprcomponentBind"),
// 						Value: to.Ptr("redis-bind"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
// 			}},
// 			Version: to.Ptr("v1"),
// 		},
// 	}

Output:
Example (GetDaprComponentWithSecrets)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_Get_Secrets.json 

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"),
// 			}},
// 			ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
// 				{
// 					Name: to.Ptr("statestore"),
// 					Metadata: &armappcontainers.DaprServiceBindMetadata{
// 						Name: to.Ptr("daprcomponentBind"),
// 						Value: to.Ptr("redis-bind"),
// 					},
// 					ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
// 			}},
// 			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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_ListSecrets.json 

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.DaprSecret{
// 		{
// 			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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprComponents_List.json 

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"),
	// 					}},
	// 					ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
	// 						{
	// 							Name: to.Ptr("statestore"),
	// 							Metadata: &armappcontainers.DaprServiceBindMetadata{
	// 								Name: to.Ptr("daprcomponentBind"),
	// 								Value: to.Ptr("redis-bind"),
	// 							},
	// 							ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
	// 					}},
	// 					Version: to.Ptr("v1"),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("vaultdog"),
	// 				Type: to.Ptr("Microsoft.App/managedEnvironments/daprcomponents"),
	// 				ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/vaultdog"),
	// 				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")},
	// 						SecretStoreComponent: to.Ptr("my-secret-store"),
	// 						ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
	// 							{
	// 								Name: to.Ptr("statestore"),
	// 								Metadata: &armappcontainers.DaprServiceBindMetadata{
	// 									Name: to.Ptr("daprcomponentBind"),
	// 									Value: to.Ptr("redis-bind"),
	// 								},
	// 								ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
	// 						}},
	// 						Version: to.Ptr("v1"),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("vaultdog"),
	// 					Type: to.Ptr("Microsoft.App/managedEnvironments/daprcomponents"),
	// 					ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/vaultdog"),
	// 					Properties: &armappcontainers.DaprComponentProperties{
	// 						ComponentType: to.Ptr("state.azure.cosmosdb"),
	// 						IgnoreErrors: to.Ptr(false),
	// 						InitTimeout: to.Ptr("50s"),
	// 						Metadata: []*armappcontainers.DaprMetadata{
	// 							{
	// 								Name: to.Ptr("url"),
	// 								SecretRef: to.Ptr("cosmosdb/url"),
	// 							},
	// 							{
	// 								Name: to.Ptr("database"),
	// 								Value: to.Ptr("itemsDB"),
	// 							},
	// 							{
	// 								Name: to.Ptr("collection"),
	// 								Value: to.Ptr("items"),
	// 							},
	// 							{
	// 								Name: to.Ptr("masterkey"),
	// 								SecretRef: to.Ptr("cosmosdb/masterkey"),
	// 						}},
	// 						Scopes: []*string{
	// 							to.Ptr("container-app-1"),
	// 							to.Ptr("container-app-2")},
	// 							SecretStoreComponent: to.Ptr("my-secret-store"),
	// 							ServiceComponentBind: []*armappcontainers.DaprComponentServiceBinding{
	// 								{
	// 									Name: to.Ptr("statestore"),
	// 									Metadata: &armappcontainers.DaprServiceBindMetadata{
	// 										Name: to.Ptr("daprcomponentBind"),
	// 										Value: to.Ptr("redis-bind"),
	// 									},
	// 									ServiceID: to.Ptr("/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis"),
	// 							}},
	// 							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 {
	// Dapr Component.
	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 {
	// Dapr Component.
	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 {
	// Dapr Components ARM resource.
	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 {
	// Dapr component Secrets Collection for ListSecrets Action.
	DaprSecretsCollection
}

DaprComponentsClientListSecretsResponse contains the response from method DaprComponentsClient.ListSecrets.

type DaprComponentsCollection 

type DaprComponentsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*DaprComponent

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

DaprComponentsCollection - Dapr Components ARM resource.

func (DaprComponentsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprComponentsCollection.

func (*DaprComponentsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprComponentsCollection.

type DaprConfiguration 

type DaprConfiguration struct {
	// READ-ONLY; The version of Dapr
	Version *string
}

DaprConfiguration - Configuration properties Dapr component

func (DaprConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprConfiguration.

func (*DaprConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprConfiguration.

type DaprMetadata 

type DaprMetadata struct {
	// Metadata property name.
	Name *string

	// Name of the Dapr Component secret from which to pull the metadata property value.
	SecretRef *string

	// Metadata property value.
	Value *string
}

DaprMetadata - Dapr component metadata.

func (DaprMetadata) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprMetadata.

func (*DaprMetadata) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprMetadata.

type DaprSecret 

type DaprSecret struct {
	// READ-ONLY; Secret Name.
	Name *string

	// READ-ONLY; Secret Value.
	Value *string
}

DaprSecret - Dapr component Secret for ListSecrets Action

func (DaprSecret) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSecret.

func (*DaprSecret) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSecret.

type DaprSecretsCollection 

type DaprSecretsCollection struct {
	// REQUIRED; Collection of secrets used by a Dapr component
	Value []*DaprSecret
}

DaprSecretsCollection - Dapr component Secrets Collection for ListSecrets Action.

func (DaprSecretsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSecretsCollection.

func (*DaprSecretsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSecretsCollection.

type DaprServiceBindMetadata 

type DaprServiceBindMetadata struct {
	// Service bind metadata property name.
	Name *string

	// Service bind metadata property value.
	Value *string
}

DaprServiceBindMetadata - Dapr component metadata.

func (DaprServiceBindMetadata) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprServiceBindMetadata.

func (*DaprServiceBindMetadata) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprServiceBindMetadata.

type DaprSubscription 

type DaprSubscription struct {
	// Dapr PubSub Event Subscription resource specific properties
	Properties *DaprSubscriptionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DaprSubscription - Dapr PubSub Event Subscription.

func (DaprSubscription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSubscription.

func (*DaprSubscription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSubscription.

type DaprSubscriptionBulkSubscribeOptions 

type DaprSubscriptionBulkSubscribeOptions struct {
	// Enable bulk subscription
	Enabled *bool

	// Maximum duration in milliseconds to wait before a bulk message is sent to the app.
	MaxAwaitDurationMs *int32

	// Maximum number of messages to deliver in a bulk message.
	MaxMessagesCount *int32
}

DaprSubscriptionBulkSubscribeOptions - Dapr PubSub Bulk Subscription Options.

func (DaprSubscriptionBulkSubscribeOptions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSubscriptionBulkSubscribeOptions.

func (*DaprSubscriptionBulkSubscribeOptions) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSubscriptionBulkSubscribeOptions.

type DaprSubscriptionProperties 

type DaprSubscriptionProperties struct {
	// Bulk subscription options
	BulkSubscribe *DaprSubscriptionBulkSubscribeOptions

	// Deadletter topic name
	DeadLetterTopic *string

	// Subscription metadata
	Metadata map[string]*string

	// Dapr PubSub component name
	PubsubName *string

	// Subscription routes
	Routes *DaprSubscriptionRoutes

	// Application scopes to restrict the subscription to specific apps.
	Scopes []*string

	// Topic name
	Topic *string
}

DaprSubscriptionProperties - Dapr PubSub Event Subscription resource specific properties

func (DaprSubscriptionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSubscriptionProperties.

func (*DaprSubscriptionProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSubscriptionProperties.

type DaprSubscriptionRouteRule 

type DaprSubscriptionRouteRule struct {
	// The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default.
	// The rules are tested in the order specified, so they should be define from
	// most-to-least specific. The default route should appear last in the list.
	Match *string

	// The path for events that match this rule
	Path *string
}

DaprSubscriptionRouteRule - Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path.

func (DaprSubscriptionRouteRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSubscriptionRouteRule.

func (*DaprSubscriptionRouteRule) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSubscriptionRouteRule.

type DaprSubscriptionRoutes 

type DaprSubscriptionRoutes struct {
	// The default path to deliver events that do not match any of the rules.
	Default *string

	// The list of Dapr PubSub Event Subscription Route Rules.
	Rules []*DaprSubscriptionRouteRule
}

DaprSubscriptionRoutes - Dapr PubSub Event Subscription Routes configuration.

func (DaprSubscriptionRoutes) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSubscriptionRoutes.

func (*DaprSubscriptionRoutes) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSubscriptionRoutes.

type DaprSubscriptionsClient 

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

DaprSubscriptionsClient contains the methods for the DaprSubscriptions group. Don't use this type directly, use NewDaprSubscriptionsClient() instead.

func NewDaprSubscriptionsClient 

func NewDaprSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DaprSubscriptionsClient, error)

NewDaprSubscriptionsClient creates a new instance of DaprSubscriptionsClient with the specified values.

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

func (*DaprSubscriptionsClient) CreateOrUpdate 

func (client *DaprSubscriptionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, name string, daprSubscriptionEnvelope DaprSubscription, options *DaprSubscriptionsClientCreateOrUpdateOptions) (DaprSubscriptionsClientCreateOrUpdateResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Dapr subscription.
  • daprSubscriptionEnvelope - Configuration details of the Dapr subscription.
  • options - DaprSubscriptionsClientCreateOrUpdateOptions contains the optional parameters for the DaprSubscriptionsClient.CreateOrUpdate method.
Example (CreateOrUpdateDaprSubscriptionWithBulkSubscribeConfigurationAndScopes)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json 

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.NewDaprSubscriptionsClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "mysubscription", armappcontainers.DaprSubscription{
	Properties: &armappcontainers.DaprSubscriptionProperties{
		BulkSubscribe: &armappcontainers.DaprSubscriptionBulkSubscribeOptions{
			Enabled:            to.Ptr(true),
			MaxAwaitDurationMs: to.Ptr[int32](500),
			MaxMessagesCount:   to.Ptr[int32](123),
		},
		PubsubName: to.Ptr("mypubsubcomponent"),
		Routes: &armappcontainers.DaprSubscriptionRoutes{
			Default: to.Ptr("/products"),
		},
		Scopes: []*string{
			to.Ptr("warehouseapp"),
			to.Ptr("customersupportapp")},
		Topic: to.Ptr("inventory"),
	},
}, 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.DaprSubscription = armappcontainers.DaprSubscription{
// 	Name: to.Ptr("mysubscription"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription"),
// 	Properties: &armappcontainers.DaprSubscriptionProperties{
// 		BulkSubscribe: &armappcontainers.DaprSubscriptionBulkSubscribeOptions{
// 			Enabled: to.Ptr(true),
// 			MaxAwaitDurationMs: to.Ptr[int32](500),
// 			MaxMessagesCount: to.Ptr[int32](123),
// 		},
// 		PubsubName: to.Ptr("mypubsubcomponent"),
// 		Routes: &armappcontainers.DaprSubscriptionRoutes{
// 			Default: to.Ptr("/products"),
// 			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
// 			},
// 		},
// 		Scopes: []*string{
// 			to.Ptr("warehouseapp"),
// 			to.Ptr("customersupportapp")},
// 			Topic: to.Ptr("inventory"),
// 		},
// 	}

Output:
Example (CreateOrUpdateDaprSubscriptionWithDefaultRouteOnly)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json 

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.NewDaprSubscriptionsClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "mysubscription", armappcontainers.DaprSubscription{
	Properties: &armappcontainers.DaprSubscriptionProperties{
		PubsubName: to.Ptr("mypubsubcomponent"),
		Routes: &armappcontainers.DaprSubscriptionRoutes{
			Default: to.Ptr("/products"),
		},
		Topic: to.Ptr("inventory"),
	},
}, 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.DaprSubscription = armappcontainers.DaprSubscription{
// 	Name: to.Ptr("mysubscription"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription"),
// 	Properties: &armappcontainers.DaprSubscriptionProperties{
// 		PubsubName: to.Ptr("mypubsubcomponent"),
// 		Routes: &armappcontainers.DaprSubscriptionRoutes{
// 			Default: to.Ptr("/products"),
// 			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
// 			},
// 		},
// 		Topic: to.Ptr("inventory"),
// 	},
// }

Output:
Example (CreateOrUpdateDaprSubscriptionWithRouteRulesAndMetadata)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json 

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.NewDaprSubscriptionsClient().CreateOrUpdate(ctx, "examplerg", "myenvironment", "mysubscription", armappcontainers.DaprSubscription{
	Properties: &armappcontainers.DaprSubscriptionProperties{
		Metadata: map[string]*string{
			"foo":   to.Ptr("bar"),
			"hello": to.Ptr("world"),
		},
		PubsubName: to.Ptr("mypubsubcomponent"),
		Routes: &armappcontainers.DaprSubscriptionRoutes{
			Default: to.Ptr("/products"),
			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
				{
					Path:  to.Ptr("/widgets"),
					Match: to.Ptr("event.type == 'widget'"),
				},
				{
					Path:  to.Ptr("/gadgets"),
					Match: to.Ptr("event.type == 'gadget'"),
				}},
		},
		Topic: to.Ptr("inventory"),
	},
}, 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.DaprSubscription = armappcontainers.DaprSubscription{
// 	Name: to.Ptr("mysubscription"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription"),
// 	Properties: &armappcontainers.DaprSubscriptionProperties{
// 		Metadata: map[string]*string{
// 			"foo": to.Ptr("bar"),
// 			"hello": to.Ptr("world"),
// 		},
// 		PubsubName: to.Ptr("mypubsubcomponent"),
// 		Routes: &armappcontainers.DaprSubscriptionRoutes{
// 			Default: to.Ptr("/products"),
// 			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
// 				{
// 					Path: to.Ptr("/widgets"),
// 					Match: to.Ptr("event.type == 'widget'"),
// 				},
// 				{
// 					Path: to.Ptr("/gadgets"),
// 					Match: to.Ptr("event.type == 'gadget'"),
// 			}},
// 		},
// 		Topic: to.Ptr("inventory"),
// 	},
// }

Output:

func (*DaprSubscriptionsClient) Delete 

func (client *DaprSubscriptionsClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, name string, options *DaprSubscriptionsClientDeleteOptions) (DaprSubscriptionsClientDeleteResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Dapr subscription.
  • options - DaprSubscriptionsClientDeleteOptions contains the optional parameters for the DaprSubscriptionsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_Delete.json 

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.NewDaprSubscriptionsClient().Delete(ctx, "examplerg", "myenvironment", "mysubscription", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*DaprSubscriptionsClient) Get 

func (client *DaprSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, name string, options *DaprSubscriptionsClientGetOptions) (DaprSubscriptionsClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Dapr subscription.
  • options - DaprSubscriptionsClientGetOptions contains the optional parameters for the DaprSubscriptionsClient.Get method.
Example (GetDaprSubscriptionWithBulkSubscribeConfigurationAndScopes)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json 

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.NewDaprSubscriptionsClient().Get(ctx, "examplerg", "myenvironment", "mypubsubcomponent", 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.DaprSubscription = armappcontainers.DaprSubscription{
// 	Name: to.Ptr("mysubscription"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription"),
// 	Properties: &armappcontainers.DaprSubscriptionProperties{
// 		PubsubName: to.Ptr("mypubsubcomponent"),
// 		Routes: &armappcontainers.DaprSubscriptionRoutes{
// 			Default: to.Ptr("/products"),
// 			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
// 			},
// 		},
// 		Topic: to.Ptr("inventory"),
// 	},
// }

Output:
Example (GetDaprSubscriptionWithDefaultRouteOnly)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json 

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.NewDaprSubscriptionsClient().Get(ctx, "examplerg", "myenvironment", "mypubsubcomponent", 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.DaprSubscription = armappcontainers.DaprSubscription{
// 	Name: to.Ptr("mysubscription"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription"),
// 	Properties: &armappcontainers.DaprSubscriptionProperties{
// 		BulkSubscribe: &armappcontainers.DaprSubscriptionBulkSubscribeOptions{
// 			Enabled: to.Ptr(true),
// 			MaxAwaitDurationMs: to.Ptr[int32](500),
// 			MaxMessagesCount: to.Ptr[int32](123),
// 		},
// 		PubsubName: to.Ptr("mypubsubcomponent"),
// 		Routes: &armappcontainers.DaprSubscriptionRoutes{
// 			Default: to.Ptr("/products"),
// 			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
// 			},
// 		},
// 		Scopes: []*string{
// 			to.Ptr("warehouseapp"),
// 			to.Ptr("customersupportapp")},
// 			Topic: to.Ptr("inventory"),
// 		},
// 	}

Output:
Example (GetDaprSubscriptionWithRouteRulesAndMetadata)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json 

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.NewDaprSubscriptionsClient().Get(ctx, "examplerg", "myenvironment", "mypubsubcomponent", 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.DaprSubscription = armappcontainers.DaprSubscription{
// 	Name: to.Ptr("mysubscription"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription"),
// 	Properties: &armappcontainers.DaprSubscriptionProperties{
// 		Metadata: map[string]*string{
// 			"foo": to.Ptr("bar"),
// 			"hello": to.Ptr("world"),
// 		},
// 		PubsubName: to.Ptr("mypubsubcomponent"),
// 		Routes: &armappcontainers.DaprSubscriptionRoutes{
// 			Default: to.Ptr("/products"),
// 			Rules: []*armappcontainers.DaprSubscriptionRouteRule{
// 				{
// 					Path: to.Ptr("/widgets"),
// 					Match: to.Ptr("event.type == 'widget'"),
// 				},
// 				{
// 					Path: to.Ptr("/gadgets"),
// 					Match: to.Ptr("event.type == 'gadget'"),
// 			}},
// 		},
// 		Topic: to.Ptr("inventory"),
// 	},
// }

Output:

func (*DaprSubscriptionsClient) NewListPager 

func (client *DaprSubscriptionsClient) NewListPager(resourceGroupName string, environmentName string, options *DaprSubscriptionsClientListOptions) *runtime.Pager[DaprSubscriptionsClientListResponse]

NewListPager - Get the Dapr subscriptions for a managed environment.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DaprSubscriptions_List.json 

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.NewDaprSubscriptionsClient().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.DaprSubscriptionsCollection = armappcontainers.DaprSubscriptionsCollection{
	// 	Value: []*armappcontainers.DaprSubscription{
	// 		{
	// 			Name: to.Ptr("mybulksubscription"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mybulksubscription"),
	// 			Properties: &armappcontainers.DaprSubscriptionProperties{
	// 				BulkSubscribe: &armappcontainers.DaprSubscriptionBulkSubscribeOptions{
	// 					Enabled: to.Ptr(true),
	// 					MaxAwaitDurationMs: to.Ptr[int32](500),
	// 					MaxMessagesCount: to.Ptr[int32](123),
	// 				},
	// 				PubsubName: to.Ptr("mypubsubcomponent"),
	// 				Routes: &armappcontainers.DaprSubscriptionRoutes{
	// 					Default: to.Ptr("/products"),
	// 					Rules: []*armappcontainers.DaprSubscriptionRouteRule{
	// 					},
	// 				},
	// 				Topic: to.Ptr("inventory"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("mydefaultsubscription"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mydefaultsubscription"),
	// 			Properties: &armappcontainers.DaprSubscriptionProperties{
	// 				PubsubName: to.Ptr("mypubsubcomponent"),
	// 				Routes: &armappcontainers.DaprSubscriptionRoutes{
	// 					Default: to.Ptr("/products"),
	// 					Rules: []*armappcontainers.DaprSubscriptionRouteRule{
	// 					},
	// 				},
	// 				Topic: to.Ptr("inventory"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("myroutingsubscription"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/daprSubscriptions"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/myroutingsubscription"),
	// 			Properties: &armappcontainers.DaprSubscriptionProperties{
	// 				Metadata: map[string]*string{
	// 					"foo": to.Ptr("bar"),
	// 					"hello": to.Ptr("world"),
	// 				},
	// 				PubsubName: to.Ptr("mypubsubcomponent"),
	// 				Routes: &armappcontainers.DaprSubscriptionRoutes{
	// 					Default: to.Ptr("/products"),
	// 					Rules: []*armappcontainers.DaprSubscriptionRouteRule{
	// 						{
	// 							Path: to.Ptr("/widgets"),
	// 							Match: to.Ptr("event.type == 'widget'"),
	// 						},
	// 						{
	// 							Path: to.Ptr("/gadgets"),
	// 							Match: to.Ptr("event.type == 'gadget'"),
	// 					}},
	// 				},
	// 				Topic: to.Ptr("inventory"),
	// 			},
	// 	}},
	// }
}

Output:

type DaprSubscriptionsClientCreateOrUpdateOptions 

type DaprSubscriptionsClientCreateOrUpdateOptions struct {
}

DaprSubscriptionsClientCreateOrUpdateOptions contains the optional parameters for the DaprSubscriptionsClient.CreateOrUpdate method.

type DaprSubscriptionsClientCreateOrUpdateResponse 

type DaprSubscriptionsClientCreateOrUpdateResponse struct {
	// Dapr PubSub Event Subscription.
	DaprSubscription
}

DaprSubscriptionsClientCreateOrUpdateResponse contains the response from method DaprSubscriptionsClient.CreateOrUpdate.

type DaprSubscriptionsClientDeleteOptions 

type DaprSubscriptionsClientDeleteOptions struct {
}

DaprSubscriptionsClientDeleteOptions contains the optional parameters for the DaprSubscriptionsClient.Delete method.

type DaprSubscriptionsClientDeleteResponse 

type DaprSubscriptionsClientDeleteResponse struct {
}

DaprSubscriptionsClientDeleteResponse contains the response from method DaprSubscriptionsClient.Delete.

type DaprSubscriptionsClientGetOptions 

type DaprSubscriptionsClientGetOptions struct {
}

DaprSubscriptionsClientGetOptions contains the optional parameters for the DaprSubscriptionsClient.Get method.

type DaprSubscriptionsClientGetResponse 

type DaprSubscriptionsClientGetResponse struct {
	// Dapr PubSub Event Subscription.
	DaprSubscription
}

DaprSubscriptionsClientGetResponse contains the response from method DaprSubscriptionsClient.Get.

type DaprSubscriptionsClientListOptions 

type DaprSubscriptionsClientListOptions struct {
}

DaprSubscriptionsClientListOptions contains the optional parameters for the DaprSubscriptionsClient.NewListPager method.

type DaprSubscriptionsClientListResponse 

type DaprSubscriptionsClientListResponse struct {
	// Dapr Subscriptions ARM resource.
	DaprSubscriptionsCollection
}

DaprSubscriptionsClientListResponse contains the response from method DaprSubscriptionsClient.NewListPager.

type DaprSubscriptionsCollection 

type DaprSubscriptionsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*DaprSubscription

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

DaprSubscriptionsCollection - Dapr Subscriptions ARM resource.

func (DaprSubscriptionsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DaprSubscriptionsCollection.

func (*DaprSubscriptionsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSubscriptionsCollection.

type DataDogConfiguration 

type DataDogConfiguration struct {
	// The data dog api key
	Key *string

	// The data dog site
	Site *string
}

DataDogConfiguration - Configuration of datadog

func (DataDogConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DataDogConfiguration.

func (*DataDogConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataDogConfiguration.

type DefaultAuthorizationPolicy 

type DefaultAuthorizationPolicy struct {
	// The configuration settings of the Azure Active Directory allowed applications.
	AllowedApplications []*string

	// The configuration settings of the Azure Active Directory allowed principals.
	AllowedPrincipals *AllowedPrincipals
}

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 

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
}

DefaultErrorResponse - App Service error response.

func (DefaultErrorResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefaultErrorResponse.

func (*DefaultErrorResponse) UnmarshalJSON 

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

	// READ-ONLY; Standardized string to programmatically identify the error.
	Code *string

	// READ-ONLY; More information to debug error.
	Innererror *string

	// READ-ONLY; Detailed error description and debugging information.
	Message *string

	// READ-ONLY; Detailed error description and debugging information.
	Target *string
}

DefaultErrorResponseError - Error model.

func (DefaultErrorResponseError) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefaultErrorResponseError.

func (*DefaultErrorResponseError) UnmarshalJSON 

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

	// READ-ONLY; Detailed error description and debugging information.
	Message *string

	// READ-ONLY; Detailed error description and debugging information.
	Target *string
}

DefaultErrorResponseErrorDetailsItem - Detailed errors.

func (DefaultErrorResponseErrorDetailsItem) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefaultErrorResponseErrorDetailsItem.

func (*DefaultErrorResponseErrorDetailsItem) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultErrorResponseErrorDetailsItem.

type DestinationsConfiguration 

type DestinationsConfiguration struct {
	// Open telemetry datadog destination configuration
	DataDogConfiguration *DataDogConfiguration

	// Open telemetry otlp configurations
	OtlpConfigurations []*OtlpConfiguration
}

DestinationsConfiguration - Configuration of Open Telemetry destinations

func (DestinationsConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DestinationsConfiguration.

func (*DestinationsConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DestinationsConfiguration.

type DiagnosticDataProviderMetadata 

type DiagnosticDataProviderMetadata struct {
	// Collection of properties
	PropertyBag []*DiagnosticDataProviderMetadataPropertyBagItem

	// Name of data provider
	ProviderName *string
}

DiagnosticDataProviderMetadata - Details of a diagnostics data provider

func (DiagnosticDataProviderMetadata) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticDataProviderMetadata.

func (*DiagnosticDataProviderMetadata) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticDataProviderMetadata.

type DiagnosticDataProviderMetadataPropertyBagItem 

type DiagnosticDataProviderMetadataPropertyBagItem struct {
	// Property name
	Name *string

	// Property value
	Value *string
}

DiagnosticDataProviderMetadataPropertyBagItem - Property details

func (DiagnosticDataProviderMetadataPropertyBagItem) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticDataProviderMetadataPropertyBagItem.

func (*DiagnosticDataProviderMetadataPropertyBagItem) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticDataProviderMetadataPropertyBagItem.

type DiagnosticDataTableResponseColumn 

type DiagnosticDataTableResponseColumn struct {
	// Column name
	ColumnName *string

	// Column type
	ColumnType *string

	// Data type of the column
	DataType *string
}

DiagnosticDataTableResponseColumn - Diagnostics data column

func (DiagnosticDataTableResponseColumn) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticDataTableResponseColumn.

func (*DiagnosticDataTableResponseColumn) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticDataTableResponseColumn.

type DiagnosticDataTableResponseObject 

type DiagnosticDataTableResponseObject struct {
	// Columns in the table
	Columns []*DiagnosticDataTableResponseColumn

	// Rows in the table
	Rows []any

	// Table name
	TableName *string
}

DiagnosticDataTableResponseObject - Diagnostics data table

func (DiagnosticDataTableResponseObject) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticDataTableResponseObject.

func (*DiagnosticDataTableResponseObject) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticDataTableResponseObject.

type DiagnosticRendering 

type DiagnosticRendering struct {
	// Description of the table
	Description *string

	// Flag if the table should be rendered
	IsVisible *bool

	// Title of the table
	Title *string

	// Rendering type
	Type *int32
}

DiagnosticRendering - Rendering details of a diagnostics table

func (DiagnosticRendering) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticRendering.

func (*DiagnosticRendering) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticRendering.

type DiagnosticSupportTopic 

type DiagnosticSupportTopic struct {
	// READ-ONLY; Unique topic identifier
	ID *string

	// READ-ONLY; PES identifier
	PesID *string
}

DiagnosticSupportTopic - Support topic information

func (DiagnosticSupportTopic) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticSupportTopic.

func (*DiagnosticSupportTopic) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticSupportTopic.

type Diagnostics 

type Diagnostics struct {
	// Diagnostics resource specific properties
	Properties *DiagnosticsProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Diagnostics data for a resource.

func (Diagnostics) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Diagnostics.

func (*Diagnostics) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Diagnostics.

type DiagnosticsCollection 

type DiagnosticsCollection struct {
	// REQUIRED; Collection of diagnostic data.
	Value []*Diagnostics

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

DiagnosticsCollection - Diagnostics data collection for a resource.

func (DiagnosticsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticsCollection.

func (*DiagnosticsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticsCollection.

type DiagnosticsDataAPIResponse 

type DiagnosticsDataAPIResponse struct {
	// Details of the table response
	RenderingProperties *DiagnosticRendering

	// Table response
	Table *DiagnosticDataTableResponseObject
}

DiagnosticsDataAPIResponse - Diagnostics data returned from a detector

func (DiagnosticsDataAPIResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticsDataAPIResponse.

func (*DiagnosticsDataAPIResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticsDataAPIResponse.

type DiagnosticsDefinition 

type DiagnosticsDefinition struct {
	// List of analysis types
	AnalysisTypes []*string

	// List of support topics
	SupportTopicList []*DiagnosticSupportTopic

	// READ-ONLY; Authors' names of the detector
	Author *string

	// READ-ONLY; Category of the detector
	Category *string

	// READ-ONLY; Details of the diagnostics info
	Description *string

	// READ-ONLY; Unique detector name
	ID *string

	// READ-ONLY; Display Name of the detector
	Name *string

	// READ-ONLY; Authors' names of the detector
	Score *float32

	// READ-ONLY; Authors' names of the detector
	Type *string
}

DiagnosticsDefinition - Metadata of the diagnostics response

func (DiagnosticsDefinition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticsDefinition.

func (*DiagnosticsDefinition) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticsDefinition.

type DiagnosticsProperties 

type DiagnosticsProperties struct {
	// List of data providers' metadata.
	DataProviderMetadata *DiagnosticDataProviderMetadata

	// Set of data collections associated with the response.
	Dataset []*DiagnosticsDataAPIResponse

	// Metadata of the diagnostics response.
	Metadata *DiagnosticsDefinition

	// Status of the diagnostics response.
	Status *DiagnosticsStatus
}

DiagnosticsProperties - Diagnostics resource specific properties

func (DiagnosticsProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticsProperties.

func (*DiagnosticsProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticsProperties.

type DiagnosticsStatus 

type DiagnosticsStatus struct {
	// Diagnostic message
	Message *string

	// Status
	StatusID *int32
}

DiagnosticsStatus - Rendering details of a diagnostics table

func (DiagnosticsStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticsStatus.

func (*DiagnosticsStatus) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticsStatus.

type DotNetComponent 

type DotNetComponent struct {
	// .NET Component resource specific properties
	Properties *DotNetComponentProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DotNetComponent - .NET Component.

func (DotNetComponent) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DotNetComponent.

func (*DotNetComponent) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DotNetComponent.

type DotNetComponentConfigurationProperty 

type DotNetComponentConfigurationProperty struct {
	// The name of the property
	PropertyName *string

	// The value of the property
	Value *string
}

DotNetComponentConfigurationProperty - Configuration properties for a .NET Component

func (DotNetComponentConfigurationProperty) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DotNetComponentConfigurationProperty.

func (*DotNetComponentConfigurationProperty) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DotNetComponentConfigurationProperty.

type DotNetComponentProperties 

type DotNetComponentProperties struct {
	// Type of the .NET Component.
	ComponentType *DotNetComponentType

	// List of .NET Components configuration properties
	Configurations []*DotNetComponentConfigurationProperty

	// List of .NET Components that are bound to the .NET component
	ServiceBinds []*DotNetComponentServiceBind

	// READ-ONLY; Provisioning state of the .NET Component.
	ProvisioningState *DotNetComponentProvisioningState
}

DotNetComponentProperties - .NET Component resource specific properties

func (DotNetComponentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DotNetComponentProperties.

func (*DotNetComponentProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DotNetComponentProperties.

type DotNetComponentProvisioningState 

type DotNetComponentProvisioningState string

DotNetComponentProvisioningState - Provisioning state of the .NET Component. 

const (
	DotNetComponentProvisioningStateCanceled   DotNetComponentProvisioningState = "Canceled"
	DotNetComponentProvisioningStateDeleting   DotNetComponentProvisioningState = "Deleting"
	DotNetComponentProvisioningStateFailed     DotNetComponentProvisioningState = "Failed"
	DotNetComponentProvisioningStateInProgress DotNetComponentProvisioningState = "InProgress"
	DotNetComponentProvisioningStateSucceeded  DotNetComponentProvisioningState = "Succeeded"
)

func PossibleDotNetComponentProvisioningStateValues 

func PossibleDotNetComponentProvisioningStateValues() []DotNetComponentProvisioningState

PossibleDotNetComponentProvisioningStateValues returns the possible values for the DotNetComponentProvisioningState const type.

type DotNetComponentServiceBind 

type DotNetComponentServiceBind struct {
	// Name of the service bind
	Name *string

	// Resource id of the target service
	ServiceID *string
}

DotNetComponentServiceBind - Configuration to bind a .NET Component to another .NET Component

func (DotNetComponentServiceBind) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DotNetComponentServiceBind.

func (*DotNetComponentServiceBind) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DotNetComponentServiceBind.

type DotNetComponentType 

type DotNetComponentType string

DotNetComponentType - Type of the .NET Component. 

const (
	DotNetComponentTypeAspireDashboard         DotNetComponentType = "AspireDashboard"
	DotNetComponentTypeAspireResourceServerAPI DotNetComponentType = "AspireResourceServerApi"
)

func PossibleDotNetComponentTypeValues 

func PossibleDotNetComponentTypeValues() []DotNetComponentType

PossibleDotNetComponentTypeValues returns the possible values for the DotNetComponentType const type.

type DotNetComponentsClient 

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

DotNetComponentsClient contains the methods for the DotNetComponents group. Don't use this type directly, use NewDotNetComponentsClient() instead.

func NewDotNetComponentsClient 

func NewDotNetComponentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DotNetComponentsClient, error)

NewDotNetComponentsClient creates a new instance of DotNetComponentsClient with the specified values.

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

func (*DotNetComponentsClient) BeginCreateOrUpdate 

func (client *DotNetComponentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, name string, dotNetComponentEnvelope DotNetComponent, options *DotNetComponentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DotNetComponentsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the .NET Component.
  • dotNetComponentEnvelope - Configuration details of the .NET Component.
  • options - DotNetComponentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DotNetComponentsClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateNetComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_CreateOrUpdate.json 

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.NewDotNetComponentsClient().BeginCreateOrUpdate(ctx, "examplerg", "myenvironment", "mydotnetcomponent", armappcontainers.DotNetComponent{
	Properties: &armappcontainers.DotNetComponentProperties{
		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("dashboard-theme"),
				Value:        to.Ptr("dark"),
			}},
	},
}, 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.DotNetComponent = armappcontainers.DotNetComponent{
// 	Name: to.Ptr("mydotnetcomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent"),
// 	Properties: &armappcontainers.DotNetComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
// 		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("dashboard-theme"),
// 				Value: to.Ptr("dark"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
// 	},
// }

Output:
Example (CreateOrUpdateNetComponentWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json 

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.NewDotNetComponentsClient().BeginCreateOrUpdate(ctx, "examplerg", "myenvironment", "mydotnetcomponent", armappcontainers.DotNetComponent{
	Properties: &armappcontainers.DotNetComponentProperties{
		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("dashboard-theme"),
				Value:        to.Ptr("dark"),
			}},
		ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
			{
				Name:      to.Ptr("yellowcat"),
				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
			}},
	},
}, 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.DotNetComponent = armappcontainers.DotNetComponent{
// 	Name: to.Ptr("mydotnetcomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent"),
// 	Properties: &armappcontainers.DotNetComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
// 		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("dashboard-theme"),
// 				Value: to.Ptr("dark"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
// 		ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
// 			{
// 				Name: to.Ptr("yellowcat"),
// 				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
// 		}},
// 	},
// }

Output:

func (*DotNetComponentsClient) BeginDelete 

func (client *DotNetComponentsClient) BeginDelete(ctx context.Context, resourceGroupName string, environmentName string, name string, options *DotNetComponentsClientBeginDeleteOptions) (*runtime.Poller[DotNetComponentsClientDeleteResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the .NET Component.
  • options - DotNetComponentsClientBeginDeleteOptions contains the optional parameters for the DotNetComponentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_Delete.json 

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.NewDotNetComponentsClient().BeginDelete(ctx, "examplerg", "myenvironment", "mydotnetcomponent", 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 (*DotNetComponentsClient) BeginUpdate 

func (client *DotNetComponentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, environmentName string, name string, dotNetComponentEnvelope DotNetComponent, options *DotNetComponentsClientBeginUpdateOptions) (*runtime.Poller[DotNetComponentsClientUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the .NET Component.
  • dotNetComponentEnvelope - Configuration details of the .NET Component.
  • options - DotNetComponentsClientBeginUpdateOptions contains the optional parameters for the DotNetComponentsClient.BeginUpdate method.
Example (PatchNetComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_Patch.json 

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.NewDotNetComponentsClient().BeginUpdate(ctx, "examplerg", "myenvironment", "mydotnetcomponent", armappcontainers.DotNetComponent{
	Properties: &armappcontainers.DotNetComponentProperties{
		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("dashboard-theme"),
				Value:        to.Ptr("dark"),
			}},
	},
}, 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.DotNetComponent = armappcontainers.DotNetComponent{
// 	Name: to.Ptr("mydotnetcomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent"),
// 	Properties: &armappcontainers.DotNetComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
// 		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("dashboard-theme"),
// 				Value: to.Ptr("dark"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
// 	},
// }

Output:
Example (PatchNetComponentWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_Patch_ServiceBind.json 

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.NewDotNetComponentsClient().BeginUpdate(ctx, "examplerg", "myenvironment", "mydotnetcomponent", armappcontainers.DotNetComponent{
	Properties: &armappcontainers.DotNetComponentProperties{
		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("dashboard-theme"),
				Value:        to.Ptr("dark"),
			}},
		ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
			{
				Name:      to.Ptr("yellowcat"),
				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
			}},
	},
}, 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.DotNetComponent = armappcontainers.DotNetComponent{
// 	Name: to.Ptr("mydotnetcomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent"),
// 	Properties: &armappcontainers.DotNetComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
// 		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("dashboard-theme"),
// 				Value: to.Ptr("dark"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
// 		ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
// 			{
// 				Name: to.Ptr("yellowcat"),
// 				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
// 		}},
// 	},
// }

Output:

func (*DotNetComponentsClient) Get 

func (client *DotNetComponentsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, name string, options *DotNetComponentsClientGetOptions) (DotNetComponentsClientGetResponse, error)

Get - Get a .NET Component. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the .NET Component.
  • options - DotNetComponentsClientGetOptions contains the optional parameters for the DotNetComponentsClient.Get method.
Example (GetNetComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_Get.json 

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.NewDotNetComponentsClient().Get(ctx, "examplerg", "myenvironment", "mydotnetcomponent", 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.DotNetComponent = armappcontainers.DotNetComponent{
// 	Name: to.Ptr("mydotnetcomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent"),
// 	Properties: &armappcontainers.DotNetComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
// 		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("dashboard-theme"),
// 				Value: to.Ptr("dark"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
// 	},
// }

Output:
Example (GetNetComponentWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_Get_ServiceBind.json 

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.NewDotNetComponentsClient().Get(ctx, "examplerg", "myenvironment", "mydotnetcomponent", 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.DotNetComponent = armappcontainers.DotNetComponent{
// 	Name: to.Ptr("mydotnetcomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent"),
// 	Properties: &armappcontainers.DotNetComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
// 		Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("dashboard-theme"),
// 				Value: to.Ptr("dark"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
// 		ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
// 			{
// 				Name: to.Ptr("yellowcat"),
// 				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
// 		}},
// 	},
// }

Output:

func (*DotNetComponentsClient) NewListPager 

func (client *DotNetComponentsClient) NewListPager(resourceGroupName string, environmentName string, options *DotNetComponentsClientListOptions) *runtime.Pager[DotNetComponentsClientListResponse]

NewListPager - Get the .NET Components for a managed environment.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • options - DotNetComponentsClientListOptions contains the optional parameters for the DotNetComponentsClient.NewListPager method.
Example (ListNetComponents)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_List.json 

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.NewDotNetComponentsClient().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.DotNetComponentsCollection = armappcontainers.DotNetComponentsCollection{
	// 	Value: []*armappcontainers.DotNetComponent{
	// 		{
	// 			Name: to.Ptr("blueshark"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark"),
	// 			Properties: &armappcontainers.DotNetComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
	// 				Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("dashboard-theme"),
	// 						Value: to.Ptr("dark"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("yellowcat"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
	// 			Properties: &armappcontainers.DotNetComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireResourceServerAPI),
	// 				Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("timeout-value"),
	// 						Value: to.Ptr("10000ms"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:
Example (ListNetComponentsWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/DotNetComponents_List_ServiceBind.json 

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.NewDotNetComponentsClient().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.DotNetComponentsCollection = armappcontainers.DotNetComponentsCollection{
	// 	Value: []*armappcontainers.DotNetComponent{
	// 		{
	// 			Name: to.Ptr("blueshark"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark"),
	// 			Properties: &armappcontainers.DotNetComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireDashboard),
	// 				Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("dashboard-theme"),
	// 						Value: to.Ptr("dark"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
	// 				ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
	// 					{
	// 						Name: to.Ptr("yellowcat"),
	// 						ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
	// 				}},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("yellowcat"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/dotNetComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat"),
	// 			Properties: &armappcontainers.DotNetComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.DotNetComponentTypeAspireResourceServerAPI),
	// 				Configurations: []*armappcontainers.DotNetComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("timeout-value"),
	// 						Value: to.Ptr("10000ms"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.DotNetComponentProvisioningStateSucceeded),
	// 				ServiceBinds: []*armappcontainers.DotNetComponentServiceBind{
	// 					{
	// 						Name: to.Ptr("blueshark"),
	// 						ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark"),
	// 				}},
	// 			},
	// 	}},
	// }
}

Output:

type DotNetComponentsClientBeginCreateOrUpdateOptions 

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

DotNetComponentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DotNetComponentsClient.BeginCreateOrUpdate method.

type DotNetComponentsClientBeginDeleteOptions 

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

DotNetComponentsClientBeginDeleteOptions contains the optional parameters for the DotNetComponentsClient.BeginDelete method.

type DotNetComponentsClientBeginUpdateOptions 

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

DotNetComponentsClientBeginUpdateOptions contains the optional parameters for the DotNetComponentsClient.BeginUpdate method.

type DotNetComponentsClientCreateOrUpdateResponse 

type DotNetComponentsClientCreateOrUpdateResponse struct {
	// .NET Component.
	DotNetComponent
}

DotNetComponentsClientCreateOrUpdateResponse contains the response from method DotNetComponentsClient.BeginCreateOrUpdate.

type DotNetComponentsClientDeleteResponse 

type DotNetComponentsClientDeleteResponse struct {
}

DotNetComponentsClientDeleteResponse contains the response from method DotNetComponentsClient.BeginDelete.

type DotNetComponentsClientGetOptions 

type DotNetComponentsClientGetOptions struct {
}

DotNetComponentsClientGetOptions contains the optional parameters for the DotNetComponentsClient.Get method.

type DotNetComponentsClientGetResponse 

type DotNetComponentsClientGetResponse struct {
	// .NET Component.
	DotNetComponent
}

DotNetComponentsClientGetResponse contains the response from method DotNetComponentsClient.Get.

type DotNetComponentsClientListOptions 

type DotNetComponentsClientListOptions struct {
}

DotNetComponentsClientListOptions contains the optional parameters for the DotNetComponentsClient.NewListPager method.

type DotNetComponentsClientListResponse 

type DotNetComponentsClientListResponse struct {
	// .NET Components ARM resource.
	DotNetComponentsCollection
}

DotNetComponentsClientListResponse contains the response from method DotNetComponentsClient.NewListPager.

type DotNetComponentsClientUpdateResponse 

type DotNetComponentsClientUpdateResponse struct {
	// .NET Component.
	DotNetComponent
}

DotNetComponentsClientUpdateResponse contains the response from method DotNetComponentsClient.BeginUpdate.

type DotNetComponentsCollection 

type DotNetComponentsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*DotNetComponent

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

DotNetComponentsCollection - .NET Components ARM resource.

func (DotNetComponentsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DotNetComponentsCollection.

func (*DotNetComponentsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DotNetComponentsCollection.

type EncryptionSettings 

type EncryptionSettings struct {
	// The secret name which is referenced for EncryptionKey.
	ContainerAppAuthEncryptionSecretName *string

	// The secret name which is referenced for SigningKey.
	ContainerAppAuthSigningSecretName *string
}

EncryptionSettings - The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.

func (EncryptionSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EncryptionSettings.

func (*EncryptionSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionSettings.

type EnvironmentAuthToken 

type EnvironmentAuthToken struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Environment auth token resource specific properties
	Properties *EnvironmentAuthTokenProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EnvironmentAuthToken - Environment Auth Token.

func (EnvironmentAuthToken) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentAuthToken.

func (*EnvironmentAuthToken) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentAuthToken.

type EnvironmentAuthTokenProperties 

type EnvironmentAuthTokenProperties struct {
	// READ-ONLY; Token expiration date.
	Expires *time.Time

	// READ-ONLY; Auth token value.
	Token *string
}

EnvironmentAuthTokenProperties - Environment auth token resource specific properties

func (EnvironmentAuthTokenProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentAuthTokenProperties.

func (*EnvironmentAuthTokenProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentAuthTokenProperties.

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

	// Name of the Container App secret from which to pull the environment variable value.
	SecretRef *string

	// Non-secret environment variable value.
	Value *string
}

EnvironmentVar - Container App container environment variable.

func (EnvironmentVar) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentVar.

func (*EnvironmentVar) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVar.

type EnvironmentVariable 

type EnvironmentVariable struct {
	// REQUIRED; Environment variable name.
	Name *string

	// REQUIRED; Environment variable value.
	Value *string
}

EnvironmentVariable - Model representing an environment variable.

func (EnvironmentVariable) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentVariable.

func (*EnvironmentVariable) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVariable.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ExtendedLocation 

type ExtendedLocation struct {
	// The name of the extended location.
	Name *string

	// The type of the extended location.
	Type *ExtendedLocationTypes
}

ExtendedLocation - The complex type of the extended location.

func (ExtendedLocation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtendedLocation.

func (*ExtendedLocation) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedLocation.

type ExtendedLocationTypes 

type ExtendedLocationTypes string

ExtendedLocationTypes - The type of extendedLocation. 

const (
	ExtendedLocationTypesCustomLocation ExtendedLocationTypes = "CustomLocation"
)

func PossibleExtendedLocationTypesValues 

func PossibleExtendedLocationTypesValues() []ExtendedLocationTypes

PossibleExtendedLocationTypesValues returns the possible values for the ExtendedLocationTypes const type.

type Facebook 

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

	// The version of the Facebook api to be used while logging in.
	GraphAPIVersion *string

	// The configuration settings of the login flow.
	Login *LoginScopes

	// The configuration settings of the app registration for the Facebook provider.
	Registration *AppRegistration
}

Facebook - The configuration settings of the Facebook provider.

func (Facebook) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Facebook.

func (*Facebook) UnmarshalJSON 

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

	// The name of the header containing the host of the request.
	CustomHostHeaderName *string

	// The name of the header containing the scheme of the request.
	CustomProtoHeaderName *string
}

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

func (ForwardProxy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ForwardProxy.

func (*ForwardProxy) UnmarshalJSON 

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 (
	ForwardProxyConventionCustom   ForwardProxyConvention = "Custom"
	ForwardProxyConventionNoProxy  ForwardProxyConvention = "NoProxy"
	ForwardProxyConventionStandard ForwardProxyConvention = "Standard"
)

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

	// The configuration settings of the login flow.
	Login *LoginScopes

	// The configuration settings of the app registration for the GitHub provider.
	Registration *ClientRegistration
}

GitHub - The configuration settings of the GitHub provider.

func (GitHub) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GitHub.

func (*GitHub) UnmarshalJSON 

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

	// List of environment variables to be passed to the build.
	BuildEnvironmentVariables []*EnvironmentVariable

	// Context path
	ContextPath *string

	// One time Github PAT to configure github environment
	GithubPersonalAccessToken *string

	// Image name
	Image *string

	// Operation system
	OS *string

	// Code or Image
	PublishType *string

	// Registry configurations.
	RegistryInfo *RegistryInfo

	// Runtime stack
	RuntimeStack *string

	// Runtime version
	RuntimeVersion *string
}

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

func (GithubActionConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GithubActionConfiguration.

func (*GithubActionConfiguration) UnmarshalJSON 

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

	// 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

	// The action to take when an unauthenticated client attempts to access the app.
	UnauthenticatedClientAction *UnauthenticatedClientActionV2
}

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 

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

	// The configuration settings of the login flow.
	Login *LoginScopes

	// The configuration settings of the app registration for the Google provider.
	Registration *ClientRegistration

	// The configuration settings of the Azure Active Directory token validation flow.
	Validation *AllowedAudiencesValidation
}

Google - The configuration settings of the Google provider.

func (Google) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Google.

func (*Google) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Google.

type HTTPConnectionPool 

type HTTPConnectionPool struct {
	// Maximum number of pending http1 requests allowed
	HTTP1MaxPendingRequests *int32

	// Maximum number of http2 requests allowed
	HTTP2MaxRequests *int32
}

HTTPConnectionPool - Defines parameters for http connection pooling

func (HTTPConnectionPool) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPConnectionPool.

func (*HTTPConnectionPool) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPConnectionPool.

type HTTPGet 

type HTTPGet struct {
	// REQUIRED; URL to make HTTP GET request against.
	URL *string

	// Name of the file that the request should be saved to.
	FileName *string

	// List of headers to send with the request.
	Headers []*string
}

HTTPGet - Model representing a http get request.

func (HTTPGet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPGet.

func (*HTTPGet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPGet.

type HTTPRetryPolicy 

type HTTPRetryPolicy struct {
	// Conditions that must be met for a request to be retried
	Matches *HTTPRetryPolicyMatches

	// Maximum number of times a request will retry
	MaxRetries *int32

	// Settings for retry backoff characteristics
	RetryBackOff *HTTPRetryPolicyRetryBackOff
}

HTTPRetryPolicy - Policy that defines http request retry conditions

func (HTTPRetryPolicy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPRetryPolicy.

func (*HTTPRetryPolicy) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPRetryPolicy.

type HTTPRetryPolicyMatches 

type HTTPRetryPolicyMatches struct {
	// Errors that can trigger a retry
	Errors []*string

	// Additional http status codes that can trigger a retry
	HTTPStatusCodes []*int32

	// Headers that must be present for a request to be retried
	Headers []*HeaderMatch
}

HTTPRetryPolicyMatches - Conditions that must be met for a request to be retried

func (HTTPRetryPolicyMatches) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPRetryPolicyMatches.

func (*HTTPRetryPolicyMatches) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPRetryPolicyMatches.

type HTTPRetryPolicyRetryBackOff 

type HTTPRetryPolicyRetryBackOff struct {
	// Initial delay, in milliseconds, before retrying a request
	InitialDelayInMilliseconds *int64

	// Maximum interval, in milliseconds, between retries
	MaxIntervalInMilliseconds *int64
}

HTTPRetryPolicyRetryBackOff - Settings for retry backoff characteristics

func (HTTPRetryPolicyRetryBackOff) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPRetryPolicyRetryBackOff.

func (*HTTPRetryPolicyRetryBackOff) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPRetryPolicyRetryBackOff.

type HTTPScaleRule 

type HTTPScaleRule struct {
	// Authentication secrets for the custom scale rule.
	Auth []*ScaleRuleAuth

	// Metadata properties to describe http scale rule.
	Metadata map[string]*string
}

HTTPScaleRule - Container App container Http scaling rule.

func (HTTPScaleRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPScaleRule.

func (*HTTPScaleRule) UnmarshalJSON 

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

	// false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.
	RequireHTTPS *bool

	// The configuration settings of the paths HTTP requests.
	Routes *HTTPSettingsRoutes
}

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

func (HTTPSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPSettings.

func (*HTTPSettings) UnmarshalJSON 

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
}

HTTPSettingsRoutes - The configuration settings of the paths HTTP requests.

func (HTTPSettingsRoutes) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPSettingsRoutes.

func (*HTTPSettingsRoutes) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPSettingsRoutes. 

type Header struct {
	// The key of otlp configuration header
	Key *string

	// The value of otlp configuration header
	Value *string
}

Header of otlp configuration

func (Header) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Header.

func (*Header) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Header.

type HeaderMatch 

type HeaderMatch struct {
	// Name of the header
	Header *string

	// Type of match to perform
	Match *HeaderMatchMatch
}

HeaderMatch - Conditions required to match a header

func (HeaderMatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HeaderMatch.

func (*HeaderMatch) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HeaderMatch.

type HeaderMatchMatch 

type HeaderMatchMatch struct {
	// Exact value of the header
	ExactMatch *string

	// Prefix value of the header
	PrefixMatch *string

	// Regex value of the header
	RegexMatch *string

	// Suffix value of the header
	SuffixMatch *string
}

HeaderMatchMatch - Type of match to perform

func (HeaderMatchMatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HeaderMatchMatch.

func (*HeaderMatchMatch) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HeaderMatchMatch.

type IPSecurityRestrictionRule 

type IPSecurityRestrictionRule struct {
	// REQUIRED; Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny
	Action *Action

	// REQUIRED; CIDR notation to match incoming IP address
	IPAddressRange *string

	// REQUIRED; Name for the IP restriction rule.
	Name *string

	// Describe the IP restriction rule that is being sent to the container-app. This is an optional field.
	Description *string
}

IPSecurityRestrictionRule - Rule to restrict incoming IP address.

func (IPSecurityRestrictionRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IPSecurityRestrictionRule.

func (*IPSecurityRestrictionRule) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IPSecurityRestrictionRule.

type IdentityProviders 

type IdentityProviders struct {
	// The configuration settings of the Apple provider.
	Apple *Apple

	// The configuration settings of the Azure Active directory provider.
	AzureActiveDirectory *AzureActiveDirectory

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

	// 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

	// The configuration settings of the Facebook provider.
	Facebook *Facebook

	// The configuration settings of the GitHub provider.
	GitHub *GitHub

	// The configuration settings of the Google provider.
	Google *Google

	// The configuration settings of the Twitter provider.
	Twitter *Twitter
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityProviders.

type Ingress 

type Ingress struct {
	// Settings to expose additional ports on container app
	AdditionalPortMappings []*IngressPortMapping

	// Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS
	// connections
	AllowInsecure *bool

	// Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept
	// indicates server forwards client certificate but does not require a client
	// certificate. Require indicates server requires a client certificate.
	ClientCertificateMode *IngressClientCertificateMode

	// CORS policy for container app
	CorsPolicy *CorsPolicy

	// custom domain bindings for Container Apps' hostnames.
	CustomDomains []*CustomDomain

	// Exposed Port in containers for TCP traffic from ingress
	ExposedPort *int32

	// Bool indicating if app exposes an external http endpoint
	External *bool

	// Rules to restrict incoming IP address.
	IPSecurityRestrictions []*IPSecurityRestrictionRule

	// Sticky Sessions for Single Revision Mode
	StickySessions *IngressStickySessions

	// Target Port in containers for traffic from ingress
	TargetPort *int32

	// Whether an http app listens on http or https
	TargetPortHTTPScheme *IngressTargetPortHTTPScheme

	// Traffic weights for app's revisions
	Traffic []*TrafficWeight

	// Ingress transport protocol
	Transport *IngressTransportMethod

	// READ-ONLY; Hostname.
	Fqdn *string
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Ingress.

type IngressClientCertificateMode 

type IngressClientCertificateMode string

IngressClientCertificateMode - Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. 

const (
	IngressClientCertificateModeAccept  IngressClientCertificateMode = "accept"
	IngressClientCertificateModeIgnore  IngressClientCertificateMode = "ignore"
	IngressClientCertificateModeRequire IngressClientCertificateMode = "require"
)

func PossibleIngressClientCertificateModeValues 

func PossibleIngressClientCertificateModeValues() []IngressClientCertificateMode

PossibleIngressClientCertificateModeValues returns the possible values for the IngressClientCertificateMode const type.

type IngressPortMapping 

type IngressPortMapping struct {
	// REQUIRED; Specifies whether the app port is accessible outside of the environment
	External *bool

	// REQUIRED; Specifies the port user's container listens on
	TargetPort *int32

	// Specifies the exposed port for the target port. If not specified, it defaults to target port
	ExposedPort *int32
}

IngressPortMapping - Port mappings of container app ingress

func (IngressPortMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IngressPortMapping.

func (*IngressPortMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IngressPortMapping.

type IngressStickySessions 

type IngressStickySessions struct {
	// Sticky Session Affinity
	Affinity *Affinity
}

IngressStickySessions - Sticky Sessions for Single Revision Mode

func (IngressStickySessions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IngressStickySessions.

func (*IngressStickySessions) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IngressStickySessions.

type IngressTargetPortHTTPScheme 

type IngressTargetPortHTTPScheme string

IngressTargetPortHTTPScheme - Whether an http app listens on http or https 

const (
	IngressTargetPortHTTPSchemeHTTP  IngressTargetPortHTTPScheme = "http"
	IngressTargetPortHTTPSchemeHTTPS IngressTargetPortHTTPScheme = "https"
)

func PossibleIngressTargetPortHTTPSchemeValues 

func PossibleIngressTargetPortHTTPSchemeValues() []IngressTargetPortHTTPScheme

PossibleIngressTargetPortHTTPSchemeValues returns the possible values for the IngressTargetPortHTTPScheme const type.

type IngressTransportMethod 

type IngressTransportMethod string

IngressTransportMethod - Ingress transport protocol 

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

func PossibleIngressTransportMethodValues 

func PossibleIngressTransportMethodValues() []IngressTransportMethod

PossibleIngressTransportMethodValues returns the possible values for the IngressTransportMethod const type.

type InitContainer 

type InitContainer struct {
	// Container start command arguments.
	Args []*string

	// Container start command.
	Command []*string

	// Container environment variables.
	Env []*EnvironmentVar

	// Container image tag.
	Image *string

	// Custom container name.
	Name *string

	// Container resource requirements.
	Resources *ContainerResources

	// Container volume mounts.
	VolumeMounts []*VolumeMount
}

InitContainer - Container App init container definition

func (InitContainer) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type InitContainer.

func (*InitContainer) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type InitContainer.

type JavaComponent 

type JavaComponent struct {
	// Java Component resource specific properties
	Properties *JavaComponentProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

JavaComponent - Java Component.

func (JavaComponent) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JavaComponent.

func (*JavaComponent) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JavaComponent.

type JavaComponentConfigurationProperty 

type JavaComponentConfigurationProperty struct {
	// The name of the property
	PropertyName *string

	// The value of the property
	Value *string
}

JavaComponentConfigurationProperty - Configuration properties for a Java Component

func (JavaComponentConfigurationProperty) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JavaComponentConfigurationProperty.

func (*JavaComponentConfigurationProperty) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JavaComponentConfigurationProperty.

type JavaComponentProperties 

type JavaComponentProperties struct {
	// Type of the Java Component.
	ComponentType *JavaComponentType

	// List of Java Components configuration properties
	Configurations []*JavaComponentConfigurationProperty

	// List of Java Components that are bound to the Java component
	ServiceBinds []*JavaComponentServiceBind

	// READ-ONLY; Provisioning state of the Java Component.
	ProvisioningState *JavaComponentProvisioningState
}

JavaComponentProperties - Java Component resource specific properties

func (JavaComponentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JavaComponentProperties.

func (*JavaComponentProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JavaComponentProperties.

type JavaComponentProvisioningState 

type JavaComponentProvisioningState string

JavaComponentProvisioningState - Provisioning state of the Java Component. 

const (
	JavaComponentProvisioningStateCanceled   JavaComponentProvisioningState = "Canceled"
	JavaComponentProvisioningStateDeleting   JavaComponentProvisioningState = "Deleting"
	JavaComponentProvisioningStateFailed     JavaComponentProvisioningState = "Failed"
	JavaComponentProvisioningStateInProgress JavaComponentProvisioningState = "InProgress"
	JavaComponentProvisioningStateSucceeded  JavaComponentProvisioningState = "Succeeded"
)

func PossibleJavaComponentProvisioningStateValues 

func PossibleJavaComponentProvisioningStateValues() []JavaComponentProvisioningState

PossibleJavaComponentProvisioningStateValues returns the possible values for the JavaComponentProvisioningState const type.

type JavaComponentServiceBind 

type JavaComponentServiceBind struct {
	// Name of the service bind
	Name *string

	// Resource id of the target service
	ServiceID *string
}

JavaComponentServiceBind - Configuration to bind a Java Component to another Java Component

func (JavaComponentServiceBind) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JavaComponentServiceBind.

func (*JavaComponentServiceBind) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JavaComponentServiceBind.

type JavaComponentType 

type JavaComponentType string

JavaComponentType - Type of the Java Component. 

const (
	JavaComponentTypeSpringBootAdmin   JavaComponentType = "SpringBootAdmin"
	JavaComponentTypeSpringCloudConfig JavaComponentType = "SpringCloudConfig"
	JavaComponentTypeSpringCloudEureka JavaComponentType = "SpringCloudEureka"
)

func PossibleJavaComponentTypeValues 

func PossibleJavaComponentTypeValues() []JavaComponentType

PossibleJavaComponentTypeValues returns the possible values for the JavaComponentType const type.

type JavaComponentsClient 

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

JavaComponentsClient contains the methods for the JavaComponents group. Don't use this type directly, use NewJavaComponentsClient() instead.

func NewJavaComponentsClient 

func NewJavaComponentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JavaComponentsClient, error)

NewJavaComponentsClient creates a new instance of JavaComponentsClient with the specified values.

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

func (*JavaComponentsClient) BeginCreateOrUpdate 

func (client *JavaComponentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, name string, javaComponentEnvelope JavaComponent, options *JavaComponentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[JavaComponentsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Java Component.
  • javaComponentEnvelope - Configuration details of the Java Component.
  • options - JavaComponentsClientBeginCreateOrUpdateOptions contains the optional parameters for the JavaComponentsClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateJavaComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_CreateOrUpdate.json 

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.NewJavaComponentsClient().BeginCreateOrUpdate(ctx, "examplerg", "myenvironment", "myjavacomponent", armappcontainers.JavaComponent{
	Properties: &armappcontainers.JavaComponentProperties{
		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
				Value:        to.Ptr("true"),
			},
			{
				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
				Value:        to.Ptr("10000ms"),
			}},
	},
}, 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.JavaComponent = armappcontainers.JavaComponent{
// 	Name: to.Ptr("myjavacomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent"),
// 	Properties: &armappcontainers.JavaComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
// 		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
// 				Value: to.Ptr("true"),
// 			},
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
// 				Value: to.Ptr("10000ms"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
// 	},
// }

Output:
Example (CreateOrUpdateJavaComponentWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json 

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.NewJavaComponentsClient().BeginCreateOrUpdate(ctx, "examplerg", "myenvironment", "myjavacomponent", armappcontainers.JavaComponent{
	Properties: &armappcontainers.JavaComponentProperties{
		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
				Value:        to.Ptr("true"),
			},
			{
				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
				Value:        to.Ptr("10000ms"),
			}},
		ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
			{
				Name:      to.Ptr("yellowcat"),
				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
			}},
	},
}, 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.JavaComponent = armappcontainers.JavaComponent{
// 	Name: to.Ptr("myjavacomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent"),
// 	Properties: &armappcontainers.JavaComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
// 		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
// 				Value: to.Ptr("true"),
// 			},
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
// 				Value: to.Ptr("10000ms"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
// 		ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
// 			{
// 				Name: to.Ptr("yellowcat"),
// 				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
// 		}},
// 	},
// }

Output:

func (*JavaComponentsClient) BeginDelete 

func (client *JavaComponentsClient) BeginDelete(ctx context.Context, resourceGroupName string, environmentName string, name string, options *JavaComponentsClientBeginDeleteOptions) (*runtime.Poller[JavaComponentsClientDeleteResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Java Component.
  • options - JavaComponentsClientBeginDeleteOptions contains the optional parameters for the JavaComponentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_Delete.json 

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.NewJavaComponentsClient().BeginDelete(ctx, "examplerg", "myenvironment", "myjavacomponent", 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 (*JavaComponentsClient) BeginUpdate 

func (client *JavaComponentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, environmentName string, name string, javaComponentEnvelope JavaComponent, options *JavaComponentsClientBeginUpdateOptions) (*runtime.Poller[JavaComponentsClientUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Java Component.
  • javaComponentEnvelope - Configuration details of the Java Component.
  • options - JavaComponentsClientBeginUpdateOptions contains the optional parameters for the JavaComponentsClient.BeginUpdate method.
Example (PatchJavaComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_Patch.json 

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.NewJavaComponentsClient().BeginUpdate(ctx, "examplerg", "myenvironment", "myjavacomponent", armappcontainers.JavaComponent{
	Properties: &armappcontainers.JavaComponentProperties{
		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
				Value:        to.Ptr("true"),
			},
			{
				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
				Value:        to.Ptr("10000ms"),
			}},
	},
}, 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.JavaComponent = armappcontainers.JavaComponent{
// 	Name: to.Ptr("myjavacomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent"),
// 	Properties: &armappcontainers.JavaComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
// 		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
// 				Value: to.Ptr("true"),
// 			},
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
// 				Value: to.Ptr("10000ms"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
// 	},
// }

Output:
Example (PatchJavaComponentWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_Patch_ServiceBind.json 

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.NewJavaComponentsClient().BeginUpdate(ctx, "examplerg", "myenvironment", "myjavacomponent", armappcontainers.JavaComponent{
	Properties: &armappcontainers.JavaComponentProperties{
		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
			{
				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
				Value:        to.Ptr("true"),
			},
			{
				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
				Value:        to.Ptr("10000ms"),
			}},
		ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
			{
				Name:      to.Ptr("yellowcat"),
				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
			}},
	},
}, 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.JavaComponent = armappcontainers.JavaComponent{
// 	Name: to.Ptr("myjavacomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent"),
// 	Properties: &armappcontainers.JavaComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
// 		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
// 				Value: to.Ptr("true"),
// 			},
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
// 				Value: to.Ptr("10000ms"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
// 		ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
// 			{
// 				Name: to.Ptr("yellowcat"),
// 				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
// 		}},
// 	},
// }

Output:

func (*JavaComponentsClient) Get 

func (client *JavaComponentsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, name string, options *JavaComponentsClientGetOptions) (JavaComponentsClientGetResponse, error)

Get - Get a Java Component. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • name - Name of the Java Component.
  • options - JavaComponentsClientGetOptions contains the optional parameters for the JavaComponentsClient.Get method.
Example (GetJavaComponent)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_Get.json 

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.NewJavaComponentsClient().Get(ctx, "examplerg", "myenvironment", "myjavacomponent", 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.JavaComponent = armappcontainers.JavaComponent{
// 	Name: to.Ptr("myjavacomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent"),
// 	Properties: &armappcontainers.JavaComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
// 		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
// 				Value: to.Ptr("true"),
// 			},
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
// 				Value: to.Ptr("10000ms"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
// 	},
// }

Output:
Example (GetJavaComponentWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_Get_ServiceBind.json 

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.NewJavaComponentsClient().Get(ctx, "examplerg", "myenvironment", "myjavacomponent", 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.JavaComponent = armappcontainers.JavaComponent{
// 	Name: to.Ptr("myjavacomponent"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent"),
// 	Properties: &armappcontainers.JavaComponentProperties{
// 		ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
// 		Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
// 				Value: to.Ptr("true"),
// 			},
// 			{
// 				PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
// 				Value: to.Ptr("10000ms"),
// 		}},
// 		ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
// 		ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
// 			{
// 				Name: to.Ptr("yellowcat"),
// 				ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
// 		}},
// 	},
// }

Output:

func (*JavaComponentsClient) NewListPager 

func (client *JavaComponentsClient) NewListPager(resourceGroupName string, environmentName string, options *JavaComponentsClientListOptions) *runtime.Pager[JavaComponentsClientListResponse]

NewListPager - Get the Java Components for a managed environment.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • options - JavaComponentsClientListOptions contains the optional parameters for the JavaComponentsClient.NewListPager method.
Example (ListJavaComponents)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_List.json 

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.NewJavaComponentsClient().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.JavaComponentsCollection = armappcontainers.JavaComponentsCollection{
	// 	Value: []*armappcontainers.JavaComponent{
	// 		{
	// 			Name: to.Ptr("blueshark"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark"),
	// 			Properties: &armappcontainers.JavaComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
	// 				Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
	// 						Value: to.Ptr("true"),
	// 					},
	// 					{
	// 						PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
	// 						Value: to.Ptr("10000ms"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("yellowcat"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
	// 			Properties: &armappcontainers.JavaComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringCloudEureka),
	// 				Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("spring.cloud.config.server.git.uri"),
	// 						Value: to.Ptr("<GIT-URL>"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:
Example (ListJavaComponentsWithServiceBinds)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/JavaComponents_List_ServiceBind.json 

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.NewJavaComponentsClient().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.JavaComponentsCollection = armappcontainers.JavaComponentsCollection{
	// 	Value: []*armappcontainers.JavaComponent{
	// 		{
	// 			Name: to.Ptr("blueshark"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark"),
	// 			Properties: &armappcontainers.JavaComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringBootAdmin),
	// 				Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("spring.boot.admin.ui.enable-toasts"),
	// 						Value: to.Ptr("true"),
	// 					},
	// 					{
	// 						PropertyName: to.Ptr("spring.boot.admin.monitor.status-interval"),
	// 						Value: to.Ptr("10000ms"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
	// 				ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
	// 					{
	// 						Name: to.Ptr("yellowcat"),
	// 						ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
	// 				}},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("yellowcat"),
	// 			Type: to.Ptr("Microsoft.App/managedEnvironments/javaComponents"),
	// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat"),
	// 			Properties: &armappcontainers.JavaComponentProperties{
	// 				ComponentType: to.Ptr(armappcontainers.JavaComponentTypeSpringCloudEureka),
	// 				Configurations: []*armappcontainers.JavaComponentConfigurationProperty{
	// 					{
	// 						PropertyName: to.Ptr("spring.cloud.config.server.git.uri"),
	// 						Value: to.Ptr("<GIT-URL>"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappcontainers.JavaComponentProvisioningStateSucceeded),
	// 				ServiceBinds: []*armappcontainers.JavaComponentServiceBind{
	// 					{
	// 						Name: to.Ptr("blueshark"),
	// 						ServiceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark"),
	// 				}},
	// 			},
	// 	}},
	// }
}

Output:

type JavaComponentsClientBeginCreateOrUpdateOptions 

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

JavaComponentsClientBeginCreateOrUpdateOptions contains the optional parameters for the JavaComponentsClient.BeginCreateOrUpdate method.

type JavaComponentsClientBeginDeleteOptions 

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

JavaComponentsClientBeginDeleteOptions contains the optional parameters for the JavaComponentsClient.BeginDelete method.

type JavaComponentsClientBeginUpdateOptions 

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

JavaComponentsClientBeginUpdateOptions contains the optional parameters for the JavaComponentsClient.BeginUpdate method.

type JavaComponentsClientCreateOrUpdateResponse 

type JavaComponentsClientCreateOrUpdateResponse struct {
	// Java Component.
	JavaComponent
}

JavaComponentsClientCreateOrUpdateResponse contains the response from method JavaComponentsClient.BeginCreateOrUpdate.

type JavaComponentsClientDeleteResponse 

type JavaComponentsClientDeleteResponse struct {
}

JavaComponentsClientDeleteResponse contains the response from method JavaComponentsClient.BeginDelete.

type JavaComponentsClientGetOptions 

type JavaComponentsClientGetOptions struct {
}

JavaComponentsClientGetOptions contains the optional parameters for the JavaComponentsClient.Get method.

type JavaComponentsClientGetResponse 

type JavaComponentsClientGetResponse struct {
	// Java Component.
	JavaComponent
}

JavaComponentsClientGetResponse contains the response from method JavaComponentsClient.Get.

type JavaComponentsClientListOptions 

type JavaComponentsClientListOptions struct {
}

JavaComponentsClientListOptions contains the optional parameters for the JavaComponentsClient.NewListPager method.

type JavaComponentsClientListResponse 

type JavaComponentsClientListResponse struct {
	// Java Components ARM resource.
	JavaComponentsCollection
}

JavaComponentsClientListResponse contains the response from method JavaComponentsClient.NewListPager.

type JavaComponentsClientUpdateResponse 

type JavaComponentsClientUpdateResponse struct {
	// Java Component.
	JavaComponent
}

JavaComponentsClientUpdateResponse contains the response from method JavaComponentsClient.BeginUpdate.

type JavaComponentsCollection 

type JavaComponentsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*JavaComponent

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

JavaComponentsCollection - Java Components ARM resource.

func (JavaComponentsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JavaComponentsCollection.

func (*JavaComponentsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JavaComponentsCollection.

type Job 

type Job struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The complex type of the extended location.
	ExtendedLocation *ExtendedLocation

	// Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials
	// in code.
	Identity *ManagedServiceIdentity

	// Container Apps Job resource specific properties.
	Properties *JobProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Job - Container App Job

func (Job) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Job.

func (*Job) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Job.

type JobConfiguration 

type JobConfiguration struct {
	// REQUIRED; Maximum number of seconds a replica is allowed to run.
	ReplicaTimeout *int32

	// REQUIRED; Trigger type of the job
	TriggerType *TriggerType

	// Trigger configuration of an event driven job.
	EventTriggerConfig *JobConfigurationEventTriggerConfig

	// Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set
	// to 1 by default
	ManualTriggerConfig *JobConfigurationManualTriggerConfig

	// Collection of private container registry credentials used by a Container apps job
	Registries []*RegistryCredentials

	// Maximum number of retries before failing the job.
	ReplicaRetryLimit *int32

	// Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set
	// to 1 by default
	ScheduleTriggerConfig *JobConfigurationScheduleTriggerConfig

	// Collection of secrets used by a Container Apps Job
	Secrets []*Secret
}

JobConfiguration - Non versioned Container Apps Job configuration properties

func (JobConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobConfiguration.

func (*JobConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobConfiguration.

type JobConfigurationEventTriggerConfig 

type JobConfigurationEventTriggerConfig struct {
	// Number of parallel replicas of a job that can run at a given time.
	Parallelism *int32

	// Minimum number of successful replica completions before overall job completion.
	ReplicaCompletionCount *int32

	// Scaling configurations for event driven jobs.
	Scale *JobScale
}

JobConfigurationEventTriggerConfig - Trigger configuration of an event driven job.

func (JobConfigurationEventTriggerConfig) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobConfigurationEventTriggerConfig.

func (*JobConfigurationEventTriggerConfig) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobConfigurationEventTriggerConfig.

type JobConfigurationManualTriggerConfig 

type JobConfigurationManualTriggerConfig struct {
	// Number of parallel replicas of a job that can run at a given time.
	Parallelism *int32

	// Minimum number of successful replica completions before overall job completion.
	ReplicaCompletionCount *int32
}

JobConfigurationManualTriggerConfig - Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default

func (JobConfigurationManualTriggerConfig) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobConfigurationManualTriggerConfig.

func (*JobConfigurationManualTriggerConfig) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobConfigurationManualTriggerConfig.

type JobConfigurationScheduleTriggerConfig 

type JobConfigurationScheduleTriggerConfig struct {
	// REQUIRED; Cron formatted repeating schedule ("* * * * *") of a Cron Job.
	CronExpression *string

	// Number of parallel replicas of a job that can run at a given time.
	Parallelism *int32

	// Minimum number of successful replica completions before overall job completion.
	ReplicaCompletionCount *int32
}

JobConfigurationScheduleTriggerConfig - Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default

func (JobConfigurationScheduleTriggerConfig) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobConfigurationScheduleTriggerConfig.

func (*JobConfigurationScheduleTriggerConfig) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobConfigurationScheduleTriggerConfig.

type JobExecution 

type JobExecution struct {
	// Job execution Id.
	ID *string

	// Job execution Name.
	Name *string

	// Container Apps Job execution specific properties.
	Properties *JobExecutionProperties

	// Job execution type
	Type *string
}

JobExecution - Container Apps Job execution.

func (JobExecution) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobExecution.

func (*JobExecution) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobExecution.

type JobExecutionBase 

type JobExecutionBase struct {
	// Job execution Id.
	ID *string

	// Job execution name.
	Name *string
}

JobExecutionBase - Container App's Job execution name.

func (JobExecutionBase) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobExecutionBase.

func (*JobExecutionBase) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobExecutionBase.

type JobExecutionContainer 

type JobExecutionContainer struct {
	// Container start command arguments.
	Args []*string

	// Container start command.
	Command []*string

	// Container environment variables.
	Env []*EnvironmentVar

	// Container image tag.
	Image *string

	// Custom container name.
	Name *string

	// Container resource requirements.
	Resources *ContainerResources
}

JobExecutionContainer - Container Apps Jobs execution container definition.

func (JobExecutionContainer) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobExecutionContainer.

func (*JobExecutionContainer) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobExecutionContainer.

type JobExecutionNamesCollection 

type JobExecutionNamesCollection struct {
	// REQUIRED; Collection of resources.
	Value []*JobExecutionBase
}

JobExecutionNamesCollection - Container App executions names list.

func (JobExecutionNamesCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobExecutionNamesCollection.

func (*JobExecutionNamesCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobExecutionNamesCollection.

type JobExecutionProperties 

type JobExecutionProperties struct {
	// Job execution end time.
	EndTime *time.Time

	// Job execution start time.
	StartTime *time.Time

	// Job's execution container.
	Template *JobExecutionTemplate

	// READ-ONLY; Current running State of the job
	Status *JobExecutionRunningState
}

JobExecutionProperties - Container Apps Job execution specific properties.

func (JobExecutionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobExecutionProperties.

func (*JobExecutionProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobExecutionProperties.

type JobExecutionRunningState 

type JobExecutionRunningState string

JobExecutionRunningState - Current running State of the job 

const (
	JobExecutionRunningStateDegraded   JobExecutionRunningState = "Degraded"
	JobExecutionRunningStateFailed     JobExecutionRunningState = "Failed"
	JobExecutionRunningStateProcessing JobExecutionRunningState = "Processing"
	JobExecutionRunningStateRunning    JobExecutionRunningState = "Running"
	JobExecutionRunningStateStopped    JobExecutionRunningState = "Stopped"
	JobExecutionRunningStateSucceeded  JobExecutionRunningState = "Succeeded"
	JobExecutionRunningStateUnknown    JobExecutionRunningState = "Unknown"
)

func PossibleJobExecutionRunningStateValues 

func PossibleJobExecutionRunningStateValues() []JobExecutionRunningState

PossibleJobExecutionRunningStateValues returns the possible values for the JobExecutionRunningState const type.

type JobExecutionTemplate 

type JobExecutionTemplate struct {
	// List of container definitions for the Container Apps Job.
	Containers []*JobExecutionContainer

	// List of specialized containers that run before job containers.
	InitContainers []*JobExecutionContainer
}

JobExecutionTemplate - Job's execution template, containing container configuration for a job's execution

func (JobExecutionTemplate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobExecutionTemplate.

func (*JobExecutionTemplate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobExecutionTemplate.

type JobPatchProperties 

type JobPatchProperties struct {
	// The complex type of the extended location.
	ExtendedLocation *ExtendedLocation

	// Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials
	// in code.
	Identity   *ManagedServiceIdentity
	Properties *JobPatchPropertiesProperties

	// Resource tags.
	Tags map[string]*string
}

JobPatchProperties - Container Apps Job resource specific properties.

func (JobPatchProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobPatchProperties.

func (*JobPatchProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobPatchProperties.

type JobPatchPropertiesProperties 

type JobPatchPropertiesProperties struct {
	// Container Apps Job configuration properties.
	Configuration *JobConfiguration

	// Resource ID of environment.
	EnvironmentID *string

	// The endpoint of the eventstream of the container apps job.
	EventStreamEndpoint *string

	// Outbound IP Addresses of a container apps job.
	OutboundIPAddresses []*string

	// Container Apps job definition.
	Template *JobTemplate
}

func (JobPatchPropertiesProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobPatchPropertiesProperties.

func (*JobPatchPropertiesProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobPatchPropertiesProperties.

type JobProperties 

type JobProperties struct {
	// Container Apps Job configuration properties.
	Configuration *JobConfiguration

	// Resource ID of environment.
	EnvironmentID *string

	// Container Apps job definition.
	Template *JobTemplate

	// Workload profile name to pin for container apps job execution.
	WorkloadProfileName *string

	// READ-ONLY; The endpoint of the eventstream of the container apps job.
	EventStreamEndpoint *string

	// READ-ONLY; Outbound IP Addresses of a container apps job.
	OutboundIPAddresses []*string

	// READ-ONLY; Provisioning state of the Container Apps Job.
	ProvisioningState *JobProvisioningState
}

JobProperties - Container Apps Job resource specific properties.

func (JobProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobProperties.

func (*JobProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobProperties.

type JobProvisioningState 

type JobProvisioningState string

JobProvisioningState - Provisioning state of the Container Apps Job. 

const (
	JobProvisioningStateCanceled   JobProvisioningState = "Canceled"
	JobProvisioningStateDeleting   JobProvisioningState = "Deleting"
	JobProvisioningStateFailed     JobProvisioningState = "Failed"
	JobProvisioningStateInProgress JobProvisioningState = "InProgress"
	JobProvisioningStateSucceeded  JobProvisioningState = "Succeeded"
)

func PossibleJobProvisioningStateValues 

func PossibleJobProvisioningStateValues() []JobProvisioningState

PossibleJobProvisioningStateValues returns the possible values for the JobProvisioningState const type.

type JobScale 

type JobScale struct {
	// Maximum number of job executions that are created for a trigger, default 100.
	MaxExecutions *int32

	// Minimum number of job executions that are created for a trigger, default 0
	MinExecutions *int32

	// Interval to check each event source in seconds. Defaults to 30s
	PollingInterval *int32

	// Scaling rules.
	Rules []*JobScaleRule
}

JobScale - Scaling configurations for event driven jobs.

func (JobScale) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobScale.

func (*JobScale) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobScale.

type JobScaleRule 

type JobScaleRule struct {
	// Authentication secrets for the scale rule.
	Auth []*ScaleRuleAuth

	// Metadata properties to describe the scale rule.
	Metadata any

	// Scale Rule Name
	Name *string

	// Type of the scale rule eg: azure-servicebus, redis etc.
	Type *string
}

JobScaleRule - Scaling rule.

func (JobScaleRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobScaleRule.

func (*JobScaleRule) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobScaleRule.

type JobSecretsCollection 

type JobSecretsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*Secret
}

JobSecretsCollection - Container Apps Job Secrets Collection ARM resource.

func (JobSecretsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobSecretsCollection.

func (*JobSecretsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobSecretsCollection.

type JobTemplate 

type JobTemplate struct {
	// List of container definitions for the Container App.
	Containers []*Container

	// List of specialized containers that run before app containers.
	InitContainers []*InitContainer

	// List of volume definitions for the Container App.
	Volumes []*Volume
}

JobTemplate - Container Apps Job 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 (JobTemplate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobTemplate.

func (*JobTemplate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobTemplate.

type JobsClient 

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

JobsClient contains the methods for the Jobs group. Don't use this type directly, use NewJobsClient() instead.

func NewJobsClient 

func NewJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsClient, error)

NewJobsClient creates a new instance of JobsClient with the specified values.

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

func (*JobsClient) BeginCreateOrUpdate 

func (client *JobsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, jobName string, jobEnvelope Job, options *JobsClientBeginCreateOrUpdateOptions) (*runtime.Poller[JobsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a Container Apps Job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • jobEnvelope - Properties used to create a container apps job
  • options - JobsClientBeginCreateOrUpdateOptions contains the optional parameters for the JobsClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateContainerAppsJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_CreateorUpdate.json 

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.NewJobsClient().BeginCreateOrUpdate(ctx, "rg", "testcontainerAppsJob0", armappcontainers.Job{
	Location: to.Ptr("East US"),
	Properties: &armappcontainers.JobProperties{
		Configuration: &armappcontainers.JobConfiguration{
			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
				Parallelism:            to.Ptr[int32](4),
				ReplicaCompletionCount: to.Ptr[int32](1),
			},
			ReplicaRetryLimit: to.Ptr[int32](10),
			ReplicaTimeout:    to.Ptr[int32](10),
			TriggerType:       to.Ptr(armappcontainers.TriggerTypeManual),
		},
		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		Template: &armappcontainers.JobTemplate{
			Containers: []*armappcontainers.Container{
				{
					Name:  to.Ptr("testcontainerAppsJob0"),
					Image: to.Ptr("repo/testcontainerAppsJob0:v1"),
					VolumeMounts: []*armappcontainers.VolumeMount{
						{
							MountPath:  to.Ptr("/mnt/path1"),
							SubPath:    to.Ptr("subPath1"),
							VolumeName: to.Ptr("azurefile"),
						},
						{
							MountPath:  to.Ptr("/mnt/path2"),
							SubPath:    to.Ptr("subPath2"),
							VolumeName: to.Ptr("nfsazurefile"),
						}},
					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](5),
							PeriodSeconds:       to.Ptr[int32](3),
						}},
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name: to.Ptr("testinitcontainerAppsJob0"),
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
					Resources: &armappcontainers.ContainerResources{
						CPU:    to.Ptr[float64](0.2),
						Memory: to.Ptr("100Mi"),
					},
				}},
		},
	},
}, 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.Job = armappcontainers.Job{
// 	Name: to.Ptr("testcontainerAppsJob0"),
// 	Type: to.Ptr("Microsoft.App/jobs"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.JobProperties{
// 		Configuration: &armappcontainers.JobConfiguration{
// 			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
// 				Parallelism: to.Ptr[int32](4),
// 				ReplicaCompletionCount: to.Ptr[int32](1),
// 			},
// 			ReplicaRetryLimit: to.Ptr[int32](10),
// 			ReplicaTimeout: to.Ptr[int32](10),
// 			TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
// 		Template: &armappcontainers.JobTemplate{
// 			Containers: []*armappcontainers.Container{
// 				{
// 					Name: to.Ptr("testcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 					VolumeMounts: []*armappcontainers.VolumeMount{
// 						{
// 							MountPath: to.Ptr("/mnt/path1"),
// 							SubPath: to.Ptr("subPath1"),
// 							VolumeName: to.Ptr("azurefile"),
// 						},
// 						{
// 							MountPath: to.Ptr("/mnt/path2"),
// 							SubPath: to.Ptr("subPath2"),
// 							VolumeName: to.Ptr("nfsazurefile"),
// 					}},
// 					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),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Args: []*string{
// 						to.Ptr("-c"),
// 						to.Ptr("while true; do echo hello; sleep 10;done")},
// 						Command: []*string{
// 							to.Ptr("/bin/sh")},
// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 							Resources: &armappcontainers.ContainerResources{
// 								CPU: to.Ptr[float64](0.2),
// 								Memory: to.Ptr("100Mi"),
// 							},
// 					}},
// 					Volumes: []*armappcontainers.Volume{
// 						{
// 							Name: to.Ptr("azurefile"),
// 							StorageName: to.Ptr("storage"),
// 							StorageType: to.Ptr(armappcontainers.StorageTypeAzureFile),
// 						},
// 						{
// 							Name: to.Ptr("nfsazurefile"),
// 							StorageName: to.Ptr("nfsStorage"),
// 							StorageType: to.Ptr(armappcontainers.StorageTypeNfsAzureFile),
// 					}},
// 				},
// 			},
// 		}

Output:
Example (CreateOrUpdateContainerAppsJobOnAConnectedEnvironment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json 

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.NewJobsClient().BeginCreateOrUpdate(ctx, "rg", "testcontainerAppsJob0", armappcontainers.Job{
	Location: to.Ptr("East US"),
	ExtendedLocation: &armappcontainers.ExtendedLocation{
		Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
		Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
	},
	Properties: &armappcontainers.JobProperties{
		Configuration: &armappcontainers.JobConfiguration{
			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
				Parallelism:            to.Ptr[int32](4),
				ReplicaCompletionCount: to.Ptr[int32](1),
			},
			ReplicaRetryLimit: to.Ptr[int32](10),
			ReplicaTimeout:    to.Ptr[int32](10),
			TriggerType:       to.Ptr(armappcontainers.TriggerTypeManual),
		},
		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube"),
		Template: &armappcontainers.JobTemplate{
			Containers: []*armappcontainers.Container{
				{
					Name:  to.Ptr("testcontainerAppsJob0"),
					Image: to.Ptr("repo/testcontainerAppsJob0: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](5),
							PeriodSeconds:       to.Ptr[int32](3),
						}},
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name: to.Ptr("testinitcontainerAppsJob0"),
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
					Resources: &armappcontainers.ContainerResources{
						CPU:    to.Ptr[float64](0.2),
						Memory: to.Ptr("100Mi"),
					},
				}},
		},
	},
}, 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.Job = armappcontainers.Job{
// 	Name: to.Ptr("testcontainerAppsJob0"),
// 	Type: to.Ptr("Microsoft.App/jobs"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
// 	Location: to.Ptr("East US"),
// 	ExtendedLocation: &armappcontainers.ExtendedLocation{
// 		Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
// 		Type: to.Ptr(armappcontainers.ExtendedLocationTypesCustomLocation),
// 	},
// 	Properties: &armappcontainers.JobProperties{
// 		Configuration: &armappcontainers.JobConfiguration{
// 			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
// 				Parallelism: to.Ptr[int32](4),
// 				ReplicaCompletionCount: to.Ptr[int32](1),
// 			},
// 			ReplicaRetryLimit: to.Ptr[int32](10),
// 			ReplicaTimeout: to.Ptr[int32](10),
// 			TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
// 		Template: &armappcontainers.JobTemplate{
// 			Containers: []*armappcontainers.Container{
// 				{
// 					Name: to.Ptr("testcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 					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),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Args: []*string{
// 						to.Ptr("-c"),
// 						to.Ptr("while true; do echo hello; sleep 10;done")},
// 						Command: []*string{
// 							to.Ptr("/bin/sh")},
// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 							Resources: &armappcontainers.ContainerResources{
// 								CPU: to.Ptr[float64](0.2),
// 								Memory: to.Ptr("100Mi"),
// 							},
// 					}},
// 				},
// 			},
// 		}

Output:
Example (CreateOrUpdateContainerAppsJobWithEventDrivenTrigger)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_CreateorUpdate_EventTrigger.json 

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.NewJobsClient().BeginCreateOrUpdate(ctx, "rg", "testcontainerAppsJob0", armappcontainers.Job{
	Location: to.Ptr("East US"),
	Properties: &armappcontainers.JobProperties{
		Configuration: &armappcontainers.JobConfiguration{
			EventTriggerConfig: &armappcontainers.JobConfigurationEventTriggerConfig{
				Parallelism:            to.Ptr[int32](4),
				ReplicaCompletionCount: to.Ptr[int32](1),
				Scale: &armappcontainers.JobScale{
					MaxExecutions:   to.Ptr[int32](5),
					MinExecutions:   to.Ptr[int32](1),
					PollingInterval: to.Ptr[int32](40),
					Rules: []*armappcontainers.JobScaleRule{
						{
							Name: to.Ptr("servicebuscalingrule"),
							Type: to.Ptr("azure-servicebus"),
							Metadata: map[string]any{
								"topicName": "my-topic",
							},
						}},
				},
			},
			ReplicaRetryLimit: to.Ptr[int32](10),
			ReplicaTimeout:    to.Ptr[int32](10),
			TriggerType:       to.Ptr(armappcontainers.TriggerTypeEvent),
		},
		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		Template: &armappcontainers.JobTemplate{
			Containers: []*armappcontainers.Container{
				{
					Name:  to.Ptr("testcontainerAppsJob0"),
					Image: to.Ptr("repo/testcontainerAppsJob0:v1"),
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name: to.Ptr("testinitcontainerAppsJob0"),
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
					Resources: &armappcontainers.ContainerResources{
						CPU:    to.Ptr[float64](0.2),
						Memory: to.Ptr("100Mi"),
					},
				}},
		},
	},
}, 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.Job = armappcontainers.Job{
// 	Name: to.Ptr("testcontainerAppsJob0"),
// 	Type: to.Ptr("Microsoft.App/jobs"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.JobProperties{
// 		Configuration: &armappcontainers.JobConfiguration{
// 			EventTriggerConfig: &armappcontainers.JobConfigurationEventTriggerConfig{
// 				Parallelism: to.Ptr[int32](4),
// 				ReplicaCompletionCount: to.Ptr[int32](1),
// 				Scale: &armappcontainers.JobScale{
// 					MaxExecutions: to.Ptr[int32](5),
// 					MinExecutions: to.Ptr[int32](1),
// 					PollingInterval: to.Ptr[int32](20),
// 					Rules: []*armappcontainers.JobScaleRule{
// 						{
// 							Name: to.Ptr("githubscalingrule"),
// 							Type: to.Ptr("github-runner"),
// 							Metadata: map[string]any{
// 								"githubAPIURL": "https://api.github.com",
// 							},
// 					}},
// 				},
// 			},
// 			ReplicaRetryLimit: to.Ptr[int32](10),
// 			ReplicaTimeout: to.Ptr[int32](10),
// 			TriggerType: to.Ptr(armappcontainers.TriggerTypeEvent),
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
// 		Template: &armappcontainers.JobTemplate{
// 			Containers: []*armappcontainers.Container{
// 				{
// 					Name: to.Ptr("testcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Args: []*string{
// 						to.Ptr("-c"),
// 						to.Ptr("while true; do echo hello; sleep 10;done")},
// 						Command: []*string{
// 							to.Ptr("/bin/sh")},
// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 							Resources: &armappcontainers.ContainerResources{
// 								CPU: to.Ptr[float64](0.2),
// 								Memory: to.Ptr("100Mi"),
// 							},
// 					}},
// 				},
// 			},
// 		}

Output:

func (*JobsClient) BeginDelete 

func (client *JobsClient) BeginDelete(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientBeginDeleteOptions) (*runtime.Poller[JobsClientDeleteResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientBeginDeleteOptions contains the optional parameters for the JobsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Delete.json 

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.NewJobsClient().BeginDelete(ctx, "rg", "testWorkerContainerAppsJob0", 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 (*JobsClient) BeginStart 

func (client *JobsClient) BeginStart(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientBeginStartOptions) (*runtime.Poller[JobsClientStartResponse], error)

BeginStart - Start a Container Apps Job If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientBeginStartOptions contains the optional parameters for the JobsClient.BeginStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Start.json 

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.NewJobsClient().BeginStart(ctx, "rg", "testcontainerAppsJob0", &armappcontainers.JobsClientBeginStartOptions{Template: &armappcontainers.JobExecutionTemplate{
	Containers: []*armappcontainers.JobExecutionContainer{
		{
			Name:  to.Ptr("testcontainerAppsJob0"),
			Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
			Resources: &armappcontainers.ContainerResources{
				CPU:    to.Ptr[float64](0.2),
				Memory: to.Ptr("100Mi"),
			},
		}},
	InitContainers: []*armappcontainers.JobExecutionContainer{
		{
			Name: to.Ptr("testinitcontainerAppsJob0"),
			Args: []*string{
				to.Ptr("-c"),
				to.Ptr("while true; do echo hello; sleep 10;done")},
			Command: []*string{
				to.Ptr("/bin/sh")},
			Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
			Resources: &armappcontainers.ContainerResources{
				CPU:    to.Ptr[float64](0.2),
				Memory: to.Ptr("100Mi"),
			},
		}},
},
})
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.JobExecutionBase = armappcontainers.JobExecutionBase{
// 	Name: to.Ptr("testcontainerAppsJob0-pjxhsye"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}"),
// }

Output:

func (*JobsClient) BeginStopExecution 

func (client *JobsClient) BeginStopExecution(ctx context.Context, resourceGroupName string, jobName string, jobExecutionName string, options *JobsClientBeginStopExecutionOptions) (*runtime.Poller[JobsClientStopExecutionResponse], error)

BeginStopExecution - Terminates execution of a running container apps job If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • jobExecutionName - Job execution name.
  • options - JobsClientBeginStopExecutionOptions contains the optional parameters for the JobsClient.BeginStopExecution method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Stop_Execution.json 

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.NewJobsClient().BeginStopExecution(ctx, "rg", "testcontainerAppsJob0", "jobExecution1", 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 (*JobsClient) BeginStopMultipleExecutions 

func (client *JobsClient) BeginStopMultipleExecutions(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientBeginStopMultipleExecutionsOptions) (*runtime.Poller[JobsClientStopMultipleExecutionsResponse], error)

BeginStopMultipleExecutions - Terminates execution of a running container apps job If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientBeginStopMultipleExecutionsOptions contains the optional parameters for the JobsClient.BeginStopMultipleExecutions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Stop_Multiple.json 

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.NewJobsClient().BeginStopMultipleExecutions(ctx, "rg", "testcontainerAppsJob0", 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.ContainerAppJobExecutions = armappcontainers.ContainerAppJobExecutions{
// 	Value: []*armappcontainers.JobExecution{
// 		{
// 			Name: to.Ptr("jobExecution-27944453"),
// 			Properties: &armappcontainers.JobExecutionProperties{
// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T20:47:30.000Z"); return t}()),
// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T20:37:30.000Z"); return t}()),
// 				Status: to.Ptr(armappcontainers.JobExecutionRunningStateRunning),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("jobExecution-27944452"),
// 			Properties: &armappcontainers.JobExecutionProperties{
// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T21:47:30.000Z"); return t}()),
// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T21:37:30.000Z"); return t}()),
// 				Status: to.Ptr(armappcontainers.JobExecutionRunningStateRunning),
// 			},
// 		},
// 		{
// 			Name: to.Ptr("jobExecution-27944453"),
// 			Properties: &armappcontainers.JobExecutionProperties{
// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T22:47:30.000Z"); return t}()),
// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T22:37:30.000Z"); return t}()),
// 				Status: to.Ptr(armappcontainers.JobExecutionRunningStateRunning),
// 			},
// 	}},
// }

Output:

func (*JobsClient) BeginUpdate 

func (client *JobsClient) BeginUpdate(ctx context.Context, resourceGroupName string, jobName string, jobEnvelope JobPatchProperties, options *JobsClientBeginUpdateOptions) (*runtime.Poller[JobsClientUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • jobEnvelope - Properties used to create a container apps job
  • options - JobsClientBeginUpdateOptions contains the optional parameters for the JobsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Patch.json 

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.NewJobsClient().BeginUpdate(ctx, "rg", "testcontainerAppsJob0", armappcontainers.JobPatchProperties{
	Properties: &armappcontainers.JobPatchPropertiesProperties{
		Configuration: &armappcontainers.JobConfiguration{
			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
				Parallelism:            to.Ptr[int32](4),
				ReplicaCompletionCount: to.Ptr[int32](1),
			},
			ReplicaRetryLimit: to.Ptr[int32](10),
			ReplicaTimeout:    to.Ptr[int32](10),
			TriggerType:       to.Ptr(armappcontainers.TriggerTypeManual),
		},
		Template: &armappcontainers.JobTemplate{
			Containers: []*armappcontainers.Container{
				{
					Name:  to.Ptr("testcontainerAppsJob0"),
					Image: to.Ptr("repo/testcontainerAppsJob0: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),
						}},
				}},
			InitContainers: []*armappcontainers.InitContainer{
				{
					Name: to.Ptr("testinitcontainerAppsJob0"),
					Args: []*string{
						to.Ptr("-c"),
						to.Ptr("while true; do echo hello; sleep 10;done")},
					Command: []*string{
						to.Ptr("/bin/sh")},
					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
					Resources: &armappcontainers.ContainerResources{
						CPU:    to.Ptr[float64](0.2),
						Memory: to.Ptr("100Mi"),
					},
				}},
		},
	},
}, 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.Job = armappcontainers.Job{
// 	Name: to.Ptr("testcontainerAppsJob0"),
// 	Type: to.Ptr("Microsoft.App/jobs"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.JobProperties{
// 		Configuration: &armappcontainers.JobConfiguration{
// 			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
// 				Parallelism: to.Ptr[int32](4),
// 				ReplicaCompletionCount: to.Ptr[int32](1),
// 			},
// 			ReplicaRetryLimit: to.Ptr[int32](10),
// 			ReplicaTimeout: to.Ptr[int32](10),
// 			TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
// 		ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
// 		Template: &armappcontainers.JobTemplate{
// 			Containers: []*armappcontainers.Container{
// 				{
// 					Name: to.Ptr("testcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 			}},
// 		},
// 	},
// }

Output:

func (*JobsClient) Get 

func (client *JobsClient) Get(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientGetOptions) (JobsClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Get.json 

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.NewJobsClient().Get(ctx, "rg", "testcontainerAppsJob0", 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.Job = armappcontainers.Job{
// 	Name: to.Ptr("testcontainerAppsJob0"),
// 	Type: to.Ptr("Microsoft.App/jobs"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.JobProperties{
// 		Configuration: &armappcontainers.JobConfiguration{
// 			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
// 				Parallelism: to.Ptr[int32](4),
// 				ReplicaCompletionCount: to.Ptr[int32](1),
// 			},
// 			ReplicaRetryLimit: to.Ptr[int32](10),
// 			ReplicaTimeout: to.Ptr[int32](10),
// 			TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
// 		ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
// 		Template: &armappcontainers.JobTemplate{
// 			Containers: []*armappcontainers.Container{
// 				{
// 					Name: to.Ptr("testcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 					VolumeMounts: []*armappcontainers.VolumeMount{
// 						{
// 							MountPath: to.Ptr("/mnt/path1"),
// 							SubPath: to.Ptr("subPath1"),
// 							VolumeName: to.Ptr("azurefile"),
// 						},
// 						{
// 							MountPath: to.Ptr("/mnt/path2"),
// 							SubPath: to.Ptr("subPath2"),
// 							VolumeName: to.Ptr("nfsazurefile"),
// 					}},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 			}},
// 			Volumes: []*armappcontainers.Volume{
// 				{
// 					Name: to.Ptr("azurefile"),
// 					StorageName: to.Ptr("storage"),
// 					StorageType: to.Ptr(armappcontainers.StorageTypeAzureFile),
// 				},
// 				{
// 					Name: to.Ptr("nfsazurefile"),
// 					StorageName: to.Ptr("nfsStorage"),
// 					StorageType: to.Ptr(armappcontainers.StorageTypeNfsAzureFile),
// 			}},
// 		},
// 	},
// }

Output:

func (*JobsClient) GetDetector 

func (client *JobsClient) GetDetector(ctx context.Context, resourceGroupName string, jobName string, detectorName string, options *JobsClientGetDetectorOptions) (JobsClientGetDetectorResponse, error)

GetDetector - Get the diagnostics data for a Container App Job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • detectorName - Name of the Container App Job detector.
  • options - JobsClientGetDetectorOptions contains the optional parameters for the JobsClient.GetDetector method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_GetDetector.json 

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.NewJobsClient().GetDetector(ctx, "mikono-workerapp-test-rg", "mikonojob1", "containerappjobnetworkIO", 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.Diagnostics = armappcontainers.Diagnostics{
// 	Name: to.Ptr("containerappjobnetworkIO"),
// 	Type: to.Ptr("Microsoft.App/jobs/detectors"),
// 	ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/containerappjobnetworkIO"),
// 	Properties: &armappcontainers.DiagnosticsProperties{
// 		Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
// 			{
// 				RenderingProperties: &armappcontainers.DiagnosticRendering{
// 					Type: to.Ptr[int32](8),
// 					Description: to.Ptr(""),
// 					IsVisible: to.Ptr(true),
// 					Title: to.Ptr("Container App Job Network Inbound "),
// 				},
// 				Table: &armappcontainers.DiagnosticDataTableResponseObject{
// 					Columns: []*armappcontainers.DiagnosticDataTableResponseColumn{
// 						{
// 							ColumnName: to.Ptr("TimeStamp"),
// 							DataType: to.Ptr("DateTime"),
// 						},
// 						{
// 							ColumnName: to.Ptr("Metric"),
// 							DataType: to.Ptr("String"),
// 						},
// 						{
// 							ColumnName: to.Ptr("Average"),
// 							DataType: to.Ptr("Double"),
// 					}},
// 					Rows: []any{
// 						[]any{
// 							"2022-03-15T21:35:00",
// 							"RxBytes",
// 							float64(0),
// 					}},
// 					TableName: to.Ptr(""),
// 				},
// 		}},
// 		Metadata: &armappcontainers.DiagnosticsDefinition{
// 			Name: to.Ptr("Container App Job Network Inbound and Outbound"),
// 			Type: to.Ptr("Detector"),
// 			Description: to.Ptr("This detector shows the Container App Job Network Inbound and Outbound."),
// 			Author: to.Ptr(""),
// 			Category: to.Ptr("Availability and Performance"),
// 			ID: to.Ptr("containerappjobnetworkIO"),
// 			Score: to.Ptr[float32](0),
// 			SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
// 			},
// 		},
// 		Status: &armappcontainers.DiagnosticsStatus{
// 			StatusID: to.Ptr[int32](3),
// 		},
// 	},
// }

Output:

func (*JobsClient) ListDetectors 

func (client *JobsClient) ListDetectors(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientListDetectorsOptions) (JobsClientListDetectorsResponse, error)

ListDetectors - Get the list of diagnostics for a Container App Job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientListDetectorsOptions contains the optional parameters for the JobsClient.ListDetectors method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_ListDetectors.json 

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.NewJobsClient().ListDetectors(ctx, "mikono-workerapp-test-rg", "mikonojob1", 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.DiagnosticsCollection = armappcontainers.DiagnosticsCollection{
// 	Value: []*armappcontainers.Diagnostics{
// 		{
// 			Name: to.Ptr("cappjobContainerAppAvailabilityMetrics"),
// 			Type: to.Ptr("Microsoft.App/containerapps/detectors"),
// 			ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/cappjobContainerAppAvailabilityMetrics"),
// 			Properties: &armappcontainers.DiagnosticsProperties{
// 				Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
// 				},
// 				Metadata: &armappcontainers.DiagnosticsDefinition{
// 					Name: to.Ptr("Availability Metrics for Container App Jobs"),
// 					Type: to.Ptr("Analysis"),
// 					Author: to.Ptr(""),
// 					Category: to.Ptr("Availability and Performance"),
// 					ID: to.Ptr("cappjobContainerAppAvailabilityMetrics"),
// 					Score: to.Ptr[float32](0),
// 					SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
// 					},
// 				},
// 				Status: &armappcontainers.DiagnosticsStatus{
// 					StatusID: to.Ptr[int32](4),
// 				},
// 			},
// 	}},
// }

Output:

func (*JobsClient) ListSecrets 

func (client *JobsClient) ListSecrets(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientListSecretsOptions) (JobsClientListSecretsResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientListSecretsOptions contains the optional parameters for the JobsClient.ListSecrets method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_ListSecrets.json 

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.NewJobsClient().ListSecrets(ctx, "rg", "testcontainerAppsJob0", 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.JobSecretsCollection = armappcontainers.JobSecretsCollection{
// 	Value: []*armappcontainers.Secret{
// 		{
// 			Name: to.Ptr("secret1"),
// 		},
// 		{
// 			Name: to.Ptr("secret2"),
// 	}},
// }

Output:

func (*JobsClient) NewListByResourceGroupPager 

func (client *JobsClient) NewListByResourceGroupPager(resourceGroupName string, options *JobsClientListByResourceGroupOptions) *runtime.Pager[JobsClientListByResourceGroupResponse]

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

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Jobs_ListByResourceGroup.json 

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.NewJobsClient().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.JobsCollection = armappcontainers.JobsCollection{
	// 	Value: []*armappcontainers.Job{
	// 		{
	// 			Name: to.Ptr("testcontainerAppsJob0"),
	// 			Type: to.Ptr("Microsoft.App/jobs"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.JobProperties{
	// 				Configuration: &armappcontainers.JobConfiguration{
	// 					ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
	// 						Parallelism: to.Ptr[int32](4),
	// 						ReplicaCompletionCount: to.Ptr[int32](1),
	// 					},
	// 					ReplicaRetryLimit: to.Ptr[int32](10),
	// 					ReplicaTimeout: to.Ptr[int32](10),
	// 					TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
	// 				},
	// 				EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 				ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
	// 				Template: &armappcontainers.JobTemplate{
	// 					Containers: []*armappcontainers.Container{
	// 						{
	// 							Name: to.Ptr("testcontainerAppsJob0"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.InitContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerAppsJob0"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testcontainerAppsJob1"),
	// 			Type: to.Ptr("Microsoft.App/jobs"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.JobProperties{
	// 				Configuration: &armappcontainers.JobConfiguration{
	// 					ReplicaRetryLimit: to.Ptr[int32](10),
	// 					ReplicaTimeout: to.Ptr[int32](10),
	// 					ScheduleTriggerConfig: &armappcontainers.JobConfigurationScheduleTriggerConfig{
	// 						CronExpression: to.Ptr("* * * * 5"),
	// 						Parallelism: to.Ptr[int32](4),
	// 						ReplicaCompletionCount: to.Ptr[int32](1),
	// 					},
	// 					TriggerType: to.Ptr(armappcontainers.TriggerType("Scheduled")),
	// 				},
	// 				EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 				ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
	// 				Template: &armappcontainers.JobTemplate{
	// 					Containers: []*armappcontainers.Container{
	// 						{
	// 							Name: to.Ptr("testcontainerApp0"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob1:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.InitContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerApp0"),
	// 							Image: to.Ptr("repo/testinitcontainerAppsJob1:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*JobsClient) NewListBySubscriptionPager 

func (client *JobsClient) NewListBySubscriptionPager(options *JobsClientListBySubscriptionOptions) *runtime.Pager[JobsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Get the Container Apps Jobs in a given subscription.

Generated from API version 2023-11-02-preview

  • options - JobsClientListBySubscriptionOptions contains the optional parameters for the JobsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Jobs_ListBySubscription.json 

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.NewJobsClient().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.JobsCollection = armappcontainers.JobsCollection{
	// 	Value: []*armappcontainers.Job{
	// 		{
	// 			Name: to.Ptr("testcontainerAppsJob0"),
	// 			Type: to.Ptr("Microsoft.App/jobs"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.JobProperties{
	// 				Configuration: &armappcontainers.JobConfiguration{
	// 					ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
	// 						Parallelism: to.Ptr[int32](4),
	// 						ReplicaCompletionCount: to.Ptr[int32](1),
	// 					},
	// 					ReplicaRetryLimit: to.Ptr[int32](10),
	// 					ReplicaTimeout: to.Ptr[int32](10),
	// 					TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
	// 				},
	// 				EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 				ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
	// 				Template: &armappcontainers.JobTemplate{
	// 					Containers: []*armappcontainers.Container{
	// 						{
	// 							Name: to.Ptr("testcontainerAppsJob0"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.InitContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerAppsJob0"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testcontainerAppsJob1"),
	// 			Type: to.Ptr("Microsoft.App/jobs"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.JobProperties{
	// 				Configuration: &armappcontainers.JobConfiguration{
	// 					ReplicaRetryLimit: to.Ptr[int32](10),
	// 					ReplicaTimeout: to.Ptr[int32](10),
	// 					ScheduleTriggerConfig: &armappcontainers.JobConfigurationScheduleTriggerConfig{
	// 						CronExpression: to.Ptr("* * * * 5"),
	// 						Parallelism: to.Ptr[int32](5),
	// 						ReplicaCompletionCount: to.Ptr[int32](1),
	// 					},
	// 					TriggerType: to.Ptr(armappcontainers.TriggerType("Scheduled")),
	// 				},
	// 				EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
	// 				ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
	// 				Template: &armappcontainers.JobTemplate{
	// 					Containers: []*armappcontainers.Container{
	// 						{
	// 							Name: to.Ptr("testcontainerAppsJob1"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob1:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.InitContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerAppsJob1"),
	// 							Image: to.Ptr("repo/testcontainerAppsJob1:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.2),
	// 								Memory: to.Ptr("100Mi"),
	// 							},
	// 					}},
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*JobsClient) ProxyGet 

func (client *JobsClient) ProxyGet(ctx context.Context, resourceGroupName string, jobName string, options *JobsClientProxyGetOptions) (JobsClientProxyGetResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsClientProxyGetOptions contains the optional parameters for the JobsClient.ProxyGet method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_ProxyGet.json 

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.NewJobsClient().ProxyGet(ctx, "rg", "testcontainerAppsJob0", 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.Job = armappcontainers.Job{
// 	Name: to.Ptr("testcontainerAppsJob0"),
// 	Type: to.Ptr("Microsoft.App/jobs"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0/detectorproperties/rootApi"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.JobProperties{
// 		Configuration: &armappcontainers.JobConfiguration{
// 			ManualTriggerConfig: &armappcontainers.JobConfigurationManualTriggerConfig{
// 				Parallelism: to.Ptr[int32](4),
// 				ReplicaCompletionCount: to.Ptr[int32](1),
// 			},
// 			ReplicaRetryLimit: to.Ptr[int32](10),
// 			ReplicaTimeout: to.Ptr[int32](10),
// 			TriggerType: to.Ptr(armappcontainers.TriggerTypeManual),
// 		},
// 		EnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
// 		ProvisioningState: to.Ptr(armappcontainers.JobProvisioningStateSucceeded),
// 		Template: &armappcontainers.JobTemplate{
// 			Containers: []*armappcontainers.Container{
// 				{
// 					Name: to.Ptr("testcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 			}},
// 			InitContainers: []*armappcontainers.InitContainer{
// 				{
// 					Name: to.Ptr("testinitcontainerAppsJob0"),
// 					Image: to.Ptr("repo/testcontainerAppsJob0:v4"),
// 					Resources: &armappcontainers.ContainerResources{
// 						CPU: to.Ptr[float64](0.2),
// 						Memory: to.Ptr("100Mi"),
// 					},
// 			}},
// 		},
// 	},
// }

Output:

type JobsClientBeginCreateOrUpdateOptions 

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

JobsClientBeginCreateOrUpdateOptions contains the optional parameters for the JobsClient.BeginCreateOrUpdate method.

type JobsClientBeginDeleteOptions 

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

JobsClientBeginDeleteOptions contains the optional parameters for the JobsClient.BeginDelete method.

type JobsClientBeginStartOptions 

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

	// Properties used to start a job execution.
	Template *JobExecutionTemplate
}

JobsClientBeginStartOptions contains the optional parameters for the JobsClient.BeginStart method.

type JobsClientBeginStopExecutionOptions 

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

JobsClientBeginStopExecutionOptions contains the optional parameters for the JobsClient.BeginStopExecution method.

type JobsClientBeginStopMultipleExecutionsOptions 

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

JobsClientBeginStopMultipleExecutionsOptions contains the optional parameters for the JobsClient.BeginStopMultipleExecutions method.

type JobsClientBeginUpdateOptions 

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

JobsClientBeginUpdateOptions contains the optional parameters for the JobsClient.BeginUpdate method.

type JobsClientCreateOrUpdateResponse 

type JobsClientCreateOrUpdateResponse struct {
	// Container App Job
	Job
}

JobsClientCreateOrUpdateResponse contains the response from method JobsClient.BeginCreateOrUpdate.

type JobsClientDeleteResponse 

type JobsClientDeleteResponse struct {
}

JobsClientDeleteResponse contains the response from method JobsClient.BeginDelete.

type JobsClientGetDetectorOptions 

type JobsClientGetDetectorOptions struct {
}

JobsClientGetDetectorOptions contains the optional parameters for the JobsClient.GetDetector method.

type JobsClientGetDetectorResponse 

type JobsClientGetDetectorResponse struct {
	// Diagnostics data for a resource.
	Diagnostics
}

JobsClientGetDetectorResponse contains the response from method JobsClient.GetDetector.

type JobsClientGetOptions 

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse 

type JobsClientGetResponse struct {
	// Container App Job
	Job
}

JobsClientGetResponse contains the response from method JobsClient.Get.

type JobsClientListByResourceGroupOptions 

type JobsClientListByResourceGroupOptions struct {
}

JobsClientListByResourceGroupOptions contains the optional parameters for the JobsClient.NewListByResourceGroupPager method.

type JobsClientListByResourceGroupResponse 

type JobsClientListByResourceGroupResponse struct {
	// Container Apps Jobs collection ARM resource.
	JobsCollection
}

JobsClientListByResourceGroupResponse contains the response from method JobsClient.NewListByResourceGroupPager.

type JobsClientListBySubscriptionOptions 

type JobsClientListBySubscriptionOptions struct {
}

JobsClientListBySubscriptionOptions contains the optional parameters for the JobsClient.NewListBySubscriptionPager method.

type JobsClientListBySubscriptionResponse 

type JobsClientListBySubscriptionResponse struct {
	// Container Apps Jobs collection ARM resource.
	JobsCollection
}

JobsClientListBySubscriptionResponse contains the response from method JobsClient.NewListBySubscriptionPager.

type JobsClientListDetectorsOptions 

type JobsClientListDetectorsOptions struct {
}

JobsClientListDetectorsOptions contains the optional parameters for the JobsClient.ListDetectors method.

type JobsClientListDetectorsResponse 

type JobsClientListDetectorsResponse struct {
	// Diagnostics data collection for a resource.
	DiagnosticsCollection
}

JobsClientListDetectorsResponse contains the response from method JobsClient.ListDetectors.

type JobsClientListSecretsOptions 

type JobsClientListSecretsOptions struct {
}

JobsClientListSecretsOptions contains the optional parameters for the JobsClient.ListSecrets method.

type JobsClientListSecretsResponse 

type JobsClientListSecretsResponse struct {
	// Container Apps Job Secrets Collection ARM resource.
	JobSecretsCollection
}

JobsClientListSecretsResponse contains the response from method JobsClient.ListSecrets.

type JobsClientProxyGetOptions 

type JobsClientProxyGetOptions struct {
}

JobsClientProxyGetOptions contains the optional parameters for the JobsClient.ProxyGet method.

type JobsClientProxyGetResponse 

type JobsClientProxyGetResponse struct {
	// Container App Job
	Job
}

JobsClientProxyGetResponse contains the response from method JobsClient.ProxyGet.

type JobsClientStartResponse 

type JobsClientStartResponse struct {
	// Container App's Job execution name.
	JobExecutionBase
}

JobsClientStartResponse contains the response from method JobsClient.BeginStart.

type JobsClientStopExecutionResponse 

type JobsClientStopExecutionResponse struct {
}

JobsClientStopExecutionResponse contains the response from method JobsClient.BeginStopExecution.

type JobsClientStopMultipleExecutionsResponse 

type JobsClientStopMultipleExecutionsResponse struct {
	// Container App executions collection ARM resource.
	ContainerAppJobExecutions
}

JobsClientStopMultipleExecutionsResponse contains the response from method JobsClient.BeginStopMultipleExecutions.

type JobsClientUpdateResponse 

type JobsClientUpdateResponse struct {
	// Container App Job
	Job
}

JobsClientUpdateResponse contains the response from method JobsClient.BeginUpdate.

type JobsCollection 

type JobsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*Job

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

JobsCollection - Container Apps Jobs collection ARM resource.

func (JobsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobsCollection.

func (*JobsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobsCollection.

type JobsExecutionsClient 

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

JobsExecutionsClient contains the methods for the JobsExecutions group. Don't use this type directly, use NewJobsExecutionsClient() instead.

func NewJobsExecutionsClient 

func NewJobsExecutionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsExecutionsClient, error)

NewJobsExecutionsClient creates a new instance of JobsExecutionsClient with the specified values.

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

func (*JobsExecutionsClient) NewListPager 

func (client *JobsExecutionsClient) NewListPager(resourceGroupName string, jobName string, options *JobsExecutionsClientListOptions) *runtime.Pager[JobsExecutionsClientListResponse]

NewListPager - Get a Container Apps Job's executions

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • jobName - Job Name
  • options - JobsExecutionsClientListOptions contains the optional parameters for the JobsExecutionsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Job_Executions_Get.json 

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.NewJobsExecutionsClient().NewListPager("rg", "testcontainerAppsJob0", &armappcontainers.JobsExecutionsClientListOptions{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.ContainerAppJobExecutions = armappcontainers.ContainerAppJobExecutions{
	// 	Value: []*armappcontainers.JobExecution{
	// 		{
	// 			Name: to.Ptr("testcontainerAppJob-27944454"),
	// 			Properties: &armappcontainers.JobExecutionProperties{
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T20:47:30.000Z"); return t}()),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-13T20:37:30.000Z"); return t}()),
	// 				Status: to.Ptr(armappcontainers.JobExecutionRunningStateRunning),
	// 				Template: &armappcontainers.JobExecutionTemplate{
	// 					Containers: []*armappcontainers.JobExecutionContainer{
	// 						{
	// 							Name: to.Ptr("testcontainerappsjob0"),
	// 							Image: to.Ptr("repo/testcontainerappsjob0:v4"),
	// 							Resources: &armappcontainers.ContainerResources{
	// 								CPU: to.Ptr[float64](0.5),
	// 								Memory: to.Ptr("1Gi"),
	// 							},
	// 					}},
	// 					InitContainers: []*armappcontainers.JobExecutionContainer{
	// 						{
	// 							Name: to.Ptr("testinitcontainerAppsJob0"),
	// 							Args: []*string{
	// 								to.Ptr("-c"),
	// 								to.Ptr("while true; do echo hello; sleep 10;done")},
	// 								Command: []*string{
	// 									to.Ptr("/bin/sh")},
	// 									Image: to.Ptr("repo/testcontainerappsjob0:v4"),
	// 									Resources: &armappcontainers.ContainerResources{
	// 										CPU: to.Ptr[float64](0.5),
	// 										Memory: to.Ptr("1Gi"),
	// 									},
	// 							}},
	// 						},
	// 					},
	// 			}},
	// 		}
}

Output:

type JobsExecutionsClientListOptions 

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

JobsExecutionsClientListOptions contains the optional parameters for the JobsExecutionsClient.NewListPager method.

type JobsExecutionsClientListResponse 

type JobsExecutionsClientListResponse struct {
	// Container App executions collection ARM resource.
	ContainerAppJobExecutions
}

JobsExecutionsClientListResponse contains the response from method JobsExecutionsClient.NewListPager.

type JwtClaimChecks 

type JwtClaimChecks struct {
	// The list of the allowed client applications.
	AllowedClientApplications []*string

	// The list of the allowed groups.
	AllowedGroups []*string
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JwtClaimChecks.

type KedaConfiguration 

type KedaConfiguration struct {
	// READ-ONLY; The version of Keda
	Version *string
}

KedaConfiguration - Configuration properties Keda component

func (KedaConfiguration) MarshalJSON 

func (k KedaConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KedaConfiguration.

func (*KedaConfiguration) UnmarshalJSON 

func (k *KedaConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KedaConfiguration.

type ListUsagesResult 

type ListUsagesResult struct {
	// The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page
	// of compute resource usage information.
	NextLink *string

	// The list of compute resource usages.
	Value []*Usage
}

func (ListUsagesResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ListUsagesResult.

func (*ListUsagesResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ListUsagesResult.

type LogAnalyticsConfiguration 

type LogAnalyticsConfiguration struct {
	// Log analytics customer id
	CustomerID *string

	// Boolean indicating whether to parse json string log into dynamic json columns
	DynamicJSONColumns *bool

	// Log analytics customer key
	SharedKey *string
}

LogAnalyticsConfiguration - Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'

func (LogAnalyticsConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type LogAnalyticsConfiguration.

func (*LogAnalyticsConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type LogAnalyticsConfiguration.

type LogLevel 

type LogLevel string

LogLevel - Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. 

const (
	LogLevelDebug LogLevel = "debug"
	LogLevelError LogLevel = "error"
	LogLevelInfo  LogLevel = "info"
	LogLevelWarn  LogLevel = "warn"
)

func PossibleLogLevelValues 

func PossibleLogLevelValues() []LogLevel

PossibleLogLevelValues returns the possible values for the LogLevel const type.

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

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

	// The configuration settings of the nonce used in the login flow.
	Nonce *Nonce

	// true if the fragments from the request are preserved after the login request is made; otherwise, false.
	PreserveURLFragmentsForLogins *bool

	// The routes that specify the endpoints used for login and logout requests.
	Routes *LoginRoutes

	// The configuration settings of the token store.
	TokenStore *TokenStore
}

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 

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
}

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

func (LoginRoutes) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type LoginRoutes.

func (*LoginRoutes) UnmarshalJSON 

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
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type LoginScopes.

type LogsConfiguration 

type LogsConfiguration struct {
	// Open telemetry logs destinations
	Destinations []*string
}

LogsConfiguration - Configuration of Open Telemetry logs

func (LogsConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type LogsConfiguration.

func (*LogsConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type LogsConfiguration.

type ManagedCertificate 

type ManagedCertificate struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Certificate resource specific properties
	Properties *ManagedCertificateProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ManagedCertificate - Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment

func (ManagedCertificate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedCertificate.

func (*ManagedCertificate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedCertificate.

type ManagedCertificateCollection 

type ManagedCertificateCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ManagedCertificate

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

ManagedCertificateCollection - Collection of Managed Certificates.

func (ManagedCertificateCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedCertificateCollection.

func (*ManagedCertificateCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedCertificateCollection.

type ManagedCertificateDomainControlValidation 

type ManagedCertificateDomainControlValidation string

ManagedCertificateDomainControlValidation - Selected type of domain control validation for managed certificates. 

const (
	ManagedCertificateDomainControlValidationCNAME ManagedCertificateDomainControlValidation = "CNAME"
	ManagedCertificateDomainControlValidationHTTP  ManagedCertificateDomainControlValidation = "HTTP"
	ManagedCertificateDomainControlValidationTXT   ManagedCertificateDomainControlValidation = "TXT"
)

func PossibleManagedCertificateDomainControlValidationValues 

func PossibleManagedCertificateDomainControlValidationValues() []ManagedCertificateDomainControlValidation

PossibleManagedCertificateDomainControlValidationValues returns the possible values for the ManagedCertificateDomainControlValidation const type.

type ManagedCertificatePatch 

type ManagedCertificatePatch struct {
	// Application-specific metadata in the form of key-value pairs.
	Tags map[string]*string
}

ManagedCertificatePatch - A managed certificate to update

func (ManagedCertificatePatch) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedCertificatePatch.

func (*ManagedCertificatePatch) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedCertificatePatch.

type ManagedCertificateProperties 

type ManagedCertificateProperties struct {
	// Selected type of domain control validation for managed certificates.
	DomainControlValidation *ManagedCertificateDomainControlValidation

	// Subject name of the certificate.
	SubjectName *string

	// READ-ONLY; Any error occurred during the certificate provision.
	Error *string

	// READ-ONLY; Provisioning state of the certificate.
	ProvisioningState *CertificateProvisioningState

	// READ-ONLY; A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.
	ValidationToken *string
}

ManagedCertificateProperties - Certificate resource specific properties

func (ManagedCertificateProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedCertificateProperties.

func (*ManagedCertificateProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedCertificateProperties.

type ManagedCertificatesClient 

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

ManagedCertificatesClient contains the methods for the ManagedCertificates group. Don't use this type directly, use NewManagedCertificatesClient() instead.

func NewManagedCertificatesClient 

func NewManagedCertificatesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedCertificatesClient, error)

NewManagedCertificatesClient creates a new instance of ManagedCertificatesClient with the specified values.

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

func (*ManagedCertificatesClient) BeginCreateOrUpdate 

func (client *ManagedCertificatesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, managedCertificateName string, options *ManagedCertificatesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ManagedCertificatesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • managedCertificateName - Name of the Managed Certificate.
  • options - ManagedCertificatesClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedCertificatesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedCertificate_CreateOrUpdate.json 

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.NewManagedCertificatesClient().BeginCreateOrUpdate(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", &armappcontainers.ManagedCertificatesClientBeginCreateOrUpdateOptions{ManagedCertificateEnvelope: &armappcontainers.ManagedCertificate{
	Location: to.Ptr("East US"),
	Properties: &armappcontainers.ManagedCertificateProperties{
		DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationCNAME),
		SubjectName:             to.Ptr("my-subject-name.company.country.net"),
	},
},
})
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.ManagedCertificate = armappcontainers.ManagedCertificate{
// 	Type: to.Ptr("Microsoft.App/ManagedEnvironments/managedCertificates"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.ManagedCertificateProperties{
// 		DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationCNAME),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectName: to.Ptr("CN=my-subject-name.company.country.net"),
// 	},
// }

Output:

func (*ManagedCertificatesClient) Delete 

func (client *ManagedCertificatesClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, managedCertificateName string, options *ManagedCertificatesClientDeleteOptions) (ManagedCertificatesClientDeleteResponse, error)

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

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedCertificate_Delete.json 

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.NewManagedCertificatesClient().Delete(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*ManagedCertificatesClient) Get 

func (client *ManagedCertificatesClient) Get(ctx context.Context, resourceGroupName string, environmentName string, managedCertificateName string, options *ManagedCertificatesClientGetOptions) (ManagedCertificatesClientGetResponse, error)

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

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedCertificate_Get.json 

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.NewManagedCertificatesClient().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.ManagedCertificate = armappcontainers.ManagedCertificate{
// 	Type: to.Ptr("Microsoft.App/ManagedEnvironments/managedCertificates"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.ManagedCertificateProperties{
// 		DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationCNAME),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectName: to.Ptr("CN=my-subject-name.company.country.net"),
// 	},
// }

Output:

func (*ManagedCertificatesClient) NewListPager 

func (client *ManagedCertificatesClient) NewListPager(resourceGroupName string, environmentName string, options *ManagedCertificatesClientListOptions) *runtime.Pager[ManagedCertificatesClientListResponse]

NewListPager - Get the Managed Certificates in a given managed environment.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json 

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.NewManagedCertificatesClient().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.ManagedCertificateCollection = armappcontainers.ManagedCertificateCollection{
	// 	Value: []*armappcontainers.ManagedCertificate{
	// 		{
	// 			Type: to.Ptr("Microsoft.App/ManagedEnvironments/managedCertificates"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.ManagedCertificateProperties{
	// 				DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationCNAME),
	// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 				SubjectName: to.Ptr("CN=my-subject-name.company.country.net"),
	// 			},
	// 		},
	// 		{
	// 			Type: to.Ptr("Microsoft.App/ManagedEnvironments/managedCertificates"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name-root"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.ManagedCertificateProperties{
	// 				DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationHTTP),
	// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 				SubjectName: to.Ptr("CN=company.country.net"),
	// 			},
	// 		},
	// 		{
	// 			Type: to.Ptr("Microsoft.App/ManagedEnvironments/managedCertificates"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name-txt"),
	// 			Location: to.Ptr("East US"),
	// 			Properties: &armappcontainers.ManagedCertificateProperties{
	// 				DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationTXT),
	// 				ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
	// 				SubjectName: to.Ptr("CN=txt.company.country.net"),
	// 			},
	// 	}},
	// }
}

Output:

func (*ManagedCertificatesClient) Update 

func (client *ManagedCertificatesClient) Update(ctx context.Context, resourceGroupName string, environmentName string, managedCertificateName string, managedCertificateEnvelope ManagedCertificatePatch, options *ManagedCertificatesClientUpdateOptions) (ManagedCertificatesClientUpdateResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Managed Environment.
  • managedCertificateName - Name of the Managed Certificate.
  • managedCertificateEnvelope - Properties of a managed certificate that need to be updated
  • options - ManagedCertificatesClientUpdateOptions contains the optional parameters for the ManagedCertificatesClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedCertificates_Patch.json 

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.NewManagedCertificatesClient().Update(ctx, "examplerg", "testcontainerenv", "certificate-firendly-name", armappcontainers.ManagedCertificatePatch{
	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.ManagedCertificate = armappcontainers.ManagedCertificate{
// 	Type: to.Ptr("Microsoft.App/ManagedEnvironments/managedCertificates"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.ManagedCertificateProperties{
// 		DomainControlValidation: to.Ptr(armappcontainers.ManagedCertificateDomainControlValidationCNAME),
// 		ProvisioningState: to.Ptr(armappcontainers.CertificateProvisioningStateSucceeded),
// 		SubjectName: to.Ptr("CN=my-subject-name.company.country.net"),
// 	},
// }

Output:

type ManagedCertificatesClientBeginCreateOrUpdateOptions 

type ManagedCertificatesClientBeginCreateOrUpdateOptions struct {
	// Managed Certificate to be created or updated
	ManagedCertificateEnvelope *ManagedCertificate

	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagedCertificatesClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedCertificatesClient.BeginCreateOrUpdate method.

type ManagedCertificatesClientCreateOrUpdateResponse 

type ManagedCertificatesClientCreateOrUpdateResponse struct {
	// Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment
	ManagedCertificate
}

ManagedCertificatesClientCreateOrUpdateResponse contains the response from method ManagedCertificatesClient.BeginCreateOrUpdate.

type ManagedCertificatesClientDeleteOptions 

type ManagedCertificatesClientDeleteOptions struct {
}

ManagedCertificatesClientDeleteOptions contains the optional parameters for the ManagedCertificatesClient.Delete method.

type ManagedCertificatesClientDeleteResponse 

type ManagedCertificatesClientDeleteResponse struct {
}

ManagedCertificatesClientDeleteResponse contains the response from method ManagedCertificatesClient.Delete.

type ManagedCertificatesClientGetOptions 

type ManagedCertificatesClientGetOptions struct {
}

ManagedCertificatesClientGetOptions contains the optional parameters for the ManagedCertificatesClient.Get method.

type ManagedCertificatesClientGetResponse 

type ManagedCertificatesClientGetResponse struct {
	// Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment
	ManagedCertificate
}

ManagedCertificatesClientGetResponse contains the response from method ManagedCertificatesClient.Get.

type ManagedCertificatesClientListOptions 

type ManagedCertificatesClientListOptions struct {
}

ManagedCertificatesClientListOptions contains the optional parameters for the ManagedCertificatesClient.NewListPager method.

type ManagedCertificatesClientListResponse 

type ManagedCertificatesClientListResponse struct {
	// Collection of Managed Certificates.
	ManagedCertificateCollection
}

ManagedCertificatesClientListResponse contains the response from method ManagedCertificatesClient.NewListPager.

type ManagedCertificatesClientUpdateOptions 

type ManagedCertificatesClientUpdateOptions struct {
}

ManagedCertificatesClientUpdateOptions contains the optional parameters for the ManagedCertificatesClient.Update method.

type ManagedCertificatesClientUpdateResponse 

type ManagedCertificatesClientUpdateResponse struct {
	// Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment
	ManagedCertificate
}

ManagedCertificatesClientUpdateResponse contains the response from method ManagedCertificatesClient.Update.

type ManagedEnvironment 

type ManagedEnvironment struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Managed identities for the Managed Environment to interact with other Azure services without maintaining any secrets or
	// credentials in code.
	Identity *ManagedServiceIdentity

	// Kind of the Environment.
	Kind *string

	// Managed environment resource specific properties
	Properties *ManagedEnvironmentProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironment.

type ManagedEnvironmentDiagnosticsClient 

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

ManagedEnvironmentDiagnosticsClient contains the methods for the ManagedEnvironmentDiagnostics group. Don't use this type directly, use NewManagedEnvironmentDiagnosticsClient() instead.

func NewManagedEnvironmentDiagnosticsClient 

func NewManagedEnvironmentDiagnosticsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedEnvironmentDiagnosticsClient, error)

NewManagedEnvironmentDiagnosticsClient creates a new instance of ManagedEnvironmentDiagnosticsClient with the specified values.

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

func (*ManagedEnvironmentDiagnosticsClient) GetDetector 

func (client *ManagedEnvironmentDiagnosticsClient) GetDetector(ctx context.Context, resourceGroupName string, environmentName string, detectorName string, options *ManagedEnvironmentDiagnosticsClientGetDetectorOptions) (ManagedEnvironmentDiagnosticsClientGetDetectorResponse, error)

GetDetector - Get the diagnostics data for a Managed Environment used to host container apps. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • detectorName - Name of the Managed Environment detector.
  • options - ManagedEnvironmentDiagnosticsClientGetDetectorOptions contains the optional parameters for the ManagedEnvironmentDiagnosticsClient.GetDetector method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json 

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.NewManagedEnvironmentDiagnosticsClient().GetDetector(ctx, "mikono-workerapp-test-rg", "mikonokubeenv", "ManagedEnvAvailabilityMetrics", 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.Diagnostics = armappcontainers.Diagnostics{
// 	Name: to.Ptr("ManagedEnvAvailabilityMetrics"),
// 	Type: to.Ptr("Microsoft.App/managedEnvironments/detectors"),
// 	ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics"),
// 	Properties: &armappcontainers.DiagnosticsProperties{
// 		Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
// 			{
// 				RenderingProperties: &armappcontainers.DiagnosticRendering{
// 					Type: to.Ptr[int32](8),
// 					Description: to.Ptr(""),
// 					IsVisible: to.Ptr(true),
// 					Title: to.Ptr("Managed Environment Network Inbound "),
// 				},
// 				Table: &armappcontainers.DiagnosticDataTableResponseObject{
// 					Columns: []*armappcontainers.DiagnosticDataTableResponseColumn{
// 						{
// 							ColumnName: to.Ptr("TimeStamp"),
// 							DataType: to.Ptr("DateTime"),
// 						},
// 						{
// 							ColumnName: to.Ptr("Metric"),
// 							DataType: to.Ptr("String"),
// 						},
// 						{
// 							ColumnName: to.Ptr("Average"),
// 							DataType: to.Ptr("Double"),
// 					}},
// 					Rows: []any{
// 						[]any{
// 							"2022-03-15T21:35:00",
// 							"RxBytes",
// 							float64(0),
// 					}},
// 					TableName: to.Ptr(""),
// 				},
// 		}},
// 		Metadata: &armappcontainers.DiagnosticsDefinition{
// 			Name: to.Ptr("Managed Env Netowrk Inbound and Outbound"),
// 			Type: to.Ptr("Detector"),
// 			Description: to.Ptr("This detector shows the Managed Environment Network Inbound and Outbound."),
// 			Author: to.Ptr(""),
// 			Category: to.Ptr("Availability and Performance"),
// 			ID: to.Ptr("ManagedEnvAvailabilityMetrics"),
// 			Score: to.Ptr[float32](0),
// 			SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
// 			},
// 		},
// 		Status: &armappcontainers.DiagnosticsStatus{
// 			StatusID: to.Ptr[int32](3),
// 		},
// 	},
// }

Output:

func (*ManagedEnvironmentDiagnosticsClient) ListDetectors 

func (client *ManagedEnvironmentDiagnosticsClient) ListDetectors(ctx context.Context, resourceGroupName string, environmentName string, options *ManagedEnvironmentDiagnosticsClientListDetectorsOptions) (ManagedEnvironmentDiagnosticsClientListDetectorsResponse, error)

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

Generated from API version 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • options - ManagedEnvironmentDiagnosticsClientListDetectorsOptions contains the optional parameters for the ManagedEnvironmentDiagnosticsClient.ListDetectors method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentDiagnostics_List.json 

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.NewManagedEnvironmentDiagnosticsClient().ListDetectors(ctx, "mikono-workerapp-test-rg", "mikonokubeenv", 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.DiagnosticsCollection = armappcontainers.DiagnosticsCollection{
// 	Value: []*armappcontainers.Diagnostics{
// 		{
// 			Name: to.Ptr("ManagedEnvAvailabilityMetrics"),
// 			Type: to.Ptr("Microsoft.App/managedEnvironments/detectors"),
// 			ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics"),
// 			Properties: &armappcontainers.DiagnosticsProperties{
// 				Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
// 				},
// 				Metadata: &armappcontainers.DiagnosticsDefinition{
// 					Name: to.Ptr("Availability Metrics for Managed Environments"),
// 					Type: to.Ptr("Analysis"),
// 					Author: to.Ptr(""),
// 					Category: to.Ptr("Availability and Performance"),
// 					ID: to.Ptr("ManagedEnvAvailabilityMetrics"),
// 					Score: to.Ptr[float32](0),
// 					SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
// 					},
// 				},
// 				Status: &armappcontainers.DiagnosticsStatus{
// 					StatusID: to.Ptr[int32](4),
// 				},
// 			},
// 	}},
// }

Output:

type ManagedEnvironmentDiagnosticsClientGetDetectorOptions 

type ManagedEnvironmentDiagnosticsClientGetDetectorOptions struct {
}

ManagedEnvironmentDiagnosticsClientGetDetectorOptions contains the optional parameters for the ManagedEnvironmentDiagnosticsClient.GetDetector method.

type ManagedEnvironmentDiagnosticsClientGetDetectorResponse 

type ManagedEnvironmentDiagnosticsClientGetDetectorResponse struct {
	// Diagnostics data for a resource.
	Diagnostics
}

ManagedEnvironmentDiagnosticsClientGetDetectorResponse contains the response from method ManagedEnvironmentDiagnosticsClient.GetDetector.

type ManagedEnvironmentDiagnosticsClientListDetectorsOptions 

type ManagedEnvironmentDiagnosticsClientListDetectorsOptions struct {
}

ManagedEnvironmentDiagnosticsClientListDetectorsOptions contains the optional parameters for the ManagedEnvironmentDiagnosticsClient.ListDetectors method.

type ManagedEnvironmentDiagnosticsClientListDetectorsResponse 

type ManagedEnvironmentDiagnosticsClientListDetectorsResponse struct {
	// Diagnostics data collection for a resource.
	DiagnosticsCollection
}

ManagedEnvironmentDiagnosticsClientListDetectorsResponse contains the response from method ManagedEnvironmentDiagnosticsClient.ListDetectors.

type ManagedEnvironmentProperties 

type ManagedEnvironmentProperties struct {
	// Environment level Application Insights configuration
	AppInsightsConfiguration *AppInsightsConfiguration

	// Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics"
	// is supported
	AppLogsConfiguration *AppLogsConfiguration

	// Custom domain configuration for the environment
	CustomDomainConfiguration *CustomDomainConfiguration

	// Application Insights connection string used by Dapr to export Service to Service communication telemetry
	DaprAIConnectionString *string

	// Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
	DaprAIInstrumentationKey *string

	// The configuration of Dapr component.
	DaprConfiguration *DaprConfiguration

	// Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a
	// subnet ID is provided, this resource group will be created in the same
	// subscription as the subnet.
	InfrastructureResourceGroup *string

	// The configuration of Keda component.
	KedaConfiguration *KedaConfiguration

	// Environment Open Telemetry configuration
	OpenTelemetryConfiguration *OpenTelemetryConfiguration

	// Peer authentication settings for the Managed Environment
	PeerAuthentication *ManagedEnvironmentPropertiesPeerAuthentication

	// Vnet configuration for the environment
	VnetConfiguration *VnetConfiguration

	// Workload profiles configured for the Managed Environment.
	WorkloadProfiles []*WorkloadProfile

	// Whether or not this Managed Environment is zone-redundant.
	ZoneRedundant *bool

	// READ-ONLY; Default Domain Name for the cluster
	DefaultDomain *string

	// READ-ONLY; Any errors that occurred during deployment or deployment validation
	DeploymentErrors *string

	// READ-ONLY; The endpoint of the eventstream of the Environment.
	EventStreamEndpoint *string

	// READ-ONLY; Provisioning state of the Environment.
	ProvisioningState *EnvironmentProvisioningState

	// READ-ONLY; Static IP of the Environment
	StaticIP *string
}

ManagedEnvironmentProperties - Managed environment resource specific properties

func (ManagedEnvironmentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentProperties.

func (*ManagedEnvironmentProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentProperties.

type ManagedEnvironmentPropertiesPeerAuthentication 

type ManagedEnvironmentPropertiesPeerAuthentication struct {
	// Mutual TLS authentication settings for the Managed Environment
	Mtls *Mtls
}

ManagedEnvironmentPropertiesPeerAuthentication - Peer authentication settings for the Managed Environment

func (ManagedEnvironmentPropertiesPeerAuthentication) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentPropertiesPeerAuthentication.

func (*ManagedEnvironmentPropertiesPeerAuthentication) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentPropertiesPeerAuthentication.

type ManagedEnvironmentStorage 

type ManagedEnvironmentStorage struct {
	// Storage properties
	Properties *ManagedEnvironmentStorageProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ManagedEnvironmentStorage - Storage resource for managedEnvironment.

func (ManagedEnvironmentStorage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentStorage.

func (*ManagedEnvironmentStorage) UnmarshalJSON 

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

	// NFS Azure file properties
	NfsAzureFile *NfsAzureFileProperties
}

ManagedEnvironmentStorageProperties - Storage properties

func (ManagedEnvironmentStorageProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentStorageProperties.

func (*ManagedEnvironmentStorageProperties) UnmarshalJSON 

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
}

ManagedEnvironmentStoragesCollection - Collection of Storage for Environments

func (ManagedEnvironmentStoragesCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentStoragesCollection.

func (*ManagedEnvironmentStoragesCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentStoragesCollection.

type ManagedEnvironmentUsagesClient 

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

ManagedEnvironmentUsagesClient contains the methods for the ManagedEnvironmentUsages group. Don't use this type directly, use NewManagedEnvironmentUsagesClient() instead.

func NewManagedEnvironmentUsagesClient 

func NewManagedEnvironmentUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedEnvironmentUsagesClient, error)

NewManagedEnvironmentUsagesClient creates a new instance of ManagedEnvironmentUsagesClient with the specified values.

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

func (*ManagedEnvironmentUsagesClient) NewListPager 

func (client *ManagedEnvironmentUsagesClient) NewListPager(resourceGroupName string, environmentName string, options *ManagedEnvironmentUsagesClientListOptions) *runtime.Pager[ManagedEnvironmentUsagesClientListResponse]

NewListPager - Gets the current usage information as well as the limits for environment.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentUsages_List.json 

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.NewManagedEnvironmentUsagesClient().NewListPager("examplerg", "jlaw-demo1", 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.ListUsagesResult = armappcontainers.ListUsagesResult{
	// 	Value: []*armappcontainers.Usage{
	// 		{
	// 			Name: &armappcontainers.UsageName{
	// 				LocalizedValue: to.Ptr("Managed Environment Consumption Cores"),
	// 				Value: to.Ptr("ManagedEnvironmentConsumptionCores"),
	// 			},
	// 			CurrentValue: to.Ptr[float32](0.5),
	// 			Limit: to.Ptr[float32](10),
	// 			Unit: to.Ptr("Count"),
	// 	}},
	// }
}

Output:

type ManagedEnvironmentUsagesClientListOptions 

type ManagedEnvironmentUsagesClientListOptions struct {
}

ManagedEnvironmentUsagesClientListOptions contains the optional parameters for the ManagedEnvironmentUsagesClient.NewListPager method.

type ManagedEnvironmentUsagesClientListResponse 

type ManagedEnvironmentUsagesClientListResponse struct {
	ListUsagesResult
}

ManagedEnvironmentUsagesClientListResponse contains the response from method ManagedEnvironmentUsagesClient.NewListPager.

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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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 (CreateEnvironmentWithCustomInfrastructureResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json 

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"),
			},
		},
		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
			CertificatePassword: to.Ptr("1234"),
			CertificateValue:    []byte("Y2VydA=="),
			DNSSuffix:           to.Ptr("www.my-name.com"),
		},
		DaprAIConnectionString:      to.Ptr("InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/"),
		InfrastructureResourceGroup: to.Ptr("myInfrastructureRgName"),
		VnetConfiguration: &armappcontainers.VnetConfiguration{
			InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
		},
		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
			{
				Name:                to.Ptr("My-GP-01"),
				MaximumCount:        to.Ptr[int32](12),
				MinimumCount:        to.Ptr[int32](3),
				WorkloadProfileType: to.Ptr("GeneralPurpose"),
			},
			{
				Name:                to.Ptr("My-MO-01"),
				MaximumCount:        to.Ptr[int32](6),
				MinimumCount:        to.Ptr[int32](3),
				WorkloadProfileType: to.Ptr("MemoryOptimized"),
			},
			{
				Name:                to.Ptr("My-CO-01"),
				MaximumCount:        to.Ptr[int32](6),
				MinimumCount:        to.Ptr[int32](3),
				WorkloadProfileType: to.Ptr("ComputeOptimized"),
			},
			{
				Name:                to.Ptr("My-consumption-01"),
				WorkloadProfileType: to.Ptr("Consumption"),
			}},
		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"),
// 			},
// 		},
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DefaultDomain: to.Ptr("testcontainerenv.k4apps.io"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		InfrastructureResourceGroup: to.Ptr("myInfrastructureRgName"),
// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("1.2.3.4"),
// 		VnetConfiguration: &armappcontainers.VnetConfiguration{
// 			InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
// 		},
// 		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
// 			{
// 				Name: to.Ptr("My-GP-01"),
// 				MaximumCount: to.Ptr[int32](12),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("GeneralPurpose"),
// 			},
// 			{
// 				Name: to.Ptr("My-MO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("MemoryOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-CO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("ComputeOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-consumption-01"),
// 				WorkloadProfileType: to.Ptr("Consumption"),
// 		}},
// 		ZoneRedundant: to.Ptr(true),
// 	},
// }

Output:
Example (CreateEnvironments)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json 

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"),
	Identity: &armappcontainers.ManagedServiceIdentity{
		Type: to.Ptr(armappcontainers.ManagedServiceIdentityType("SystemAssigned, UserAssigned")),
		UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {},
		},
	},
	Properties: &armappcontainers.ManagedEnvironmentProperties{
		AppInsightsConfiguration: &armappcontainers.AppInsightsConfiguration{
			ConnectionString: to.Ptr("InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://eastus-8.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/"),
		},
		AppLogsConfiguration: &armappcontainers.AppLogsConfiguration{
			LogAnalyticsConfiguration: &armappcontainers.LogAnalyticsConfiguration{
				CustomerID:         to.Ptr("string"),
				DynamicJSONColumns: to.Ptr(true),
				SharedKey:          to.Ptr("string"),
			},
		},
		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
			CertificatePassword: to.Ptr("1234"),
			CertificateValue:    []byte("Y2VydA=="),
			DNSSuffix:           to.Ptr("www.my-name.com"),
		},
		DaprAIConnectionString: to.Ptr("InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/"),
		OpenTelemetryConfiguration: &armappcontainers.OpenTelemetryConfiguration{
			DestinationsConfiguration: &armappcontainers.DestinationsConfiguration{
				DataDogConfiguration: &armappcontainers.DataDogConfiguration{
					Key:  to.Ptr("000000000000000000000000"),
					Site: to.Ptr("string"),
				},
				OtlpConfigurations: []*armappcontainers.OtlpConfiguration{
					{
						Name:     to.Ptr("dashboard"),
						Endpoint: to.Ptr("dashboard.k8s.region.azurecontainerapps.io:80"),
						Headers: []*armappcontainers.Header{
							{
								Key:   to.Ptr("api-key"),
								Value: to.Ptr("xxxxxxxxxxx"),
							}},
						Insecure: to.Ptr(true),
					}},
			},
			LogsConfiguration: &armappcontainers.LogsConfiguration{
				Destinations: []*string{
					to.Ptr("appInsights")},
			},
			MetricsConfiguration: &armappcontainers.MetricsConfiguration{
				Destinations: []*string{
					to.Ptr("dataDog")},
			},
			TracesConfiguration: &armappcontainers.TracesConfiguration{
				Destinations: []*string{
					to.Ptr("appInsights")},
			},
		},
		PeerAuthentication: &armappcontainers.ManagedEnvironmentPropertiesPeerAuthentication{
			Mtls: &armappcontainers.Mtls{
				Enabled: to.Ptr(true),
			},
		},
		VnetConfiguration: &armappcontainers.VnetConfiguration{
			InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
		},
		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
			{
				Name:                to.Ptr("My-GP-01"),
				MaximumCount:        to.Ptr[int32](12),
				MinimumCount:        to.Ptr[int32](3),
				WorkloadProfileType: to.Ptr("GeneralPurpose"),
			},
			{
				Name:                to.Ptr("My-MO-01"),
				MaximumCount:        to.Ptr[int32](6),
				MinimumCount:        to.Ptr[int32](3),
				WorkloadProfileType: to.Ptr("MemoryOptimized"),
			},
			{
				Name:                to.Ptr("My-CO-01"),
				MaximumCount:        to.Ptr[int32](6),
				MinimumCount:        to.Ptr[int32](3),
				WorkloadProfileType: to.Ptr("ComputeOptimized"),
			},
			{
				Name:                to.Ptr("My-consumption-01"),
				WorkloadProfileType: to.Ptr("Consumption"),
			}},
		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"),
// 	Identity: &armappcontainers.ManagedServiceIdentity{
// 		Type: to.Ptr(armappcontainers.ManagedServiceIdentityType("SystemAssigned, UserAssigned")),
// 		PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		UserAssignedIdentities: map[string]*armappcontainers.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": &armappcontainers.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	Properties: &armappcontainers.ManagedEnvironmentProperties{
// 		AppLogsConfiguration: &armappcontainers.AppLogsConfiguration{
// 			LogAnalyticsConfiguration: &armappcontainers.LogAnalyticsConfiguration{
// 				CustomerID: to.Ptr("string"),
// 				DynamicJSONColumns: to.Ptr(true),
// 			},
// 		},
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DefaultDomain: to.Ptr("testcontainerenv.k4apps.io"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		InfrastructureResourceGroup: to.Ptr("capp-svc-testcontainerenv-eastus"),
// 		OpenTelemetryConfiguration: &armappcontainers.OpenTelemetryConfiguration{
// 			DestinationsConfiguration: &armappcontainers.DestinationsConfiguration{
// 				DataDogConfiguration: &armappcontainers.DataDogConfiguration{
// 					Site: to.Ptr("datadoghq.com"),
// 				},
// 				OtlpConfigurations: []*armappcontainers.OtlpConfiguration{
// 					{
// 						Name: to.Ptr("dashboard"),
// 						Endpoint: to.Ptr("dashboard.k8s.region.azurecontainerapps.io:80"),
// 						Insecure: to.Ptr(true),
// 				}},
// 			},
// 			LogsConfiguration: &armappcontainers.LogsConfiguration{
// 				Destinations: []*string{
// 					to.Ptr("appInsights")},
// 				},
// 				MetricsConfiguration: &armappcontainers.MetricsConfiguration{
// 					Destinations: []*string{
// 						to.Ptr("dataDog")},
// 					},
// 					TracesConfiguration: &armappcontainers.TracesConfiguration{
// 						Destinations: []*string{
// 							to.Ptr("appInsights")},
// 						},
// 					},
// 					PeerAuthentication: &armappcontainers.ManagedEnvironmentPropertiesPeerAuthentication{
// 						Mtls: &armappcontainers.Mtls{
// 							Enabled: to.Ptr(true),
// 						},
// 					},
// 					ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
// 					StaticIP: to.Ptr("1.2.3.4"),
// 					VnetConfiguration: &armappcontainers.VnetConfiguration{
// 						InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
// 					},
// 					WorkloadProfiles: []*armappcontainers.WorkloadProfile{
// 						{
// 							Name: to.Ptr("My-GP-01"),
// 							MaximumCount: to.Ptr[int32](12),
// 							MinimumCount: to.Ptr[int32](3),
// 							WorkloadProfileType: to.Ptr("GeneralPurpose"),
// 						},
// 						{
// 							Name: to.Ptr("My-MO-01"),
// 							MaximumCount: to.Ptr[int32](6),
// 							MinimumCount: to.Ptr[int32](3),
// 							WorkloadProfileType: to.Ptr("MemoryOptimized"),
// 						},
// 						{
// 							Name: to.Ptr("My-CO-01"),
// 							MaximumCount: to.Ptr[int32](6),
// 							MinimumCount: to.Ptr[int32](3),
// 							WorkloadProfileType: to.Ptr("ComputeOptimized"),
// 						},
// 						{
// 							Name: to.Ptr("My-consumption-01"),
// 							WorkloadProfileType: to.Ptr("Consumption"),
// 					}},
// 					ZoneRedundant: to.Ptr(true),
// 				},
// 			}

Output:

func (*ManagedEnvironmentsClient) BeginDelete 

func (client *ManagedEnvironmentsClient) BeginDelete(ctx context.Context, resourceGroupName string, environmentName string, options *ManagedEnvironmentsClientBeginDeleteOptions) (*runtime.Poller[ManagedEnvironmentsClientDeleteResponse], error)

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_Delete.json 

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_Patch.json 

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)
}
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("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{
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("20.42.33.145"),
// 		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
// 			{
// 				Name: to.Ptr("My-GP-01"),
// 				MaximumCount: to.Ptr[int32](12),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("GeneralPurpose"),
// 			},
// 			{
// 				Name: to.Ptr("My-MO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("MemoryOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-CO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("ComputeOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-consumption-01"),
// 				WorkloadProfileType: to.Ptr("Consumption"),
// 		}},
// 		ZoneRedundant: to.Ptr(true),
// 	},
// }

Output:

func (*ManagedEnvironmentsClient) Get 

func (client *ManagedEnvironmentsClient) Get(ctx context.Context, resourceGroupName string, environmentName string, options *ManagedEnvironmentsClientGetOptions) (ManagedEnvironmentsClientGetResponse, error)

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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_Get.json 

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{
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DaprConfiguration: &armappcontainers.DaprConfiguration{
// 			Version: to.Ptr("1.9"),
// 		},
// 		DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
// 		KedaConfiguration: &armappcontainers.KedaConfiguration{
// 			Version: to.Ptr("2.8.1"),
// 		},
// 		PeerAuthentication: &armappcontainers.ManagedEnvironmentPropertiesPeerAuthentication{
// 			Mtls: &armappcontainers.Mtls{
// 				Enabled: to.Ptr(true),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("20.42.33.145"),
// 		VnetConfiguration: &armappcontainers.VnetConfiguration{
// 			InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
// 		},
// 		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
// 			{
// 				Name: to.Ptr("My-GP-01"),
// 				MaximumCount: to.Ptr[int32](12),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("GeneralPurpose"),
// 			},
// 			{
// 				Name: to.Ptr("My-MO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("MemoryOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-CO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("ComputeOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-consumption-01"),
// 				WorkloadProfileType: to.Ptr("Consumption"),
// 		}},
// 		ZoneRedundant: to.Ptr(true),
// 	},
// }

Output:

func (*ManagedEnvironmentsClient) GetAuthToken 

func (client *ManagedEnvironmentsClient) GetAuthToken(ctx context.Context, resourceGroupName string, environmentName string, options *ManagedEnvironmentsClientGetAuthTokenOptions) (ManagedEnvironmentsClientGetAuthTokenResponse, error)

GetAuthToken - Checks if resource name is available. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_GetAuthToken.json 

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().GetAuthToken(ctx, "rg", "testenv", 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.EnvironmentAuthToken = armappcontainers.EnvironmentAuthToken{
// 	Name: to.Ptr("testenv"),
// 	Type: to.Ptr("Microsoft.App/environments/accesstoken"),
// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testenv"),
// 	Location: to.Ptr("East US"),
// 	Properties: &armappcontainers.EnvironmentAuthTokenProperties{
// 		Expires: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-14T19:22:50.308Z"); return t}()),
// 		Token: to.Ptr("testToken"),
// 	},
// }

Output:

func (*ManagedEnvironmentsClient) NewListByResourceGroupPager 

func (client *ManagedEnvironmentsClient) NewListByResourceGroupPager(resourceGroupName string, options *ManagedEnvironmentsClientListByResourceGroupOptions) *runtime.Pager[ManagedEnvironmentsClientListByResourceGroupResponse]

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

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json 

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{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
	// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 				InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
	// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("20.42.33.145"),
	// 				VnetConfiguration: &armappcontainers.VnetConfiguration{
	// 					InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
	// 				},
	// 				WorkloadProfiles: []*armappcontainers.WorkloadProfile{
	// 					{
	// 						Name: to.Ptr("My-GP-01"),
	// 						MaximumCount: to.Ptr[int32](12),
	// 						MinimumCount: to.Ptr[int32](3),
	// 						WorkloadProfileType: to.Ptr("GeneralPurpose"),
	// 					},
	// 					{
	// 						Name: to.Ptr("My-MO-01"),
	// 						MaximumCount: to.Ptr[int32](6),
	// 						MinimumCount: to.Ptr[int32](3),
	// 						WorkloadProfileType: to.Ptr("MemoryOptimized"),
	// 					},
	// 					{
	// 						Name: to.Ptr("My-CO-01"),
	// 						MaximumCount: to.Ptr[int32](6),
	// 						MinimumCount: to.Ptr[int32](3),
	// 						WorkloadProfileType: to.Ptr("ComputeOptimized"),
	// 					},
	// 					{
	// 						Name: to.Ptr("My-consumption-01"),
	// 						WorkloadProfileType: to.Ptr("Consumption"),
	// 				}},
	// 				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{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name2.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name2.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("demo1.k4apps.io"),
	// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 				InfrastructureResourceGroup: to.Ptr("capp-svc-demo1-northcentralus"),
	// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("52.142.21.61"),
	// 				VnetConfiguration: &armappcontainers.VnetConfiguration{
	// 					InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
	// 				},
	// 				ZoneRedundant: to.Ptr(true),
	// 			},
	// 	}},
	// }
}

Output:

func (*ManagedEnvironmentsClient) NewListBySubscriptionPager 

func (client *ManagedEnvironmentsClient) NewListBySubscriptionPager(options *ManagedEnvironmentsClientListBySubscriptionOptions) *runtime.Pager[ManagedEnvironmentsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Get all Managed Environments for a subscription.

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_ListBySubscription.json 

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{
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
	// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 				InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
	// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("20.42.33.145"),
	// 				VnetConfiguration: &armappcontainers.VnetConfiguration{
	// 					InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
	// 				},
	// 				WorkloadProfiles: []*armappcontainers.WorkloadProfile{
	// 					{
	// 						Name: to.Ptr("My-GP-01"),
	// 						MaximumCount: to.Ptr[int32](12),
	// 						MinimumCount: to.Ptr[int32](3),
	// 						WorkloadProfileType: to.Ptr("GeneralPurpose"),
	// 					},
	// 					{
	// 						Name: to.Ptr("My-MO-01"),
	// 						MaximumCount: to.Ptr[int32](6),
	// 						MinimumCount: to.Ptr[int32](3),
	// 						WorkloadProfileType: to.Ptr("MemoryOptimized"),
	// 					},
	// 					{
	// 						Name: to.Ptr("My-CO-01"),
	// 						MaximumCount: to.Ptr[int32](6),
	// 						MinimumCount: to.Ptr[int32](3),
	// 						WorkloadProfileType: to.Ptr("ComputeOptimized"),
	// 					},
	// 					{
	// 						Name: to.Ptr("My-consumption-01"),
	// 						WorkloadProfileType: to.Ptr("Consumption"),
	// 				}},
	// 				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{
	// 				AppLogsConfiguration: &armappcontainers.AppLogsConfiguration{
	// 					Destination: to.Ptr("log-analytics"),
	// 					LogAnalyticsConfiguration: &armappcontainers.LogAnalyticsConfiguration{
	// 						CustomerID: to.Ptr("9ccccd4a-268f-4a9a-8d03-9bfe77c3fbd2"),
	// 						DynamicJSONColumns: to.Ptr(true),
	// 					},
	// 				},
	// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 					DNSSuffix: to.Ptr("www.my-name2.com"),
	// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 					SubjectName: to.Ptr("CN=www.my-name2.com"),
	// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 				},
	// 				DefaultDomain: to.Ptr("demo1.k4apps.io"),
	// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 				InfrastructureResourceGroup: to.Ptr("capp-svc-demo1-northcentralus"),
	// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 				StaticIP: to.Ptr("52.142.21.61"),
	// 				VnetConfiguration: &armappcontainers.VnetConfiguration{
	// 					InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
	// 				},
	// 				ZoneRedundant: to.Ptr(true),
	// 			},
	// 	}},
	// }
}

Output:

func (*ManagedEnvironmentsClient) NewListWorkloadProfileStatesPager 

func (client *ManagedEnvironmentsClient) NewListWorkloadProfileStatesPager(resourceGroupName string, environmentName string, options *ManagedEnvironmentsClientListWorkloadProfileStatesOptions) *runtime.Pager[ManagedEnvironmentsClientListWorkloadProfileStatesResponse]

NewListWorkloadProfileStatesPager - Get all workload Profile States for a Managed Environment.

Generated from API version 2023-11-02-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json 

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().NewListWorkloadProfileStatesPager("examplerg", "jlaw-demo1", 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.WorkloadProfileStatesCollection = armappcontainers.WorkloadProfileStatesCollection{
	// 	Value: []*armappcontainers.WorkloadProfileStates{
	// 		{
	// 			Name: to.Ptr("GP1"),
	// 			Type: to.Ptr("/providers/Microsoft.App/workloadProfileStates"),
	// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/workloadProfileStates/GP1"),
	// 			Properties: &armappcontainers.WorkloadProfileStatesProperties{
	// 				CurrentCount: to.Ptr[int32](3),
	// 				MaximumCount: to.Ptr[int32](10),
	// 				MinimumCount: to.Ptr[int32](3),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("MO3"),
	// 			Type: to.Ptr("/providers/Microsoft.App/workloadProfileStates"),
	// 			ID: to.Ptr("/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/workloadProfileStates/MO3"),
	// 			Properties: &armappcontainers.WorkloadProfileStatesProperties{
	// 				CurrentCount: to.Ptr[int32](0),
	// 				MaximumCount: to.Ptr[int32](2),
	// 				MinimumCount: to.Ptr[int32](0),
	// 			},
	// 	}},
	// }
}

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 {
	// An environment for hosting container apps
	ManagedEnvironment
}

ManagedEnvironmentsClientCreateOrUpdateResponse contains the response from method ManagedEnvironmentsClient.BeginCreateOrUpdate.

type ManagedEnvironmentsClientDeleteResponse 

type ManagedEnvironmentsClientDeleteResponse struct {
}

ManagedEnvironmentsClientDeleteResponse contains the response from method ManagedEnvironmentsClient.BeginDelete.

type ManagedEnvironmentsClientGetAuthTokenOptions 

type ManagedEnvironmentsClientGetAuthTokenOptions struct {
}

ManagedEnvironmentsClientGetAuthTokenOptions contains the optional parameters for the ManagedEnvironmentsClient.GetAuthToken method.

type ManagedEnvironmentsClientGetAuthTokenResponse 

type ManagedEnvironmentsClientGetAuthTokenResponse struct {
	// Environment Auth Token.
	EnvironmentAuthToken
}

ManagedEnvironmentsClientGetAuthTokenResponse contains the response from method ManagedEnvironmentsClient.GetAuthToken.

type ManagedEnvironmentsClientGetOptions 

type ManagedEnvironmentsClientGetOptions struct {
}

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

type ManagedEnvironmentsClientGetResponse 

type ManagedEnvironmentsClientGetResponse struct {
	// An environment for hosting container apps
	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 {
	// Collection of Environments
	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 {
	// Collection of Environments
	ManagedEnvironmentsCollection
}

ManagedEnvironmentsClientListBySubscriptionResponse contains the response from method ManagedEnvironmentsClient.NewListBySubscriptionPager.

type ManagedEnvironmentsClientListWorkloadProfileStatesOptions 

type ManagedEnvironmentsClientListWorkloadProfileStatesOptions struct {
}

ManagedEnvironmentsClientListWorkloadProfileStatesOptions contains the optional parameters for the ManagedEnvironmentsClient.NewListWorkloadProfileStatesPager method.

type ManagedEnvironmentsClientListWorkloadProfileStatesResponse 

type ManagedEnvironmentsClientListWorkloadProfileStatesResponse struct {
	// Collection of workloadProfileStates
	WorkloadProfileStatesCollection
}

ManagedEnvironmentsClientListWorkloadProfileStatesResponse contains the response from method ManagedEnvironmentsClient.NewListWorkloadProfileStatesPager.

type ManagedEnvironmentsClientUpdateResponse 

type ManagedEnvironmentsClientUpdateResponse struct {
	// An environment for hosting container apps
	ManagedEnvironment
}

ManagedEnvironmentsClientUpdateResponse contains the response from method ManagedEnvironmentsClient.BeginUpdate.

type ManagedEnvironmentsCollection 

type ManagedEnvironmentsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ManagedEnvironment

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

ManagedEnvironmentsCollection - Collection of Environments

func (ManagedEnvironmentsCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedEnvironmentsCollection.

func (*ManagedEnvironmentsCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedEnvironmentsCollection.

type ManagedEnvironmentsDiagnosticsClient 

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

ManagedEnvironmentsDiagnosticsClient contains the methods for the ManagedEnvironmentsDiagnostics group. Don't use this type directly, use NewManagedEnvironmentsDiagnosticsClient() instead.

func NewManagedEnvironmentsDiagnosticsClient 

func NewManagedEnvironmentsDiagnosticsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedEnvironmentsDiagnosticsClient, error)

NewManagedEnvironmentsDiagnosticsClient creates a new instance of ManagedEnvironmentsDiagnosticsClient with the specified values.

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

func (*ManagedEnvironmentsDiagnosticsClient) GetRoot 

func (client *ManagedEnvironmentsDiagnosticsClient) GetRoot(ctx context.Context, resourceGroupName string, environmentName string, options *ManagedEnvironmentsDiagnosticsClientGetRootOptions) (ManagedEnvironmentsDiagnosticsClientGetRootResponse, error)

GetRoot - 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 2023-11-02-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • environmentName - Name of the Environment.
  • options - ManagedEnvironmentsDiagnosticsClientGetRootOptions contains the optional parameters for the ManagedEnvironmentsDiagnosticsClient.GetRoot method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironments_Get.json 

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.NewManagedEnvironmentsDiagnosticsClient().GetRoot(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{
// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
// 			DNSSuffix: to.Ptr("www.my-name.com"),
// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
// 			SubjectName: to.Ptr("CN=www.my-name.com"),
// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
// 		},
// 		DaprConfiguration: &armappcontainers.DaprConfiguration{
// 			Version: to.Ptr("1.9"),
// 		},
// 		DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
// 		InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
// 		KedaConfiguration: &armappcontainers.KedaConfiguration{
// 			Version: to.Ptr("2.8.1"),
// 		},
// 		PeerAuthentication: &armappcontainers.ManagedEnvironmentPropertiesPeerAuthentication{
// 			Mtls: &armappcontainers.Mtls{
// 				Enabled: to.Ptr(true),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
// 		StaticIP: to.Ptr("20.42.33.145"),
// 		VnetConfiguration: &armappcontainers.VnetConfiguration{
// 			InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
// 		},
// 		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
// 			{
// 				Name: to.Ptr("My-GP-01"),
// 				MaximumCount: to.Ptr[int32](12),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("GeneralPurpose"),
// 			},
// 			{
// 				Name: to.Ptr("My-MO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("MemoryOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-CO-01"),
// 				MaximumCount: to.Ptr[int32](6),
// 				MinimumCount: to.Ptr[int32](3),
// 				WorkloadProfileType: to.Ptr("ComputeOptimized"),
// 			},
// 			{
// 				Name: to.Ptr("My-consumption-01"),
// 				WorkloadProfileType: to.Ptr("Consumption"),
// 		}},
// 		ZoneRedundant: to.Ptr(true),
// 	},
// }

Output:

type ManagedEnvironmentsDiagnosticsClientGetRootOptions 

type ManagedEnvironmentsDiagnosticsClientGetRootOptions struct {
}

ManagedEnvironmentsDiagnosticsClientGetRootOptions contains the optional parameters for the ManagedEnvironmentsDiagnosticsClient.GetRoot method.

type ManagedEnvironmentsDiagnosticsClientGetRootResponse 

type ManagedEnvironmentsDiagnosticsClientGetRootResponse struct {
	// An environment for hosting container apps
	ManagedEnvironment
}

ManagedEnvironmentsDiagnosticsClientGetRootResponse contains the response from method ManagedEnvironmentsDiagnosticsClient.GetRoot.

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. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ManagedEnvironmentsStoragesClient) CreateOrUpdate 

func (client *ManagedEnvironmentsStoragesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, environmentName string, storageName string, storageEnvelope ManagedEnvironmentStorage, options *ManagedEnvironmentsStoragesClientCreateOrUpdateOptions) (ManagedEnvironmentsStoragesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update storage for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • 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 (CreateOrUpdateEnvironmentsStorage)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json 

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:
Example (CreateOrUpdateEnvironmentsStorageForNfsAzureFile)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json 

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{
		NfsAzureFile: &armappcontainers.NfsAzureFileProperties{
			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
			Server:     to.Ptr("server1"),
			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{
// 		NfsAzureFile: &armappcontainers.NfsAzureFileProperties{
// 			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
// 			Server: to.Ptr("server1"),
// 			ShareName: to.Ptr("share1"),
// 		},
// 	},
// }

Output:

func (*ManagedEnvironmentsStoragesClient) Delete 

func (client *ManagedEnvironmentsStoragesClient) Delete(ctx context.Context, resourceGroupName string, environmentName string, storageName string, options *ManagedEnvironmentsStoragesClientDeleteOptions) (ManagedEnvironmentsStoragesClientDeleteResponse, error)

Delete - Delete storage for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentsStorages_Delete.json 

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 

func (client *ManagedEnvironmentsStoragesClient) Get(ctx context.Context, resourceGroupName string, environmentName string, storageName string, options *ManagedEnvironmentsStoragesClientGetOptions) (ManagedEnvironmentsStoragesClientGetResponse, error)

Get - Get storage for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • 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 (GetAEnvironmentsStorage)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentsStorages_Get.json 

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:
Example (GetAEnvironmentsStorageForNfsAzureFile)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json 

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{
// 		NfsAzureFile: &armappcontainers.NfsAzureFileProperties{
// 			AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
// 			Server: to.Ptr("server1"),
// 			ShareName: to.Ptr("share1"),
// 		},
// 	},
// }

Output:

func (*ManagedEnvironmentsStoragesClient) List 

func (client *ManagedEnvironmentsStoragesClient) List(ctx context.Context, resourceGroupName string, environmentName string, options *ManagedEnvironmentsStoragesClientListOptions) (ManagedEnvironmentsStoragesClientListResponse, error)

List - Get all storages for a managedEnvironment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ManagedEnvironmentsStorages_List.json 

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"),
// 				},
// 			},
// 		},
// 		{
// 			Name: to.Ptr("jlaw-demo2"),
// 			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-demo2"),
// 			Properties: &armappcontainers.ManagedEnvironmentStorageProperties{
// 				NfsAzureFile: &armappcontainers.NfsAzureFileProperties{
// 					AccessMode: to.Ptr(armappcontainers.AccessModeReadOnly),
// 					Server: to.Ptr("server1"),
// 					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 {
	// Storage resource for managedEnvironment.
	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 {
	// Storage resource for managedEnvironment.
	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 {
	// Collection of Storage for Environments
	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

	// 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

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string
}

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 

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 MetricsConfiguration 

type MetricsConfiguration struct {
	// Open telemetry metrics destinations
	Destinations []*string
}

MetricsConfiguration - Configuration of Open Telemetry metrics

func (MetricsConfiguration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MetricsConfiguration.

func (*MetricsConfiguration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MetricsConfiguration.

type Mtls 

type Mtls struct {
	// Boolean indicating whether the mutual TLS authentication is enabled
	Enabled *bool
}

Mtls - Configuration properties for mutual TLS authentication

func (Mtls) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Mtls.

func (*Mtls) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Mtls.

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. The value must be an UUID.
  • 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 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Certificates_CheckNameAvailability.json 

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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/ContainerApps_CheckNameAvailability.json 

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 {
	// The check availability result.
	CheckNameAvailabilityResponse
}

NamespacesClientCheckNameAvailabilityResponse contains the response from method NamespacesClient.CheckNameAvailability.

type NfsAzureFileProperties 

type NfsAzureFileProperties struct {
	// Access mode for storage
	AccessMode *AccessMode

	// Server for NFS azure file.
	Server *string

	// NFS Azure file share name.
	ShareName *string
}

NfsAzureFileProperties - NFS Azure File Properties.

func (NfsAzureFileProperties) MarshalJSON 

func (n NfsAzureFileProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NfsAzureFileProperties.

func (*NfsAzureFileProperties) UnmarshalJSON 

func (n *NfsAzureFileProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NfsAzureFileProperties.

type Nonce 

type Nonce struct {
	// The time after the request is made when the nonce should expire.
	NonceExpirationInterval *string

	// false if the nonce should not be validated while completing the login flow; otherwise, true.
	ValidateNonce *bool
}

Nonce - The configuration settings of the nonce used in the login flow.

func (Nonce) MarshalJSON 

func (n Nonce) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Nonce.

func (*Nonce) UnmarshalJSON 

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

	// The method that should be used to authenticate the user.
	Method *string
}

OpenIDConnectClientCredential - The authentication client credentials of the custom Open ID Connect provider.

func (OpenIDConnectClientCredential) MarshalJSON 

func (o OpenIDConnectClientCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectClientCredential.

func (*OpenIDConnectClientCredential) UnmarshalJSON 

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

	// The endpoint that provides the keys necessary to validate the token.
	CertificationURI *string

	// The endpoint that issues the token.
	Issuer *string

	// The endpoint to be used to request a token.
	TokenEndpoint *string

	// The endpoint that contains all the configuration endpoints for the provider.
	WellKnownOpenIDConfiguration *string
}

OpenIDConnectConfig - The configuration settings of the endpoints used for the custom Open ID Connect provider.

func (OpenIDConnectConfig) MarshalJSON 

func (o OpenIDConnectConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectConfig.

func (*OpenIDConnectConfig) UnmarshalJSON 

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

	// A list of the scopes that should be requested while authenticating.
	Scopes []*string
}

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 

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

	// The client id of the custom Open ID Connect provider.
	ClientID *string

	// The configuration settings of the endpoints used for the custom Open ID Connect provider.
	OpenIDConnectConfiguration *OpenIDConnectConfig
}

OpenIDConnectRegistration - The configuration settings of the app registration for the custom Open ID Connect provider.

func (OpenIDConnectRegistration) MarshalJSON 

func (o OpenIDConnectRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenIDConnectRegistration.

func (*OpenIDConnectRegistration) UnmarshalJSON 

func (o *OpenIDConnectRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenIDConnectRegistration.

type OpenTelemetryConfiguration 

type OpenTelemetryConfiguration struct {
	// Open telemetry destinations configuration
	DestinationsConfiguration *DestinationsConfiguration

	// Open telemetry logs configuration
	LogsConfiguration *LogsConfiguration

	// Open telemetry metrics configuration
	MetricsConfiguration *MetricsConfiguration

	// Open telemetry trace configuration
	TracesConfiguration *TracesConfiguration
}

OpenTelemetryConfiguration - Configuration of Open Telemetry

func (OpenTelemetryConfiguration) MarshalJSON 

func (o OpenTelemetryConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenTelemetryConfiguration.

func (*OpenTelemetryConfiguration) UnmarshalJSON 

func (o *OpenTelemetryConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenTelemetryConfiguration.

type OperationDetail 

type OperationDetail struct {
	// Display of the operation
	Display *OperationDisplay

	// Indicates whether the operation is a data action
	IsDataAction *bool

	// Name of the operation
	Name *string

	// Origin of the operation
	Origin *string
}

OperationDetail - Operation detail payload

func (OperationDetail) MarshalJSON 

func (o OperationDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDetail.

func (*OperationDetail) UnmarshalJSON 

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

	// Localized friendly name for the operation
	Operation *string

	// Resource provider of the operation
	Provider *string

	// Resource of the operation
	Resource *string
}

OperationDisplay - Operation display payload

func (OperationDisplay) MarshalJSON 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

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 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available RP operations.

Generated from API version 2023-11-02-preview

  • 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/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Operations_List.json 

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 {
	// Available operations of the service
	AvailableOperations
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OtlpConfiguration 

type OtlpConfiguration struct {
	// The endpoint of otlp configuration
	Endpoint *string

	// Headers of otlp configurations
	Headers []*Header

	// Boolean indicating if otlp configuration is insecure
	Insecure *bool

	// The name of otlp configuration
	Name *string
}

OtlpConfiguration - Configuration of otlp

func (OtlpConfiguration) MarshalJSON 

func (o OtlpConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OtlpConfiguration.

func (*OtlpConfiguration) UnmarshalJSON 

func (o *OtlpConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OtlpConfiguration.

type PreBuildStep 

type PreBuildStep struct {
	// Description of the pre-build step.
	Description *string

	// Http get request to send before the build.
	HTTPGet *HTTPGet

	// List of custom commands to run.
	Scripts []*string
}

PreBuildStep - Model representing a pre-build step.

func (PreBuildStep) MarshalJSON 

func (p PreBuildStep) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PreBuildStep.

func (*PreBuildStep) UnmarshalJSON 

func (p *PreBuildStep) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PreBuildStep.

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

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON 

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON 

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

	// Queue length.
	QueueLength *int32

	// Queue name.
	QueueName *string
}

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 

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

	// The name of the Secret that contains the registry login password
	PasswordSecretRef *string

	// Container Registry Server
	Server *string

	// Container Registry Username
	Username *string
}

RegistryCredentials - Container App Private Registry

func (RegistryCredentials) MarshalJSON 

func (r RegistryCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegistryCredentials.

func (*RegistryCredentials) UnmarshalJSON 

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

	// registry server Url.
	RegistryURL *string

	// registry username.
	RegistryUserName *string
}

RegistryInfo - Container App registry information.

func (RegistryInfo) MarshalJSON 

func (r RegistryInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegistryInfo.

func (*RegistryInfo) UnmarshalJSON 

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Replica - Container App Revision Replica.

func (Replica) MarshalJSON 

func (r Replica) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Replica.

func (*Replica) UnmarshalJSON 

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
}

ReplicaCollection - Container App Revision Replicas collection ARM resource.

func (ReplicaCollection) MarshalJSON 

func (r ReplicaCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicaCollection.

func (*ReplicaCollection) UnmarshalJSON 

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

	// The Name of the Container
	Name *string

	// The container ready status
	Ready *bool

	// The container restart count
	RestartCount *int32

	// The container start status
	Started *bool

	// READ-ONLY; Container exec endpoint
	ExecEndpoint *string

	// READ-ONLY; Log Stream endpoint
	LogStreamEndpoint *string

	// READ-ONLY; Current running state of the container
	RunningState *ContainerAppContainerRunningState

	// READ-ONLY; The details of container current running state
	RunningStateDetails *string
}

ReplicaContainer - Container object under Container App Revision Replica.

func (ReplicaContainer) MarshalJSON 

func (r ReplicaContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicaContainer.

func (*ReplicaContainer) UnmarshalJSON 

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

	// The init containers collection under a replica.
	InitContainers []*ReplicaContainer

	// READ-ONLY; Timestamp describing when the pod was created by controller
	CreatedTime *time.Time

	// READ-ONLY; Current running state of the replica
	RunningState *ContainerAppReplicaRunningState

	// READ-ONLY; The details of replica current running state
	RunningStateDetails *string
}

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

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON 

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Revision - Container App Revision.

func (Revision) MarshalJSON 

func (r Revision) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Revision.

func (*Revision) UnmarshalJSON 

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

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

RevisionCollection - Container App Revisions collection ARM resource.

func (RevisionCollection) MarshalJSON 

func (r RevisionCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RevisionCollection.

func (*RevisionCollection) UnmarshalJSON 

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

	// READ-ONLY; Timestamp describing when the revision was created by controller
	CreatedTime *time.Time

	// READ-ONLY; Fully qualified domain name of the revision
	Fqdn *string

	// READ-ONLY; Current health State of the revision
	HealthState *RevisionHealthState

	// READ-ONLY; Timestamp describing when the revision was last active. Only meaningful when revision is inactive
	LastActiveTime *time.Time

	// READ-ONLY; Optional Field - Platform Error Message
	ProvisioningError *string

	// READ-ONLY; Current provisioning State of the revision
	ProvisioningState *RevisionProvisioningState

	// READ-ONLY; Number of pods currently running for this revision
	Replicas *int32

	// READ-ONLY; Current running state of the revision
	RunningState *RevisionRunningState

	// 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

	// READ-ONLY; Traffic weight assigned to this revision
	TrafficWeight *int32
}

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 RevisionRunningState 

type RevisionRunningState string

RevisionRunningState - Current running state of the revision 

const (
	RevisionRunningStateDegraded   RevisionRunningState = "Degraded"
	RevisionRunningStateFailed     RevisionRunningState = "Failed"
	RevisionRunningStateProcessing RevisionRunningState = "Processing"
	RevisionRunningStateRunning    RevisionRunningState = "Running"
	RevisionRunningStateStopped    RevisionRunningState = "Stopped"
	RevisionRunningStateUnknown    RevisionRunningState = "Unknown"
)

func PossibleRevisionRunningStateValues 

func PossibleRevisionRunningStateValues() []RevisionRunningState

PossibleRevisionRunningStateValues returns the possible values for the RevisionRunningState const type.

type Scale 

type Scale struct {
	// Optional. Maximum number of container replicas. Defaults to 10 if not set.
	MaxReplicas *int32

	// Optional. Minimum number of container replicas.
	MinReplicas *int32

	// Scaling rules.
	Rules []*ScaleRule
}

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 

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

	// Custom scale rule.
	Custom *CustomScaleRule

	// HTTP requests based scaling.
	HTTP *HTTPScaleRule

	// Scale Rule Name
	Name *string

	// Tcp requests based scaling.
	TCP *TCPScaleRule
}

ScaleRule - Container App container scaling rule.

func (ScaleRule) MarshalJSON 

func (s ScaleRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScaleRule.

func (*ScaleRule) UnmarshalJSON 

func (s *ScaleRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScaleRule.

type ScaleRuleAuth 

type ScaleRuleAuth struct {
	// Name of the secret from which to pull the auth params.
	SecretRef *string

	// Trigger Parameter that uses the secret
	TriggerParameter *string
}

ScaleRuleAuth - Auth Secrets for Scale Rule

func (ScaleRuleAuth) MarshalJSON 

func (s ScaleRuleAuth) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScaleRuleAuth.

func (*ScaleRuleAuth) UnmarshalJSON 

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 {
	// Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.
	Identity *string

	// Azure Key Vault URL pointing to the secret referenced by the container app.
	KeyVaultURL *string

	// Secret Name.
	Name *string

	// Secret Value.
	Value *string
}

Secret definition.

func (Secret) MarshalJSON 

func (s Secret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Secret.

func (*Secret) UnmarshalJSON 

func (s *Secret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Secret.

type SecretVolumeItem 

type SecretVolumeItem struct {
	// Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.
	Path *string

	// Name of the Container App secret from which to pull the secret value.
	SecretRef *string
}

SecretVolumeItem - Secret to be added to volume.

func (SecretVolumeItem) MarshalJSON 

func (s SecretVolumeItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretVolumeItem.

func (*SecretVolumeItem) UnmarshalJSON 

func (s *SecretVolumeItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretVolumeItem.

type SecretsCollection 

type SecretsCollection struct {
	// REQUIRED; Collection of resources.
	Value []*ContainerAppSecret
}

SecretsCollection - Container App Secrets Collection ARM resource.

func (SecretsCollection) MarshalJSON 

func (s SecretsCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretsCollection.

func (*SecretsCollection) UnmarshalJSON 

func (s *SecretsCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretsCollection.

type Service 

type Service struct {
	// REQUIRED; Dev ContainerApp service type
	Type *string
}

Service - Container App to be a dev service

func (Service) MarshalJSON 

func (s Service) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Service.

func (*Service) UnmarshalJSON 

func (s *Service) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Service.

type ServiceBind 

type ServiceBind struct {
	// Type of the client to be used to connect to the service
	ClientType *string

	// Customized keys for customizing injected values to the app
	CustomizedKeys map[string]*string

	// Name of the service bind
	Name *string

	// Resource id of the target service
	ServiceID *string
}

ServiceBind - Configuration to bind a ContainerApp to a dev ContainerApp Service

func (ServiceBind) MarshalJSON 

func (s ServiceBind) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceBind.

func (*ServiceBind) UnmarshalJSON 

func (s *ServiceBind) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBind.

type SourceControl 

type SourceControl struct {
	// SourceControl resource specific properties
	Properties *SourceControlProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SourceControl - Container App SourceControl.

func (SourceControl) MarshalJSON 

func (s SourceControl) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControl.

func (*SourceControl) UnmarshalJSON 

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

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

SourceControlCollection - SourceControl collection ARM resource.

func (SourceControlCollection) MarshalJSON 

func (s SourceControlCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlCollection.

func (*SourceControlCollection) UnmarshalJSON 

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

	// 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

	// The repo url which will be integrated to ContainerApp.
	RepoURL *string

	// READ-ONLY; Current provisioning State of the operation
	OperationState *SourceControlOperationState
}

SourceControlProperties - SourceControl resource specific properties

func (SourceControlProperties) MarshalJSON 

func (s SourceControlProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlProperties.

func (*SourceControlProperties) UnmarshalJSON 

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"
	StorageTypeNfsAzureFile StorageType = "NfsAzureFile"
	StorageTypeSecret       StorageType = "Secret"
)

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

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

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 TCPConnectionPool 

type TCPConnectionPool struct {
	// Maximum number of tcp connections allowed
	MaxConnections *int32
}

TCPConnectionPool - Defines parameters for tcp connection pooling

func (TCPConnectionPool) MarshalJSON 

func (t TCPConnectionPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TCPConnectionPool.

func (*TCPConnectionPool) UnmarshalJSON 

func (t *TCPConnectionPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TCPConnectionPool.

type TCPRetryPolicy 

type TCPRetryPolicy struct {
	// Maximum number of attempts to connect to the tcp service
	MaxConnectAttempts *int32
}

TCPRetryPolicy - Policy that defines tcp request retry conditions

func (TCPRetryPolicy) MarshalJSON 

func (t TCPRetryPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TCPRetryPolicy.

func (*TCPRetryPolicy) UnmarshalJSON 

func (t *TCPRetryPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TCPRetryPolicy.

type TCPScaleRule 

type TCPScaleRule struct {
	// Authentication secrets for the tcp scale rule.
	Auth []*ScaleRuleAuth

	// Metadata properties to describe tcp scale rule.
	Metadata map[string]*string
}

TCPScaleRule - Container App container Tcp scaling rule.

func (TCPScaleRule) MarshalJSON 

func (t TCPScaleRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TCPScaleRule.

func (*TCPScaleRule) UnmarshalJSON 

func (t *TCPScaleRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TCPScaleRule.

type Template 

type Template struct {
	// List of container definitions for the Container App.
	Containers []*Container

	// List of specialized containers that run before app containers.
	InitContainers []*InitContainer

	// User friendly suffix that is appended to the revision name
	RevisionSuffix *string

	// Scaling properties for the Container App.
	Scale *Scale

	// List of container app services bound to the app
	ServiceBinds []*ServiceBind

	// Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer.
	// The value zero indicates stop immediately via the kill signal (no opportunity
	// to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected
	// cleanup time for your process. Defaults to 30 seconds.
	TerminationGracePeriodSeconds *int64

	// List of volume definitions for the Container App.
	Volumes []*Volume
}

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 

func (t *Template) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Template.

type TimeoutPolicy 

type TimeoutPolicy struct {
	// Timeout, in seconds, for a request to initiate a connection
	ConnectionTimeoutInSeconds *int32

	// Timeout, in seconds, for a request to respond
	ResponseTimeoutInSeconds *int32
}

TimeoutPolicy - Policy to set request timeouts

func (TimeoutPolicy) MarshalJSON 

func (t TimeoutPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TimeoutPolicy.

func (*TimeoutPolicy) UnmarshalJSON 

func (t *TimeoutPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TimeoutPolicy.

type TokenStore 

type TokenStore struct {
	// The configuration settings of the storage of the tokens if blob storage is used.
	AzureBlobStorage *BlobStorageTokenStore

	// true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default
	// is false.
	Enabled *bool

	// The number of hours after session token expiration that a session token can be used to call the token refresh API. The
	// default is 72 hours.
	TokenRefreshExtensionHours *float64
}

TokenStore - The configuration settings of the token store.

func (TokenStore) MarshalJSON 

func (t TokenStore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TokenStore.

func (*TokenStore) UnmarshalJSON 

func (t *TokenStore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TokenStore.

type TracesConfiguration 

type TracesConfiguration struct {
	// Open telemetry traces destinations
	Destinations []*string
}

TracesConfiguration - Configuration of Open Telemetry traces

func (TracesConfiguration) MarshalJSON 

func (t TracesConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TracesConfiguration.

func (*TracesConfiguration) UnmarshalJSON 

func (t *TracesConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TracesConfiguration.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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 

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

	// Indicates that the traffic weight belongs to a latest stable revision
	LatestRevision *bool

	// Name of a revision
	RevisionName *string

	// Traffic weight assigned to a revision
	Weight *int32
}

TrafficWeight - Traffic weight assigned to a revision

func (TrafficWeight) MarshalJSON 

func (t TrafficWeight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrafficWeight.

func (*TrafficWeight) UnmarshalJSON 

func (t *TrafficWeight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrafficWeight.

type TriggerType 

type TriggerType string

TriggerType - Trigger type of the job 

const (
	TriggerTypeEvent    TriggerType = "Event"
	TriggerTypeManual   TriggerType = "Manual"
	TriggerTypeSchedule TriggerType = "Schedule"
)

func PossibleTriggerTypeValues 

func PossibleTriggerTypeValues() []TriggerType

PossibleTriggerTypeValues returns the possible values for the TriggerType const type.

type Twitter 

type Twitter struct {
	// false if the Twitter provider should not be enabled despite the set registration; otherwise, true.
	Enabled *bool

	// The configuration settings of the app registration for the Twitter provider.
	Registration *TwitterRegistration
}

Twitter - The configuration settings of the Twitter provider.

func (Twitter) MarshalJSON 

func (t Twitter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Twitter.

func (*Twitter) UnmarshalJSON 

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

	// The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
	ConsumerSecretSettingName *string
}

TwitterRegistration - The configuration settings of the app registration for the Twitter provider.

func (TwitterRegistration) MarshalJSON 

func (t TwitterRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TwitterRegistration.

func (*TwitterRegistration) UnmarshalJSON 

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 (
	UnauthenticatedClientActionV2AllowAnonymous      UnauthenticatedClientActionV2 = "AllowAnonymous"
	UnauthenticatedClientActionV2RedirectToLoginPage UnauthenticatedClientActionV2 = "RedirectToLoginPage"
	UnauthenticatedClientActionV2Return401           UnauthenticatedClientActionV2 = "Return401"
	UnauthenticatedClientActionV2Return403           UnauthenticatedClientActionV2 = "Return403"
)

func PossibleUnauthenticatedClientActionV2Values 

func PossibleUnauthenticatedClientActionV2Values() []UnauthenticatedClientActionV2

PossibleUnauthenticatedClientActionV2Values returns the possible values for the UnauthenticatedClientActionV2 const type.

type Usage 

type Usage struct {
	// REQUIRED; The current usage of the resource.
	CurrentValue *float32

	// REQUIRED; The maximum permitted usage of the resource.
	Limit *float32

	// REQUIRED; The name of the type of usage.
	Name *UsageName

	// REQUIRED; An enum describing the unit of usage measurement.
	Unit *string
}

Usage - Describes Compute Resource Usage.

func (Usage) MarshalJSON 

func (u Usage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Usage.

func (*Usage) UnmarshalJSON 

func (u *Usage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Usage.

type UsageName 

type UsageName struct {
	// The localized name of the resource.
	LocalizedValue *string

	// The name of the resource.
	Value *string
}

UsageName - The Usage Names.

func (UsageName) MarshalJSON 

func (u UsageName) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsageName.

func (*UsageName) UnmarshalJSON 

func (u *UsageName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UsageName.

type UsagesClient 

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

UsagesClient contains the methods for the Usages group. Don't use this type directly, use NewUsagesClient() instead.

func NewUsagesClient 

func NewUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UsagesClient, error)

NewUsagesClient creates a new instance of UsagesClient with the specified values.

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

func (*UsagesClient) NewListPager 

func (client *UsagesClient) NewListPager(location string, options *UsagesClientListOptions) *runtime.Pager[UsagesClientListResponse]

NewListPager - Gets, for the specified location, the current resource usage information as well as the limits under the subscription.

Generated from API version 2023-11-02-preview

  • location - The location for which resource usage is queried.
  • options - UsagesClientListOptions contains the optional parameters for the UsagesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d74afb775446d7f0bc1810fdc5a128c56289e854/specification/app/resource-manager/Microsoft.App/preview/2023-11-02-preview/examples/Usages_List.json 

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.NewUsagesClient().NewListPager("westus", 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.ListUsagesResult = armappcontainers.ListUsagesResult{
	// 	Value: []*armappcontainers.Usage{
	// 		{
	// 			Name: &armappcontainers.UsageName{
	// 				LocalizedValue: to.Ptr("ManagedEnvironmentCount"),
	// 				Value: to.Ptr("ManagedEnvironmentCount"),
	// 			},
	// 			CurrentValue: to.Ptr[float32](5),
	// 			Limit: to.Ptr[float32](10),
	// 			Unit: to.Ptr("Count"),
	// 		},
	// 		{
	// 			Name: &armappcontainers.UsageName{
	// 				LocalizedValue: to.Ptr("ManagedEnvironmentCores"),
	// 				Value: to.Ptr("ManagedEnvironmentCores"),
	// 			},
	// 			CurrentValue: to.Ptr[float32](3),
	// 			Limit: to.Ptr[float32](20),
	// 			Unit: to.Ptr("Count"),
	// 	}},
	// }
}

Output:

type UsagesClientListOptions 

type UsagesClientListOptions struct {
}

UsagesClientListOptions contains the optional parameters for the UsagesClient.NewListPager method.

type UsagesClientListResponse 

type UsagesClientListResponse struct {
	ListUsagesResult
}

UsagesClientListResponse contains the response from method UsagesClient.NewListPager.

type UserAssignedIdentity 

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON 

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON 

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

	// Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.
	InfrastructureSubnetID *string

	// Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP
	// resource. They must provide infrastructureSubnetId if enabling this property
	Internal *bool

	// 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

	// An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.
	PlatformReservedDNSIP *string
}

VnetConfiguration - Configuration properties for apps environment to join a Virtual Network

func (VnetConfiguration) MarshalJSON 

func (v VnetConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VnetConfiguration.

func (*VnetConfiguration) UnmarshalJSON 

func (v *VnetConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VnetConfiguration.

type Volume 

type Volume struct {
	// Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string.
	MountOptions *string

	// Volume name.
	Name *string

	// List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.
	Secrets []*SecretVolumeItem

	// Name of storage resource. No need to provide for EmptyDir and Secret.
	StorageName *string

	// Storage type for the volume. If not provided, use EmptyDir.
	StorageType *StorageType
}

Volume definitions for the Container App.

func (Volume) MarshalJSON 

func (v Volume) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Volume.

func (*Volume) UnmarshalJSON 

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

	// Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
	SubPath *string

	// This must match the Name of a Volume.
	VolumeName *string
}

VolumeMount - Volume mount for the Container App.

func (VolumeMount) MarshalJSON 

func (v VolumeMount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeMount.

func (*VolumeMount) UnmarshalJSON 

func (v *VolumeMount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeMount.

type WorkloadProfile 

type WorkloadProfile struct {
	// REQUIRED; Workload profile type for the workloads to run on.
	Name *string

	// REQUIRED; Workload profile type for the workloads to run on.
	WorkloadProfileType *string

	// The maximum capacity.
	MaximumCount *int32

	// The minimum capacity.
	MinimumCount *int32
}

WorkloadProfile - Workload profile to scope container app execution.

func (WorkloadProfile) MarshalJSON 

func (w WorkloadProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadProfile.

func (*WorkloadProfile) UnmarshalJSON 

func (w *WorkloadProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadProfile.

type WorkloadProfileStates 

type WorkloadProfileStates struct {
	// Workload Profile resource specific properties.
	Properties *WorkloadProfileStatesProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

WorkloadProfileStates - Collection of all the workload Profile States for a Managed Environment..

func (WorkloadProfileStates) MarshalJSON 

func (w WorkloadProfileStates) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadProfileStates.

func (*WorkloadProfileStates) UnmarshalJSON 

func (w *WorkloadProfileStates) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadProfileStates.

type WorkloadProfileStatesCollection 

type WorkloadProfileStatesCollection struct {
	// REQUIRED; Collection of resources.
	Value []*WorkloadProfileStates

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

WorkloadProfileStatesCollection - Collection of workloadProfileStates

func (WorkloadProfileStatesCollection) MarshalJSON 

func (w WorkloadProfileStatesCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadProfileStatesCollection.

func (*WorkloadProfileStatesCollection) UnmarshalJSON 

func (w *WorkloadProfileStatesCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadProfileStatesCollection.

type WorkloadProfileStatesProperties 

type WorkloadProfileStatesProperties struct {
	// Current count of nodes.
	CurrentCount *int32

	// Maximum count of nodes.
	MaximumCount *int32

	// Minimum count of instances.
	MinimumCount *int32
}

WorkloadProfileStatesProperties - Workload Profile resource specific properties.

func (WorkloadProfileStatesProperties) MarshalJSON 

func (w WorkloadProfileStatesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadProfileStatesProperties.

func (*WorkloadProfileStatesProperties) UnmarshalJSON 

func (w *WorkloadProfileStatesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadProfileStatesProperties.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.