armappplatform

package module
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Jan 26, 2024 License: MIT Imports: 14 Imported by: 2

README

Azure App Platform Module for Go

PkgGoDev

The armappplatform module provides operations for working with Azure App Platform.

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 App Platform module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure App Platform. 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 App Platform 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 := armappplatform.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 := armappplatform.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.NewAPIPortalCustomDomainsClient()

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 App Platform 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 APIPortalAPITryOutEnabledState 

type APIPortalAPITryOutEnabledState string

APIPortalAPITryOutEnabledState - Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API. 

const (
	APIPortalAPITryOutEnabledStateDisabled APIPortalAPITryOutEnabledState = "Disabled"
	APIPortalAPITryOutEnabledStateEnabled  APIPortalAPITryOutEnabledState = "Enabled"
)

func PossibleAPIPortalAPITryOutEnabledStateValues 

func PossibleAPIPortalAPITryOutEnabledStateValues() []APIPortalAPITryOutEnabledState

PossibleAPIPortalAPITryOutEnabledStateValues returns the possible values for the APIPortalAPITryOutEnabledState const type.

type APIPortalCustomDomainProperties 

type APIPortalCustomDomainProperties struct {
	// The thumbprint of bound certificate.
	Thumbprint *string
}

APIPortalCustomDomainProperties - The properties of custom domain for API portal

func (APIPortalCustomDomainProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalCustomDomainProperties.

func (*APIPortalCustomDomainProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalCustomDomainProperties.

type APIPortalCustomDomainResource 

type APIPortalCustomDomainResource struct {
	// The properties of custom domain for API portal
	Properties *APIPortalCustomDomainProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

APIPortalCustomDomainResource - Custom domain of the API portal

func (APIPortalCustomDomainResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalCustomDomainResource.

func (*APIPortalCustomDomainResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalCustomDomainResource.

type APIPortalCustomDomainResourceCollection 

type APIPortalCustomDomainResourceCollection 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 API portal custom domain resources
	Value []*APIPortalCustomDomainResource
}

APIPortalCustomDomainResourceCollection - Object that includes an array of API portal custom domain resources and a possible link for next set

func (APIPortalCustomDomainResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalCustomDomainResourceCollection.

func (*APIPortalCustomDomainResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalCustomDomainResourceCollection.

type APIPortalCustomDomainsClient 

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

APIPortalCustomDomainsClient contains the methods for the APIPortalCustomDomains group. Don't use this type directly, use NewAPIPortalCustomDomainsClient() instead.

func NewAPIPortalCustomDomainsClient 

func NewAPIPortalCustomDomainsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*APIPortalCustomDomainsClient, error)

NewAPIPortalCustomDomainsClient creates a new instance of APIPortalCustomDomainsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*APIPortalCustomDomainsClient) BeginCreateOrUpdate 

func (client *APIPortalCustomDomainsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, domainName string, apiPortalCustomDomainResource APIPortalCustomDomainResource, options *APIPortalCustomDomainsClientBeginCreateOrUpdateOptions) (*runtime.Poller[APIPortalCustomDomainsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update the API portal custom domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • domainName - The name of the API portal custom domain.
  • apiPortalCustomDomainResource - The API portal custom domain for the create or update operation
  • options - APIPortalCustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the APIPortalCustomDomainsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAPIPortalCustomDomainsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "myDomainName", armappplatform.APIPortalCustomDomainResource{
	Properties: &armappplatform.APIPortalCustomDomainProperties{
		Thumbprint: to.Ptr("*"),
	},
}, 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.APIPortalCustomDomainResource = armappplatform.APIPortalCustomDomainResource{
// 	Name: to.Ptr("myDomainName"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.APIPortalCustomDomainProperties{
// 		Thumbprint: to.Ptr("*"),
// 	},
// }

Output:

func (*APIPortalCustomDomainsClient) BeginDelete 

func (client *APIPortalCustomDomainsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, domainName string, options *APIPortalCustomDomainsClientBeginDeleteOptions) (*runtime.Poller[APIPortalCustomDomainsClientDeleteResponse], error)

BeginDelete - Delete the API portal custom domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • domainName - The name of the API portal custom domain.
  • options - APIPortalCustomDomainsClientBeginDeleteOptions contains the optional parameters for the APIPortalCustomDomainsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAPIPortalCustomDomainsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", "myDomainName", 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 (*APIPortalCustomDomainsClient) Get 

func (client *APIPortalCustomDomainsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, domainName string, options *APIPortalCustomDomainsClientGetOptions) (APIPortalCustomDomainsClientGetResponse, error)

Get - Get the API portal custom domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • domainName - The name of the API portal custom domain.
  • options - APIPortalCustomDomainsClientGetOptions contains the optional parameters for the APIPortalCustomDomainsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAPIPortalCustomDomainsClient().Get(ctx, "myResourceGroup", "myservice", "default", "myDomainName", 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.APIPortalCustomDomainResource = armappplatform.APIPortalCustomDomainResource{
// 	Name: to.Ptr("myDomainName"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomainName"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.APIPortalCustomDomainProperties{
// 		Thumbprint: to.Ptr("*"),
// 	},
// }

Output:

func (*APIPortalCustomDomainsClient) NewListPager 

func (client *APIPortalCustomDomainsClient) NewListPager(resourceGroupName string, serviceName string, apiPortalName string, options *APIPortalCustomDomainsClientListOptions) *runtime.Pager[APIPortalCustomDomainsClientListResponse]

NewListPager - Handle requests to list all API portal custom domains.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • options - APIPortalCustomDomainsClientListOptions contains the optional parameters for the APIPortalCustomDomainsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortalCustomDomains_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAPIPortalCustomDomainsClient().NewListPager("myResourceGroup", "myservice", "default", 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.APIPortalCustomDomainResourceCollection = armappplatform.APIPortalCustomDomainResourceCollection{
	// 	Value: []*armappplatform.APIPortalCustomDomainResource{
	// 		{
	// 			Name: to.Ptr("myDomain"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals/domains"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default/domains/myDomain"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.APIPortalCustomDomainProperties{
	// 				Thumbprint: to.Ptr("*"),
	// 			},
	// 	}},
	// }
}

Output:

type APIPortalCustomDomainsClientBeginCreateOrUpdateOptions 

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

APIPortalCustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the APIPortalCustomDomainsClient.BeginCreateOrUpdate method.

type APIPortalCustomDomainsClientBeginDeleteOptions 

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

APIPortalCustomDomainsClientBeginDeleteOptions contains the optional parameters for the APIPortalCustomDomainsClient.BeginDelete method.

type APIPortalCustomDomainsClientCreateOrUpdateResponse 

type APIPortalCustomDomainsClientCreateOrUpdateResponse struct {
	// Custom domain of the API portal
	APIPortalCustomDomainResource
}

APIPortalCustomDomainsClientCreateOrUpdateResponse contains the response from method APIPortalCustomDomainsClient.BeginCreateOrUpdate.

type APIPortalCustomDomainsClientDeleteResponse 

type APIPortalCustomDomainsClientDeleteResponse struct {
}

APIPortalCustomDomainsClientDeleteResponse contains the response from method APIPortalCustomDomainsClient.BeginDelete.

type APIPortalCustomDomainsClientGetOptions 

type APIPortalCustomDomainsClientGetOptions struct {
}

APIPortalCustomDomainsClientGetOptions contains the optional parameters for the APIPortalCustomDomainsClient.Get method.

type APIPortalCustomDomainsClientGetResponse 

type APIPortalCustomDomainsClientGetResponse struct {
	// Custom domain of the API portal
	APIPortalCustomDomainResource
}

APIPortalCustomDomainsClientGetResponse contains the response from method APIPortalCustomDomainsClient.Get.

type APIPortalCustomDomainsClientListOptions 

type APIPortalCustomDomainsClientListOptions struct {
}

APIPortalCustomDomainsClientListOptions contains the optional parameters for the APIPortalCustomDomainsClient.NewListPager method.

type APIPortalCustomDomainsClientListResponse 

type APIPortalCustomDomainsClientListResponse struct {
	// Object that includes an array of API portal custom domain resources and a possible link for next set
	APIPortalCustomDomainResourceCollection
}

APIPortalCustomDomainsClientListResponse contains the response from method APIPortalCustomDomainsClient.NewListPager.

type APIPortalInstance 

type APIPortalInstance struct {
	// READ-ONLY; Name of the API portal instance
	Name *string

	// READ-ONLY; Status of the API portal instance
	Status *string
}

APIPortalInstance - Collection of instances belong to the API portal

func (APIPortalInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalInstance.

func (*APIPortalInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalInstance.

type APIPortalProperties 

type APIPortalProperties struct {
	// Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests
	// and viewing responses in API portal. When disabled, users cannot try out
	// the API.
	APITryOutEnabledState *APIPortalAPITryOutEnabledState

	// The array of resource Ids of gateway to integrate with API portal.
	GatewayIDs []*string

	// Indicate if only https is allowed.
	HTTPSOnly *bool

	// Indicates whether the API portal exposes endpoint.
	Public *bool

	// Collection of OpenAPI source URL locations.
	SourceUrls []*string

	// Single sign-on related configuration
	SsoProperties *SsoProperties

	// READ-ONLY; Collection of instances belong to API portal.
	Instances []*APIPortalInstance

	// READ-ONLY; State of the API portal.
	ProvisioningState *APIPortalProvisioningState

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *APIPortalResourceRequests

	// READ-ONLY; URL of the API portal, exposed when 'public' is true.
	URL *string
}

APIPortalProperties - API portal properties payload

func (APIPortalProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalProperties.

func (*APIPortalProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalProperties.

type APIPortalProvisioningState 

type APIPortalProvisioningState string

APIPortalProvisioningState - State of the API portal. 

const (
	APIPortalProvisioningStateCreating  APIPortalProvisioningState = "Creating"
	APIPortalProvisioningStateDeleting  APIPortalProvisioningState = "Deleting"
	APIPortalProvisioningStateFailed    APIPortalProvisioningState = "Failed"
	APIPortalProvisioningStateSucceeded APIPortalProvisioningState = "Succeeded"
	APIPortalProvisioningStateUpdating  APIPortalProvisioningState = "Updating"
)

func PossibleAPIPortalProvisioningStateValues 

func PossibleAPIPortalProvisioningStateValues() []APIPortalProvisioningState

PossibleAPIPortalProvisioningStateValues returns the possible values for the APIPortalProvisioningState const type.

type APIPortalResource 

type APIPortalResource struct {
	// API portal properties payload
	Properties *APIPortalProperties

	// Sku of the API portal resource
	SKU *SKU

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

APIPortalResource - API portal resource

func (APIPortalResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalResource.

func (*APIPortalResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalResource.

type APIPortalResourceCollection 

type APIPortalResourceCollection 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 API portal resources
	Value []*APIPortalResource
}

APIPortalResourceCollection - Object that includes an array of API portal resources and a possible link for next set

func (APIPortalResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalResourceCollection.

func (*APIPortalResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalResourceCollection.

type APIPortalResourceRequests 

type APIPortalResourceRequests struct {
	// READ-ONLY; Cpu allocated to each API portal instance
	CPU *string

	// READ-ONLY; Memory allocated to each API portal instance
	Memory *string
}

APIPortalResourceRequests - Resource requests of the API portal

func (APIPortalResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalResourceRequests.

func (*APIPortalResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIPortalResourceRequests.

type APIPortalsClient 

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

APIPortalsClient contains the methods for the APIPortals group. Don't use this type directly, use NewAPIPortalsClient() instead.

func NewAPIPortalsClient 

func NewAPIPortalsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*APIPortalsClient, error)

NewAPIPortalsClient creates a new instance of APIPortalsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*APIPortalsClient) BeginCreateOrUpdate 

func (client *APIPortalsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, apiPortalResource APIPortalResource, options *APIPortalsClientBeginCreateOrUpdateOptions) (*runtime.Poller[APIPortalsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default API portal or update the existing API portal. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • apiPortalResource - The API portal for the create or update operation
  • options - APIPortalsClientBeginCreateOrUpdateOptions contains the optional parameters for the APIPortalsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAPIPortalsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.APIPortalResource{
	Properties: &armappplatform.APIPortalProperties{
		APITryOutEnabledState: to.Ptr(armappplatform.APIPortalAPITryOutEnabledStateEnabled),
		GatewayIDs: []*string{
			to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default")},
		Public: to.Ptr(true),
	},
	SKU: &armappplatform.SKU{
		Name:     to.Ptr("E0"),
		Capacity: to.Ptr[int32](2),
		Tier:     to.Ptr("Enterprise"),
	},
}, 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.APIPortalResource = armappplatform.APIPortalResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.APIPortalProperties{
// 		GatewayIDs: []*string{
// 			to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default")},
// 			Instances: []*armappplatform.APIPortalInstance{
// 				{
// 					Name: to.Ptr("instance1"),
// 					Status: to.Ptr("Running"),
// 				},
// 				{
// 					Name: to.Ptr("instance2"),
// 					Status: to.Ptr("Running"),
// 			}},
// 			ProvisioningState: to.Ptr(armappplatform.APIPortalProvisioningStateSucceeded),
// 			Public: to.Ptr(true),
// 			ResourceRequests: &armappplatform.APIPortalResourceRequests{
// 				CPU: to.Ptr("1"),
// 				Memory: to.Ptr("1G"),
// 			},
// 			URL: to.Ptr("test-url"),
// 		},
// 		SKU: &armappplatform.SKU{
// 			Name: to.Ptr("E0"),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr("Enterprise"),
// 		},
// 	}

Output:

func (*APIPortalsClient) BeginDelete 

func (client *APIPortalsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, options *APIPortalsClientBeginDeleteOptions) (*runtime.Poller[APIPortalsClientDeleteResponse], error)

BeginDelete - Delete the default API portal. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • options - APIPortalsClientBeginDeleteOptions contains the optional parameters for the APIPortalsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAPIPortalsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*APIPortalsClient) Get 

func (client *APIPortalsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, options *APIPortalsClientGetOptions) (APIPortalsClientGetResponse, error)

Get - Get the API portal and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • options - APIPortalsClientGetOptions contains the optional parameters for the APIPortalsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAPIPortalsClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.APIPortalResource = armappplatform.APIPortalResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.APIPortalProperties{
// 		APITryOutEnabledState: to.Ptr(armappplatform.APIPortalAPITryOutEnabledStateEnabled),
// 		GatewayIDs: []*string{
// 			to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default")},
// 			Instances: []*armappplatform.APIPortalInstance{
// 				{
// 					Name: to.Ptr("instance1"),
// 					Status: to.Ptr("Running"),
// 				},
// 				{
// 					Name: to.Ptr("instance2"),
// 					Status: to.Ptr("Running"),
// 			}},
// 			ProvisioningState: to.Ptr(armappplatform.APIPortalProvisioningStateSucceeded),
// 			Public: to.Ptr(true),
// 			ResourceRequests: &armappplatform.APIPortalResourceRequests{
// 				CPU: to.Ptr("1"),
// 				Memory: to.Ptr("1G"),
// 			},
// 			URL: to.Ptr("test-url"),
// 		},
// 		SKU: &armappplatform.SKU{
// 			Name: to.Ptr("E0"),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr("Enterprise"),
// 		},
// 	}

Output:

func (*APIPortalsClient) NewListPager 

func (client *APIPortalsClient) NewListPager(resourceGroupName string, serviceName string, options *APIPortalsClientListOptions) *runtime.Pager[APIPortalsClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - APIPortalsClientListOptions contains the optional parameters for the APIPortalsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAPIPortalsClient().NewListPager("myResourceGroup", "myservice", 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.APIPortalResourceCollection = armappplatform.APIPortalResourceCollection{
	// 	Value: []*armappplatform.APIPortalResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.APIPortalProperties{
	// 				APITryOutEnabledState: to.Ptr(armappplatform.APIPortalAPITryOutEnabledStateEnabled),
	// 				GatewayIDs: []*string{
	// 					to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default")},
	// 					Instances: []*armappplatform.APIPortalInstance{
	// 						{
	// 							Name: to.Ptr("instance1"),
	// 							Status: to.Ptr("Running"),
	// 						},
	// 						{
	// 							Name: to.Ptr("instance2"),
	// 							Status: to.Ptr("Running"),
	// 					}},
	// 					ProvisioningState: to.Ptr(armappplatform.APIPortalProvisioningStateSucceeded),
	// 					Public: to.Ptr(true),
	// 					ResourceRequests: &armappplatform.APIPortalResourceRequests{
	// 						CPU: to.Ptr("1"),
	// 						Memory: to.Ptr("1G"),
	// 					},
	// 					URL: to.Ptr("test-url"),
	// 				},
	// 				SKU: &armappplatform.SKU{
	// 					Name: to.Ptr("E0"),
	// 					Capacity: to.Ptr[int32](2),
	// 					Tier: to.Ptr("Enterprise"),
	// 				},
	// 		}},
	// 	}
}

Output:

func (*APIPortalsClient) ValidateDomain 

func (client *APIPortalsClient) ValidateDomain(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, validatePayload CustomDomainValidatePayload, options *APIPortalsClientValidateDomainOptions) (APIPortalsClientValidateDomainResponse, error)

ValidateDomain - Check the domains are valid as well as not in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apiPortalName - The name of API portal.
  • validatePayload - Custom domain payload to be validated
  • options - APIPortalsClientValidateDomainOptions contains the optional parameters for the APIPortalsClient.ValidateDomain method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_ValidateDomain.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAPIPortalsClient().ValidateDomain(ctx, "myResourceGroup", "myservice", "default", armappplatform.CustomDomainValidatePayload{
	Name: to.Ptr("mydomain.io"),
}, 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.CustomDomainValidateResult = armappplatform.CustomDomainValidateResult{
// 	IsValid: to.Ptr(false),
// 	Message: to.Ptr("Certificate is invalid, please check if it is a self signed cert or if it contains a suitable dns name"),
// }

Output:

type APIPortalsClientBeginCreateOrUpdateOptions 

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

APIPortalsClientBeginCreateOrUpdateOptions contains the optional parameters for the APIPortalsClient.BeginCreateOrUpdate method.

type APIPortalsClientBeginDeleteOptions 

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

APIPortalsClientBeginDeleteOptions contains the optional parameters for the APIPortalsClient.BeginDelete method.

type APIPortalsClientCreateOrUpdateResponse 

type APIPortalsClientCreateOrUpdateResponse struct {
	// API portal resource
	APIPortalResource
}

APIPortalsClientCreateOrUpdateResponse contains the response from method APIPortalsClient.BeginCreateOrUpdate.

type APIPortalsClientDeleteResponse 

type APIPortalsClientDeleteResponse struct {
}

APIPortalsClientDeleteResponse contains the response from method APIPortalsClient.BeginDelete.

type APIPortalsClientGetOptions 

type APIPortalsClientGetOptions struct {
}

APIPortalsClientGetOptions contains the optional parameters for the APIPortalsClient.Get method.

type APIPortalsClientGetResponse 

type APIPortalsClientGetResponse struct {
	// API portal resource
	APIPortalResource
}

APIPortalsClientGetResponse contains the response from method APIPortalsClient.Get.

type APIPortalsClientListOptions 

type APIPortalsClientListOptions struct {
}

APIPortalsClientListOptions contains the optional parameters for the APIPortalsClient.NewListPager method.

type APIPortalsClientListResponse 

type APIPortalsClientListResponse struct {
	// Object that includes an array of API portal resources and a possible link for next set
	APIPortalResourceCollection
}

APIPortalsClientListResponse contains the response from method APIPortalsClient.NewListPager.

type APIPortalsClientValidateDomainOptions 

type APIPortalsClientValidateDomainOptions struct {
}

APIPortalsClientValidateDomainOptions contains the optional parameters for the APIPortalsClient.ValidateDomain method.

type APIPortalsClientValidateDomainResponse 

type APIPortalsClientValidateDomainResponse struct {
	// Validation result for custom domain.
	CustomDomainValidateResult
}

APIPortalsClientValidateDomainResponse contains the response from method APIPortalsClient.ValidateDomain.

type AcceleratorAuthSetting 

type AcceleratorAuthSetting struct {
	// REQUIRED; The type of the auth setting.
	AuthType *string
}

AcceleratorAuthSetting - Auth setting payload.

func (*AcceleratorAuthSetting) GetAcceleratorAuthSetting 

func (a *AcceleratorAuthSetting) GetAcceleratorAuthSetting() *AcceleratorAuthSetting

GetAcceleratorAuthSetting implements the AcceleratorAuthSettingClassification interface for type AcceleratorAuthSetting.

func (AcceleratorAuthSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AcceleratorAuthSetting.

func (*AcceleratorAuthSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AcceleratorAuthSetting.

type AcceleratorAuthSettingClassification 

type AcceleratorAuthSettingClassification interface {
	// GetAcceleratorAuthSetting returns the AcceleratorAuthSetting content of the underlying type.
	GetAcceleratorAuthSetting() *AcceleratorAuthSetting
}

AcceleratorAuthSettingClassification provides polymorphic access to related types. Call the interface's GetAcceleratorAuthSetting() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AcceleratorAuthSetting, *AcceleratorBasicAuthSetting, *AcceleratorPublicSetting, *AcceleratorSSHSetting

type AcceleratorBasicAuthSetting 

type AcceleratorBasicAuthSetting struct {
	// REQUIRED; The type of the auth setting.
	AuthType *string

	// REQUIRED; Username of git repository basic auth.
	Username *string

	// Resource Id of CA certificate for https URL of Git repository.
	CaCertResourceID *string

	// Password of git repository basic auth.
	Password *string
}

AcceleratorBasicAuthSetting - Auth setting for basic auth.

func (*AcceleratorBasicAuthSetting) GetAcceleratorAuthSetting 

func (a *AcceleratorBasicAuthSetting) GetAcceleratorAuthSetting() *AcceleratorAuthSetting

GetAcceleratorAuthSetting implements the AcceleratorAuthSettingClassification interface for type AcceleratorBasicAuthSetting.

func (AcceleratorBasicAuthSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AcceleratorBasicAuthSetting.

func (*AcceleratorBasicAuthSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AcceleratorBasicAuthSetting.

type AcceleratorGitRepository 

type AcceleratorGitRepository struct {
	// REQUIRED; Properties of the auth setting payload.
	AuthSetting AcceleratorAuthSettingClassification

	// REQUIRED; Git repository URL for the accelerator.
	URL *string

	// Git repository branch to be used.
	Branch *string

	// Git repository commit to be used.
	Commit *string

	// Git repository tag to be used.
	GitTag *string

	// Interval for checking for updates to Git or image repository.
	IntervalInSeconds *int32

	// Folder path inside the git repository to consider as the root of the accelerator or fragment.
	SubPath *string
}

func (AcceleratorGitRepository) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AcceleratorGitRepository.

func (*AcceleratorGitRepository) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AcceleratorGitRepository.

type AcceleratorPublicSetting 

type AcceleratorPublicSetting struct {
	// REQUIRED; The type of the auth setting.
	AuthType *string

	// Resource Id of CA certificate for https URL of Git repository.
	CaCertResourceID *string
}

AcceleratorPublicSetting - Auth setting for public url.

func (*AcceleratorPublicSetting) GetAcceleratorAuthSetting 

func (a *AcceleratorPublicSetting) GetAcceleratorAuthSetting() *AcceleratorAuthSetting

GetAcceleratorAuthSetting implements the AcceleratorAuthSettingClassification interface for type AcceleratorPublicSetting.

func (AcceleratorPublicSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AcceleratorPublicSetting.

func (*AcceleratorPublicSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AcceleratorPublicSetting.

type AcceleratorSSHSetting 

type AcceleratorSSHSetting struct {
	// REQUIRED; The type of the auth setting.
	AuthType *string

	// Public SSH Key of git repository.
	HostKey *string

	// SSH Key algorithm of git repository.
	HostKeyAlgorithm *string

	// Private SSH Key algorithm of git repository.
	PrivateKey *string
}

AcceleratorSSHSetting - Auth setting for SSH auth.

func (*AcceleratorSSHSetting) GetAcceleratorAuthSetting 

func (a *AcceleratorSSHSetting) GetAcceleratorAuthSetting() *AcceleratorAuthSetting

GetAcceleratorAuthSetting implements the AcceleratorAuthSettingClassification interface for type AcceleratorSSHSetting.

func (AcceleratorSSHSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AcceleratorSSHSetting.

func (*AcceleratorSSHSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AcceleratorSSHSetting.

type ActionType 

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. 

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ActiveDeploymentCollection 

type ActiveDeploymentCollection struct {
	// Collection of Deployment name.
	ActiveDeploymentNames []*string
}

ActiveDeploymentCollection - Object that includes an array of Deployment resource name and set them as active.

func (ActiveDeploymentCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ActiveDeploymentCollection.

func (*ActiveDeploymentCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveDeploymentCollection.

type ApmProperties 

type ApmProperties struct {
	// REQUIRED; APM Type
	Type *string

	// Non-sensitive properties for the APM
	Properties map[string]*string

	// Sensitive properties for the APM
	Secrets map[string]*string

	// READ-ONLY; State of the APM.
	ProvisioningState *ApmProvisioningState
}

ApmProperties - Properties of an APM

func (ApmProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApmProperties.

func (*ApmProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApmProperties.

type ApmProvisioningState 

type ApmProvisioningState string

ApmProvisioningState - State of the APM. 

const (
	ApmProvisioningStateCanceled  ApmProvisioningState = "Canceled"
	ApmProvisioningStateCreating  ApmProvisioningState = "Creating"
	ApmProvisioningStateDeleting  ApmProvisioningState = "Deleting"
	ApmProvisioningStateFailed    ApmProvisioningState = "Failed"
	ApmProvisioningStateSucceeded ApmProvisioningState = "Succeeded"
	ApmProvisioningStateUpdating  ApmProvisioningState = "Updating"
)

func PossibleApmProvisioningStateValues 

func PossibleApmProvisioningStateValues() []ApmProvisioningState

PossibleApmProvisioningStateValues returns the possible values for the ApmProvisioningState const type.

type ApmReference 

type ApmReference struct {
	// REQUIRED; Resource Id of the APM
	ResourceID *string
}

ApmReference - A reference to the APM

func (ApmReference) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApmReference.

func (*ApmReference) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApmReference.

type ApmResource 

type ApmResource struct {
	// Properties of an APM
	Properties *ApmProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ApmResource - APM Resource object

func (ApmResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApmResource.

func (*ApmResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApmResource.

type ApmResourceCollection 

type ApmResourceCollection 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 APM resources
	Value []*ApmResource
}

ApmResourceCollection - Object that includes an array of APM resources and a possible link for next set

func (ApmResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApmResourceCollection.

func (*ApmResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApmResourceCollection.

type ApmSecretKeys 

type ApmSecretKeys struct {
	// Collection of the keys for the APM sensitive properties
	Value []*string
}

ApmSecretKeys - Keys of APM sensitive properties

func (ApmSecretKeys) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApmSecretKeys.

func (*ApmSecretKeys) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApmSecretKeys.

type ApmsClient 

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

ApmsClient contains the methods for the Apms group. Don't use this type directly, use NewApmsClient() instead.

func NewApmsClient 

func NewApmsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApmsClient, error)

NewApmsClient creates a new instance of ApmsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ApmsClient) BeginCreateOrUpdate 

func (client *ApmsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apmName string, apmResource ApmResource, options *ApmsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ApmsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apmName - The name of the APM
  • apmResource - Parameters for the create or update operation
  • options - ApmsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApmsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewApmsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myappinsights", armappplatform.ApmResource{
	Properties: &armappplatform.ApmProperties{
		Type: to.Ptr("ApplicationInsights"),
		Properties: map[string]*string{
			"any-string":    to.Ptr("any-string"),
			"sampling-rate": to.Ptr("12.0"),
		},
		Secrets: map[string]*string{
			"connection-string": to.Ptr("XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX"),
		},
	},
}, 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.ApmResource = armappplatform.ApmResource{
// 	Name: to.Ptr("myappinsights"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apms"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ApmProperties{
// 		Type: to.Ptr("ApplicationInsights"),
// 		Properties: map[string]*string{
// 			"any-string": to.Ptr("any-string"),
// 			"sampling-rate": to.Ptr("12.0"),
// 		},
// 	},
// }

Output:

func (*ApmsClient) BeginDelete 

func (client *ApmsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, apmName string, options *ApmsClientBeginDeleteOptions) (*runtime.Poller[ApmsClientDeleteResponse], error)

BeginDelete - Operation to delete an APM If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apmName - The name of the APM
  • options - ApmsClientBeginDeleteOptions contains the optional parameters for the ApmsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewApmsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "myappinsights", 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 (*ApmsClient) Get 

func (client *ApmsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apmName string, options *ApmsClientGetOptions) (ApmsClientGetResponse, error)

Get - Get the APM by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apmName - The name of the APM
  • options - ApmsClientGetOptions contains the optional parameters for the ApmsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewApmsClient().Get(ctx, "myResourceGroup", "myservice", "myappinsights", 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.ApmResource = armappplatform.ApmResource{
// 	Name: to.Ptr("myappinsights"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apms"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ApmProperties{
// 		Type: to.Ptr("ApplicationInsights"),
// 		Properties: map[string]*string{
// 			"any-string": to.Ptr("any-string"),
// 			"sampling-rate": to.Ptr("12.0"),
// 		},
// 	},
// }

Output:

func (*ApmsClient) ListSecretKeys 

func (client *ApmsClient) ListSecretKeys(ctx context.Context, resourceGroupName string, serviceName string, apmName string, options *ApmsClientListSecretKeysOptions) (ApmsClientListSecretKeysResponse, error)

ListSecretKeys - List keys of APM sensitive properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apmName - The name of the APM
  • options - ApmsClientListSecretKeysOptions contains the optional parameters for the ApmsClient.ListSecretKeys method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_ListSecretKeys.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewApmsClient().ListSecretKeys(ctx, "myResourceGroup", "myservice", "myappinsights", 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.ApmSecretKeys = armappplatform.ApmSecretKeys{
// 	Value: []*string{
// 		to.Ptr("connection-string")},
// 	}

Output:

func (*ApmsClient) NewListPager 

func (client *ApmsClient) NewListPager(resourceGroupName string, serviceName string, options *ApmsClientListOptions) *runtime.Pager[ApmsClientListResponse]

NewListPager - Get collection of APMs.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ApmsClientListOptions contains the optional parameters for the ApmsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apms_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewApmsClient().NewListPager("myResourceGroup", "myservice", 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.ApmResourceCollection = armappplatform.ApmResourceCollection{
	// 	Value: []*armappplatform.ApmResource{
	// 		{
	// 			Name: to.Ptr("myappinsights"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apms"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ApmProperties{
	// 				Type: to.Ptr("ApplicationInsights"),
	// 				Properties: map[string]*string{
	// 					"any-string": to.Ptr("any-string"),
	// 					"sampling-rate": to.Ptr("12.0"),
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.ApmProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("myappdynamic"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apms"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappdynamic"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ApmProperties{
	// 				Type: to.Ptr("AppDynamics"),
	// 				Properties: map[string]*string{
	// 					"abc": to.Ptr("def"),
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.ApmProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type ApmsClientBeginCreateOrUpdateOptions 

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

ApmsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApmsClient.BeginCreateOrUpdate method.

type ApmsClientBeginDeleteOptions 

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

ApmsClientBeginDeleteOptions contains the optional parameters for the ApmsClient.BeginDelete method.

type ApmsClientCreateOrUpdateResponse 

type ApmsClientCreateOrUpdateResponse struct {
	// APM Resource object
	ApmResource
}

ApmsClientCreateOrUpdateResponse contains the response from method ApmsClient.BeginCreateOrUpdate.

type ApmsClientDeleteResponse 

type ApmsClientDeleteResponse struct {
}

ApmsClientDeleteResponse contains the response from method ApmsClient.BeginDelete.

type ApmsClientGetOptions 

type ApmsClientGetOptions struct {
}

ApmsClientGetOptions contains the optional parameters for the ApmsClient.Get method.

type ApmsClientGetResponse 

type ApmsClientGetResponse struct {
	// APM Resource object
	ApmResource
}

ApmsClientGetResponse contains the response from method ApmsClient.Get.

type ApmsClientListOptions 

type ApmsClientListOptions struct {
}

ApmsClientListOptions contains the optional parameters for the ApmsClient.NewListPager method.

type ApmsClientListResponse 

type ApmsClientListResponse struct {
	// Object that includes an array of APM resources and a possible link for next set
	ApmResourceCollection
}

ApmsClientListResponse contains the response from method ApmsClient.NewListPager.

type ApmsClientListSecretKeysOptions 

type ApmsClientListSecretKeysOptions struct {
}

ApmsClientListSecretKeysOptions contains the optional parameters for the ApmsClient.ListSecretKeys method.

type ApmsClientListSecretKeysResponse 

type ApmsClientListSecretKeysResponse struct {
	// Keys of APM sensitive properties
	ApmSecretKeys
}

ApmsClientListSecretKeysResponse contains the response from method ApmsClient.ListSecretKeys.

type AppResource 

type AppResource struct {
	// The Managed Identity type of the app resource
	Identity *ManagedIdentityProperties

	// The GEO location of the application, always the same with its parent resource
	Location *string

	// Properties of the App resource
	Properties *AppResourceProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

AppResource - App resource payload

func (AppResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppResource.

func (*AppResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResource.

type AppResourceCollection 

type AppResourceCollection 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 App resources
	Value []*AppResource
}

AppResourceCollection - Object that includes an array of App resources and a possible link for next set

func (AppResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppResourceCollection.

func (*AppResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResourceCollection.

type AppResourceProperties 

type AppResourceProperties struct {
	// Collection of addons
	AddonConfigs map[string]any

	// List of custom persistent disks
	CustomPersistentDisks []*CustomPersistentDiskResource

	// Indicate if end to end TLS is enabled.
	EnableEndToEndTLS *bool

	// Indicate if only https is allowed.
	HTTPSOnly *bool

	// App ingress settings payload.
	IngressSettings *IngressSettings

	// Collection of loaded certificates
	LoadedCertificates []*LoadedCertificate

	// Persistent disk settings
	PersistentDisk *PersistentDisk

	// Indicates whether the App exposes public endpoint
	Public *bool

	// Temporary disk settings
	TemporaryDisk *TemporaryDisk

	// Additional App settings in vnet injection instance
	VnetAddons *AppVNetAddons

	// READ-ONLY; Fully qualified dns Name.
	Fqdn *string

	// READ-ONLY; Provisioning state of the App
	ProvisioningState *AppResourceProvisioningState

	// READ-ONLY; URL of the App
	URL *string
}

AppResourceProperties - App resource properties payload

func (AppResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppResourceProperties.

func (*AppResourceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResourceProperties.

type AppResourceProvisioningState 

type AppResourceProvisioningState string

AppResourceProvisioningState - Provisioning state of the App 

const (
	AppResourceProvisioningStateCreating  AppResourceProvisioningState = "Creating"
	AppResourceProvisioningStateDeleting  AppResourceProvisioningState = "Deleting"
	AppResourceProvisioningStateFailed    AppResourceProvisioningState = "Failed"
	AppResourceProvisioningStateSucceeded AppResourceProvisioningState = "Succeeded"
	AppResourceProvisioningStateUpdating  AppResourceProvisioningState = "Updating"
)

func PossibleAppResourceProvisioningStateValues 

func PossibleAppResourceProvisioningStateValues() []AppResourceProvisioningState

PossibleAppResourceProvisioningStateValues returns the possible values for the AppResourceProvisioningState const type.

type AppVNetAddons 

type AppVNetAddons struct {
	// Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.
	PublicEndpoint *bool

	// READ-ONLY; URL of the App in vnet injection instance which could be accessed from internet
	PublicEndpointURL *string
}

AppVNetAddons - Additional App settings in vnet injection instance

func (AppVNetAddons) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AppVNetAddons.

func (*AppVNetAddons) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppVNetAddons.

type ApplicationAcceleratorComponent 

type ApplicationAcceleratorComponent struct {
	ResourceRequests *ApplicationAcceleratorResourceRequests

	// READ-ONLY
	Instances []*ApplicationAcceleratorInstance

	// READ-ONLY
	Name *string
}

func (ApplicationAcceleratorComponent) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationAcceleratorComponent.

func (*ApplicationAcceleratorComponent) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationAcceleratorComponent.

type ApplicationAcceleratorInstance 

type ApplicationAcceleratorInstance struct {
	// READ-ONLY; Name of the Application Accelerator instance.
	Name *string

	// READ-ONLY; Status of the Application Accelerator instance. It can be Pending, Running, Succeeded, Failed, Unknown.
	Status *string
}

func (ApplicationAcceleratorInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationAcceleratorInstance.

func (*ApplicationAcceleratorInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationAcceleratorInstance.

type ApplicationAcceleratorProperties 

type ApplicationAcceleratorProperties struct {
	// READ-ONLY; Collection of components belong to application accelerator.
	Components []*ApplicationAcceleratorComponent

	// READ-ONLY; State of the application accelerator.
	ProvisioningState *ApplicationAcceleratorProvisioningState
}

ApplicationAcceleratorProperties - Application accelerator properties payload

func (ApplicationAcceleratorProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationAcceleratorProperties.

func (*ApplicationAcceleratorProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationAcceleratorProperties.

type ApplicationAcceleratorProvisioningState 

type ApplicationAcceleratorProvisioningState string

ApplicationAcceleratorProvisioningState - State of the application accelerator. 

const (
	ApplicationAcceleratorProvisioningStateCanceled  ApplicationAcceleratorProvisioningState = "Canceled"
	ApplicationAcceleratorProvisioningStateCreating  ApplicationAcceleratorProvisioningState = "Creating"
	ApplicationAcceleratorProvisioningStateDeleting  ApplicationAcceleratorProvisioningState = "Deleting"
	ApplicationAcceleratorProvisioningStateFailed    ApplicationAcceleratorProvisioningState = "Failed"
	ApplicationAcceleratorProvisioningStateSucceeded ApplicationAcceleratorProvisioningState = "Succeeded"
	ApplicationAcceleratorProvisioningStateUpdating  ApplicationAcceleratorProvisioningState = "Updating"
)

func PossibleApplicationAcceleratorProvisioningStateValues 

func PossibleApplicationAcceleratorProvisioningStateValues() []ApplicationAcceleratorProvisioningState

PossibleApplicationAcceleratorProvisioningStateValues returns the possible values for the ApplicationAcceleratorProvisioningState const type.

type ApplicationAcceleratorResource 

type ApplicationAcceleratorResource struct {
	// Application accelerator properties payload
	Properties *ApplicationAcceleratorProperties

	// Sku of the application accelerator resource
	SKU *SKU

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ApplicationAcceleratorResource - Application accelerator resource

func (ApplicationAcceleratorResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationAcceleratorResource.

func (*ApplicationAcceleratorResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationAcceleratorResource.

type ApplicationAcceleratorResourceCollection 

type ApplicationAcceleratorResourceCollection 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 application accelerator resources
	Value []*ApplicationAcceleratorResource
}

ApplicationAcceleratorResourceCollection - Object that includes an array of application accelerator resources and a possible link for next set

func (ApplicationAcceleratorResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationAcceleratorResourceCollection.

func (*ApplicationAcceleratorResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationAcceleratorResourceCollection.

type ApplicationAcceleratorResourceRequests 

type ApplicationAcceleratorResourceRequests struct {
	// READ-ONLY; Cpu allocated to each application accelerator component. 1 core can be represented by 1 or 1000m
	CPU *string

	// READ-ONLY; Instance count of the application accelerator component.
	InstanceCount *int32

	// READ-ONLY; Memory allocated to each application accelerator component. 1 GB can be represented by 1Gi or 1024Mi.
	Memory *string
}

func (ApplicationAcceleratorResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationAcceleratorResourceRequests.

func (*ApplicationAcceleratorResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationAcceleratorResourceRequests.

type ApplicationAcceleratorsClient 

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

ApplicationAcceleratorsClient contains the methods for the ApplicationAccelerators group. Don't use this type directly, use NewApplicationAcceleratorsClient() instead.

func NewApplicationAcceleratorsClient 

func NewApplicationAcceleratorsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationAcceleratorsClient, error)

NewApplicationAcceleratorsClient creates a new instance of ApplicationAcceleratorsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ApplicationAcceleratorsClient) BeginCreateOrUpdate 

func (client *ApplicationAcceleratorsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, applicationAcceleratorResource ApplicationAcceleratorResource, options *ApplicationAcceleratorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ApplicationAcceleratorsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • applicationAcceleratorResource - The application accelerator for the create or update operation
  • options - ApplicationAcceleratorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationAcceleratorsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationAccelerators_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewApplicationAcceleratorsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.ApplicationAcceleratorResource{
	Properties: &armappplatform.ApplicationAcceleratorProperties{},
	SKU: &armappplatform.SKU{
		Name:     to.Ptr("E0"),
		Capacity: to.Ptr[int32](2),
		Tier:     to.Ptr("Enterprise"),
	},
}, 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.ApplicationAcceleratorResource = armappplatform.ApplicationAcceleratorResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ApplicationAcceleratorProperties{
// 		Components: []*armappplatform.ApplicationAcceleratorComponent{
// 			{
// 				Name: to.Ptr("component1"),
// 				Instances: []*armappplatform.ApplicationAcceleratorInstance{
// 					{
// 						Name: to.Ptr("instance1"),
// 						Status: to.Ptr("Running"),
// 				}},
// 				ResourceRequests: &armappplatform.ApplicationAcceleratorResourceRequests{
// 					CPU: to.Ptr("1"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("1Gi"),
// 				},
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ApplicationAcceleratorProvisioningStateSucceeded),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("E0"),
// 		Capacity: to.Ptr[int32](2),
// 		Tier: to.Ptr("Enterprise"),
// 	},
// }

Output:

func (*ApplicationAcceleratorsClient) BeginDelete 

func (client *ApplicationAcceleratorsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, options *ApplicationAcceleratorsClientBeginDeleteOptions) (*runtime.Poller[ApplicationAcceleratorsClientDeleteResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • options - ApplicationAcceleratorsClientBeginDeleteOptions contains the optional parameters for the ApplicationAcceleratorsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationAccelerators_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewApplicationAcceleratorsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*ApplicationAcceleratorsClient) Get 

func (client *ApplicationAcceleratorsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, options *ApplicationAcceleratorsClientGetOptions) (ApplicationAcceleratorsClientGetResponse, error)

Get - Get the application accelerator. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • options - ApplicationAcceleratorsClientGetOptions contains the optional parameters for the ApplicationAcceleratorsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationAccelerators_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewApplicationAcceleratorsClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.ApplicationAcceleratorResource = armappplatform.ApplicationAcceleratorResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ApplicationAcceleratorProperties{
// 		Components: []*armappplatform.ApplicationAcceleratorComponent{
// 			{
// 				Name: to.Ptr("component1"),
// 				Instances: []*armappplatform.ApplicationAcceleratorInstance{
// 					{
// 						Name: to.Ptr("instance1"),
// 						Status: to.Ptr("Running"),
// 				}},
// 				ResourceRequests: &armappplatform.ApplicationAcceleratorResourceRequests{
// 					CPU: to.Ptr("1"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("1Gi"),
// 				},
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ApplicationAcceleratorProvisioningStateSucceeded),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("E0"),
// 		Capacity: to.Ptr[int32](2),
// 		Tier: to.Ptr("Enterprise"),
// 	},
// }

Output:

func (*ApplicationAcceleratorsClient) NewListPager 

func (client *ApplicationAcceleratorsClient) NewListPager(resourceGroupName string, serviceName string, options *ApplicationAcceleratorsClientListOptions) *runtime.Pager[ApplicationAcceleratorsClientListResponse]

NewListPager - Handle requests to list all application accelerator.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ApplicationAcceleratorsClientListOptions contains the optional parameters for the ApplicationAcceleratorsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationAccelerators_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewApplicationAcceleratorsClient().NewListPager("myResourceGroup", "myservice", 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.ApplicationAcceleratorResourceCollection = armappplatform.ApplicationAcceleratorResourceCollection{
	// 	Value: []*armappplatform.ApplicationAcceleratorResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ApplicationAcceleratorProperties{
	// 				Components: []*armappplatform.ApplicationAcceleratorComponent{
	// 					{
	// 						Name: to.Ptr("component1"),
	// 						Instances: []*armappplatform.ApplicationAcceleratorInstance{
	// 							{
	// 								Name: to.Ptr("instance1"),
	// 								Status: to.Ptr("Running"),
	// 						}},
	// 						ResourceRequests: &armappplatform.ApplicationAcceleratorResourceRequests{
	// 							CPU: to.Ptr("1"),
	// 							InstanceCount: to.Ptr[int32](1),
	// 							Memory: to.Ptr("1Gi"),
	// 						},
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.ApplicationAcceleratorProvisioningStateSucceeded),
	// 			},
	// 			SKU: &armappplatform.SKU{
	// 				Name: to.Ptr("E0"),
	// 				Capacity: to.Ptr[int32](2),
	// 				Tier: to.Ptr("Enterprise"),
	// 			},
	// 	}},
	// }
}

Output:

type ApplicationAcceleratorsClientBeginCreateOrUpdateOptions 

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

ApplicationAcceleratorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationAcceleratorsClient.BeginCreateOrUpdate method.

type ApplicationAcceleratorsClientBeginDeleteOptions 

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

ApplicationAcceleratorsClientBeginDeleteOptions contains the optional parameters for the ApplicationAcceleratorsClient.BeginDelete method.

type ApplicationAcceleratorsClientCreateOrUpdateResponse 

type ApplicationAcceleratorsClientCreateOrUpdateResponse struct {
	// Application accelerator resource
	ApplicationAcceleratorResource
}

ApplicationAcceleratorsClientCreateOrUpdateResponse contains the response from method ApplicationAcceleratorsClient.BeginCreateOrUpdate.

type ApplicationAcceleratorsClientDeleteResponse 

type ApplicationAcceleratorsClientDeleteResponse struct {
}

ApplicationAcceleratorsClientDeleteResponse contains the response from method ApplicationAcceleratorsClient.BeginDelete.

type ApplicationAcceleratorsClientGetOptions 

type ApplicationAcceleratorsClientGetOptions struct {
}

ApplicationAcceleratorsClientGetOptions contains the optional parameters for the ApplicationAcceleratorsClient.Get method.

type ApplicationAcceleratorsClientGetResponse 

type ApplicationAcceleratorsClientGetResponse struct {
	// Application accelerator resource
	ApplicationAcceleratorResource
}

ApplicationAcceleratorsClientGetResponse contains the response from method ApplicationAcceleratorsClient.Get.

type ApplicationAcceleratorsClientListOptions 

type ApplicationAcceleratorsClientListOptions struct {
}

ApplicationAcceleratorsClientListOptions contains the optional parameters for the ApplicationAcceleratorsClient.NewListPager method.

type ApplicationAcceleratorsClientListResponse 

type ApplicationAcceleratorsClientListResponse struct {
	// Object that includes an array of application accelerator resources and a possible link for next set
	ApplicationAcceleratorResourceCollection
}

ApplicationAcceleratorsClientListResponse contains the response from method ApplicationAcceleratorsClient.NewListPager.

type ApplicationInsightsAgentVersions 

type ApplicationInsightsAgentVersions struct {
	// READ-ONLY; Indicates the version of application insight java agent
	Java *string
}

ApplicationInsightsAgentVersions - Application Insights agent versions properties payload

func (ApplicationInsightsAgentVersions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationInsightsAgentVersions.

func (*ApplicationInsightsAgentVersions) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationInsightsAgentVersions.

type ApplicationLiveViewComponent 

type ApplicationLiveViewComponent struct {
	// READ-ONLY; Collection of instances belong to Application Live View.
	Instances []*ApplicationLiveViewInstance

	// READ-ONLY; Name of the component.
	Name any

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *ApplicationLiveViewResourceRequests
}

ApplicationLiveViewComponent - Application Live View properties payload

func (ApplicationLiveViewComponent) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationLiveViewComponent.

func (*ApplicationLiveViewComponent) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationLiveViewComponent.

type ApplicationLiveViewInstance 

type ApplicationLiveViewInstance struct {
	// READ-ONLY; Name of the Application Live View instance.
	Name *string

	// READ-ONLY; Status of the Application Live View instance. It can be Pending, Running, Succeeded, Failed, Unknown.
	Status *string
}

ApplicationLiveViewInstance - Collection of instances belong to the Application Live View

func (ApplicationLiveViewInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationLiveViewInstance.

func (*ApplicationLiveViewInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationLiveViewInstance.

type ApplicationLiveViewProperties 

type ApplicationLiveViewProperties struct {
	// READ-ONLY; Component details of Application Live View
	Components []*ApplicationLiveViewComponent

	// READ-ONLY; State of the Application Live View.
	ProvisioningState *ApplicationLiveViewProvisioningState
}

ApplicationLiveViewProperties - Application Live View properties payload

func (ApplicationLiveViewProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationLiveViewProperties.

func (*ApplicationLiveViewProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationLiveViewProperties.

type ApplicationLiveViewProvisioningState 

type ApplicationLiveViewProvisioningState string

ApplicationLiveViewProvisioningState - State of the Application Live View. 

const (
	ApplicationLiveViewProvisioningStateCanceled  ApplicationLiveViewProvisioningState = "Canceled"
	ApplicationLiveViewProvisioningStateCreating  ApplicationLiveViewProvisioningState = "Creating"
	ApplicationLiveViewProvisioningStateDeleting  ApplicationLiveViewProvisioningState = "Deleting"
	ApplicationLiveViewProvisioningStateFailed    ApplicationLiveViewProvisioningState = "Failed"
	ApplicationLiveViewProvisioningStateSucceeded ApplicationLiveViewProvisioningState = "Succeeded"
	ApplicationLiveViewProvisioningStateUpdating  ApplicationLiveViewProvisioningState = "Updating"
)

func PossibleApplicationLiveViewProvisioningStateValues 

func PossibleApplicationLiveViewProvisioningStateValues() []ApplicationLiveViewProvisioningState

PossibleApplicationLiveViewProvisioningStateValues returns the possible values for the ApplicationLiveViewProvisioningState const type.

type ApplicationLiveViewResource 

type ApplicationLiveViewResource struct {
	// Application Live View properties payload
	Properties *ApplicationLiveViewProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ApplicationLiveViewResource - Application Live View resource

func (ApplicationLiveViewResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationLiveViewResource.

func (*ApplicationLiveViewResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationLiveViewResource.

type ApplicationLiveViewResourceCollection 

type ApplicationLiveViewResourceCollection 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 Application Live View resources
	Value []*ApplicationLiveViewResource
}

ApplicationLiveViewResourceCollection - Object that includes an array of Application Live View resources and a possible link for next set

func (ApplicationLiveViewResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationLiveViewResourceCollection.

func (*ApplicationLiveViewResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationLiveViewResourceCollection.

type ApplicationLiveViewResourceRequests 

type ApplicationLiveViewResourceRequests struct {
	// READ-ONLY; Cpu quantity allocated to each Application Live View component instance. 1 core can be represented by 1 or 1000m.
	CPU *string

	// READ-ONLY; Desired instance count of Application Live View component instance.
	InstanceCount *int32

	// READ-ONLY; Memory quantity allocated to each Application Live View component instance. 1 GB can be represented by 1Gi or
	// 1024Mi.
	Memory *string
}

ApplicationLiveViewResourceRequests - The resource quantity for required CPU and Memory of Application Live View component

func (ApplicationLiveViewResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationLiveViewResourceRequests.

func (*ApplicationLiveViewResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationLiveViewResourceRequests.

type ApplicationLiveViewsClient 

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

ApplicationLiveViewsClient contains the methods for the ApplicationLiveViews group. Don't use this type directly, use NewApplicationLiveViewsClient() instead.

func NewApplicationLiveViewsClient 

func NewApplicationLiveViewsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationLiveViewsClient, error)

NewApplicationLiveViewsClient creates a new instance of ApplicationLiveViewsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ApplicationLiveViewsClient) BeginCreateOrUpdate 

func (client *ApplicationLiveViewsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, applicationLiveViewName string, applicationLiveViewResource ApplicationLiveViewResource, options *ApplicationLiveViewsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ApplicationLiveViewsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default Application Live View or update the existing Application Live View. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationLiveViewName - The name of Application Live View.
  • applicationLiveViewResource - Parameters for the update operation
  • options - ApplicationLiveViewsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationLiveViewsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationLiveViews_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewApplicationLiveViewsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.ApplicationLiveViewResource{
	Properties: &armappplatform.ApplicationLiveViewProperties{},
}, 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.ApplicationLiveViewResource = armappplatform.ApplicationLiveViewResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ApplicationLiveViewProperties{
// 		Components: []*armappplatform.ApplicationLiveViewComponent{
// 			{
// 				Name: "app-live-view-server",
// 				Instances: []*armappplatform.ApplicationLiveViewInstance{
// 					{
// 						Name: to.Ptr("app-live-view-server-name"),
// 						Status: to.Ptr("Running"),
// 				}},
// 				ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
// 					CPU: to.Ptr("1"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("1Gi"),
// 				},
// 			},
// 			{
// 				Name: "app-live-view-connector",
// 				Instances: []*armappplatform.ApplicationLiveViewInstance{
// 					{
// 						Name: to.Ptr("app-live-view-connector-name1"),
// 						Status: to.Ptr("Starting"),
// 				}},
// 				ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
// 					CPU: to.Ptr("500m"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("500Mi"),
// 				},
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ApplicationLiveViewProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ApplicationLiveViewsClient) BeginDelete 

func (client *ApplicationLiveViewsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, applicationLiveViewName string, options *ApplicationLiveViewsClientBeginDeleteOptions) (*runtime.Poller[ApplicationLiveViewsClientDeleteResponse], error)

BeginDelete - Disable the default Application Live View. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationLiveViewName - The name of Application Live View.
  • options - ApplicationLiveViewsClientBeginDeleteOptions contains the optional parameters for the ApplicationLiveViewsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationLiveView_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewApplicationLiveViewsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*ApplicationLiveViewsClient) Get 

func (client *ApplicationLiveViewsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, applicationLiveViewName string, options *ApplicationLiveViewsClientGetOptions) (ApplicationLiveViewsClientGetResponse, error)

Get - Get the Application Live and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationLiveViewName - The name of Application Live View.
  • options - ApplicationLiveViewsClientGetOptions contains the optional parameters for the ApplicationLiveViewsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationLiveViews_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewApplicationLiveViewsClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.ApplicationLiveViewResource = armappplatform.ApplicationLiveViewResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ApplicationLiveViewProperties{
// 		Components: []*armappplatform.ApplicationLiveViewComponent{
// 			{
// 				Name: "app-live-view-server",
// 				Instances: []*armappplatform.ApplicationLiveViewInstance{
// 					{
// 						Name: to.Ptr("app-live-view-server-name"),
// 						Status: to.Ptr("Running"),
// 				}},
// 				ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
// 					CPU: to.Ptr("1"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("1Gi"),
// 				},
// 			},
// 			{
// 				Name: "app-live-view-connector",
// 				Instances: []*armappplatform.ApplicationLiveViewInstance{
// 					{
// 						Name: to.Ptr("app-live-view-connector-name1"),
// 						Status: to.Ptr("Starting"),
// 				}},
// 				ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
// 					CPU: to.Ptr("500m"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("500Mi"),
// 				},
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ApplicationLiveViewProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ApplicationLiveViewsClient) NewListPager 

func (client *ApplicationLiveViewsClient) NewListPager(resourceGroupName string, serviceName string, options *ApplicationLiveViewsClientListOptions) *runtime.Pager[ApplicationLiveViewsClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ApplicationLiveViewsClientListOptions contains the optional parameters for the ApplicationLiveViewsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationLiveViews_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewApplicationLiveViewsClient().NewListPager("myResourceGroup", "myservice", 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.ApplicationLiveViewResourceCollection = armappplatform.ApplicationLiveViewResourceCollection{
	// 	Value: []*armappplatform.ApplicationLiveViewResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ApplicationLiveViewProperties{
	// 				Components: []*armappplatform.ApplicationLiveViewComponent{
	// 					{
	// 						Name: "app-live-view-server",
	// 						Instances: []*armappplatform.ApplicationLiveViewInstance{
	// 							{
	// 								Name: to.Ptr("app-live-view-server-name"),
	// 								Status: to.Ptr("Running"),
	// 						}},
	// 						ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
	// 							CPU: to.Ptr("1"),
	// 							InstanceCount: to.Ptr[int32](1),
	// 							Memory: to.Ptr("1Gi"),
	// 						},
	// 					},
	// 					{
	// 						Name: "app-live-view-connector",
	// 						Instances: []*armappplatform.ApplicationLiveViewInstance{
	// 							{
	// 								Name: to.Ptr("app-live-view-connector-name1"),
	// 								Status: to.Ptr("Starting"),
	// 						}},
	// 						ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
	// 							CPU: to.Ptr("500m"),
	// 							InstanceCount: to.Ptr[int32](1),
	// 							Memory: to.Ptr("500Mi"),
	// 						},
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.ApplicationLiveViewProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type ApplicationLiveViewsClientBeginCreateOrUpdateOptions 

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

ApplicationLiveViewsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationLiveViewsClient.BeginCreateOrUpdate method.

type ApplicationLiveViewsClientBeginDeleteOptions 

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

ApplicationLiveViewsClientBeginDeleteOptions contains the optional parameters for the ApplicationLiveViewsClient.BeginDelete method.

type ApplicationLiveViewsClientCreateOrUpdateResponse 

type ApplicationLiveViewsClientCreateOrUpdateResponse struct {
	// Application Live View resource
	ApplicationLiveViewResource
}

ApplicationLiveViewsClientCreateOrUpdateResponse contains the response from method ApplicationLiveViewsClient.BeginCreateOrUpdate.

type ApplicationLiveViewsClientDeleteResponse 

type ApplicationLiveViewsClientDeleteResponse struct {
}

ApplicationLiveViewsClientDeleteResponse contains the response from method ApplicationLiveViewsClient.BeginDelete.

type ApplicationLiveViewsClientGetOptions 

type ApplicationLiveViewsClientGetOptions struct {
}

ApplicationLiveViewsClientGetOptions contains the optional parameters for the ApplicationLiveViewsClient.Get method.

type ApplicationLiveViewsClientGetResponse 

type ApplicationLiveViewsClientGetResponse struct {
	// Application Live View resource
	ApplicationLiveViewResource
}

ApplicationLiveViewsClientGetResponse contains the response from method ApplicationLiveViewsClient.Get.

type ApplicationLiveViewsClientListOptions 

type ApplicationLiveViewsClientListOptions struct {
}

ApplicationLiveViewsClientListOptions contains the optional parameters for the ApplicationLiveViewsClient.NewListPager method.

type ApplicationLiveViewsClientListResponse 

type ApplicationLiveViewsClientListResponse struct {
	// Object that includes an array of Application Live View resources and a possible link for next set
	ApplicationLiveViewResourceCollection
}

ApplicationLiveViewsClientListResponse contains the response from method ApplicationLiveViewsClient.NewListPager.

type AppsClient 

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

AppsClient contains the methods for the Apps group. Don't use this type directly, use NewAppsClient() instead.

func NewAppsClient 

func NewAppsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AppsClient, error)

NewAppsClient creates a new instance of AppsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AppsClient) BeginCreateOrUpdate 

func (client *AppsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, appResource AppResource, options *AppsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AppsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • appResource - Parameters for the create or update operation
  • options - AppsClientBeginCreateOrUpdateOptions contains the optional parameters for the AppsClient.BeginCreateOrUpdate method.
Example (AppsCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAppsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", armappplatform.AppResource{
	Identity: &armappplatform.ManagedIdentityProperties{
		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {},
		},
	},
	Location: to.Ptr("eastus"),
	Properties: &armappplatform.AppResourceProperties{
		AddonConfigs: map[string]any{
			"ApplicationConfigurationService": map[string]any{
				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs",
			},
			"ServiceRegistry": map[string]any{
				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry",
			},
		},
		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
			{
				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
					Type:          to.Ptr(armappplatform.TypeAzureFileVolume),
					EnableSubPath: to.Ptr(true),
					MountOptions: []*string{
						to.Ptr("uid=0"),
						to.Ptr("gid=0"),
						to.Ptr("dir_mode=0777"),
						to.Ptr("file_mode=0777")},
					MountPath: to.Ptr("/mypath1/mypath2"),
					ShareName: to.Ptr("myFileShare"),
				},
				StorageID: to.Ptr("myASCStorageID"),
			}},
		EnableEndToEndTLS: to.Ptr(false),
		HTTPSOnly:         to.Ptr(false),
		LoadedCertificates: []*armappplatform.LoadedCertificate{
			{
				LoadTrustStore: to.Ptr(false),
				ResourceID:     to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
			},
			{
				LoadTrustStore: to.Ptr(true),
				ResourceID:     to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
			}},
		PersistentDisk: &armappplatform.PersistentDisk{
			MountPath: to.Ptr("/mypersistentdisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
		Public: to.Ptr(true),
		TemporaryDisk: &armappplatform.TemporaryDisk{
			MountPath: to.Ptr("/mytemporarydisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
	},
}, 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		AddonConfigs: map[string]any{
// 			"ApplicationConfigurationService": map[string]any{
// 				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs",
// 			},
// 			"ServiceRegistry": map[string]any{
// 				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry",
// 			},
// 		},
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					EnableSubPath: to.Ptr(true),
// 					MountOptions: []*string{
// 						to.Ptr("uid=0"),
// 						to.Ptr("gid=0"),
// 						to.Ptr("dir_mode=0777"),
// 						to.Ptr("file_mode=0777")},
// 						MountPath: to.Ptr("/mypath1/mypath2"),
// 						ShareName: to.Ptr("myFileShare"),
// 					},
// 					StorageID: to.Ptr("myASCStorageID"),
// 			}},
// 			EnableEndToEndTLS: to.Ptr(false),
// 			Fqdn: to.Ptr("myapp.mydomain.com"),
// 			HTTPSOnly: to.Ptr(false),
// 			PersistentDisk: &armappplatform.PersistentDisk{
// 				MountPath: to.Ptr("/mypersistentdisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 				UsedInGB: to.Ptr[int32](1),
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 			Public: to.Ptr(true),
// 			TemporaryDisk: &armappplatform.TemporaryDisk{
// 				MountPath: to.Ptr("/mytemporarydisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 			},
// 			URL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 		},
// 	}

Output:
Example (AppsCreateOrUpdateVNetInjection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_CreateOrUpdate_VNetInjection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAppsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", armappplatform.AppResource{
	Identity: &armappplatform.ManagedIdentityProperties{
		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {},
		},
	},
	Location: to.Ptr("eastus"),
	Properties: &armappplatform.AppResourceProperties{
		AddonConfigs: map[string]any{
			"ApplicationConfigurationService": map[string]any{
				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs",
			},
			"ServiceRegistry": map[string]any{
				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry",
			},
		},
		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
			{
				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
					MountOptions: []*string{
						to.Ptr("uid=0"),
						to.Ptr("gid=0"),
						to.Ptr("dir_mode=0777"),
						to.Ptr("file_mode=0777")},
					MountPath: to.Ptr("/mypath1/mypath2"),
					ShareName: to.Ptr("myFileShare"),
				},
				StorageID: to.Ptr("myASCStorageID"),
			}},
		EnableEndToEndTLS: to.Ptr(false),
		HTTPSOnly:         to.Ptr(false),
		LoadedCertificates: []*armappplatform.LoadedCertificate{
			{
				LoadTrustStore: to.Ptr(false),
				ResourceID:     to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
			},
			{
				LoadTrustStore: to.Ptr(true),
				ResourceID:     to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
			}},
		PersistentDisk: &armappplatform.PersistentDisk{
			MountPath: to.Ptr("/mypersistentdisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
		Public: to.Ptr(true),
		TemporaryDisk: &armappplatform.TemporaryDisk{
			MountPath: to.Ptr("/mytemporarydisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
		VnetAddons: &armappplatform.AppVNetAddons{
			PublicEndpoint: 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		AddonConfigs: map[string]any{
// 			"ApplicationConfigurationService": map[string]any{
// 				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs",
// 			},
// 			"ServiceRegistry": map[string]any{
// 				"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/myServiceRegistry",
// 			},
// 		},
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					MountOptions: []*string{
// 						to.Ptr("uid=0"),
// 						to.Ptr("gid=0"),
// 						to.Ptr("dir_mode=0777"),
// 						to.Ptr("file_mode=0777")},
// 						MountPath: to.Ptr("/mypath1/mypath2"),
// 						ShareName: to.Ptr("myFileShare"),
// 					},
// 					StorageID: to.Ptr("myASCStorageID"),
// 			}},
// 			EnableEndToEndTLS: to.Ptr(false),
// 			Fqdn: to.Ptr("myapp.private.mydomain.com"),
// 			HTTPSOnly: to.Ptr(false),
// 			PersistentDisk: &armappplatform.PersistentDisk{
// 				MountPath: to.Ptr("/mypersistentdisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 				UsedInGB: to.Ptr[int32](1),
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 			Public: to.Ptr(true),
// 			TemporaryDisk: &armappplatform.TemporaryDisk{
// 				MountPath: to.Ptr("/mytemporarydisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 			},
// 			URL: to.Ptr("myapp.myservice.private.azuremicroservices.io"),
// 			VnetAddons: &armappplatform.AppVNetAddons{
// 				PublicEndpoint: to.Ptr(true),
// 				PublicEndpointURL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 			},
// 		},
// 	}

Output:

func (*AppsClient) BeginDelete 

func (client *AppsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, appName string, options *AppsClientBeginDeleteOptions) (*runtime.Poller[AppsClientDeleteResponse], error)

BeginDelete - Operation to delete an App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • options - AppsClientBeginDeleteOptions contains the optional parameters for the AppsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAppsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "myapp", 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 (*AppsClient) BeginSetActiveDeployments 

func (client *AppsClient) BeginSetActiveDeployments(ctx context.Context, resourceGroupName string, serviceName string, appName string, activeDeploymentCollection ActiveDeploymentCollection, options *AppsClientBeginSetActiveDeploymentsOptions) (*runtime.Poller[AppsClientSetActiveDeploymentsResponse], error)

BeginSetActiveDeployments - Set existing Deployment under the app as active If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • activeDeploymentCollection - A list of Deployment name to be active.
  • options - AppsClientBeginSetActiveDeploymentsOptions contains the optional parameters for the AppsClient.BeginSetActiveDeployments method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_SetActiveDeployments.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAppsClient().BeginSetActiveDeployments(ctx, "myResourceGroup", "myservice", "myapp", armappplatform.ActiveDeploymentCollection{
	ActiveDeploymentNames: []*string{
		to.Ptr("default")},
}, 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					MountOptions: []*string{
// 					},
// 					MountPath: to.Ptr("/mypath1/mypath2"),
// 					ShareName: to.Ptr("myFileShare"),
// 				},
// 				StorageID: to.Ptr("myASCStorageID"),
// 		}},
// 		EnableEndToEndTLS: to.Ptr(false),
// 		Fqdn: to.Ptr("myapp.mydomain.com"),
// 		HTTPSOnly: to.Ptr(false),
// 		PersistentDisk: &armappplatform.PersistentDisk{
// 			MountPath: to.Ptr("/mypersistentdisk"),
// 			SizeInGB: to.Ptr[int32](2),
// 			UsedInGB: to.Ptr[int32](1),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		TemporaryDisk: &armappplatform.TemporaryDisk{
// 			MountPath: to.Ptr("/mytemporarydisk"),
// 			SizeInGB: to.Ptr[int32](2),
// 		},
// 		URL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 	},
// }

Output:

func (*AppsClient) BeginUpdate 

func (client *AppsClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, appResource AppResource, options *AppsClientBeginUpdateOptions) (*runtime.Poller[AppsClientUpdateResponse], error)

BeginUpdate - Operation to update an exiting App. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • appResource - Parameters for the update operation
  • options - AppsClientBeginUpdateOptions contains the optional parameters for the AppsClient.BeginUpdate method.
Example (AppsUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAppsClient().BeginUpdate(ctx, "myResourceGroup", "myservice", "myapp", armappplatform.AppResource{
	Identity: &armappplatform.ManagedIdentityProperties{
		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {},
		},
	},
	Location: to.Ptr("eastus"),
	Properties: &armappplatform.AppResourceProperties{
		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
			{
				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
					Type:         to.Ptr(armappplatform.TypeAzureFileVolume),
					MountOptions: []*string{},
					MountPath:    to.Ptr("/mypath1/mypath2"),
					ShareName:    to.Ptr("myFileShare"),
				},
				StorageID: to.Ptr("myASCStorageID"),
			}},
		EnableEndToEndTLS: to.Ptr(false),
		HTTPSOnly:         to.Ptr(false),
		PersistentDisk: &armappplatform.PersistentDisk{
			MountPath: to.Ptr("/mypersistentdisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
		Public: to.Ptr(true),
		TemporaryDisk: &armappplatform.TemporaryDisk{
			MountPath: to.Ptr("/mytemporarydisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
	},
}, 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					MountOptions: []*string{
// 					},
// 					MountPath: to.Ptr("/mypath1/mypath2"),
// 					ShareName: to.Ptr("myFileShare"),
// 				},
// 				StorageID: to.Ptr("myASCStorageID"),
// 		}},
// 		EnableEndToEndTLS: to.Ptr(false),
// 		Fqdn: to.Ptr("myapp.mydomain.com"),
// 		HTTPSOnly: to.Ptr(false),
// 		PersistentDisk: &armappplatform.PersistentDisk{
// 			MountPath: to.Ptr("/mypersistentdisk"),
// 			SizeInGB: to.Ptr[int32](2),
// 			UsedInGB: to.Ptr[int32](1),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		TemporaryDisk: &armappplatform.TemporaryDisk{
// 			MountPath: to.Ptr("/mytemporarydisk"),
// 			SizeInGB: to.Ptr[int32](2),
// 		},
// 		URL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 	},
// }

Output:
Example (AppsUpdateVNetInjection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_Update_VNetInjection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAppsClient().BeginUpdate(ctx, "myResourceGroup", "myservice", "myapp", armappplatform.AppResource{
	Identity: &armappplatform.ManagedIdentityProperties{
		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {},
		},
	},
	Location: to.Ptr("eastus"),
	Properties: &armappplatform.AppResourceProperties{
		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
			{
				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
					Type:         to.Ptr(armappplatform.TypeAzureFileVolume),
					MountOptions: []*string{},
					MountPath:    to.Ptr("/mypath1/mypath2"),
					ShareName:    to.Ptr("myFileShare"),
				},
				StorageID: to.Ptr("myASCStorageID"),
			}},
		EnableEndToEndTLS: to.Ptr(false),
		HTTPSOnly:         to.Ptr(false),
		PersistentDisk: &armappplatform.PersistentDisk{
			MountPath: to.Ptr("/mypersistentdisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
		Public: to.Ptr(true),
		TemporaryDisk: &armappplatform.TemporaryDisk{
			MountPath: to.Ptr("/mytemporarydisk"),
			SizeInGB:  to.Ptr[int32](2),
		},
		VnetAddons: &armappplatform.AppVNetAddons{
			PublicEndpoint: 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					MountOptions: []*string{
// 					},
// 					MountPath: to.Ptr("/mypath1/mypath2"),
// 					ShareName: to.Ptr("myFileShare"),
// 				},
// 				StorageID: to.Ptr("myASCStorageID"),
// 		}},
// 		EnableEndToEndTLS: to.Ptr(false),
// 		Fqdn: to.Ptr("myapp.private.mydomain.com"),
// 		HTTPSOnly: to.Ptr(false),
// 		PersistentDisk: &armappplatform.PersistentDisk{
// 			MountPath: to.Ptr("/mypersistentdisk"),
// 			SizeInGB: to.Ptr[int32](2),
// 			UsedInGB: to.Ptr[int32](1),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		TemporaryDisk: &armappplatform.TemporaryDisk{
// 			MountPath: to.Ptr("/mytemporarydisk"),
// 			SizeInGB: to.Ptr[int32](2),
// 		},
// 		URL: to.Ptr("myapp.myservice.private.azuremicroservices.io"),
// 		VnetAddons: &armappplatform.AppVNetAddons{
// 			PublicEndpoint: to.Ptr(true),
// 			PublicEndpointURL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 		},
// 	},
// }

Output:

func (*AppsClient) Get 

func (client *AppsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, appName string, options *AppsClientGetOptions) (AppsClientGetResponse, error)

Get - Get an App and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • options - AppsClientGetOptions contains the optional parameters for the AppsClient.Get method.
Example (AppsGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAppsClient().Get(ctx, "myResourceGroup", "myservice", "myapp", &armappplatform.AppsClientGetOptions{SyncStatus: 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					MountOptions: []*string{
// 						to.Ptr("uid=0"),
// 						to.Ptr("gid=0"),
// 						to.Ptr("dir_mode=0777"),
// 						to.Ptr("file_mode=0777")},
// 						MountPath: to.Ptr("/mypath1/mypath2"),
// 						ShareName: to.Ptr("myFileShare"),
// 					},
// 					StorageID: to.Ptr("myASCStorageID"),
// 			}},
// 			EnableEndToEndTLS: to.Ptr(false),
// 			Fqdn: to.Ptr("myapp.mydomain.com"),
// 			HTTPSOnly: to.Ptr(false),
// 			LoadedCertificates: []*armappplatform.LoadedCertificate{
// 				{
// 					LoadTrustStore: to.Ptr(false),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
// 				},
// 				{
// 					LoadTrustStore: to.Ptr(true),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
// 			}},
// 			PersistentDisk: &armappplatform.PersistentDisk{
// 				MountPath: to.Ptr("/mypersistentdisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 				UsedInGB: to.Ptr[int32](1),
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 			Public: to.Ptr(true),
// 			TemporaryDisk: &armappplatform.TemporaryDisk{
// 				MountPath: to.Ptr("/mytemporarydisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 			},
// 			URL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 		},
// 	}

Output:
Example (AppsGetVNetInjection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_Get_VNetInjection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAppsClient().Get(ctx, "myResourceGroup", "myservice", "myapp", &armappplatform.AppsClientGetOptions{SyncStatus: 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.AppResource = armappplatform.AppResource{
// 	Name: to.Ptr("myapp"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Identity: &armappplatform.ManagedIdentityProperties{
// 		Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("principalid"),
// 		TenantID: to.Ptr("tenantid"),
// 		UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId1"),
// 				PrincipalID: to.Ptr("principalId1"),
// 			},
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
// 				ClientID: to.Ptr("clientId2"),
// 				PrincipalID: to.Ptr("principalId2"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappplatform.AppResourceProperties{
// 		CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
// 			{
// 				CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
// 					Type: to.Ptr(armappplatform.TypeAzureFileVolume),
// 					MountOptions: []*string{
// 						to.Ptr("uid=0"),
// 						to.Ptr("gid=0"),
// 						to.Ptr("dir_mode=0777"),
// 						to.Ptr("file_mode=0777")},
// 						MountPath: to.Ptr("/mypath1/mypath2"),
// 						ShareName: to.Ptr("myFileShare"),
// 					},
// 					StorageID: to.Ptr("myASCStorageID"),
// 			}},
// 			EnableEndToEndTLS: to.Ptr(false),
// 			Fqdn: to.Ptr("myapp.private.mydomain.com"),
// 			HTTPSOnly: to.Ptr(false),
// 			LoadedCertificates: []*armappplatform.LoadedCertificate{
// 				{
// 					LoadTrustStore: to.Ptr(false),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
// 				},
// 				{
// 					LoadTrustStore: to.Ptr(true),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
// 			}},
// 			PersistentDisk: &armappplatform.PersistentDisk{
// 				MountPath: to.Ptr("/mypersistentdisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 				UsedInGB: to.Ptr[int32](1),
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
// 			Public: to.Ptr(true),
// 			TemporaryDisk: &armappplatform.TemporaryDisk{
// 				MountPath: to.Ptr("/mytemporarydisk"),
// 				SizeInGB: to.Ptr[int32](2),
// 			},
// 			URL: to.Ptr("myapp.myservice.private.azuremicroservices.io"),
// 			VnetAddons: &armappplatform.AppVNetAddons{
// 				PublicEndpoint: to.Ptr(true),
// 				PublicEndpointURL: to.Ptr("myapp.myservice.azuremicroservices.io"),
// 			},
// 		},
// 	}

Output:

func (*AppsClient) GetResourceUploadURL 

func (client *AppsClient) GetResourceUploadURL(ctx context.Context, resourceGroupName string, serviceName string, appName string, options *AppsClientGetResourceUploadURLOptions) (AppsClientGetResourceUploadURLResponse, error)

GetResourceUploadURL - Get an resource upload URL for an App, which may be artifacts or source archive. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • options - AppsClientGetResourceUploadURLOptions contains the optional parameters for the AppsClient.GetResourceUploadURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_GetResourceUploadUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAppsClient().GetResourceUploadURL(ctx, "myResourceGroup", "myservice", "myapp", 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.ResourceUploadDefinition = armappplatform.ResourceUploadDefinition{
// 	RelativePath: to.Ptr("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20190801-3ed9f4a2-986b-4bbd-b833-a42dccb2f777"),
// 	UploadURL: to.Ptr("https://springcloudstorageaccount.file.core.windows.net/bd172614181f42e2853f6fd90029cda8/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20190801-3ed9f4a2-986b-4bbd-b833-a42dccb2f777?sv=2018-03-28&sr=f&sig=SampleSignature&se=2019-08-01T10%3A42%3A21Z&sp=w"),
// }

Output:

func (*AppsClient) NewListPager 

func (client *AppsClient) NewListPager(resourceGroupName string, serviceName string, options *AppsClientListOptions) *runtime.Pager[AppsClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - AppsClientListOptions contains the optional parameters for the AppsClient.NewListPager method.
Example (AppsList)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAppsClient().NewListPager("myResourceGroup", "myservice", 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.AppResourceCollection = armappplatform.AppResourceCollection{
	// 	Value: []*armappplatform.AppResource{
	// 		{
	// 			Name: to.Ptr("myapp"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Identity: &armappplatform.ManagedIdentityProperties{
	// 				Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
	// 				PrincipalID: to.Ptr("principalid"),
	// 				TenantID: to.Ptr("tenantid"),
	// 				UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
	// 						ClientID: to.Ptr("clientId1"),
	// 						PrincipalID: to.Ptr("principalId1"),
	// 					},
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
	// 						ClientID: to.Ptr("clientId2"),
	// 						PrincipalID: to.Ptr("principalId2"),
	// 					},
	// 				},
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armappplatform.AppResourceProperties{
	// 				CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
	// 					{
	// 						CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
	// 							Type: to.Ptr(armappplatform.TypeAzureFileVolume),
	// 							MountOptions: []*string{
	// 								to.Ptr("uid=0"),
	// 								to.Ptr("gid=0"),
	// 								to.Ptr("dir_mode=0777"),
	// 								to.Ptr("file_mode=0777")},
	// 								MountPath: to.Ptr("/mypath1/mypath2"),
	// 								ShareName: to.Ptr("myFileShare"),
	// 							},
	// 							StorageID: to.Ptr("myASCStorageID"),
	// 					}},
	// 					EnableEndToEndTLS: to.Ptr(false),
	// 					Fqdn: to.Ptr("myapp.mydomain.com"),
	// 					HTTPSOnly: to.Ptr(false),
	// 					LoadedCertificates: []*armappplatform.LoadedCertificate{
	// 						{
	// 							LoadTrustStore: to.Ptr(false),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
	// 						},
	// 						{
	// 							LoadTrustStore: to.Ptr(true),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
	// 					}},
	// 					PersistentDisk: &armappplatform.PersistentDisk{
	// 						MountPath: to.Ptr("/mypersistentdisk"),
	// 						SizeInGB: to.Ptr[int32](2),
	// 						UsedInGB: to.Ptr[int32](1),
	// 					},
	// 					ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
	// 					Public: to.Ptr(true),
	// 					TemporaryDisk: &armappplatform.TemporaryDisk{
	// 						MountPath: to.Ptr("/mytemporarydisk"),
	// 						SizeInGB: to.Ptr[int32](2),
	// 					},
	// 					URL: to.Ptr("myapp.myservice.azuremicroservices.io"),
	// 				},
	// 		}},
	// 	}
}

Output:
Example (AppsListVNetInjection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_List_VNetInjection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAppsClient().NewListPager("myResourceGroup", "myservice", 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.AppResourceCollection = armappplatform.AppResourceCollection{
	// 	Value: []*armappplatform.AppResource{
	// 		{
	// 			Name: to.Ptr("myapp"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Identity: &armappplatform.ManagedIdentityProperties{
	// 				Type: to.Ptr(armappplatform.ManagedIdentityTypeSystemAssignedUserAssigned),
	// 				PrincipalID: to.Ptr("principalid"),
	// 				TenantID: to.Ptr("tenantid"),
	// 				UserAssignedIdentities: map[string]*armappplatform.UserAssignedManagedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armappplatform.UserAssignedManagedIdentity{
	// 						ClientID: to.Ptr("clientId1"),
	// 						PrincipalID: to.Ptr("principalId1"),
	// 					},
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": &armappplatform.UserAssignedManagedIdentity{
	// 						ClientID: to.Ptr("clientId2"),
	// 						PrincipalID: to.Ptr("principalId2"),
	// 					},
	// 				},
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armappplatform.AppResourceProperties{
	// 				CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
	// 					{
	// 						CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
	// 							Type: to.Ptr(armappplatform.TypeAzureFileVolume),
	// 							MountOptions: []*string{
	// 								to.Ptr("uid=0"),
	// 								to.Ptr("gid=0"),
	// 								to.Ptr("dir_mode=0777"),
	// 								to.Ptr("file_mode=0777")},
	// 								MountPath: to.Ptr("/mypath1/mypath2"),
	// 								ShareName: to.Ptr("myFileShare"),
	// 							},
	// 							StorageID: to.Ptr("myASCStorageID"),
	// 					}},
	// 					EnableEndToEndTLS: to.Ptr(false),
	// 					Fqdn: to.Ptr("myapp.mydomain.com"),
	// 					HTTPSOnly: to.Ptr(false),
	// 					LoadedCertificates: []*armappplatform.LoadedCertificate{
	// 						{
	// 							LoadTrustStore: to.Ptr(false),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
	// 						},
	// 						{
	// 							LoadTrustStore: to.Ptr(true),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
	// 					}},
	// 					PersistentDisk: &armappplatform.PersistentDisk{
	// 						MountPath: to.Ptr("/mypersistentdisk"),
	// 						SizeInGB: to.Ptr[int32](2),
	// 						UsedInGB: to.Ptr[int32](1),
	// 					},
	// 					ProvisioningState: to.Ptr(armappplatform.AppResourceProvisioningStateSucceeded),
	// 					Public: to.Ptr(true),
	// 					TemporaryDisk: &armappplatform.TemporaryDisk{
	// 						MountPath: to.Ptr("/mytemporarydisk"),
	// 						SizeInGB: to.Ptr[int32](2),
	// 					},
	// 					URL: to.Ptr("myapp.myservice.private.azuremicroservices.io"),
	// 					VnetAddons: &armappplatform.AppVNetAddons{
	// 						PublicEndpoint: to.Ptr(true),
	// 						PublicEndpointURL: to.Ptr("myapp.myservice.azuremicroservices.io"),
	// 					},
	// 				},
	// 		}},
	// 	}
}

Output:

func (*AppsClient) ValidateDomain 

func (client *AppsClient) ValidateDomain(ctx context.Context, resourceGroupName string, serviceName string, appName string, validatePayload CustomDomainValidatePayload, options *AppsClientValidateDomainOptions) (AppsClientValidateDomainResponse, error)

ValidateDomain - Check the resource name is valid as well as not in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • validatePayload - Custom domain payload to be validated
  • options - AppsClientValidateDomainOptions contains the optional parameters for the AppsClient.ValidateDomain method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Apps_ValidateDomain.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAppsClient().ValidateDomain(ctx, "myResourceGroup", "myservice", "myapp", armappplatform.CustomDomainValidatePayload{
	Name: to.Ptr("mydomain.io"),
}, 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.CustomDomainValidateResult = armappplatform.CustomDomainValidateResult{
// 	IsValid: to.Ptr(false),
// 	Message: to.Ptr("Certificate is invalid, please check if it is a self signed cert or if it contains a suitable dns name"),
// }

Output:

type AppsClientBeginCreateOrUpdateOptions 

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

AppsClientBeginCreateOrUpdateOptions contains the optional parameters for the AppsClient.BeginCreateOrUpdate method.

type AppsClientBeginDeleteOptions 

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

AppsClientBeginDeleteOptions contains the optional parameters for the AppsClient.BeginDelete method.

type AppsClientBeginSetActiveDeploymentsOptions 

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

AppsClientBeginSetActiveDeploymentsOptions contains the optional parameters for the AppsClient.BeginSetActiveDeployments method.

type AppsClientBeginUpdateOptions 

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

AppsClientBeginUpdateOptions contains the optional parameters for the AppsClient.BeginUpdate method.

type AppsClientCreateOrUpdateResponse 

type AppsClientCreateOrUpdateResponse struct {
	// App resource payload
	AppResource
}

AppsClientCreateOrUpdateResponse contains the response from method AppsClient.BeginCreateOrUpdate.

type AppsClientDeleteResponse 

type AppsClientDeleteResponse struct {
}

AppsClientDeleteResponse contains the response from method AppsClient.BeginDelete.

type AppsClientGetOptions 

type AppsClientGetOptions struct {
	// Indicates whether sync status
	SyncStatus *string
}

AppsClientGetOptions contains the optional parameters for the AppsClient.Get method.

type AppsClientGetResourceUploadURLOptions 

type AppsClientGetResourceUploadURLOptions struct {
}

AppsClientGetResourceUploadURLOptions contains the optional parameters for the AppsClient.GetResourceUploadURL method.

type AppsClientGetResourceUploadURLResponse 

type AppsClientGetResourceUploadURLResponse struct {
	// Resource upload definition payload
	ResourceUploadDefinition
}

AppsClientGetResourceUploadURLResponse contains the response from method AppsClient.GetResourceUploadURL.

type AppsClientGetResponse 

type AppsClientGetResponse struct {
	// App resource payload
	AppResource
}

AppsClientGetResponse contains the response from method AppsClient.Get.

type AppsClientListOptions 

type AppsClientListOptions struct {
}

AppsClientListOptions contains the optional parameters for the AppsClient.NewListPager method.

type AppsClientListResponse 

type AppsClientListResponse struct {
	// Object that includes an array of App resources and a possible link for next set
	AppResourceCollection
}

AppsClientListResponse contains the response from method AppsClient.NewListPager.

type AppsClientSetActiveDeploymentsResponse 

type AppsClientSetActiveDeploymentsResponse struct {
	// App resource payload
	AppResource
}

AppsClientSetActiveDeploymentsResponse contains the response from method AppsClient.BeginSetActiveDeployments.

type AppsClientUpdateResponse 

type AppsClientUpdateResponse struct {
	// App resource payload
	AppResource
}

AppsClientUpdateResponse contains the response from method AppsClient.BeginUpdate.

type AppsClientValidateDomainOptions 

type AppsClientValidateDomainOptions struct {
}

AppsClientValidateDomainOptions contains the optional parameters for the AppsClient.ValidateDomain method.

type AppsClientValidateDomainResponse 

type AppsClientValidateDomainResponse struct {
	// Validation result for custom domain.
	CustomDomainValidateResult
}

AppsClientValidateDomainResponse contains the response from method AppsClient.ValidateDomain.

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 AvailableRuntimeVersions 

type AvailableRuntimeVersions struct {
	// READ-ONLY; A list of all supported runtime versions.
	Value []*SupportedRuntimeVersion
}

func (AvailableRuntimeVersions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableRuntimeVersions.

func (*AvailableRuntimeVersions) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableRuntimeVersions.

type AzureFileVolume 

type AzureFileVolume struct {
	// REQUIRED; The mount path of the persistent disk.
	MountPath *string

	// REQUIRED; The type of the underlying resource to mount as a persistent disk.
	Type *Type

	// If set to true, it will create and mount a dedicated directory for every individual app instance.
	EnableSubPath *bool

	// These are the mount options for a persistent disk.
	MountOptions []*string

	// Indicates whether the persistent disk is a readOnly one.
	ReadOnly *bool

	// The share name of the Azure File share.
	ShareName *string
}

AzureFileVolume - The properties of the Azure File volume. Azure File shares are mounted as volumes.

func (*AzureFileVolume) GetCustomPersistentDiskProperties 

func (a *AzureFileVolume) GetCustomPersistentDiskProperties() *CustomPersistentDiskProperties

GetCustomPersistentDiskProperties implements the CustomPersistentDiskPropertiesClassification interface for type AzureFileVolume.

func (AzureFileVolume) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureFileVolume.

func (*AzureFileVolume) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFileVolume.

type BackendProtocol 

type BackendProtocol string

BackendProtocol - How ingress should communicate with this app backend service. 

const (
	BackendProtocolDefault BackendProtocol = "Default"
	BackendProtocolGRPC    BackendProtocol = "GRPC"
)

func PossibleBackendProtocolValues 

func PossibleBackendProtocolValues() []BackendProtocol

PossibleBackendProtocolValues returns the possible values for the BackendProtocol const type.

type BindingResource 

type BindingResource struct {
	// Properties of the Binding resource
	Properties *BindingResourceProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

BindingResource - Binding resource payload

func (BindingResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BindingResource.

func (*BindingResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BindingResource.

type BindingResourceCollection 

type BindingResourceCollection 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 Binding resources
	Value []*BindingResource
}

BindingResourceCollection - Object that includes an array of Binding resources and a possible link for next set

func (BindingResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BindingResourceCollection.

func (*BindingResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BindingResourceCollection.

type BindingResourceProperties 

type BindingResourceProperties struct {
	// Binding parameters of the Binding resource
	BindingParameters map[string]*string

	// The key of the bound resource
	Key *string

	// The Azure resource id of the bound resource
	ResourceID *string

	// READ-ONLY; Creation time of the Binding resource
	CreatedAt *string

	// READ-ONLY; The generated Spring Boot property file for this binding. The secret will be deducted.
	GeneratedProperties *string

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

	// READ-ONLY; The standard Azure resource type of the bound resource
	ResourceType *string

	// READ-ONLY; Update time of the Binding resource
	UpdatedAt *string
}

BindingResourceProperties - Binding resource properties payload

func (BindingResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BindingResourceProperties.

func (*BindingResourceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BindingResourceProperties.

type BindingType 

type BindingType string

BindingType - Buildpack Binding Type 

const (
	BindingTypeApacheSkyWalking    BindingType = "ApacheSkyWalking"
	BindingTypeAppDynamics         BindingType = "AppDynamics"
	BindingTypeApplicationInsights BindingType = "ApplicationInsights"
	BindingTypeDynatrace           BindingType = "Dynatrace"
	BindingTypeElasticAPM          BindingType = "ElasticAPM"
	BindingTypeNewRelic            BindingType = "NewRelic"
)

func PossibleBindingTypeValues 

func PossibleBindingTypeValues() []BindingType

PossibleBindingTypeValues returns the possible values for the BindingType const type.

type BindingsClient 

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

BindingsClient contains the methods for the Bindings group. Don't use this type directly, use NewBindingsClient() instead.

func NewBindingsClient 

func NewBindingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BindingsClient, error)

NewBindingsClient creates a new instance of BindingsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BindingsClient) BeginCreateOrUpdate 

func (client *BindingsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, bindingName string, bindingResource BindingResource, options *BindingsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BindingsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • bindingName - The name of the Binding resource.
  • bindingResource - Parameters for the create or update operation
  • options - BindingsClientBeginCreateOrUpdateOptions contains the optional parameters for the BindingsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Bindings_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBindingsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mybinding", armappplatform.BindingResource{
	Properties: &armappplatform.BindingResourceProperties{
		BindingParameters: map[string]*string{
			"apiType":      to.Ptr("SQL"),
			"databaseName": to.Ptr("db1"),
		},
		Key:        to.Ptr("xxxx"),
		ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1"),
	},
}, 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.BindingResource = armappplatform.BindingResource{
// 	Name: to.Ptr("mybinding"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/bindings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BindingResourceProperties{
// 		BindingParameters: map[string]*string{
// 			"apiType": to.Ptr("SQL"),
// 			"databaseName": to.Ptr("db1"),
// 		},
// 		CreatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
// 		GeneratedProperties: to.Ptr("<connection-string>"),
// 		ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1"),
// 		ResourceName: to.Ptr("my-cosmosdb-1"),
// 		ResourceType: to.Ptr("Microsoft.DocumentDB"),
// 		UpdatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
// 	},
// }

Output:

func (*BindingsClient) BeginDelete 

func (client *BindingsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, appName string, bindingName string, options *BindingsClientBeginDeleteOptions) (*runtime.Poller[BindingsClientDeleteResponse], error)

BeginDelete - Operation to delete a Binding. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • bindingName - The name of the Binding resource.
  • options - BindingsClientBeginDeleteOptions contains the optional parameters for the BindingsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Bindings_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBindingsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "myapp", "mybinding", 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 (*BindingsClient) BeginUpdate 

func (client *BindingsClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, bindingName string, bindingResource BindingResource, options *BindingsClientBeginUpdateOptions) (*runtime.Poller[BindingsClientUpdateResponse], error)

BeginUpdate - Operation to update an exiting Binding. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • bindingName - The name of the Binding resource.
  • bindingResource - Parameters for the update operation
  • options - BindingsClientBeginUpdateOptions contains the optional parameters for the BindingsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Bindings_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBindingsClient().BeginUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mybinding", armappplatform.BindingResource{
	Properties: &armappplatform.BindingResourceProperties{
		BindingParameters: map[string]*string{
			"apiType":      to.Ptr("SQL"),
			"databaseName": to.Ptr("db1"),
		},
		Key: to.Ptr("xxxx"),
	},
}, 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.BindingResource = armappplatform.BindingResource{
// 	Name: to.Ptr("mybinding"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/bindings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BindingResourceProperties{
// 		BindingParameters: map[string]*string{
// 			"apiType": to.Ptr("SQL"),
// 			"databaseName": to.Ptr("db1"),
// 		},
// 		CreatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
// 		GeneratedProperties: to.Ptr("<connection-string>"),
// 		ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1"),
// 		ResourceName: to.Ptr("my-cosmosdb-1"),
// 		ResourceType: to.Ptr("Microsoft.DocumentDB"),
// 		UpdatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
// 	},
// }

Output:

func (*BindingsClient) Get 

func (client *BindingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, appName string, bindingName string, options *BindingsClientGetOptions) (BindingsClientGetResponse, error)

Get - Get a Binding and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • bindingName - The name of the Binding resource.
  • options - BindingsClientGetOptions contains the optional parameters for the BindingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Bindings_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBindingsClient().Get(ctx, "myResourceGroup", "myservice", "myapp", "mybinding", 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.BindingResource = armappplatform.BindingResource{
// 	Name: to.Ptr("mybinding"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/bindings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BindingResourceProperties{
// 		BindingParameters: map[string]*string{
// 			"apiType": to.Ptr("SQL"),
// 			"databaseName": to.Ptr("db1"),
// 		},
// 		CreatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
// 		GeneratedProperties: to.Ptr("<connection-string>"),
// 		ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1"),
// 		ResourceName: to.Ptr("my-cosmosdb-1"),
// 		ResourceType: to.Ptr("Microsoft.DocumentDB"),
// 		UpdatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
// 	},
// }

Output:

func (*BindingsClient) NewListPager 

func (client *BindingsClient) NewListPager(resourceGroupName string, serviceName string, appName string, options *BindingsClientListOptions) *runtime.Pager[BindingsClientListResponse]

NewListPager - Handles requests to list all resources in an App.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • options - BindingsClientListOptions contains the optional parameters for the BindingsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Bindings_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBindingsClient().NewListPager("myResourceGroup", "myservice", "myapp", 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.BindingResourceCollection = armappplatform.BindingResourceCollection{
	// 	Value: []*armappplatform.BindingResource{
	// 		{
	// 			Name: to.Ptr("mybinding"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/bindings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/bindings/mybinding"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BindingResourceProperties{
	// 				BindingParameters: map[string]*string{
	// 					"apiType": to.Ptr("SQL"),
	// 					"databaseName": to.Ptr("db1"),
	// 				},
	// 				CreatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
	// 				GeneratedProperties: to.Ptr("<connection-string>"),
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1"),
	// 				ResourceName: to.Ptr("my-cosmosdb-1"),
	// 				ResourceType: to.Ptr("Microsoft.DocumentDB"),
	// 				UpdatedAt: to.Ptr("2019-01-01T12:34:56.000Z"),
	// 			},
	// 	}},
	// }
}

Output:

type BindingsClientBeginCreateOrUpdateOptions 

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

BindingsClientBeginCreateOrUpdateOptions contains the optional parameters for the BindingsClient.BeginCreateOrUpdate method.

type BindingsClientBeginDeleteOptions 

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

BindingsClientBeginDeleteOptions contains the optional parameters for the BindingsClient.BeginDelete method.

type BindingsClientBeginUpdateOptions 

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

BindingsClientBeginUpdateOptions contains the optional parameters for the BindingsClient.BeginUpdate method.

type BindingsClientCreateOrUpdateResponse 

type BindingsClientCreateOrUpdateResponse struct {
	// Binding resource payload
	BindingResource
}

BindingsClientCreateOrUpdateResponse contains the response from method BindingsClient.BeginCreateOrUpdate.

type BindingsClientDeleteResponse 

type BindingsClientDeleteResponse struct {
}

BindingsClientDeleteResponse contains the response from method BindingsClient.BeginDelete.

type BindingsClientGetOptions 

type BindingsClientGetOptions struct {
}

BindingsClientGetOptions contains the optional parameters for the BindingsClient.Get method.

type BindingsClientGetResponse 

type BindingsClientGetResponse struct {
	// Binding resource payload
	BindingResource
}

BindingsClientGetResponse contains the response from method BindingsClient.Get.

type BindingsClientListOptions 

type BindingsClientListOptions struct {
}

BindingsClientListOptions contains the optional parameters for the BindingsClient.NewListPager method.

type BindingsClientListResponse 

type BindingsClientListResponse struct {
	// Object that includes an array of Binding resources and a possible link for next set
	BindingResourceCollection
}

BindingsClientListResponse contains the response from method BindingsClient.NewListPager.

type BindingsClientUpdateResponse 

type BindingsClientUpdateResponse struct {
	// Binding resource payload
	BindingResource
}

BindingsClientUpdateResponse contains the response from method BindingsClient.BeginUpdate.

type Build 

type Build struct {
	// Properties of the build resource
	Properties *BuildProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

Build resource payload

func (Build) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Build.

func (*Build) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Build.

type BuildCollection 

type BuildCollection 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 Build resources
	Value []*Build
}

BuildCollection - Object that includes an array of Build resources and a possible link for next set

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 BuildProperties 

type BuildProperties struct {
	// The resource id of agent pool
	AgentPool *string

	// The APMs for this build
	Apms []*ApmReference

	// The resource id of builder to build the source code
	Builder *string

	// The CA Certificates for this build
	Certificates []*CertificateReference

	// The environment variables for this build
	Env map[string]*string

	// The relative path of source code
	RelativePath *string

	// The customized build resource for this build
	ResourceRequests *BuildResourceRequests

	// READ-ONLY; Provisioning state of the KPack build result
	ProvisioningState *BuildProvisioningState

	// READ-ONLY; The build result triggered by this build
	TriggeredBuildResult *TriggeredBuildResult
}

BuildProperties - Build resource properties payload

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 - Provisioning state of the KPack build result 

const (
	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 BuildResourceRequests 

type BuildResourceRequests struct {
	// Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. The default value is 1, this should
	// not exceed build service agent pool cpu size.
	CPU *string

	// Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. The default value is 2Gi, this
	// should not exceed build service agent pool memory size.
	Memory *string
}

BuildResourceRequests - Resource request payload of Build Resource.

func (BuildResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildResourceRequests.

func (*BuildResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResourceRequests.

type BuildResult 

type BuildResult struct {
	// Properties of the build result resource
	Properties *BuildResultProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

BuildResult - Build result resource payload

func (BuildResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildResult.

func (*BuildResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResult.

type BuildResultCollection 

type BuildResultCollection 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 Build result resources
	Value []*BuildResult
}

BuildResultCollection - Object that includes an array of Build result resources and a possible link for next set

func (BuildResultCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultCollection.

func (*BuildResultCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResultCollection.

type BuildResultLog 

type BuildResultLog struct {
	// The public download URL of this build result log
	BlobURL *string
}

BuildResultLog - Build result log resource properties payload

func (BuildResultLog) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultLog.

func (*BuildResultLog) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResultLog.

type BuildResultProperties 

type BuildResultProperties struct {
	// The build pod name which can be used to get the build log streaming.
	BuildPodName *string

	// Error when build is failed.
	Error *Error

	// The name of this build result
	Name *string

	// READ-ONLY; All of the build stage (init-container and container) resources in build pod.
	BuildStages []*BuildStageProperties

	// READ-ONLY; The container registry image of this build result.
	Image *string

	// READ-ONLY; Provisioning state of the KPack build result
	ProvisioningState *BuildResultProvisioningState
}

BuildResultProperties - Build result resource properties payload

func (BuildResultProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultProperties.

func (*BuildResultProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResultProperties.

type BuildResultProvisioningState 

type BuildResultProvisioningState string

BuildResultProvisioningState - Provisioning state of the KPack build result 

const (
	BuildResultProvisioningStateBuilding  BuildResultProvisioningState = "Building"
	BuildResultProvisioningStateDeleting  BuildResultProvisioningState = "Deleting"
	BuildResultProvisioningStateFailed    BuildResultProvisioningState = "Failed"
	BuildResultProvisioningStateQueuing   BuildResultProvisioningState = "Queuing"
	BuildResultProvisioningStateSucceeded BuildResultProvisioningState = "Succeeded"
)

func PossibleBuildResultProvisioningStateValues 

func PossibleBuildResultProvisioningStateValues() []BuildResultProvisioningState

PossibleBuildResultProvisioningStateValues returns the possible values for the BuildResultProvisioningState const type.

type BuildResultUserSourceInfo 

type BuildResultUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// Resource id of an existing succeeded build result under the same Spring instance.
	BuildResultID *string

	// Version of the source
	Version *string
}

BuildResultUserSourceInfo - Reference to a build result

func (*BuildResultUserSourceInfo) GetUserSourceInfo 

func (b *BuildResultUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type BuildResultUserSourceInfo.

func (BuildResultUserSourceInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultUserSourceInfo.

func (*BuildResultUserSourceInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResultUserSourceInfo.

type BuildService 

type BuildService struct {
	// Properties of the build resource
	Properties *BuildServiceProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

BuildService - Build service resource payload

func (BuildService) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildService.

func (*BuildService) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildService.

type BuildServiceAgentPoolClient 

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

BuildServiceAgentPoolClient contains the methods for the BuildServiceAgentPool group. Don't use this type directly, use NewBuildServiceAgentPoolClient() instead.

func NewBuildServiceAgentPoolClient 

func NewBuildServiceAgentPoolClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildServiceAgentPoolClient, error)

NewBuildServiceAgentPoolClient creates a new instance of BuildServiceAgentPoolClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BuildServiceAgentPoolClient) BeginUpdatePut 

func (client *BuildServiceAgentPoolClient) BeginUpdatePut(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, agentPoolName string, agentPoolResource BuildServiceAgentPoolResource, options *BuildServiceAgentPoolClientBeginUpdatePutOptions) (*runtime.Poller[BuildServiceAgentPoolClientUpdatePutResponse], error)

BeginUpdatePut - Create or update build service agent pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • agentPoolName - The name of the build service agent pool resource.
  • agentPoolResource - Parameters for the update operation
  • options - BuildServiceAgentPoolClientBeginUpdatePutOptions contains the optional parameters for the BuildServiceAgentPoolClient.BeginUpdatePut method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceAgentPool_UpdatePut.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildServiceAgentPoolClient().BeginUpdatePut(ctx, "myResourceGroup", "myservice", "default", "default", armappplatform.BuildServiceAgentPoolResource{
	Properties: &armappplatform.BuildServiceAgentPoolProperties{
		PoolSize: &armappplatform.BuildServiceAgentPoolSizeProperties{
			Name: to.Ptr("S3"),
		},
	},
}, 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.BuildServiceAgentPoolResource = armappplatform.BuildServiceAgentPoolResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/agentPools"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildServiceAgentPoolProperties{
// 		PoolSize: &armappplatform.BuildServiceAgentPoolSizeProperties{
// 			Name: to.Ptr("S3"),
// 			CPU: to.Ptr("4"),
// 			Memory: to.Ptr("8Gi"),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*BuildServiceAgentPoolClient) Get 

func (client *BuildServiceAgentPoolClient) Get(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, agentPoolName string, options *BuildServiceAgentPoolClientGetOptions) (BuildServiceAgentPoolClientGetResponse, error)

Get - Get build service agent pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • agentPoolName - The name of the build service agent pool resource.
  • options - BuildServiceAgentPoolClientGetOptions contains the optional parameters for the BuildServiceAgentPoolClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceAgentPool_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceAgentPoolClient().Get(ctx, "myResourceGroup", "myservice", "default", "default", 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.BuildServiceAgentPoolResource = armappplatform.BuildServiceAgentPoolResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/agentPools"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildServiceAgentPoolProperties{
// 		PoolSize: &armappplatform.BuildServiceAgentPoolSizeProperties{
// 			Name: to.Ptr("S3"),
// 			CPU: to.Ptr("4"),
// 			Memory: to.Ptr("8Gi"),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*BuildServiceAgentPoolClient) NewListPager 

func (client *BuildServiceAgentPoolClient) NewListPager(resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceAgentPoolClientListOptions) *runtime.Pager[BuildServiceAgentPoolClientListResponse]

NewListPager - List build service agent pool.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceAgentPoolClientListOptions contains the optional parameters for the BuildServiceAgentPoolClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceAgentPool_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildServiceAgentPoolClient().NewListPager("myResourceGroup", "myservice", "default", 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.BuildServiceAgentPoolResourceCollection = armappplatform.BuildServiceAgentPoolResourceCollection{
	// 	Value: []*armappplatform.BuildServiceAgentPoolResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/agentPools"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildServiceAgentPoolProperties{
	// 				PoolSize: &armappplatform.BuildServiceAgentPoolSizeProperties{
	// 					Name: to.Ptr("S3"),
	// 					CPU: to.Ptr("4"),
	// 					Memory: to.Ptr("8Gi"),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 	}},
	// }
}

Output:

type BuildServiceAgentPoolClientBeginUpdatePutOptions 

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

BuildServiceAgentPoolClientBeginUpdatePutOptions contains the optional parameters for the BuildServiceAgentPoolClient.BeginUpdatePut method.

type BuildServiceAgentPoolClientGetOptions 

type BuildServiceAgentPoolClientGetOptions struct {
}

BuildServiceAgentPoolClientGetOptions contains the optional parameters for the BuildServiceAgentPoolClient.Get method.

type BuildServiceAgentPoolClientGetResponse 

type BuildServiceAgentPoolClientGetResponse struct {
	// The build service agent pool resource
	BuildServiceAgentPoolResource
}

BuildServiceAgentPoolClientGetResponse contains the response from method BuildServiceAgentPoolClient.Get.

type BuildServiceAgentPoolClientListOptions 

type BuildServiceAgentPoolClientListOptions struct {
}

BuildServiceAgentPoolClientListOptions contains the optional parameters for the BuildServiceAgentPoolClient.NewListPager method.

type BuildServiceAgentPoolClientListResponse 

type BuildServiceAgentPoolClientListResponse struct {
	// Object that includes an array of build service agent pool resources and a possible link for next set
	BuildServiceAgentPoolResourceCollection
}

BuildServiceAgentPoolClientListResponse contains the response from method BuildServiceAgentPoolClient.NewListPager.

type BuildServiceAgentPoolClientUpdatePutResponse 

type BuildServiceAgentPoolClientUpdatePutResponse struct {
	// The build service agent pool resource
	BuildServiceAgentPoolResource
}

BuildServiceAgentPoolClientUpdatePutResponse contains the response from method BuildServiceAgentPoolClient.BeginUpdatePut.

type BuildServiceAgentPoolProperties 

type BuildServiceAgentPoolProperties struct {
	// build service agent pool size properties
	PoolSize *BuildServiceAgentPoolSizeProperties

	// READ-ONLY; Provisioning state of the build service agent pool
	ProvisioningState *string
}

BuildServiceAgentPoolProperties - Build service agent pool properties

func (BuildServiceAgentPoolProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceAgentPoolProperties.

func (*BuildServiceAgentPoolProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServiceAgentPoolProperties.

type BuildServiceAgentPoolResource 

type BuildServiceAgentPoolResource struct {
	// build service agent pool properties
	Properties *BuildServiceAgentPoolProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

BuildServiceAgentPoolResource - The build service agent pool resource

func (BuildServiceAgentPoolResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceAgentPoolResource.

func (*BuildServiceAgentPoolResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServiceAgentPoolResource.

type BuildServiceAgentPoolResourceCollection 

type BuildServiceAgentPoolResourceCollection 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 build service agent pool resource
	Value []*BuildServiceAgentPoolResource
}

BuildServiceAgentPoolResourceCollection - Object that includes an array of build service agent pool resources and a possible link for next set

func (BuildServiceAgentPoolResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceAgentPoolResourceCollection.

func (*BuildServiceAgentPoolResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServiceAgentPoolResourceCollection.

type BuildServiceAgentPoolSizeProperties 

type BuildServiceAgentPoolSizeProperties struct {
	// The name of build service agent pool size
	Name *string

	// READ-ONLY; The cpu property of build service agent pool size
	CPU *string

	// READ-ONLY; The memory property of build service agent pool size
	Memory *string
}

BuildServiceAgentPoolSizeProperties - Build service agent pool size properties

func (BuildServiceAgentPoolSizeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceAgentPoolSizeProperties.

func (*BuildServiceAgentPoolSizeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServiceAgentPoolSizeProperties.

type BuildServiceBuilderClient 

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

BuildServiceBuilderClient contains the methods for the BuildServiceBuilder group. Don't use this type directly, use NewBuildServiceBuilderClient() instead.

func NewBuildServiceBuilderClient 

func NewBuildServiceBuilderClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildServiceBuilderClient, error)

NewBuildServiceBuilderClient creates a new instance of BuildServiceBuilderClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BuildServiceBuilderClient) BeginCreateOrUpdate 

func (client *BuildServiceBuilderClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, builderResource BuilderResource, options *BuildServiceBuilderClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildServiceBuilderClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • builderResource - The target builder for the create or update operation
  • options - BuildServiceBuilderClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildServiceBuilderClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildServiceBuilderClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "mybuilder", armappplatform.BuilderResource{
	Properties: &armappplatform.BuilderProperties{
		BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
			{
				Name: to.Ptr("mix"),
				Buildpacks: []*armappplatform.BuildpackProperties{
					{
						ID: to.Ptr("tanzu-buildpacks/java-azure"),
					}},
			}},
		Stack: &armappplatform.StackProperties{
			ID:      to.Ptr("io.buildpacks.stacks.bionic"),
			Version: to.Ptr("base"),
		},
	},
}, 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 = armappplatform.BuilderResource{
// 	Name: to.Ptr("mybuilder"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuilderProperties{
// 		BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
// 			{
// 				Name: to.Ptr("mix"),
// 				Buildpacks: []*armappplatform.BuildpackProperties{
// 					{
// 						ID: to.Ptr("tanzu-buildpacks/java-azure"),
// 					},
// 					{
// 						ID: to.Ptr("tanzu-buildpacks/dotnet-core"),
// 				}},
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.BuilderProvisioningStateSucceeded),
// 		Stack: &armappplatform.StackProperties{
// 			ID: to.Ptr("io.buildpacks.stacks.bionic"),
// 			Version: to.Ptr("base"),
// 		},
// 	},
// }

Output:

func (*BuildServiceBuilderClient) BeginDelete 

func (client *BuildServiceBuilderClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, options *BuildServiceBuilderClientBeginDeleteOptions) (*runtime.Poller[BuildServiceBuilderClientDeleteResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • options - BuildServiceBuilderClientBeginDeleteOptions contains the optional parameters for the BuildServiceBuilderClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildServiceBuilderClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", "mybuilder", 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 (*BuildServiceBuilderClient) Get 

func (client *BuildServiceBuilderClient) Get(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, options *BuildServiceBuilderClientGetOptions) (BuildServiceBuilderClientGetResponse, error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • options - BuildServiceBuilderClientGetOptions contains the optional parameters for the BuildServiceBuilderClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceBuilderClient().Get(ctx, "myResourceGroup", "myservice", "default", "mybuilder", 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 = armappplatform.BuilderResource{
// 	Name: to.Ptr("mybuilder"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuilderProperties{
// 		BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
// 			{
// 				Name: to.Ptr("mix"),
// 				Buildpacks: []*armappplatform.BuildpackProperties{
// 					{
// 						ID: to.Ptr("tanzu-buildpacks/java-azure"),
// 				}},
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.BuilderProvisioningStateSucceeded),
// 		Stack: &armappplatform.StackProperties{
// 			ID: to.Ptr("io.buildpacks.stacks.bionic"),
// 			Version: to.Ptr("base"),
// 		},
// 	},
// }

Output:

func (*BuildServiceBuilderClient) ListDeployments 

func (client *BuildServiceBuilderClient) ListDeployments(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, options *BuildServiceBuilderClientListDeploymentsOptions) (BuildServiceBuilderClientListDeploymentsResponse, error)

ListDeployments - List deployments that are using the builder. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • options - BuildServiceBuilderClientListDeploymentsOptions contains the optional parameters for the BuildServiceBuilderClient.ListDeployments method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_ListDeployments.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceBuilderClient().ListDeployments(ctx, "myResourceGroup", "myservice", "default", "default", 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.DeploymentList = armappplatform.DeploymentList{
// 	Deployments: []*string{
// 		to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/test/deployments/default"),
// 		to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/test/deployments/green")},
// 	}

Output:

func (*BuildServiceBuilderClient) NewListPager 

func (client *BuildServiceBuilderClient) NewListPager(resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceBuilderClientListOptions) *runtime.Pager[BuildServiceBuilderClientListResponse]

NewListPager - List KPack builders result.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceBuilderClientListOptions contains the optional parameters for the BuildServiceBuilderClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildServiceBuilderClient().NewListPager("myResourceGroup", "myservice", "default", 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.BuilderResourceCollection = armappplatform.BuilderResourceCollection{
	// 	Value: []*armappplatform.BuilderResource{
	// 		{
	// 			Name: to.Ptr("mybuilder"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuilderProperties{
	// 				BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
	// 					{
	// 						Name: to.Ptr("mix"),
	// 						Buildpacks: []*armappplatform.BuildpackProperties{
	// 							{
	// 								ID: to.Ptr("tanzu-buildpacks/java-azure"),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.BuilderProvisioningStateSucceeded),
	// 				Stack: &armappplatform.StackProperties{
	// 					ID: to.Ptr("io.buildpacks.stacks.bionic"),
	// 					Version: to.Ptr("base"),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type BuildServiceBuilderClientBeginCreateOrUpdateOptions 

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

BuildServiceBuilderClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildServiceBuilderClient.BeginCreateOrUpdate method.

type BuildServiceBuilderClientBeginDeleteOptions 

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

BuildServiceBuilderClientBeginDeleteOptions contains the optional parameters for the BuildServiceBuilderClient.BeginDelete method.

type BuildServiceBuilderClientCreateOrUpdateResponse 

type BuildServiceBuilderClientCreateOrUpdateResponse struct {
	// KPack Builder resource
	BuilderResource
}

BuildServiceBuilderClientCreateOrUpdateResponse contains the response from method BuildServiceBuilderClient.BeginCreateOrUpdate.

type BuildServiceBuilderClientDeleteResponse 

type BuildServiceBuilderClientDeleteResponse struct {
}

BuildServiceBuilderClientDeleteResponse contains the response from method BuildServiceBuilderClient.BeginDelete.

type BuildServiceBuilderClientGetOptions 

type BuildServiceBuilderClientGetOptions struct {
}

BuildServiceBuilderClientGetOptions contains the optional parameters for the BuildServiceBuilderClient.Get method.

type BuildServiceBuilderClientGetResponse 

type BuildServiceBuilderClientGetResponse struct {
	// KPack Builder resource
	BuilderResource
}

BuildServiceBuilderClientGetResponse contains the response from method BuildServiceBuilderClient.Get.

type BuildServiceBuilderClientListDeploymentsOptions 

type BuildServiceBuilderClientListDeploymentsOptions struct {
}

BuildServiceBuilderClientListDeploymentsOptions contains the optional parameters for the BuildServiceBuilderClient.ListDeployments method.

type BuildServiceBuilderClientListDeploymentsResponse 

type BuildServiceBuilderClientListDeploymentsResponse struct {
	// A list of deployments resource ids.
	DeploymentList
}

BuildServiceBuilderClientListDeploymentsResponse contains the response from method BuildServiceBuilderClient.ListDeployments.

type BuildServiceBuilderClientListOptions 

type BuildServiceBuilderClientListOptions struct {
}

BuildServiceBuilderClientListOptions contains the optional parameters for the BuildServiceBuilderClient.NewListPager method.

type BuildServiceBuilderClientListResponse 

type BuildServiceBuilderClientListResponse struct {
	// Object that includes an array of Builder resources and a possible link for next set
	BuilderResourceCollection
}

BuildServiceBuilderClientListResponse contains the response from method BuildServiceBuilderClient.NewListPager.

type BuildServiceClient 

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

BuildServiceClient contains the methods for the BuildService group. Don't use this type directly, use NewBuildServiceClient() instead.

func NewBuildServiceClient 

func NewBuildServiceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildServiceClient, error)

NewBuildServiceClient creates a new instance of BuildServiceClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BuildServiceClient) BeginCreateOrUpdate 

func (client *BuildServiceClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildService BuildService, options *BuildServiceClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildServiceClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildService - Parameters for the create operation
  • options - BuildServiceClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildServiceClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildServiceClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.BuildService{
	Properties: &armappplatform.BuildServiceProperties{
		ContainerRegistry: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/containerRegistrys/default"),
	},
}, 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.BuildService = armappplatform.BuildService{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildServiceProperties{
// 		ContainerRegistry: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/containerRegistrys/default"),
// 		KPackVersion: to.Ptr("0.7.2"),
// 		ProvisioningState: to.Ptr(armappplatform.BuildServiceProvisioningStateSucceeded),
// 		ResourceRequests: &armappplatform.BuildServicePropertiesResourceRequests{
// 			CPU: to.Ptr("2000m"),
// 			Memory: to.Ptr("4Gi"),
// 		},
// 	},
// }

Output:

func (*BuildServiceClient) BeginDeleteBuild 

func (client *BuildServiceClient) BeginDeleteBuild(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildName string, options *BuildServiceClientBeginDeleteBuildOptions) (*runtime.Poller[BuildServiceClientDeleteBuildResponse], error)

BeginDeleteBuild - delete a KPack build. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildName - The name of the build resource.
  • options - BuildServiceClientBeginDeleteBuildOptions contains the optional parameters for the BuildServiceClient.BeginDeleteBuild method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_DeleteBuild.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildServiceClient().BeginDeleteBuild(ctx, "myResourceGroup", "myservice", "default", "mybuild", 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 (*BuildServiceClient) CreateOrUpdateBuild 

func (client *BuildServiceClient) CreateOrUpdateBuild(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildName string, buildParam Build, options *BuildServiceClientCreateOrUpdateBuildOptions) (BuildServiceClientCreateOrUpdateBuildResponse, error)

CreateOrUpdateBuild - Create or update a KPack build. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildName - The name of the build resource.
  • buildParam - Parameters for the create or update operation
  • options - BuildServiceClientCreateOrUpdateBuildOptions contains the optional parameters for the BuildServiceClient.CreateOrUpdateBuild method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_CreateOrUpdateBuild.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().CreateOrUpdateBuild(ctx, "myResourceGroup", "myservice", "default", "mybuild", armappplatform.Build{
	Properties: &armappplatform.BuildProperties{
		AgentPool: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
		Apms: []*armappplatform.ApmReference{
			{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
			}},
		Builder: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default"),
		Certificates: []*armappplatform.CertificateReference{
			{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
			},
			{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
			}},
		Env: map[string]*string{
			"environmentVariable": to.Ptr("test"),
		},
		RelativePath: to.Ptr("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777"),
		ResourceRequests: &armappplatform.BuildResourceRequests{
			CPU:    to.Ptr("1"),
			Memory: to.Ptr("2Gi"),
		},
	},
}, 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.Build = armappplatform.Build{
// 	Name: to.Ptr("mybuild"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builds"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildProperties{
// 		AgentPool: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
// 		Builder: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default"),
// 		Env: map[string]*string{
// 			"environmentVariable": to.Ptr("test"),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.BuildProvisioningStateSucceeded),
// 		RelativePath: to.Ptr("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777"),
// 		ResourceRequests: &armappplatform.BuildResourceRequests{
// 			CPU: to.Ptr("1"),
// 			Memory: to.Ptr("2Gi"),
// 		},
// 	},
// }

Output:

func (*BuildServiceClient) GetBuild 

func (client *BuildServiceClient) GetBuild(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildName string, options *BuildServiceClientGetBuildOptions) (BuildServiceClientGetBuildResponse, error)

GetBuild - Get a KPack build. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildName - The name of the build resource.
  • options - BuildServiceClientGetBuildOptions contains the optional parameters for the BuildServiceClient.GetBuild method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetBuild.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetBuild(ctx, "myResourceGroup", "myservice", "default", "mybuild", 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.Build = armappplatform.Build{
// 	Name: to.Ptr("mybuild"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builds"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildProperties{
// 		AgentPool: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
// 		Apms: []*armappplatform.ApmReference{
// 			{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 		}},
// 		Builder: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default"),
// 		Certificates: []*armappplatform.CertificateReference{
// 			{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
// 			},
// 			{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
// 		}},
// 		Env: map[string]*string{
// 			"environmentVariable": to.Ptr("test"),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.BuildProvisioningStateSucceeded),
// 		RelativePath: to.Ptr("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777"),
// 		ResourceRequests: &armappplatform.BuildResourceRequests{
// 			CPU: to.Ptr("1"),
// 			Memory: to.Ptr("2Gi"),
// 		},
// 	},
// }

Output:

func (*BuildServiceClient) GetBuildResult 

func (client *BuildServiceClient) GetBuildResult(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildName string, buildResultName string, options *BuildServiceClientGetBuildResultOptions) (BuildServiceClientGetBuildResultResponse, error)

GetBuildResult - Get a KPack build result. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildName - The name of the build resource.
  • buildResultName - The name of the build result resource.
  • options - BuildServiceClientGetBuildResultOptions contains the optional parameters for the BuildServiceClient.GetBuildResult method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetBuildResult.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetBuildResult(ctx, "myResourceGroup", "myservice", "default", "mybuild", "123", 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.BuildResult = armappplatform.BuildResult{
// 	Name: to.Ptr("123"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builds/results"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild/results/123"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildResultProperties{
// 		Name: to.Ptr("123"),
// 		BuildPodName: to.Ptr("mybuild-default-1"),
// 		BuildStages: []*armappplatform.BuildStageProperties{
// 			{
// 				Name: to.Ptr("prepare"),
// 				ExitCode: to.Ptr("0"),
// 				Reason: to.Ptr("Completed"),
// 				Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
// 			},
// 			{
// 				Name: to.Ptr("detect"),
// 				ExitCode: to.Ptr("0"),
// 				Reason: to.Ptr("Completed"),
// 				Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
// 			},
// 			{
// 				Name: to.Ptr("analyze"),
// 				ExitCode: to.Ptr("0"),
// 				Reason: to.Ptr("Completed"),
// 				Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
// 			},
// 			{
// 				Name: to.Ptr("restore"),
// 				ExitCode: to.Ptr("0"),
// 				Reason: to.Ptr("Completed"),
// 				Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
// 			},
// 			{
// 				Name: to.Ptr("build"),
// 				ExitCode: to.Ptr("51"),
// 				Reason: to.Ptr("Error"),
// 				Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateFailed),
// 			},
// 			{
// 				Name: to.Ptr("export"),
// 				ExitCode: to.Ptr("-1"),
// 				Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateNotStarted),
// 		}},
// 		Error: &armappplatform.Error{
// 			Code: to.Ptr("51"),
// 			Message: to.Ptr("Build failed in stage build with reason OOMKilled, please refer to https://aka.ms/buildexitcode"),
// 		},
// 		Image: to.Ptr("myacr.azurecr.io/build-result-image:latest"),
// 		ProvisioningState: to.Ptr(armappplatform.BuildResultProvisioningStateSucceeded),
// 	},
// }

Output:

func (*BuildServiceClient) GetBuildResultLog 

func (client *BuildServiceClient) GetBuildResultLog(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildName string, buildResultName string, options *BuildServiceClientGetBuildResultLogOptions) (BuildServiceClientGetBuildResultLogResponse, error)

GetBuildResultLog - Get a KPack build result log download URL. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildName - The name of the build resource.
  • buildResultName - The name of the build result resource.
  • options - BuildServiceClientGetBuildResultLogOptions contains the optional parameters for the BuildServiceClient.GetBuildResultLog method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetBuildResultLog.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetBuildResultLog(ctx, "myResourceGroup", "myservice", "default", "mybuild", "123", 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.BuildResultLog = armappplatform.BuildResultLog{
// 	BlobURL: to.Ptr("https://sample-storage-account-name.blob.core.windows.net/sample-log-blob-file?readonly-sas-token"),
// }

Output:

func (*BuildServiceClient) GetBuildService 

func (client *BuildServiceClient) GetBuildService(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceClientGetBuildServiceOptions) (BuildServiceClientGetBuildServiceResponse, error)

GetBuildService - Get a build service resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceClientGetBuildServiceOptions contains the optional parameters for the BuildServiceClient.GetBuildService method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetBuildService.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetBuildService(ctx, "myResourceGroup", "myservice", "default", 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.BuildService = armappplatform.BuildService{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildServiceProperties{
// 		KPackVersion: to.Ptr("0.3.1"),
// 		ProvisioningState: to.Ptr(armappplatform.BuildServiceProvisioningStateSucceeded),
// 		ResourceRequests: &armappplatform.BuildServicePropertiesResourceRequests{
// 			CPU: to.Ptr("200m"),
// 			Memory: to.Ptr("4Gi"),
// 		},
// 	},
// }

Output:

func (*BuildServiceClient) GetResourceUploadURL 

func (client *BuildServiceClient) GetResourceUploadURL(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceClientGetResourceUploadURLOptions) (BuildServiceClientGetResourceUploadURLResponse, error)

GetResourceUploadURL - Get an resource upload URL for build service, which may be artifacts or source archive. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceClientGetResourceUploadURLOptions contains the optional parameters for the BuildServiceClient.GetResourceUploadURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetResourceUploadUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetResourceUploadURL(ctx, "myResourceGroup", "myservice", "default", 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.ResourceUploadDefinition = armappplatform.ResourceUploadDefinition{
// 	RelativePath: to.Ptr("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777"),
// 	UploadURL: to.Ptr("https://springcloudstorageaccount.file.core.windows.net/bd172614181f42e2853f6fd90029cda8/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777?sv=2021-06-01&sr=f&sig=SampleSignature&se=2021-06-01T10%3A42%3A21Z&sp=w"),
// }

Output:

func (*BuildServiceClient) GetSupportedBuildpack 

func (client *BuildServiceClient) GetSupportedBuildpack(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, buildpackName string, options *BuildServiceClientGetSupportedBuildpackOptions) (BuildServiceClientGetSupportedBuildpackResponse, error)

GetSupportedBuildpack - Get the supported buildpack resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildpackName - The name of the buildpack resource.
  • options - BuildServiceClientGetSupportedBuildpackOptions contains the optional parameters for the BuildServiceClient.GetSupportedBuildpack method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetSupportedBuildpack.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetSupportedBuildpack(ctx, "myResourceGroup", "myservice", "default", "tanzu-buildpacks-java-azure", 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.SupportedBuildpackResource = armappplatform.SupportedBuildpackResource{
// 	Name: to.Ptr("tanzu-buildpacks-java-azure"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/supportedBuildpacks"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks/tanzu-buildpacks-java-azure"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.SupportedBuildpackResourceProperties{
// 		BuildpackID: to.Ptr("tanzu-buildpacks/java-azure"),
// 	},
// }

Output:

func (*BuildServiceClient) GetSupportedStack 

func (client *BuildServiceClient) GetSupportedStack(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, stackName string, options *BuildServiceClientGetSupportedStackOptions) (BuildServiceClientGetSupportedStackResponse, error)

GetSupportedStack - Get the supported stack resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • stackName - The name of the stack resource.
  • options - BuildServiceClientGetSupportedStackOptions contains the optional parameters for the BuildServiceClient.GetSupportedStack method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetSupportedStack.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().GetSupportedStack(ctx, "myResourceGroup", "myservice", "default", "io.buildpacks.stacks.bionic-base", 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.SupportedStackResource = armappplatform.SupportedStackResource{
// 	Name: to.Ptr("io.buildpacks.stacks.bionic-base"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/supportedStacks"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks/io.buildpacks.stacks.bionic-base"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.SupportedStackResourceProperties{
// 		StackID: to.Ptr("io.buildpacks.stacks.bionic"),
// 		Version: to.Ptr("base"),
// 	},
// }

Output:

func (*BuildServiceClient) ListSupportedBuildpacks 

func (client *BuildServiceClient) ListSupportedBuildpacks(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceClientListSupportedBuildpacksOptions) (BuildServiceClientListSupportedBuildpacksResponse, error)

ListSupportedBuildpacks - Get all supported buildpacks. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceClientListSupportedBuildpacksOptions contains the optional parameters for the BuildServiceClient.ListSupportedBuildpacks method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListSupportedBuildpacks.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().ListSupportedBuildpacks(ctx, "myResourceGroup", "myservice", "default", 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.SupportedBuildpacksCollection = armappplatform.SupportedBuildpacksCollection{
// 	Value: []*armappplatform.SupportedBuildpackResource{
// 		{
// 			Name: to.Ptr("tanzu-buildpacks-java-azure"),
// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/supportedBuildpacks"),
// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedBuildpacks/tanzu-buildpacks-java-azure"),
// 			SystemData: &armappplatform.SystemData{
// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 				CreatedBy: to.Ptr("sample-user"),
// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 				LastModifiedBy: to.Ptr("sample-user"),
// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 			},
// 			Properties: &armappplatform.SupportedBuildpackResourceProperties{
// 				BuildpackID: to.Ptr("tanzu-buildpacks/java-azure"),
// 			},
// 	}},
// }

Output:

func (*BuildServiceClient) ListSupportedStacks 

func (client *BuildServiceClient) ListSupportedStacks(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceClientListSupportedStacksOptions) (BuildServiceClientListSupportedStacksResponse, error)

ListSupportedStacks - Get all supported stacks. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceClientListSupportedStacksOptions contains the optional parameters for the BuildServiceClient.ListSupportedStacks method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListSupportedStacks.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildServiceClient().ListSupportedStacks(ctx, "myResourceGroup", "myservice", "default", 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.SupportedStacksCollection = armappplatform.SupportedStacksCollection{
// 	Value: []*armappplatform.SupportedStackResource{
// 		{
// 			Name: to.Ptr("io.buildpacks.stacks.bionic-base"),
// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/supportedStacks"),
// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/supportedStacks/io.buildpacks.stacks.bionic-base"),
// 			SystemData: &armappplatform.SystemData{
// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 				CreatedBy: to.Ptr("sample-user"),
// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 				LastModifiedBy: to.Ptr("sample-user"),
// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 			},
// 			Properties: &armappplatform.SupportedStackResourceProperties{
// 				StackID: to.Ptr("io.buildpacks.stacks.bionic"),
// 				Version: to.Ptr("base"),
// 			},
// 	}},
// }

Output:

func (*BuildServiceClient) NewListBuildResultsPager 

func (client *BuildServiceClient) NewListBuildResultsPager(resourceGroupName string, serviceName string, buildServiceName string, buildName string, options *BuildServiceClientListBuildResultsOptions) *runtime.Pager[BuildServiceClientListBuildResultsResponse]

NewListBuildResultsPager - List KPack build results.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • buildName - The name of the build resource.
  • options - BuildServiceClientListBuildResultsOptions contains the optional parameters for the BuildServiceClient.NewListBuildResultsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuildResults.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildServiceClient().NewListBuildResultsPager("myResourceGroup", "myservice", "default", "mybuild", 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.BuildResultCollection = armappplatform.BuildResultCollection{
	// 	Value: []*armappplatform.BuildResult{
	// 		{
	// 			Name: to.Ptr("123"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builds/results"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/mybuild/results/123"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildResultProperties{
	// 				Name: to.Ptr("123"),
	// 				BuildPodName: to.Ptr("mybuild-default-1"),
	// 				BuildStages: []*armappplatform.BuildStageProperties{
	// 					{
	// 						Name: to.Ptr("prepare"),
	// 						ExitCode: to.Ptr("0"),
	// 						Reason: to.Ptr("Completed"),
	// 						Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
	// 					},
	// 					{
	// 						Name: to.Ptr("detect"),
	// 						ExitCode: to.Ptr("0"),
	// 						Reason: to.Ptr("Completed"),
	// 						Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
	// 					},
	// 					{
	// 						Name: to.Ptr("analyze"),
	// 						ExitCode: to.Ptr("0"),
	// 						Reason: to.Ptr("Completed"),
	// 						Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
	// 					},
	// 					{
	// 						Name: to.Ptr("restore"),
	// 						ExitCode: to.Ptr("0"),
	// 						Reason: to.Ptr("Completed"),
	// 						Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateSucceeded),
	// 					},
	// 					{
	// 						Name: to.Ptr("build"),
	// 						ExitCode: to.Ptr("51"),
	// 						Reason: to.Ptr("Error"),
	// 						Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateFailed),
	// 					},
	// 					{
	// 						Name: to.Ptr("export"),
	// 						ExitCode: to.Ptr("-1"),
	// 						Status: to.Ptr(armappplatform.KPackBuildStageProvisioningStateNotStarted),
	// 				}},
	// 				Error: &armappplatform.Error{
	// 					Code: to.Ptr("51"),
	// 					Message: to.Ptr("Build failed in stage build with reason OOMKilled, please refer to https://aka.ms/buildexitcode"),
	// 				},
	// 				Image: to.Ptr("myacr.azurecr.io/build-result-image:latest"),
	// 				ProvisioningState: to.Ptr(armappplatform.BuildResultProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*BuildServiceClient) NewListBuildServicesPager 

func (client *BuildServiceClient) NewListBuildServicesPager(resourceGroupName string, serviceName string, options *BuildServiceClientListBuildServicesOptions) *runtime.Pager[BuildServiceClientListBuildServicesResponse]

NewListBuildServicesPager - List build services resource.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - BuildServiceClientListBuildServicesOptions contains the optional parameters for the BuildServiceClient.NewListBuildServicesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuildServices.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildServiceClient().NewListBuildServicesPager("myResourceGroup", "myservice", 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.BuildServiceCollection = armappplatform.BuildServiceCollection{
	// 	Value: []*armappplatform.BuildService{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildServiceProperties{
	// 				KPackVersion: to.Ptr("0.3.1"),
	// 				ProvisioningState: to.Ptr(armappplatform.BuildServiceProvisioningStateSucceeded),
	// 				ResourceRequests: &armappplatform.BuildServicePropertiesResourceRequests{
	// 					CPU: to.Ptr("200m"),
	// 					Memory: to.Ptr("4Gi"),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

func (*BuildServiceClient) NewListBuildsPager 

func (client *BuildServiceClient) NewListBuildsPager(resourceGroupName string, serviceName string, buildServiceName string, options *BuildServiceClientListBuildsOptions) *runtime.Pager[BuildServiceClientListBuildsResponse]

NewListBuildsPager - List KPack builds.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • options - BuildServiceClientListBuildsOptions contains the optional parameters for the BuildServiceClient.NewListBuildsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuilds.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildServiceClient().NewListBuildsPager("myResourceGroup", "myservice", "default", 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 = armappplatform.BuildCollection{
	// 	Value: []*armappplatform.Build{
	// 		{
	// 			Name: to.Ptr("myBuild"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builds"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builds/myBuild"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildProperties{
	// 				AgentPool: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/agentPools/default"),
	// 				Apms: []*armappplatform.ApmReference{
	// 					{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
	// 				}},
	// 				Builder: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default"),
	// 				Certificates: []*armappplatform.CertificateReference{
	// 					{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert1"),
	// 					},
	// 					{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycert2"),
	// 				}},
	// 				Env: map[string]*string{
	// 					"environmentVariable": to.Ptr("test"),
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.BuildProvisioningStateSucceeded),
	// 				RelativePath: to.Ptr("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855-20210601-3ed9f4a2-986b-4bbd-b833-a42dccb2f777"),
	// 				ResourceRequests: &armappplatform.BuildResourceRequests{
	// 					CPU: to.Ptr("1"),
	// 					Memory: to.Ptr("2Gi"),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type BuildServiceClientBeginCreateOrUpdateOptions 

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

BuildServiceClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildServiceClient.BeginCreateOrUpdate method.

type BuildServiceClientBeginDeleteBuildOptions 

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

BuildServiceClientBeginDeleteBuildOptions contains the optional parameters for the BuildServiceClient.BeginDeleteBuild method.

type BuildServiceClientCreateOrUpdateBuildOptions 

type BuildServiceClientCreateOrUpdateBuildOptions struct {
}

BuildServiceClientCreateOrUpdateBuildOptions contains the optional parameters for the BuildServiceClient.CreateOrUpdateBuild method.

type BuildServiceClientCreateOrUpdateBuildResponse 

type BuildServiceClientCreateOrUpdateBuildResponse struct {
	// Build resource payload
	Build
}

BuildServiceClientCreateOrUpdateBuildResponse contains the response from method BuildServiceClient.CreateOrUpdateBuild.

type BuildServiceClientCreateOrUpdateResponse 

type BuildServiceClientCreateOrUpdateResponse struct {
	// Build service resource payload
	BuildService
}

BuildServiceClientCreateOrUpdateResponse contains the response from method BuildServiceClient.BeginCreateOrUpdate.

type BuildServiceClientDeleteBuildResponse 

type BuildServiceClientDeleteBuildResponse struct {
}

BuildServiceClientDeleteBuildResponse contains the response from method BuildServiceClient.BeginDeleteBuild.

type BuildServiceClientGetBuildOptions 

type BuildServiceClientGetBuildOptions struct {
}

BuildServiceClientGetBuildOptions contains the optional parameters for the BuildServiceClient.GetBuild method.

type BuildServiceClientGetBuildResponse 

type BuildServiceClientGetBuildResponse struct {
	// Build resource payload
	Build
}

BuildServiceClientGetBuildResponse contains the response from method BuildServiceClient.GetBuild.

type BuildServiceClientGetBuildResultLogOptions 

type BuildServiceClientGetBuildResultLogOptions struct {
}

BuildServiceClientGetBuildResultLogOptions contains the optional parameters for the BuildServiceClient.GetBuildResultLog method.

type BuildServiceClientGetBuildResultLogResponse 

type BuildServiceClientGetBuildResultLogResponse struct {
	// Build result log resource properties payload
	BuildResultLog
}

BuildServiceClientGetBuildResultLogResponse contains the response from method BuildServiceClient.GetBuildResultLog.

type BuildServiceClientGetBuildResultOptions 

type BuildServiceClientGetBuildResultOptions struct {
}

BuildServiceClientGetBuildResultOptions contains the optional parameters for the BuildServiceClient.GetBuildResult method.

type BuildServiceClientGetBuildResultResponse 

type BuildServiceClientGetBuildResultResponse struct {
	// Build result resource payload
	BuildResult
}

BuildServiceClientGetBuildResultResponse contains the response from method BuildServiceClient.GetBuildResult.

type BuildServiceClientGetBuildServiceOptions 

type BuildServiceClientGetBuildServiceOptions struct {
}

BuildServiceClientGetBuildServiceOptions contains the optional parameters for the BuildServiceClient.GetBuildService method.

type BuildServiceClientGetBuildServiceResponse 

type BuildServiceClientGetBuildServiceResponse struct {
	// Build service resource payload
	BuildService
}

BuildServiceClientGetBuildServiceResponse contains the response from method BuildServiceClient.GetBuildService.

type BuildServiceClientGetResourceUploadURLOptions 

type BuildServiceClientGetResourceUploadURLOptions struct {
}

BuildServiceClientGetResourceUploadURLOptions contains the optional parameters for the BuildServiceClient.GetResourceUploadURL method.

type BuildServiceClientGetResourceUploadURLResponse 

type BuildServiceClientGetResourceUploadURLResponse struct {
	// Resource upload definition payload
	ResourceUploadDefinition
}

BuildServiceClientGetResourceUploadURLResponse contains the response from method BuildServiceClient.GetResourceUploadURL.

type BuildServiceClientGetSupportedBuildpackOptions 

type BuildServiceClientGetSupportedBuildpackOptions struct {
}

BuildServiceClientGetSupportedBuildpackOptions contains the optional parameters for the BuildServiceClient.GetSupportedBuildpack method.

type BuildServiceClientGetSupportedBuildpackResponse 

type BuildServiceClientGetSupportedBuildpackResponse struct {
	// Supported buildpack resource payload
	SupportedBuildpackResource
}

BuildServiceClientGetSupportedBuildpackResponse contains the response from method BuildServiceClient.GetSupportedBuildpack.

type BuildServiceClientGetSupportedStackOptions 

type BuildServiceClientGetSupportedStackOptions struct {
}

BuildServiceClientGetSupportedStackOptions contains the optional parameters for the BuildServiceClient.GetSupportedStack method.

type BuildServiceClientGetSupportedStackResponse 

type BuildServiceClientGetSupportedStackResponse struct {
	// Supported stack resource payload
	SupportedStackResource
}

BuildServiceClientGetSupportedStackResponse contains the response from method BuildServiceClient.GetSupportedStack.

type BuildServiceClientListBuildResultsOptions 

type BuildServiceClientListBuildResultsOptions struct {
}

BuildServiceClientListBuildResultsOptions contains the optional parameters for the BuildServiceClient.NewListBuildResultsPager method.

type BuildServiceClientListBuildResultsResponse 

type BuildServiceClientListBuildResultsResponse struct {
	// Object that includes an array of Build result resources and a possible link for next set
	BuildResultCollection
}

BuildServiceClientListBuildResultsResponse contains the response from method BuildServiceClient.NewListBuildResultsPager.

type BuildServiceClientListBuildServicesOptions 

type BuildServiceClientListBuildServicesOptions struct {
}

BuildServiceClientListBuildServicesOptions contains the optional parameters for the BuildServiceClient.NewListBuildServicesPager method.

type BuildServiceClientListBuildServicesResponse 

type BuildServiceClientListBuildServicesResponse struct {
	// Object that includes an array of Build service resources and a possible link for next set
	BuildServiceCollection
}

BuildServiceClientListBuildServicesResponse contains the response from method BuildServiceClient.NewListBuildServicesPager.

type BuildServiceClientListBuildsOptions 

type BuildServiceClientListBuildsOptions struct {
}

BuildServiceClientListBuildsOptions contains the optional parameters for the BuildServiceClient.NewListBuildsPager method.

type BuildServiceClientListBuildsResponse 

type BuildServiceClientListBuildsResponse struct {
	// Object that includes an array of Build resources and a possible link for next set
	BuildCollection
}

BuildServiceClientListBuildsResponse contains the response from method BuildServiceClient.NewListBuildsPager.

type BuildServiceClientListSupportedBuildpacksOptions 

type BuildServiceClientListSupportedBuildpacksOptions struct {
}

BuildServiceClientListSupportedBuildpacksOptions contains the optional parameters for the BuildServiceClient.ListSupportedBuildpacks method.

type BuildServiceClientListSupportedBuildpacksResponse 

type BuildServiceClientListSupportedBuildpacksResponse struct {
	// Object that includes an array of supported buildpacks resources and a possible link for next set
	SupportedBuildpacksCollection
}

BuildServiceClientListSupportedBuildpacksResponse contains the response from method BuildServiceClient.ListSupportedBuildpacks.

type BuildServiceClientListSupportedStacksOptions 

type BuildServiceClientListSupportedStacksOptions struct {
}

BuildServiceClientListSupportedStacksOptions contains the optional parameters for the BuildServiceClient.ListSupportedStacks method.

type BuildServiceClientListSupportedStacksResponse 

type BuildServiceClientListSupportedStacksResponse struct {
	// Object that includes an array of supported stacks resources and a possible link for next set
	SupportedStacksCollection
}

BuildServiceClientListSupportedStacksResponse contains the response from method BuildServiceClient.ListSupportedStacks.

type BuildServiceCollection 

type BuildServiceCollection 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 Build service resources
	Value []*BuildService
}

BuildServiceCollection - Object that includes an array of Build service resources and a possible link for next set

func (BuildServiceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceCollection.

func (*BuildServiceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServiceCollection.

type BuildServiceProperties 

type BuildServiceProperties struct {
	// The resource id of the container registry used in this build service.
	ContainerRegistry *string

	// The runtime resource configuration of this build service.
	ResourceRequests *BuildServicePropertiesResourceRequests

	// READ-ONLY; The installed KPack version in this build service.
	KPackVersion *string

	// READ-ONLY; Provisioning state of the KPack build service
	ProvisioningState *BuildServiceProvisioningState
}

BuildServiceProperties - Build service resource properties payload

func (BuildServiceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceProperties.

func (*BuildServiceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServiceProperties.

type BuildServicePropertiesResourceRequests 

type BuildServicePropertiesResourceRequests struct {
	// READ-ONLY; vCPU allocated to the entire build service node pool.
	CPU *string

	// READ-ONLY; Memory allocated to the entire build service node pool.
	Memory *string
}

BuildServicePropertiesResourceRequests - The runtime resource configuration of this build service.

func (BuildServicePropertiesResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildServicePropertiesResourceRequests.

func (*BuildServicePropertiesResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildServicePropertiesResourceRequests.

type BuildServiceProvisioningState 

type BuildServiceProvisioningState string

BuildServiceProvisioningState - Provisioning state of the KPack build service 

const (
	BuildServiceProvisioningStateCreating  BuildServiceProvisioningState = "Creating"
	BuildServiceProvisioningStateDeleting  BuildServiceProvisioningState = "Deleting"
	BuildServiceProvisioningStateFailed    BuildServiceProvisioningState = "Failed"
	BuildServiceProvisioningStateSucceeded BuildServiceProvisioningState = "Succeeded"
	BuildServiceProvisioningStateUpdating  BuildServiceProvisioningState = "Updating"
)

func PossibleBuildServiceProvisioningStateValues 

func PossibleBuildServiceProvisioningStateValues() []BuildServiceProvisioningState

PossibleBuildServiceProvisioningStateValues returns the possible values for the BuildServiceProvisioningState const type.

type BuildStageProperties 

type BuildStageProperties struct {
	// READ-ONLY; The exit code of this build init container.
	ExitCode *string

	// READ-ONLY; The name of this build stage resource.
	Name *string

	// READ-ONLY; The reason of this build init container.
	Reason *string

	// READ-ONLY; The provisioning state of this build stage resource.
	Status *KPackBuildStageProvisioningState
}

BuildStageProperties - The build stage (init-container and container) resources in build pod.

func (BuildStageProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildStageProperties.

func (*BuildStageProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildStageProperties.

type BuilderProperties 

type BuilderProperties struct {
	// Builder buildpack groups.
	BuildpackGroups []*BuildpacksGroupProperties

	// Builder cluster stack property.
	Stack *StackProperties

	// READ-ONLY; Builder provision status.
	ProvisioningState *BuilderProvisioningState
}

BuilderProperties - KPack Builder properties payload

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 - Builder provision status. 

const (
	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 {
	// Property of the Builder resource.
	Properties *BuilderProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

BuilderResource - KPack 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 BuilderResourceCollection 

type BuilderResourceCollection 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 Builder resources
	Value []*BuilderResource
}

BuilderResourceCollection - Object that includes an array of Builder resources and a possible link for next set

func (BuilderResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuilderResourceCollection.

func (*BuilderResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuilderResourceCollection.

type BuildpackBindingClient 

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

BuildpackBindingClient contains the methods for the BuildpackBinding group. Don't use this type directly, use NewBuildpackBindingClient() instead.

func NewBuildpackBindingClient 

func NewBuildpackBindingClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BuildpackBindingClient, error)

NewBuildpackBindingClient creates a new instance of BuildpackBindingClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BuildpackBindingClient) BeginCreateOrUpdate 

func (client *BuildpackBindingClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, buildpackBindingName string, buildpackBinding BuildpackBindingResource, options *BuildpackBindingClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildpackBindingClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • buildpackBindingName - The name of the Buildpack Binding Name
  • buildpackBinding - The target buildpack binding for the create or update operation
  • options - BuildpackBindingClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildpackBindingClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildpackBindingClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "default", "myBuildpackBinding", armappplatform.BuildpackBindingResource{
	Properties: &armappplatform.BuildpackBindingProperties{
		BindingType: to.Ptr(armappplatform.BindingTypeApplicationInsights),
		LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
			Properties: map[string]*string{
				"abc":           to.Ptr("def"),
				"any-string":    to.Ptr("any-string"),
				"sampling-rate": to.Ptr("12.0"),
			},
			Secrets: map[string]*string{
				"connection-string": to.Ptr("XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXX;XXXXXXXXXXXXXXXXX=XXXXXXXXXXXXXXXXXXX"),
			},
		},
	},
}, 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.BuildpackBindingResource = armappplatform.BuildpackBindingResource{
// 	Name: to.Ptr("myBuildpackBinding"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildpackBindingProperties{
// 		BindingType: to.Ptr(armappplatform.BindingTypeApplicationInsights),
// 		LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
// 			Properties: map[string]*string{
// 				"abc": to.Ptr("def"),
// 				"any-string": to.Ptr("any-string"),
// 				"sampling-rate": to.Ptr("12.0"),
// 			},
// 			Secrets: map[string]*string{
// 				"connection-string": to.Ptr("*"),
// 			},
// 		},
// 	},
// }

Output:

func (*BuildpackBindingClient) BeginDelete 

func (client *BuildpackBindingClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, buildpackBindingName string, options *BuildpackBindingClientBeginDeleteOptions) (*runtime.Poller[BuildpackBindingClientDeleteResponse], error)

BeginDelete - Operation to delete a Buildpack Binding If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • buildpackBindingName - The name of the Buildpack Binding Name
  • options - BuildpackBindingClientBeginDeleteOptions contains the optional parameters for the BuildpackBindingClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBuildpackBindingClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", "default", "myBuildpackBinding", 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 (*BuildpackBindingClient) Get 

func (client *BuildpackBindingClient) Get(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, buildpackBindingName string, options *BuildpackBindingClientGetOptions) (BuildpackBindingClientGetResponse, error)

Get - Get a buildpack binding by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • buildpackBindingName - The name of the Buildpack Binding Name
  • options - BuildpackBindingClientGetOptions contains the optional parameters for the BuildpackBindingClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBuildpackBindingClient().Get(ctx, "myResourceGroup", "myservice", "default", "default", "myBuildpackBinding", 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.BuildpackBindingResource = armappplatform.BuildpackBindingResource{
// 	Name: to.Ptr("myBuildpackBinding"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.BuildpackBindingProperties{
// 		BindingType: to.Ptr(armappplatform.BindingTypeApplicationInsights),
// 		LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
// 			Properties: map[string]*string{
// 				"abc": to.Ptr("def"),
// 				"any-string": to.Ptr("any-string"),
// 				"sampling-rate": to.Ptr("12.0"),
// 			},
// 			Secrets: map[string]*string{
// 				"connection-string": to.Ptr("*"),
// 			},
// 		},
// 	},
// }

Output:

func (*BuildpackBindingClient) NewListForClusterPager 

func (client *BuildpackBindingClient) NewListForClusterPager(resourceGroupName string, serviceName string, options *BuildpackBindingClientListForClusterOptions) *runtime.Pager[BuildpackBindingClientListForClusterResponse]

NewListForClusterPager - Get collection of buildpack bindings under all builders.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - BuildpackBindingClientListForClusterOptions contains the optional parameters for the BuildpackBindingClient.NewListForClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_ListForCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildpackBindingClient().NewListForClusterPager("myResourceGroup", "myservice", 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.BuildpackBindingResourceCollection = armappplatform.BuildpackBindingResourceCollection{
	// 	Value: []*armappplatform.BuildpackBindingResource{
	// 		{
	// 			Name: to.Ptr("myBuildpackBinding"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildpackBindingProperties{
	// 				BindingType: to.Ptr(armappplatform.BindingTypeApplicationInsights),
	// 				LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
	// 					Properties: map[string]*string{
	// 						"abc": to.Ptr("def"),
	// 						"any-string": to.Ptr("any-string"),
	// 						"sampling-rate": to.Ptr("12.0"),
	// 					},
	// 					Secrets: map[string]*string{
	// 						"connection-string": to.Ptr("*"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.BuildpackBindingProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("appdynamic"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/appdynamic"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildpackBindingProperties{
	// 				BindingType: to.Ptr(armappplatform.BindingTypeAppDynamics),
	// 				LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
	// 					Properties: map[string]*string{
	// 						"abc": to.Ptr("def"),
	// 					},
	// 					Secrets: map[string]*string{
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.BuildpackBindingProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*BuildpackBindingClient) NewListPager 

func (client *BuildpackBindingClient) NewListPager(resourceGroupName string, serviceName string, buildServiceName string, builderName string, options *BuildpackBindingClientListOptions) *runtime.Pager[BuildpackBindingClientListResponse]

NewListPager - Handles requests to list all buildpack bindings in a builder.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • buildServiceName - The name of the build service resource.
  • builderName - The name of the builder resource.
  • options - BuildpackBindingClientListOptions contains the optional parameters for the BuildpackBindingClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBuildpackBindingClient().NewListPager("myResourceGroup", "myservice", "default", "default", 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.BuildpackBindingResourceCollection = armappplatform.BuildpackBindingResourceCollection{
	// 	Value: []*armappplatform.BuildpackBindingResource{
	// 		{
	// 			Name: to.Ptr("myBuildpackBinding"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.BuildpackBindingProperties{
	// 				BindingType: to.Ptr(armappplatform.BindingTypeApplicationInsights),
	// 				LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
	// 					Properties: map[string]*string{
	// 						"abc": to.Ptr("def"),
	// 						"any-string": to.Ptr("any-string"),
	// 						"sampling-rate": to.Ptr("12.0"),
	// 					},
	// 					Secrets: map[string]*string{
	// 						"connection-string": to.Ptr("*"),
	// 					},
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type BuildpackBindingClientBeginCreateOrUpdateOptions 

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

BuildpackBindingClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildpackBindingClient.BeginCreateOrUpdate method.

type BuildpackBindingClientBeginDeleteOptions 

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

BuildpackBindingClientBeginDeleteOptions contains the optional parameters for the BuildpackBindingClient.BeginDelete method.

type BuildpackBindingClientCreateOrUpdateResponse 

type BuildpackBindingClientCreateOrUpdateResponse struct {
	// Buildpack Binding Resource object
	BuildpackBindingResource
}

BuildpackBindingClientCreateOrUpdateResponse contains the response from method BuildpackBindingClient.BeginCreateOrUpdate.

type BuildpackBindingClientDeleteResponse 

type BuildpackBindingClientDeleteResponse struct {
}

BuildpackBindingClientDeleteResponse contains the response from method BuildpackBindingClient.BeginDelete.

type BuildpackBindingClientGetOptions 

type BuildpackBindingClientGetOptions struct {
}

BuildpackBindingClientGetOptions contains the optional parameters for the BuildpackBindingClient.Get method.

type BuildpackBindingClientGetResponse 

type BuildpackBindingClientGetResponse struct {
	// Buildpack Binding Resource object
	BuildpackBindingResource
}

BuildpackBindingClientGetResponse contains the response from method BuildpackBindingClient.Get.

type BuildpackBindingClientListForClusterOptions 

type BuildpackBindingClientListForClusterOptions struct {
}

BuildpackBindingClientListForClusterOptions contains the optional parameters for the BuildpackBindingClient.NewListForClusterPager method.

type BuildpackBindingClientListForClusterResponse 

type BuildpackBindingClientListForClusterResponse struct {
	// Object that includes an array of BuildpackBinding resources and a possible link for next set
	BuildpackBindingResourceCollection
}

BuildpackBindingClientListForClusterResponse contains the response from method BuildpackBindingClient.NewListForClusterPager.

type BuildpackBindingClientListOptions 

type BuildpackBindingClientListOptions struct {
}

BuildpackBindingClientListOptions contains the optional parameters for the BuildpackBindingClient.NewListPager method.

type BuildpackBindingClientListResponse 

type BuildpackBindingClientListResponse struct {
	// Object that includes an array of BuildpackBinding resources and a possible link for next set
	BuildpackBindingResourceCollection
}

BuildpackBindingClientListResponse contains the response from method BuildpackBindingClient.NewListPager.

type BuildpackBindingLaunchProperties 

type BuildpackBindingLaunchProperties struct {
	// Non-sensitive properties for launchProperties
	Properties map[string]*string

	// Sensitive properties for launchProperties
	Secrets map[string]*string
}

BuildpackBindingLaunchProperties - Buildpack Binding Launch Properties

func (BuildpackBindingLaunchProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackBindingLaunchProperties.

func (*BuildpackBindingLaunchProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildpackBindingLaunchProperties.

type BuildpackBindingProperties 

type BuildpackBindingProperties struct {
	// Buildpack Binding Type
	BindingType *BindingType

	// The object describes the buildpack binding launch properties
	LaunchProperties *BuildpackBindingLaunchProperties

	// READ-ONLY; State of the Buildpack Binding.
	ProvisioningState *BuildpackBindingProvisioningState
}

BuildpackBindingProperties - Properties of a buildpack binding

func (BuildpackBindingProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackBindingProperties.

func (*BuildpackBindingProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildpackBindingProperties.

type BuildpackBindingProvisioningState 

type BuildpackBindingProvisioningState string

BuildpackBindingProvisioningState - State of the Buildpack Binding. 

const (
	BuildpackBindingProvisioningStateCreating  BuildpackBindingProvisioningState = "Creating"
	BuildpackBindingProvisioningStateDeleting  BuildpackBindingProvisioningState = "Deleting"
	BuildpackBindingProvisioningStateFailed    BuildpackBindingProvisioningState = "Failed"
	BuildpackBindingProvisioningStateSucceeded BuildpackBindingProvisioningState = "Succeeded"
	BuildpackBindingProvisioningStateUpdating  BuildpackBindingProvisioningState = "Updating"
)

func PossibleBuildpackBindingProvisioningStateValues 

func PossibleBuildpackBindingProvisioningStateValues() []BuildpackBindingProvisioningState

PossibleBuildpackBindingProvisioningStateValues returns the possible values for the BuildpackBindingProvisioningState const type.

type BuildpackBindingResource 

type BuildpackBindingResource struct {
	// Properties of a buildpack binding
	Properties *BuildpackBindingProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

BuildpackBindingResource - Buildpack Binding Resource object

func (BuildpackBindingResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackBindingResource.

func (*BuildpackBindingResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildpackBindingResource.

type BuildpackBindingResourceCollection 

type BuildpackBindingResourceCollection 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 BuildpackBinding resources
	Value []*BuildpackBindingResource
}

BuildpackBindingResourceCollection - Object that includes an array of BuildpackBinding resources and a possible link for next set

func (BuildpackBindingResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackBindingResourceCollection.

func (*BuildpackBindingResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildpackBindingResourceCollection.

type BuildpackProperties 

type BuildpackProperties struct {
	// Id of the buildpack
	ID *string
}

BuildpackProperties - Buildpack properties payload

func (BuildpackProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackProperties.

func (*BuildpackProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildpackProperties.

type BuildpacksGroupProperties 

type BuildpacksGroupProperties struct {
	// Buildpacks in the buildpack group
	Buildpacks []*BuildpackProperties

	// Buildpack group name
	Name *string
}

BuildpacksGroupProperties - Buildpack group properties of the Builder

func (BuildpacksGroupProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BuildpacksGroupProperties.

func (*BuildpacksGroupProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildpacksGroupProperties.

type CertificateProperties 

type CertificateProperties struct {
	// REQUIRED; The type of the certificate source.
	Type *string

	// READ-ONLY; The activate date of certificate.
	ActivateDate *string

	// READ-ONLY; The domain list of certificate.
	DNSNames []*string

	// READ-ONLY; The expiration date of certificate.
	ExpirationDate *string

	// READ-ONLY; The issue date of certificate.
	IssuedDate *string

	// READ-ONLY; The issuer of certificate.
	Issuer *string

	// READ-ONLY; Provisioning state of the Certificate
	ProvisioningState *CertificateResourceProvisioningState

	// READ-ONLY; The subject name of certificate.
	SubjectName *string

	// READ-ONLY; The thumbprint of certificate.
	Thumbprint *string
}

CertificateProperties - Certificate resource payload.

func (*CertificateProperties) GetCertificateProperties 

func (c *CertificateProperties) GetCertificateProperties() *CertificateProperties

GetCertificateProperties implements the CertificatePropertiesClassification interface for type CertificateProperties.

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 CertificatePropertiesClassification 

type CertificatePropertiesClassification interface {
	// GetCertificateProperties returns the CertificateProperties content of the underlying type.
	GetCertificateProperties() *CertificateProperties
}

CertificatePropertiesClassification provides polymorphic access to related types. Call the interface's GetCertificateProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CertificateProperties, *ContentCertificateProperties, *KeyVaultCertificateProperties

type CertificateReference 

type CertificateReference struct {
	// REQUIRED; Resource Id of the certificate
	ResourceID *string
}

CertificateReference - A reference to the certificate

func (CertificateReference) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateReference.

func (*CertificateReference) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateReference.

type CertificateResource 

type CertificateResource struct {
	// Properties of the certificate resource payload.
	Properties CertificatePropertiesClassification

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

CertificateResource - Certificate resource payload.

func (CertificateResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateResource.

func (*CertificateResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateResource.

type CertificateResourceCollection 

type CertificateResourceCollection struct {
	// The link to next page of certificate list.
	NextLink *string

	// The certificate resources list.
	Value []*CertificateResource
}

CertificateResourceCollection - Collection compose of certificate resources list and a possible link for next page.

func (CertificateResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateResourceCollection.

func (*CertificateResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateResourceCollection.

type CertificateResourceProvisioningState 

type CertificateResourceProvisioningState string

CertificateResourceProvisioningState - Provisioning state of the Certificate 

const (
	CertificateResourceProvisioningStateCreating  CertificateResourceProvisioningState = "Creating"
	CertificateResourceProvisioningStateDeleting  CertificateResourceProvisioningState = "Deleting"
	CertificateResourceProvisioningStateFailed    CertificateResourceProvisioningState = "Failed"
	CertificateResourceProvisioningStateSucceeded CertificateResourceProvisioningState = "Succeeded"
	CertificateResourceProvisioningStateUpdating  CertificateResourceProvisioningState = "Updating"
)

func PossibleCertificateResourceProvisioningStateValues 

func PossibleCertificateResourceProvisioningStateValues() []CertificateResourceProvisioningState

PossibleCertificateResourceProvisioningStateValues returns the possible values for the CertificateResourceProvisioningState 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 - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*CertificatesClient) BeginCreateOrUpdate 

func (client *CertificatesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, certificateName string, certificateResource CertificateResource, options *CertificatesClientBeginCreateOrUpdateOptions) (*runtime.Poller[CertificatesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • certificateName - The name of the certificate resource.
  • certificateResource - Parameters for the create or update operation
  • options - CertificatesClientBeginCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCertificatesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "mycertificate", armappplatform.CertificateResource{
	Properties: &armappplatform.KeyVaultCertificateProperties{
		Type:             to.Ptr("KeyVaultCertificate"),
		AutoSync:         to.Ptr(armappplatform.KeyVaultCertificateAutoSyncEnabled),
		CertVersion:      to.Ptr("08a219d06d874795a96db47e06fbb01e"),
		KeyVaultCertName: to.Ptr("mycert"),
		VaultURI:         to.Ptr("https://myvault.vault.azure.net"),
	},
}, 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.CertificateResource = armappplatform.CertificateResource{
// 	Name: to.Ptr("mycertificate"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/certificates"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.KeyVaultCertificateProperties{
// 		Type: to.Ptr("KeyVaultCertificate"),
// 		ActivateDate: to.Ptr("2019-02-22T07:40:42Z"),
// 		DNSNames: []*string{
// 			to.Ptr("mydomain.com"),
// 			to.Ptr("mydomain.net"),
// 			to.Ptr("mydomain.io")},
// 			ExpirationDate: to.Ptr("2019-02-21T07:40:42Z"),
// 			IssuedDate: to.Ptr("2019-02-20T07:40:42Z"),
// 			Issuer: to.Ptr("mydomain.com"),
// 			SubjectName: to.Ptr("mysubjectname"),
// 			Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
// 			AutoSync: to.Ptr(armappplatform.KeyVaultCertificateAutoSyncEnabled),
// 			CertVersion: to.Ptr("08a219d06d874795a96db47e06fbb01e"),
// 			ExcludePrivateKey: to.Ptr(false),
// 			KeyVaultCertName: to.Ptr("mycert"),
// 			VaultURI: to.Ptr("https://myvault.vault.azure.net"),
// 		},
// 	}

Output:

func (*CertificatesClient) BeginDelete 

func (client *CertificatesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, certificateName string, options *CertificatesClientBeginDeleteOptions) (*runtime.Poller[CertificatesClientDeleteResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • certificateName - The name of the certificate resource.
  • options - CertificatesClientBeginDeleteOptions contains the optional parameters for the CertificatesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCertificatesClient().BeginDelete(ctx, "myResourceGroup", "myservice", "mycertificate", 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 (*CertificatesClient) Get 

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

Get - Get the certificate resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • certificateName - The name of the certificate resource.
  • 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/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCertificatesClient().Get(ctx, "myResourceGroup", "myservice", "mycertificate", 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.CertificateResource = armappplatform.CertificateResource{
// 	Name: to.Ptr("mycertificate"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/certificates"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.KeyVaultCertificateProperties{
// 		Type: to.Ptr("KeyVaultCertificate"),
// 		ActivateDate: to.Ptr("2019-02-22T07:40:42Z"),
// 		DNSNames: []*string{
// 			to.Ptr("mydomain.com"),
// 			to.Ptr("mydomain.net"),
// 			to.Ptr("mydomain.io")},
// 			ExpirationDate: to.Ptr("2019-02-21T07:40:42Z"),
// 			IssuedDate: to.Ptr("2019-02-20T07:40:42Z"),
// 			Issuer: to.Ptr("mydomain.com"),
// 			ProvisioningState: to.Ptr(armappplatform.CertificateResourceProvisioningStateSucceeded),
// 			SubjectName: to.Ptr("mysubjectname"),
// 			Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
// 			AutoSync: to.Ptr(armappplatform.KeyVaultCertificateAutoSyncDisabled),
// 			CertVersion: to.Ptr("08a219d06d874795a96db47e06fbb01e"),
// 			ExcludePrivateKey: to.Ptr(false),
// 			KeyVaultCertName: to.Ptr("mycert"),
// 			VaultURI: to.Ptr("https://myvault.vault.azure.net"),
// 		},
// 	}

Output:

func (*CertificatesClient) NewListPager 

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

NewListPager - List all the certificates of one user.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • 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/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Certificates_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCertificatesClient().NewListPager("myResourceGroup", "myservice", 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.CertificateResourceCollection = armappplatform.CertificateResourceCollection{
	// 	Value: []*armappplatform.CertificateResource{
	// 		{
	// 			Name: to.Ptr("mycertificate"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/certificates"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.KeyVaultCertificateProperties{
	// 				Type: to.Ptr("KeyVaultCertificate"),
	// 				ActivateDate: to.Ptr("2019-02-22T07:40:42Z"),
	// 				DNSNames: []*string{
	// 					to.Ptr("mydomain.com"),
	// 					to.Ptr("mydomain.net"),
	// 					to.Ptr("mydomain.io")},
	// 					ExpirationDate: to.Ptr("2019-02-21T07:40:42Z"),
	// 					IssuedDate: to.Ptr("2019-02-20T07:40:42Z"),
	// 					Issuer: to.Ptr("mydomain.com"),
	// 					ProvisioningState: to.Ptr(armappplatform.CertificateResourceProvisioningStateSucceeded),
	// 					SubjectName: to.Ptr("mysubjectname"),
	// 					Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
	// 					AutoSync: to.Ptr(armappplatform.KeyVaultCertificateAutoSyncDisabled),
	// 					CertVersion: to.Ptr("08a219d06d874795a96db47e06fbb01e"),
	// 					ExcludePrivateKey: to.Ptr(false),
	// 					KeyVaultCertName: to.Ptr("mycert"),
	// 					VaultURI: to.Ptr("https://myvault.vault.azure.net"),
	// 				},
	// 		}},
	// 	}
}

Output:

type CertificatesClientBeginCreateOrUpdateOptions 

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

CertificatesClientBeginCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.BeginCreateOrUpdate method.

type CertificatesClientBeginDeleteOptions 

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

CertificatesClientBeginDeleteOptions contains the optional parameters for the CertificatesClient.BeginDelete method.

type CertificatesClientCreateOrUpdateResponse 

type CertificatesClientCreateOrUpdateResponse struct {
	// Certificate resource payload.
	CertificateResource
}

CertificatesClientCreateOrUpdateResponse contains the response from method CertificatesClient.BeginCreateOrUpdate.

type CertificatesClientDeleteResponse 

type CertificatesClientDeleteResponse struct {
}

CertificatesClientDeleteResponse contains the response from method CertificatesClient.BeginDelete.

type CertificatesClientGetOptions 

type CertificatesClientGetOptions struct {
}

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

type CertificatesClientGetResponse 

type CertificatesClientGetResponse struct {
	// Certificate resource payload.
	CertificateResource
}

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 compose of certificate resources list and a possible link for next page.
	CertificateResourceCollection
}

CertificatesClientListResponse contains the response from method CertificatesClient.NewListPager.

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 - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAPIPortalCustomDomainsClient 

func (c *ClientFactory) NewAPIPortalCustomDomainsClient() *APIPortalCustomDomainsClient

NewAPIPortalCustomDomainsClient creates a new instance of APIPortalCustomDomainsClient.

func (*ClientFactory) NewAPIPortalsClient 

func (c *ClientFactory) NewAPIPortalsClient() *APIPortalsClient

NewAPIPortalsClient creates a new instance of APIPortalsClient.

func (*ClientFactory) NewApmsClient 

func (c *ClientFactory) NewApmsClient() *ApmsClient

NewApmsClient creates a new instance of ApmsClient.

func (*ClientFactory) NewApplicationAcceleratorsClient 

func (c *ClientFactory) NewApplicationAcceleratorsClient() *ApplicationAcceleratorsClient

NewApplicationAcceleratorsClient creates a new instance of ApplicationAcceleratorsClient.

func (*ClientFactory) NewApplicationLiveViewsClient 

func (c *ClientFactory) NewApplicationLiveViewsClient() *ApplicationLiveViewsClient

NewApplicationLiveViewsClient creates a new instance of ApplicationLiveViewsClient.

func (*ClientFactory) NewAppsClient 

func (c *ClientFactory) NewAppsClient() *AppsClient

NewAppsClient creates a new instance of AppsClient.

func (*ClientFactory) NewBindingsClient 

func (c *ClientFactory) NewBindingsClient() *BindingsClient

NewBindingsClient creates a new instance of BindingsClient.

func (*ClientFactory) NewBuildServiceAgentPoolClient 

func (c *ClientFactory) NewBuildServiceAgentPoolClient() *BuildServiceAgentPoolClient

NewBuildServiceAgentPoolClient creates a new instance of BuildServiceAgentPoolClient.

func (*ClientFactory) NewBuildServiceBuilderClient 

func (c *ClientFactory) NewBuildServiceBuilderClient() *BuildServiceBuilderClient

NewBuildServiceBuilderClient creates a new instance of BuildServiceBuilderClient.

func (*ClientFactory) NewBuildServiceClient 

func (c *ClientFactory) NewBuildServiceClient() *BuildServiceClient

NewBuildServiceClient creates a new instance of BuildServiceClient.

func (*ClientFactory) NewBuildpackBindingClient 

func (c *ClientFactory) NewBuildpackBindingClient() *BuildpackBindingClient

NewBuildpackBindingClient creates a new instance of BuildpackBindingClient.

func (*ClientFactory) NewCertificatesClient 

func (c *ClientFactory) NewCertificatesClient() *CertificatesClient

NewCertificatesClient creates a new instance of CertificatesClient.

func (*ClientFactory) NewConfigServersClient 

func (c *ClientFactory) NewConfigServersClient() *ConfigServersClient

NewConfigServersClient creates a new instance of ConfigServersClient.

func (*ClientFactory) NewConfigurationServicesClient 

func (c *ClientFactory) NewConfigurationServicesClient() *ConfigurationServicesClient

NewConfigurationServicesClient creates a new instance of ConfigurationServicesClient.

func (*ClientFactory) NewContainerRegistriesClient 

func (c *ClientFactory) NewContainerRegistriesClient() *ContainerRegistriesClient

NewContainerRegistriesClient creates a new instance of ContainerRegistriesClient.

func (*ClientFactory) NewCustomDomainsClient 

func (c *ClientFactory) NewCustomDomainsClient() *CustomDomainsClient

NewCustomDomainsClient creates a new instance of CustomDomainsClient.

func (*ClientFactory) NewCustomizedAcceleratorsClient 

func (c *ClientFactory) NewCustomizedAcceleratorsClient() *CustomizedAcceleratorsClient

NewCustomizedAcceleratorsClient creates a new instance of CustomizedAcceleratorsClient.

func (*ClientFactory) NewDeploymentsClient 

func (c *ClientFactory) NewDeploymentsClient() *DeploymentsClient

NewDeploymentsClient creates a new instance of DeploymentsClient.

func (*ClientFactory) NewDevToolPortalsClient 

func (c *ClientFactory) NewDevToolPortalsClient() *DevToolPortalsClient

NewDevToolPortalsClient creates a new instance of DevToolPortalsClient.

func (*ClientFactory) NewGatewayCustomDomainsClient 

func (c *ClientFactory) NewGatewayCustomDomainsClient() *GatewayCustomDomainsClient

NewGatewayCustomDomainsClient creates a new instance of GatewayCustomDomainsClient.

func (*ClientFactory) NewGatewayRouteConfigsClient 

func (c *ClientFactory) NewGatewayRouteConfigsClient() *GatewayRouteConfigsClient

NewGatewayRouteConfigsClient creates a new instance of GatewayRouteConfigsClient.

func (*ClientFactory) NewGatewaysClient 

func (c *ClientFactory) NewGatewaysClient() *GatewaysClient

NewGatewaysClient creates a new instance of GatewaysClient.

func (*ClientFactory) NewMonitoringSettingsClient 

func (c *ClientFactory) NewMonitoringSettingsClient() *MonitoringSettingsClient

NewMonitoringSettingsClient creates a new instance of MonitoringSettingsClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPredefinedAcceleratorsClient 

func (c *ClientFactory) NewPredefinedAcceleratorsClient() *PredefinedAcceleratorsClient

NewPredefinedAcceleratorsClient creates a new instance of PredefinedAcceleratorsClient.

func (*ClientFactory) NewRuntimeVersionsClient 

func (c *ClientFactory) NewRuntimeVersionsClient() *RuntimeVersionsClient

NewRuntimeVersionsClient creates a new instance of RuntimeVersionsClient.

func (*ClientFactory) NewSKUsClient 

func (c *ClientFactory) NewSKUsClient() *SKUsClient

NewSKUsClient creates a new instance of SKUsClient.

func (*ClientFactory) NewServiceRegistriesClient 

func (c *ClientFactory) NewServiceRegistriesClient() *ServiceRegistriesClient

NewServiceRegistriesClient creates a new instance of ServiceRegistriesClient.

func (*ClientFactory) NewServicesClient 

func (c *ClientFactory) NewServicesClient() *ServicesClient

NewServicesClient creates a new instance of ServicesClient.

func (*ClientFactory) NewStoragesClient 

func (c *ClientFactory) NewStoragesClient() *StoragesClient

NewStoragesClient creates a new instance of StoragesClient.

type ClusterResourceProperties 

type ClusterResourceProperties struct {
	// Purchasing 3rd party product of the Service resource.
	MarketplaceResource *MarketplaceResource

	// Network profile of the Service
	NetworkProfile *NetworkProfile

	// Additional Service settings in vnet injection instance
	VnetAddons    *ServiceVNetAddons
	ZoneRedundant *bool

	// READ-ONLY; Fully qualified dns name of the service instance
	Fqdn *string

	// READ-ONLY; Power state of the Service
	PowerState *PowerState

	// READ-ONLY; Provisioning state of the Service
	ProvisioningState *ProvisioningState

	// READ-ONLY; ServiceInstanceEntity Id which uniquely identifies a created resource
	ServiceID *string

	// READ-ONLY; Version of the Service
	Version *int32
}

ClusterResourceProperties - Service properties payload

func (ClusterResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterResourceProperties.

func (*ClusterResourceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterResourceProperties.

type ConfigServerGitProperty 

type ConfigServerGitProperty struct {
	// REQUIRED; URI of the repository
	URI *string

	// Public sshKey of git repository.
	HostKey *string

	// SshKey algorithm of git repository.
	HostKeyAlgorithm *string

	// Label of the repository
	Label *string

	// Password of git repository basic auth.
	Password *string

	// Private sshKey algorithm of git repository.
	PrivateKey *string

	// Repositories of git.
	Repositories []*GitPatternRepository

	// Searching path of the repository
	SearchPaths []*string

	// Strict host key checking or not.
	StrictHostKeyChecking *bool

	// Username of git repository basic auth.
	Username *string
}

ConfigServerGitProperty - Property of git.

func (ConfigServerGitProperty) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerGitProperty.

func (*ConfigServerGitProperty) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigServerGitProperty.

type ConfigServerProperties 

type ConfigServerProperties struct {
	// Settings of config server.
	ConfigServer *ConfigServerSettings

	// Error when apply config server settings.
	Error *Error

	// READ-ONLY; State of the config server.
	ProvisioningState *ConfigServerState
}

ConfigServerProperties - Config server git properties payload

func (ConfigServerProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerProperties.

func (*ConfigServerProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigServerProperties.

type ConfigServerResource 

type ConfigServerResource struct {
	// Properties of the Config Server resource
	Properties *ConfigServerProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ConfigServerResource - Config Server resource

func (ConfigServerResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerResource.

func (*ConfigServerResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigServerResource.

type ConfigServerSettings 

type ConfigServerSettings struct {
	// Property of git environment.
	GitProperty *ConfigServerGitProperty
}

ConfigServerSettings - The settings of config server.

func (ConfigServerSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerSettings.

func (*ConfigServerSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigServerSettings.

type ConfigServerSettingsErrorRecord 

type ConfigServerSettingsErrorRecord struct {
	// The detail error messages of the record
	Messages []*string

	// The name of the config server settings error record
	Name *string

	// The uri of the config server settings error record
	URI *string
}

ConfigServerSettingsErrorRecord - Error record of the config server settings

func (ConfigServerSettingsErrorRecord) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerSettingsErrorRecord.

func (*ConfigServerSettingsErrorRecord) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigServerSettingsErrorRecord.

type ConfigServerSettingsValidateResult 

type ConfigServerSettingsValidateResult struct {
	// The detail validation results
	Details []*ConfigServerSettingsErrorRecord

	// Indicate if the config server settings are valid
	IsValid *bool
}

ConfigServerSettingsValidateResult - Validation result for config server settings

func (ConfigServerSettingsValidateResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerSettingsValidateResult.

func (*ConfigServerSettingsValidateResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigServerSettingsValidateResult.

type ConfigServerState 

type ConfigServerState string

ConfigServerState - State of the config server. 

const (
	ConfigServerStateDeleted      ConfigServerState = "Deleted"
	ConfigServerStateFailed       ConfigServerState = "Failed"
	ConfigServerStateNotAvailable ConfigServerState = "NotAvailable"
	ConfigServerStateSucceeded    ConfigServerState = "Succeeded"
	ConfigServerStateUpdating     ConfigServerState = "Updating"
)

func PossibleConfigServerStateValues 

func PossibleConfigServerStateValues() []ConfigServerState

PossibleConfigServerStateValues returns the possible values for the ConfigServerState const type.

type ConfigServersClient 

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

ConfigServersClient contains the methods for the ConfigServers group. Don't use this type directly, use NewConfigServersClient() instead.

func NewConfigServersClient 

func NewConfigServersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConfigServersClient, error)

NewConfigServersClient creates a new instance of ConfigServersClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConfigServersClient) BeginUpdatePatch 

func (client *ConfigServersClient) BeginUpdatePatch(ctx context.Context, resourceGroupName string, serviceName string, configServerResource ConfigServerResource, options *ConfigServersClientBeginUpdatePatchOptions) (*runtime.Poller[ConfigServersClientUpdatePatchResponse], error)

BeginUpdatePatch - Update the config server. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configServerResource - Parameters for the update operation
  • options - ConfigServersClientBeginUpdatePatchOptions contains the optional parameters for the ConfigServersClient.BeginUpdatePatch method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_UpdatePatch.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigServersClient().BeginUpdatePatch(ctx, "myResourceGroup", "myservice", armappplatform.ConfigServerResource{
	Properties: &armappplatform.ConfigServerProperties{
		ConfigServer: &armappplatform.ConfigServerSettings{
			GitProperty: &armappplatform.ConfigServerGitProperty{
				Label: to.Ptr("master"),
				SearchPaths: []*string{
					to.Ptr("/")},
				URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
			},
		},
	},
}, 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.ConfigServerResource = armappplatform.ConfigServerResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/configServers"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ConfigServerProperties{
// 		ConfigServer: &armappplatform.ConfigServerSettings{
// 			GitProperty: &armappplatform.ConfigServerGitProperty{
// 				Label: to.Ptr("master"),
// 				SearchPaths: []*string{
// 					to.Ptr("/")},
// 					URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
// 				},
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.ConfigServerStateSucceeded),
// 		},
// 	}

Output:

func (*ConfigServersClient) BeginUpdatePut 

func (client *ConfigServersClient) BeginUpdatePut(ctx context.Context, resourceGroupName string, serviceName string, configServerResource ConfigServerResource, options *ConfigServersClientBeginUpdatePutOptions) (*runtime.Poller[ConfigServersClientUpdatePutResponse], error)

BeginUpdatePut - Update the config server. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configServerResource - Parameters for the update operation
  • options - ConfigServersClientBeginUpdatePutOptions contains the optional parameters for the ConfigServersClient.BeginUpdatePut method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_UpdatePut.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigServersClient().BeginUpdatePut(ctx, "myResourceGroup", "myservice", armappplatform.ConfigServerResource{
	Properties: &armappplatform.ConfigServerProperties{
		ConfigServer: &armappplatform.ConfigServerSettings{
			GitProperty: &armappplatform.ConfigServerGitProperty{
				Label: to.Ptr("master"),
				SearchPaths: []*string{
					to.Ptr("/")},
				URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
			},
		},
	},
}, 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.ConfigServerResource = armappplatform.ConfigServerResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/configServers"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ConfigServerProperties{
// 		ConfigServer: &armappplatform.ConfigServerSettings{
// 			GitProperty: &armappplatform.ConfigServerGitProperty{
// 				Label: to.Ptr("master"),
// 				SearchPaths: []*string{
// 					to.Ptr("/")},
// 					URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
// 				},
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.ConfigServerStateSucceeded),
// 		},
// 	}

Output:

func (*ConfigServersClient) BeginValidate 

func (client *ConfigServersClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, configServerSettings ConfigServerSettings, options *ConfigServersClientBeginValidateOptions) (*runtime.Poller[ConfigServersClientValidateResponse], error)

BeginValidate - Check if the config server settings are valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configServerSettings - Config server settings to be validated
  • options - ConfigServersClientBeginValidateOptions contains the optional parameters for the ConfigServersClient.BeginValidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_Validate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigServersClient().BeginValidate(ctx, "myResourceGroup", "myservice", armappplatform.ConfigServerSettings{
	GitProperty: &armappplatform.ConfigServerGitProperty{
		Label: to.Ptr("master"),
		SearchPaths: []*string{
			to.Ptr("/")},
		URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
	},
}, 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.ConfigServerSettingsValidateResult = armappplatform.ConfigServerSettingsValidateResult{
// 	IsValid: to.Ptr(true),
// }

Output:

func (*ConfigServersClient) Get 

func (client *ConfigServersClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *ConfigServersClientGetOptions) (ConfigServersClientGetResponse, error)

Get - Get the config server and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ConfigServersClientGetOptions contains the optional parameters for the ConfigServersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigServersClient().Get(ctx, "myResourceGroup", "myservice", 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.ConfigServerResource = armappplatform.ConfigServerResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/configServers"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ConfigServerProperties{
// 		ConfigServer: &armappplatform.ConfigServerSettings{
// 			GitProperty: &armappplatform.ConfigServerGitProperty{
// 				Label: to.Ptr("master"),
// 				SearchPaths: []*string{
// 					to.Ptr("/")},
// 					URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
// 				},
// 			},
// 			ProvisioningState: to.Ptr(armappplatform.ConfigServerStateSucceeded),
// 		},
// 	}

Output:

type ConfigServersClientBeginUpdatePatchOptions 

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

ConfigServersClientBeginUpdatePatchOptions contains the optional parameters for the ConfigServersClient.BeginUpdatePatch method.

type ConfigServersClientBeginUpdatePutOptions 

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

ConfigServersClientBeginUpdatePutOptions contains the optional parameters for the ConfigServersClient.BeginUpdatePut method.

type ConfigServersClientBeginValidateOptions 

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

ConfigServersClientBeginValidateOptions contains the optional parameters for the ConfigServersClient.BeginValidate method.

type ConfigServersClientGetOptions 

type ConfigServersClientGetOptions struct {
}

ConfigServersClientGetOptions contains the optional parameters for the ConfigServersClient.Get method.

type ConfigServersClientGetResponse 

type ConfigServersClientGetResponse struct {
	// Config Server resource
	ConfigServerResource
}

ConfigServersClientGetResponse contains the response from method ConfigServersClient.Get.

type ConfigServersClientUpdatePatchResponse 

type ConfigServersClientUpdatePatchResponse struct {
	// Config Server resource
	ConfigServerResource
}

ConfigServersClientUpdatePatchResponse contains the response from method ConfigServersClient.BeginUpdatePatch.

type ConfigServersClientUpdatePutResponse 

type ConfigServersClientUpdatePutResponse struct {
	// Config Server resource
	ConfigServerResource
}

ConfigServersClientUpdatePutResponse contains the response from method ConfigServersClient.BeginUpdatePut.

type ConfigServersClientValidateResponse 

type ConfigServersClientValidateResponse struct {
	// Validation result for config server settings
	ConfigServerSettingsValidateResult
}

ConfigServersClientValidateResponse contains the response from method ConfigServersClient.BeginValidate.

type ConfigurationServiceGeneration 

type ConfigurationServiceGeneration string

ConfigurationServiceGeneration - The generation of the Application Configuration Service. 

const (
	ConfigurationServiceGenerationGen1 ConfigurationServiceGeneration = "Gen1"
	ConfigurationServiceGenerationGen2 ConfigurationServiceGeneration = "Gen2"
)

func PossibleConfigurationServiceGenerationValues 

func PossibleConfigurationServiceGenerationValues() []ConfigurationServiceGeneration

PossibleConfigurationServiceGenerationValues returns the possible values for the ConfigurationServiceGeneration const type.

type ConfigurationServiceGitProperty 

type ConfigurationServiceGitProperty struct {
	// Repositories of Application Configuration Service git property.
	Repositories []*ConfigurationServiceGitRepository
}

ConfigurationServiceGitProperty - Property of git environment.

func (ConfigurationServiceGitProperty) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceGitProperty.

func (*ConfigurationServiceGitProperty) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceGitProperty.

type ConfigurationServiceGitPropertyValidateResult 

type ConfigurationServiceGitPropertyValidateResult struct {
	// The detail validation results
	GitReposValidationResult []*ValidationMessages

	// Indicate if the configuration service settings are valid
	IsValid *bool
}

ConfigurationServiceGitPropertyValidateResult - Validation result for configuration service settings

func (ConfigurationServiceGitPropertyValidateResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceGitPropertyValidateResult.

func (*ConfigurationServiceGitPropertyValidateResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceGitPropertyValidateResult.

type ConfigurationServiceGitRepository 

type ConfigurationServiceGitRepository struct {
	// REQUIRED; Label of the repository
	Label *string

	// REQUIRED; Name of the repository
	Name *string

	// REQUIRED; Collection of patterns of the repository
	Patterns []*string

	// REQUIRED; URI of the repository
	URI *string

	// Resource Id of CA certificate for https URL of Git repository.
	CaCertResourceID *string

	// Git libraries used to support various repository providers
	GitImplementation *GitImplementation

	// Public sshKey of git repository.
	HostKey *string

	// SshKey algorithm of git repository.
	HostKeyAlgorithm *string

	// Password of git repository basic auth.
	Password *string

	// Private sshKey algorithm of git repository.
	PrivateKey *string

	// Searching path of the repository
	SearchPaths []*string

	// Strict host key checking or not.
	StrictHostKeyChecking *bool

	// Username of git repository basic auth.
	Username *string
}

ConfigurationServiceGitRepository - Git repository property payload for Application Configuration Service

func (ConfigurationServiceGitRepository) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceGitRepository.

func (*ConfigurationServiceGitRepository) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceGitRepository.

type ConfigurationServiceInstance 

type ConfigurationServiceInstance struct {
	// READ-ONLY; Name of the Application Configuration Service instance
	Name *string

	// READ-ONLY; Status of the Application Configuration Service instance
	Status *string
}

ConfigurationServiceInstance - Collection of instances belong to the Application Configuration Service

func (ConfigurationServiceInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceInstance.

func (*ConfigurationServiceInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceInstance.

type ConfigurationServiceProperties 

type ConfigurationServiceProperties struct {
	// The generation of the Application Configuration Service.
	Generation *ConfigurationServiceGeneration

	// The settings of Application Configuration Service.
	Settings *ConfigurationServiceSettings

	// READ-ONLY; Collection of instances belong to Application Configuration Service.
	Instances []*ConfigurationServiceInstance

	// READ-ONLY; State of the Application Configuration Service.
	ProvisioningState *ConfigurationServiceProvisioningState

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *ConfigurationServiceResourceRequests
}

ConfigurationServiceProperties - Application Configuration Service properties payload

func (ConfigurationServiceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceProperties.

func (*ConfigurationServiceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceProperties.

type ConfigurationServiceProvisioningState 

type ConfigurationServiceProvisioningState string

ConfigurationServiceProvisioningState - State of the Application Configuration Service. 

const (
	ConfigurationServiceProvisioningStateCreating  ConfigurationServiceProvisioningState = "Creating"
	ConfigurationServiceProvisioningStateDeleting  ConfigurationServiceProvisioningState = "Deleting"
	ConfigurationServiceProvisioningStateFailed    ConfigurationServiceProvisioningState = "Failed"
	ConfigurationServiceProvisioningStateSucceeded ConfigurationServiceProvisioningState = "Succeeded"
	ConfigurationServiceProvisioningStateUpdating  ConfigurationServiceProvisioningState = "Updating"
)

func PossibleConfigurationServiceProvisioningStateValues 

func PossibleConfigurationServiceProvisioningStateValues() []ConfigurationServiceProvisioningState

PossibleConfigurationServiceProvisioningStateValues returns the possible values for the ConfigurationServiceProvisioningState const type.

type ConfigurationServiceResource 

type ConfigurationServiceResource struct {
	// Application Configuration Service properties payload
	Properties *ConfigurationServiceProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ConfigurationServiceResource - Application Configuration Service resource

func (ConfigurationServiceResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceResource.

func (*ConfigurationServiceResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceResource.

type ConfigurationServiceResourceCollection 

type ConfigurationServiceResourceCollection 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 configuration service resources
	Value []*ConfigurationServiceResource
}

ConfigurationServiceResourceCollection - Object that includes an array of configuration service resources and a possible link for next set

func (ConfigurationServiceResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceResourceCollection.

func (*ConfigurationServiceResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceResourceCollection.

type ConfigurationServiceResourceRequests 

type ConfigurationServiceResourceRequests struct {
	// READ-ONLY; Cpu allocated to each Application Configuration Service instance
	CPU *string

	// READ-ONLY; Instance count of the Application Configuration Service
	InstanceCount *int32

	// READ-ONLY; Memory allocated to each Application Configuration Service instance
	Memory *string
}

ConfigurationServiceResourceRequests - Resource request payload of Application Configuration Service

func (ConfigurationServiceResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceResourceRequests.

func (*ConfigurationServiceResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceResourceRequests.

type ConfigurationServiceSettings 

type ConfigurationServiceSettings struct {
	// Property of git environment.
	GitProperty *ConfigurationServiceGitProperty
}

ConfigurationServiceSettings - The settings of Application Configuration Service.

func (ConfigurationServiceSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceSettings.

func (*ConfigurationServiceSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceSettings.

type ConfigurationServiceSettingsValidateResult 

type ConfigurationServiceSettingsValidateResult struct {
	// Validation result for configuration service settings
	GitPropertyValidationResult *ConfigurationServiceGitPropertyValidateResult
}

ConfigurationServiceSettingsValidateResult - Validation result for configuration service settings

func (ConfigurationServiceSettingsValidateResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceSettingsValidateResult.

func (*ConfigurationServiceSettingsValidateResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationServiceSettingsValidateResult.

type ConfigurationServicesClient 

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

ConfigurationServicesClient contains the methods for the ConfigurationServices group. Don't use this type directly, use NewConfigurationServicesClient() instead.

func NewConfigurationServicesClient 

func NewConfigurationServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConfigurationServicesClient, error)

NewConfigurationServicesClient creates a new instance of ConfigurationServicesClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConfigurationServicesClient) BeginCreateOrUpdate 

func (client *ConfigurationServicesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, configurationServiceResource ConfigurationServiceResource, options *ConfigurationServicesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConfigurationServicesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default Application Configuration Service or update the existing Application Configuration Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configurationServiceName - The name of Application Configuration Service.
  • configurationServiceResource - Parameters for the update operation
  • options - ConfigurationServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationServicesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationServicesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.ConfigurationServiceResource{
	Properties: &armappplatform.ConfigurationServiceProperties{
		Settings: &armappplatform.ConfigurationServiceSettings{
			GitProperty: &armappplatform.ConfigurationServiceGitProperty{
				Repositories: []*armappplatform.ConfigurationServiceGitRepository{
					{
						Name:  to.Ptr("fake"),
						Label: to.Ptr("master"),
						Patterns: []*string{
							to.Ptr("app/dev")},
						URI: to.Ptr("https://github.com/fake-user/fake-repository"),
					}},
			},
		},
	},
}, 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.ConfigurationServiceResource = armappplatform.ConfigurationServiceResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/configurationServices"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ConfigurationServiceProperties{
// 		Instances: []*armappplatform.ConfigurationServiceInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				Status: to.Ptr("Running"),
// 			},
// 			{
// 				Name: to.Ptr("instance2"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ConfigurationServiceProvisioningStateSucceeded),
// 		ResourceRequests: &armappplatform.ConfigurationServiceResourceRequests{
// 			CPU: to.Ptr("1"),
// 			InstanceCount: to.Ptr[int32](2),
// 			Memory: to.Ptr("1G"),
// 		},
// 		Settings: &armappplatform.ConfigurationServiceSettings{
// 			GitProperty: &armappplatform.ConfigurationServiceGitProperty{
// 				Repositories: []*armappplatform.ConfigurationServiceGitRepository{
// 					{
// 						Name: to.Ptr("fake"),
// 						Label: to.Ptr("master"),
// 						Patterns: []*string{
// 							to.Ptr("app/dev")},
// 							URI: to.Ptr("https://github.com/fake-user/fake-repository"),
// 					}},
// 				},
// 			},
// 		},
// 	}

Output:

func (*ConfigurationServicesClient) BeginDelete 

func (client *ConfigurationServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, options *ConfigurationServicesClientBeginDeleteOptions) (*runtime.Poller[ConfigurationServicesClientDeleteResponse], error)

BeginDelete - Disable the default Application Configuration Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configurationServiceName - The name of Application Configuration Service.
  • options - ConfigurationServicesClientBeginDeleteOptions contains the optional parameters for the ConfigurationServicesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationServicesClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*ConfigurationServicesClient) BeginValidate 

func (client *ConfigurationServicesClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, settings ConfigurationServiceSettings, options *ConfigurationServicesClientBeginValidateOptions) (*runtime.Poller[ConfigurationServicesClientValidateResponse], error)

BeginValidate - Check if the Application Configuration Service settings are valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configurationServiceName - The name of Application Configuration Service.
  • settings - Application Configuration Service settings to be validated
  • options - ConfigurationServicesClientBeginValidateOptions contains the optional parameters for the ConfigurationServicesClient.BeginValidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_Validate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationServicesClient().BeginValidate(ctx, "myResourceGroup", "myservice", "default", armappplatform.ConfigurationServiceSettings{
	GitProperty: &armappplatform.ConfigurationServiceGitProperty{
		Repositories: []*armappplatform.ConfigurationServiceGitRepository{
			{
				Name:  to.Ptr("fake"),
				Label: to.Ptr("master"),
				Patterns: []*string{
					to.Ptr("app/dev")},
				URI: to.Ptr("https://github.com/fake-user/fake-repository"),
			}},
	},
}, 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.ConfigurationServiceSettingsValidateResult = armappplatform.ConfigurationServiceSettingsValidateResult{
// 	GitPropertyValidationResult: &armappplatform.ConfigurationServiceGitPropertyValidateResult{
// 		IsValid: to.Ptr(true),
// 	},
// }

Output:

func (*ConfigurationServicesClient) BeginValidateResource 

func (client *ConfigurationServicesClient) BeginValidateResource(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, configurationServiceResource ConfigurationServiceResource, options *ConfigurationServicesClientBeginValidateResourceOptions) (*runtime.Poller[ConfigurationServicesClientValidateResourceResponse], error)

BeginValidateResource - Check if the Application Configuration Service resource is valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configurationServiceName - The name of Application Configuration Service.
  • configurationServiceResource - Application Configuration Service resource to be validated
  • options - ConfigurationServicesClientBeginValidateResourceOptions contains the optional parameters for the ConfigurationServicesClient.BeginValidateResource method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_ValidateResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationServicesClient().BeginValidateResource(ctx, "myResourceGroup", "myservice", "default", armappplatform.ConfigurationServiceResource{
	Properties: &armappplatform.ConfigurationServiceProperties{
		Settings: &armappplatform.ConfigurationServiceSettings{
			GitProperty: &armappplatform.ConfigurationServiceGitProperty{
				Repositories: []*armappplatform.ConfigurationServiceGitRepository{
					{
						Name:  to.Ptr("fake"),
						Label: to.Ptr("master"),
						Patterns: []*string{
							to.Ptr("app/dev")},
						URI: to.Ptr("https://github.com/fake-user/fake-repository"),
					}},
			},
		},
	},
}, 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.ConfigurationServiceSettingsValidateResult = armappplatform.ConfigurationServiceSettingsValidateResult{
// 	GitPropertyValidationResult: &armappplatform.ConfigurationServiceGitPropertyValidateResult{
// 		IsValid: to.Ptr(true),
// 	},
// }

Output:

func (*ConfigurationServicesClient) Get 

func (client *ConfigurationServicesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, options *ConfigurationServicesClientGetOptions) (ConfigurationServicesClientGetResponse, error)

Get - Get the Application Configuration Service and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • configurationServiceName - The name of Application Configuration Service.
  • options - ConfigurationServicesClientGetOptions contains the optional parameters for the ConfigurationServicesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationServicesClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.ConfigurationServiceResource = armappplatform.ConfigurationServiceResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/configurationServices"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ConfigurationServiceProperties{
// 		Instances: []*armappplatform.ConfigurationServiceInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				Status: to.Ptr("Running"),
// 			},
// 			{
// 				Name: to.Ptr("instance2"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ConfigurationServiceProvisioningStateSucceeded),
// 		ResourceRequests: &armappplatform.ConfigurationServiceResourceRequests{
// 			CPU: to.Ptr("1"),
// 			InstanceCount: to.Ptr[int32](2),
// 			Memory: to.Ptr("1G"),
// 		},
// 		Settings: &armappplatform.ConfigurationServiceSettings{
// 			GitProperty: &armappplatform.ConfigurationServiceGitProperty{
// 				Repositories: []*armappplatform.ConfigurationServiceGitRepository{
// 					{
// 						Name: to.Ptr("fake"),
// 						Label: to.Ptr("master"),
// 						Patterns: []*string{
// 							to.Ptr("app1"),
// 							to.Ptr("app2/dev")},
// 							URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
// 					}},
// 				},
// 			},
// 		},
// 	}

Output:

func (*ConfigurationServicesClient) NewListPager 

func (client *ConfigurationServicesClient) NewListPager(resourceGroupName string, serviceName string, options *ConfigurationServicesClientListOptions) *runtime.Pager[ConfigurationServicesClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ConfigurationServicesClientListOptions contains the optional parameters for the ConfigurationServicesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationServicesClient().NewListPager("myResourceGroup", "myservice", 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.ConfigurationServiceResourceCollection = armappplatform.ConfigurationServiceResourceCollection{
	// 	Value: []*armappplatform.ConfigurationServiceResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/configurationServices"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ConfigurationServiceProperties{
	// 				Instances: []*armappplatform.ConfigurationServiceInstance{
	// 					{
	// 						Name: to.Ptr("instance1"),
	// 						Status: to.Ptr("Running"),
	// 					},
	// 					{
	// 						Name: to.Ptr("instance2"),
	// 						Status: to.Ptr("Running"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.ConfigurationServiceProvisioningStateSucceeded),
	// 				ResourceRequests: &armappplatform.ConfigurationServiceResourceRequests{
	// 					CPU: to.Ptr("1"),
	// 					InstanceCount: to.Ptr[int32](2),
	// 					Memory: to.Ptr("1G"),
	// 				},
	// 				Settings: &armappplatform.ConfigurationServiceSettings{
	// 					GitProperty: &armappplatform.ConfigurationServiceGitProperty{
	// 						Repositories: []*armappplatform.ConfigurationServiceGitRepository{
	// 							{
	// 								Name: to.Ptr("fake"),
	// 								Label: to.Ptr("master"),
	// 								Patterns: []*string{
	// 									to.Ptr("app1"),
	// 									to.Ptr("app2/dev")},
	// 									URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
	// 							}},
	// 						},
	// 					},
	// 				},
	// 		}},
	// 	}
}

Output:

type ConfigurationServicesClientBeginCreateOrUpdateOptions 

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

ConfigurationServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationServicesClient.BeginCreateOrUpdate method.

type ConfigurationServicesClientBeginDeleteOptions 

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

ConfigurationServicesClientBeginDeleteOptions contains the optional parameters for the ConfigurationServicesClient.BeginDelete method.

type ConfigurationServicesClientBeginValidateOptions 

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

ConfigurationServicesClientBeginValidateOptions contains the optional parameters for the ConfigurationServicesClient.BeginValidate method.

type ConfigurationServicesClientBeginValidateResourceOptions 

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

ConfigurationServicesClientBeginValidateResourceOptions contains the optional parameters for the ConfigurationServicesClient.BeginValidateResource method.

type ConfigurationServicesClientCreateOrUpdateResponse 

type ConfigurationServicesClientCreateOrUpdateResponse struct {
	// Application Configuration Service resource
	ConfigurationServiceResource
}

ConfigurationServicesClientCreateOrUpdateResponse contains the response from method ConfigurationServicesClient.BeginCreateOrUpdate.

type ConfigurationServicesClientDeleteResponse 

type ConfigurationServicesClientDeleteResponse struct {
}

ConfigurationServicesClientDeleteResponse contains the response from method ConfigurationServicesClient.BeginDelete.

type ConfigurationServicesClientGetOptions 

type ConfigurationServicesClientGetOptions struct {
}

ConfigurationServicesClientGetOptions contains the optional parameters for the ConfigurationServicesClient.Get method.

type ConfigurationServicesClientGetResponse 

type ConfigurationServicesClientGetResponse struct {
	// Application Configuration Service resource
	ConfigurationServiceResource
}

ConfigurationServicesClientGetResponse contains the response from method ConfigurationServicesClient.Get.

type ConfigurationServicesClientListOptions 

type ConfigurationServicesClientListOptions struct {
}

ConfigurationServicesClientListOptions contains the optional parameters for the ConfigurationServicesClient.NewListPager method.

type ConfigurationServicesClientListResponse 

type ConfigurationServicesClientListResponse struct {
	// Object that includes an array of configuration service resources and a possible link for next set
	ConfigurationServiceResourceCollection
}

ConfigurationServicesClientListResponse contains the response from method ConfigurationServicesClient.NewListPager.

type ConfigurationServicesClientValidateResourceResponse 

type ConfigurationServicesClientValidateResourceResponse struct {
	// Validation result for configuration service settings
	ConfigurationServiceSettingsValidateResult
}

ConfigurationServicesClientValidateResourceResponse contains the response from method ConfigurationServicesClient.BeginValidateResource.

type ConfigurationServicesClientValidateResponse 

type ConfigurationServicesClientValidateResponse struct {
	// Validation result for configuration service settings
	ConfigurationServiceSettingsValidateResult
}

ConfigurationServicesClientValidateResponse contains the response from method ConfigurationServicesClient.BeginValidate.

type ContainerProbeSettings 

type ContainerProbeSettings struct {
	// Indicates whether disable the liveness and readiness probe
	DisableProbe *bool
}

ContainerProbeSettings - Container liveness and readiness probe settings

func (ContainerProbeSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerProbeSettings.

func (*ContainerProbeSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerProbeSettings.

type ContainerRegistriesClient 

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

ContainerRegistriesClient contains the methods for the ContainerRegistries group. Don't use this type directly, use NewContainerRegistriesClient() instead.

func NewContainerRegistriesClient 

func NewContainerRegistriesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainerRegistriesClient, error)

NewContainerRegistriesClient creates a new instance of ContainerRegistriesClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContainerRegistriesClient) BeginCreateOrUpdate 

func (client *ContainerRegistriesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, containerRegistryName string, containerRegistryResource ContainerRegistryResource, options *ContainerRegistriesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContainerRegistriesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update container registry resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • containerRegistryName - The name of the container registry.
  • containerRegistryResource - Parameters for the create or update operation
  • options - ContainerRegistriesClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainerRegistriesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContainerRegistriesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "my-service", "my-container-registry", armappplatform.ContainerRegistryResource{
	Properties: &armappplatform.ContainerRegistryProperties{
		Credentials: &armappplatform.ContainerRegistryBasicCredentials{
			Type:     to.Ptr("BasicAuth"),
			Password: to.Ptr("myPassword"),
			Server:   to.Ptr("myServer"),
			Username: to.Ptr("myUsername"),
		},
	},
}, 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.ContainerRegistryResource = armappplatform.ContainerRegistryResource{
// 	Name: to.Ptr("my-container-registry"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/containerRegistries"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries/my-container-registry"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ContainerRegistryProperties{
// 		Credentials: &armappplatform.ContainerRegistryBasicCredentials{
// 			Type: to.Ptr("BasicAuth"),
// 			Server: to.Ptr("myServer"),
// 			Username: to.Ptr("myUsername"),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.ContainerRegistryProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ContainerRegistriesClient) BeginDelete 

func (client *ContainerRegistriesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, containerRegistryName string, options *ContainerRegistriesClientBeginDeleteOptions) (*runtime.Poller[ContainerRegistriesClientDeleteResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • containerRegistryName - The name of the container registry.
  • options - ContainerRegistriesClientBeginDeleteOptions contains the optional parameters for the ContainerRegistriesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContainerRegistriesClient().BeginDelete(ctx, "myResourceGroup", "service-name", "my-container-registry", 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 (*ContainerRegistriesClient) BeginValidate 

func (client *ContainerRegistriesClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, containerRegistryName string, containerRegistryProperties ContainerRegistryProperties, options *ContainerRegistriesClientBeginValidateOptions) (*runtime.Poller[ContainerRegistriesClientValidateResponse], error)

BeginValidate - Check if the container registry properties are valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • containerRegistryName - The name of the container registry.
  • containerRegistryProperties - Parameters for the validate operation
  • options - ContainerRegistriesClientBeginValidateOptions contains the optional parameters for the ContainerRegistriesClient.BeginValidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_Validate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContainerRegistriesClient().BeginValidate(ctx, "myResourceGroup", "my-service", "my-container-registry", armappplatform.ContainerRegistryProperties{
	Credentials: &armappplatform.ContainerRegistryBasicCredentials{
		Type:     to.Ptr("BasicAuth"),
		Password: to.Ptr("myPassword"),
		Server:   to.Ptr("myServer"),
		Username: to.Ptr("myUsername"),
	},
}, 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.ContainerRegistryValidateResult = armappplatform.ContainerRegistryValidateResult{
// 	IsValid: to.Ptr(false),
// 	Message: to.Ptr("Validate container registry failed. please check the properties first."),
// }

Output:

func (*ContainerRegistriesClient) Get 

func (client *ContainerRegistriesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, containerRegistryName string, options *ContainerRegistriesClientGetOptions) (ContainerRegistriesClientGetResponse, error)

Get - Get the container registries resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • containerRegistryName - The name of the container registry.
  • options - ContainerRegistriesClientGetOptions contains the optional parameters for the ContainerRegistriesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewContainerRegistriesClient().Get(ctx, "myResourceGroup", "service-name", "my-container-registry", 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.ContainerRegistryResource = armappplatform.ContainerRegistryResource{
// 	Name: to.Ptr("my-container-registry"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/containerRegistries"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/service-name/containerRegistries/my-container-registry"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ContainerRegistryProperties{
// 		Credentials: &armappplatform.ContainerRegistryBasicCredentials{
// 			Type: to.Ptr("BasicAuth"),
// 			Server: to.Ptr("myServer"),
// 			Username: to.Ptr("myUsername"),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.ContainerRegistryProvisioningStateSucceeded),
// 	},
// }

Output:

func (*ContainerRegistriesClient) NewListPager 

func (client *ContainerRegistriesClient) NewListPager(resourceGroupName string, serviceName string, options *ContainerRegistriesClientListOptions) *runtime.Pager[ContainerRegistriesClientListResponse]

NewListPager - List container registries resource.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ContainerRegistriesClientListOptions contains the optional parameters for the ContainerRegistriesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ContainerRegistries_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewContainerRegistriesClient().NewListPager("myResourceGroup", "my-service", 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.ContainerRegistryResourceCollection = armappplatform.ContainerRegistryResourceCollection{
	// 	Value: []*armappplatform.ContainerRegistryResource{
	// 		{
	// 			Name: to.Ptr("my-container-registry"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/containerRegistries"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/my-service/containerRegistries/my-container-registry"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ContainerRegistryProperties{
	// 				Credentials: &armappplatform.ContainerRegistryBasicCredentials{
	// 					Type: to.Ptr("BasicAuth"),
	// 					Server: to.Ptr("myServer"),
	// 					Username: to.Ptr("myUsername"),
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.ContainerRegistryProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type ContainerRegistriesClientBeginCreateOrUpdateOptions 

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

ContainerRegistriesClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainerRegistriesClient.BeginCreateOrUpdate method.

type ContainerRegistriesClientBeginDeleteOptions 

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

ContainerRegistriesClientBeginDeleteOptions contains the optional parameters for the ContainerRegistriesClient.BeginDelete method.

type ContainerRegistriesClientBeginValidateOptions 

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

ContainerRegistriesClientBeginValidateOptions contains the optional parameters for the ContainerRegistriesClient.BeginValidate method.

type ContainerRegistriesClientCreateOrUpdateResponse 

type ContainerRegistriesClientCreateOrUpdateResponse struct {
	// Container registry resource payload.
	ContainerRegistryResource
}

ContainerRegistriesClientCreateOrUpdateResponse contains the response from method ContainerRegistriesClient.BeginCreateOrUpdate.

type ContainerRegistriesClientDeleteResponse 

type ContainerRegistriesClientDeleteResponse struct {
}

ContainerRegistriesClientDeleteResponse contains the response from method ContainerRegistriesClient.BeginDelete.

type ContainerRegistriesClientGetOptions 

type ContainerRegistriesClientGetOptions struct {
}

ContainerRegistriesClientGetOptions contains the optional parameters for the ContainerRegistriesClient.Get method.

type ContainerRegistriesClientGetResponse 

type ContainerRegistriesClientGetResponse struct {
	// Container registry resource payload.
	ContainerRegistryResource
}

ContainerRegistriesClientGetResponse contains the response from method ContainerRegistriesClient.Get.

type ContainerRegistriesClientListOptions 

type ContainerRegistriesClientListOptions struct {
}

ContainerRegistriesClientListOptions contains the optional parameters for the ContainerRegistriesClient.NewListPager method.

type ContainerRegistriesClientListResponse 

type ContainerRegistriesClientListResponse struct {
	// Collection compose of container registry resources list and a possible link for next page.
	ContainerRegistryResourceCollection
}

ContainerRegistriesClientListResponse contains the response from method ContainerRegistriesClient.NewListPager.

type ContainerRegistriesClientValidateResponse 

type ContainerRegistriesClientValidateResponse struct {
	// Validation result for container registry properties
	ContainerRegistryValidateResult
}

ContainerRegistriesClientValidateResponse contains the response from method ContainerRegistriesClient.BeginValidate.

type ContainerRegistryBasicCredentials 

type ContainerRegistryBasicCredentials struct {
	// REQUIRED; The password of the Container Registry.
	Password *string

	// REQUIRED; The login server of the Container Registry.
	Server *string

	// REQUIRED; The credential type of the container registry credentials.
	Type *string

	// REQUIRED; The username of the Container Registry.
	Username *string
}

ContainerRegistryBasicCredentials - The basic authentication properties for the container registry resource.

func (*ContainerRegistryBasicCredentials) GetContainerRegistryCredentials 

func (c *ContainerRegistryBasicCredentials) GetContainerRegistryCredentials() *ContainerRegistryCredentials

GetContainerRegistryCredentials implements the ContainerRegistryCredentialsClassification interface for type ContainerRegistryBasicCredentials.

func (ContainerRegistryBasicCredentials) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryBasicCredentials.

func (*ContainerRegistryBasicCredentials) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryBasicCredentials.

type ContainerRegistryCredentials 

type ContainerRegistryCredentials struct {
	// REQUIRED; The credential type of the container registry credentials.
	Type *string
}

ContainerRegistryCredentials - The credential for the container registry resource.

func (*ContainerRegistryCredentials) GetContainerRegistryCredentials 

func (c *ContainerRegistryCredentials) GetContainerRegistryCredentials() *ContainerRegistryCredentials

GetContainerRegistryCredentials implements the ContainerRegistryCredentialsClassification interface for type ContainerRegistryCredentials.

func (ContainerRegistryCredentials) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryCredentials.

func (*ContainerRegistryCredentials) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryCredentials.

type ContainerRegistryCredentialsClassification 

type ContainerRegistryCredentialsClassification interface {
	// GetContainerRegistryCredentials returns the ContainerRegistryCredentials content of the underlying type.
	GetContainerRegistryCredentials() *ContainerRegistryCredentials
}

ContainerRegistryCredentialsClassification provides polymorphic access to related types. Call the interface's GetContainerRegistryCredentials() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ContainerRegistryBasicCredentials, *ContainerRegistryCredentials

type ContainerRegistryProperties 

type ContainerRegistryProperties struct {
	// REQUIRED; The credentials of the container registry resource.
	Credentials ContainerRegistryCredentialsClassification

	// READ-ONLY; State of the Container Registry.
	ProvisioningState *ContainerRegistryProvisioningState
}

ContainerRegistryProperties - Container registry resource payload.

func (ContainerRegistryProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryProperties.

func (*ContainerRegistryProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryProperties.

type ContainerRegistryProvisioningState 

type ContainerRegistryProvisioningState string

ContainerRegistryProvisioningState - State of the Container Registry. 

const (
	ContainerRegistryProvisioningStateCanceled  ContainerRegistryProvisioningState = "Canceled"
	ContainerRegistryProvisioningStateCreating  ContainerRegistryProvisioningState = "Creating"
	ContainerRegistryProvisioningStateDeleting  ContainerRegistryProvisioningState = "Deleting"
	ContainerRegistryProvisioningStateFailed    ContainerRegistryProvisioningState = "Failed"
	ContainerRegistryProvisioningStateSucceeded ContainerRegistryProvisioningState = "Succeeded"
	ContainerRegistryProvisioningStateUpdating  ContainerRegistryProvisioningState = "Updating"
)

func PossibleContainerRegistryProvisioningStateValues 

func PossibleContainerRegistryProvisioningStateValues() []ContainerRegistryProvisioningState

PossibleContainerRegistryProvisioningStateValues returns the possible values for the ContainerRegistryProvisioningState const type.

type ContainerRegistryResource 

type ContainerRegistryResource struct {
	// Properties of the container registry resource payload.
	Properties *ContainerRegistryProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ContainerRegistryResource - Container registry resource payload.

func (ContainerRegistryResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryResource.

func (*ContainerRegistryResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryResource.

type ContainerRegistryResourceCollection 

type ContainerRegistryResourceCollection struct {
	// The link to next page of storage list.
	NextLink *string

	// The container registry resources list.
	Value []*ContainerRegistryResource
}

ContainerRegistryResourceCollection - Collection compose of container registry resources list and a possible link for next page.

func (ContainerRegistryResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryResourceCollection.

func (*ContainerRegistryResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryResourceCollection.

type ContainerRegistryValidateResult 

type ContainerRegistryValidateResult struct {
	// Indicate if the container registry properties are valid
	IsValid *bool

	// Detailed validation messages.
	Message *string
}

ContainerRegistryValidateResult - Validation result for container registry properties

func (ContainerRegistryValidateResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContainerRegistryValidateResult.

func (*ContainerRegistryValidateResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryValidateResult.

type ContentCertificateProperties 

type ContentCertificateProperties struct {
	// REQUIRED; The type of the certificate source.
	Type *string

	// The content of uploaded certificate.
	Content *string

	// READ-ONLY; The activate date of certificate.
	ActivateDate *string

	// READ-ONLY; The domain list of certificate.
	DNSNames []*string

	// READ-ONLY; The expiration date of certificate.
	ExpirationDate *string

	// READ-ONLY; The issue date of certificate.
	IssuedDate *string

	// READ-ONLY; The issuer of certificate.
	Issuer *string

	// READ-ONLY; Provisioning state of the Certificate
	ProvisioningState *CertificateResourceProvisioningState

	// READ-ONLY; The subject name of certificate.
	SubjectName *string

	// READ-ONLY; The thumbprint of certificate.
	Thumbprint *string
}

ContentCertificateProperties - Properties of certificate imported from key vault.

func (*ContentCertificateProperties) GetCertificateProperties 

func (c *ContentCertificateProperties) GetCertificateProperties() *CertificateProperties

GetCertificateProperties implements the CertificatePropertiesClassification interface for type ContentCertificateProperties.

func (ContentCertificateProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ContentCertificateProperties.

func (*ContentCertificateProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContentCertificateProperties.

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 CustomContainer 

type CustomContainer struct {
	// Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
	Args []*string

	// Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
	Command []*string

	// Container image of the custom container. This should be in the form of : without the server name of the registry
	ContainerImage *string

	// Credential of the image registry
	ImageRegistryCredential *ImageRegistryCredential

	// Language framework of the container image uploaded. Supported values: "springboot", "", null.
	LanguageFramework *string

	// The name of the registry that contains the container image
	Server *string
}

CustomContainer - Custom container payload

func (CustomContainer) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomContainer.

func (*CustomContainer) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomContainer.

type CustomContainerUserSourceInfo 

type CustomContainerUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// Custom container payload
	CustomContainer *CustomContainer

	// Version of the source
	Version *string
}

CustomContainerUserSourceInfo - Custom container user source info

func (*CustomContainerUserSourceInfo) GetUserSourceInfo 

func (c *CustomContainerUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type CustomContainerUserSourceInfo.

func (CustomContainerUserSourceInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomContainerUserSourceInfo.

func (*CustomContainerUserSourceInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomContainerUserSourceInfo.

type CustomDomainProperties 

type CustomDomainProperties struct {
	// The bound certificate name of domain.
	CertName *string

	// The thumbprint of bound certificate.
	Thumbprint *string

	// READ-ONLY; The app name of domain.
	AppName *string

	// READ-ONLY; Provisioning state of the Domain
	ProvisioningState *CustomDomainResourceProvisioningState
}

CustomDomainProperties - Custom domain of app resource payload.

func (CustomDomainProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainProperties.

func (*CustomDomainProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomainProperties.

type CustomDomainResource 

type CustomDomainResource struct {
	// Properties of the custom domain resource.
	Properties *CustomDomainProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

CustomDomainResource - Custom domain resource payload.

func (CustomDomainResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainResource.

func (*CustomDomainResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomainResource.

type CustomDomainResourceCollection 

type CustomDomainResourceCollection struct {
	// The link to next page of custom domain list.
	NextLink *string

	// The custom domain resources list.
	Value []*CustomDomainResource
}

CustomDomainResourceCollection - Collection compose of a custom domain resources list and a possible link for next page.

func (CustomDomainResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainResourceCollection.

func (*CustomDomainResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomainResourceCollection.

type CustomDomainResourceProvisioningState 

type CustomDomainResourceProvisioningState string

CustomDomainResourceProvisioningState - Provisioning state of the Domain 

const (
	CustomDomainResourceProvisioningStateCreating  CustomDomainResourceProvisioningState = "Creating"
	CustomDomainResourceProvisioningStateDeleting  CustomDomainResourceProvisioningState = "Deleting"
	CustomDomainResourceProvisioningStateFailed    CustomDomainResourceProvisioningState = "Failed"
	CustomDomainResourceProvisioningStateSucceeded CustomDomainResourceProvisioningState = "Succeeded"
	CustomDomainResourceProvisioningStateUpdating  CustomDomainResourceProvisioningState = "Updating"
)

func PossibleCustomDomainResourceProvisioningStateValues 

func PossibleCustomDomainResourceProvisioningStateValues() []CustomDomainResourceProvisioningState

PossibleCustomDomainResourceProvisioningStateValues returns the possible values for the CustomDomainResourceProvisioningState const type.

type CustomDomainValidatePayload 

type CustomDomainValidatePayload struct {
	// REQUIRED; Name to be validated
	Name *string
}

CustomDomainValidatePayload - Custom domain validate payload.

func (CustomDomainValidatePayload) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainValidatePayload.

func (*CustomDomainValidatePayload) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomainValidatePayload.

type CustomDomainValidateResult 

type CustomDomainValidateResult struct {
	// Indicates if domain name is valid.
	IsValid *bool

	// Message of why domain name is invalid.
	Message *string
}

CustomDomainValidateResult - Validation result for custom domain.

func (CustomDomainValidateResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainValidateResult.

func (*CustomDomainValidateResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomDomainValidateResult.

type CustomDomainsClient 

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

CustomDomainsClient contains the methods for the CustomDomains group. Don't use this type directly, use NewCustomDomainsClient() instead.

func NewCustomDomainsClient 

func NewCustomDomainsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CustomDomainsClient, error)

NewCustomDomainsClient creates a new instance of CustomDomainsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*CustomDomainsClient) BeginCreateOrUpdate 

func (client *CustomDomainsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, domainName string, domainResource CustomDomainResource, options *CustomDomainsClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomDomainsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • domainName - The name of the custom domain resource.
  • domainResource - Parameters for the create or update operation
  • options - CustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomDomainsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCustomDomainsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydomain.com", armappplatform.CustomDomainResource{
	Properties: &armappplatform.CustomDomainProperties{
		CertName:   to.Ptr("mycert"),
		Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
	},
}, 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.CustomDomainResource = armappplatform.CustomDomainResource{
// 	Name: to.Ptr("mydomain.com"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.CustomDomainProperties{
// 		AppName: to.Ptr("myapp"),
// 		CertName: to.Ptr("mycert"),
// 		Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
// 	},
// }

Output:

func (*CustomDomainsClient) BeginDelete 

func (client *CustomDomainsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, appName string, domainName string, options *CustomDomainsClientBeginDeleteOptions) (*runtime.Poller[CustomDomainsClientDeleteResponse], error)

BeginDelete - Delete the custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • domainName - The name of the custom domain resource.
  • options - CustomDomainsClientBeginDeleteOptions contains the optional parameters for the CustomDomainsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCustomDomainsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "myapp", "mydomain.com", 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 (*CustomDomainsClient) BeginUpdate 

func (client *CustomDomainsClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, domainName string, domainResource CustomDomainResource, options *CustomDomainsClientBeginUpdateOptions) (*runtime.Poller[CustomDomainsClientUpdateResponse], error)

BeginUpdate - Update custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • domainName - The name of the custom domain resource.
  • domainResource - Parameters for the create or update operation
  • options - CustomDomainsClientBeginUpdateOptions contains the optional parameters for the CustomDomainsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCustomDomainsClient().BeginUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydomain.com", armappplatform.CustomDomainResource{
	Properties: &armappplatform.CustomDomainProperties{
		CertName:   to.Ptr("mycert"),
		Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
	},
}, 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.CustomDomainResource = armappplatform.CustomDomainResource{
// 	Name: to.Ptr("mydomain.com"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.CustomDomainProperties{
// 		AppName: to.Ptr("myapp"),
// 		CertName: to.Ptr("mycert"),
// 		Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
// 	},
// }

Output:

func (*CustomDomainsClient) Get 

func (client *CustomDomainsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, appName string, domainName string, options *CustomDomainsClientGetOptions) (CustomDomainsClientGetResponse, error)

Get - Get the custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • domainName - The name of the custom domain resource.
  • options - CustomDomainsClientGetOptions contains the optional parameters for the CustomDomainsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCustomDomainsClient().Get(ctx, "myResourceGroup", "myservice", "myapp", "mydomain.com", 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.CustomDomainResource = armappplatform.CustomDomainResource{
// 	Name: to.Ptr("mydomain.com"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.CustomDomainProperties{
// 		AppName: to.Ptr("myapp"),
// 		CertName: to.Ptr("mycert"),
// 		ProvisioningState: to.Ptr(armappplatform.CustomDomainResourceProvisioningStateSucceeded),
// 		Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
// 	},
// }

Output:

func (*CustomDomainsClient) NewListPager 

func (client *CustomDomainsClient) NewListPager(resourceGroupName string, serviceName string, appName string, options *CustomDomainsClientListOptions) *runtime.Pager[CustomDomainsClientListResponse]

NewListPager - List the custom domains of one lifecycle application.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • options - CustomDomainsClientListOptions contains the optional parameters for the CustomDomainsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomDomains_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCustomDomainsClient().NewListPager("myResourceGroup", "myservice", "myapp", 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.CustomDomainResourceCollection = armappplatform.CustomDomainResourceCollection{
	// 	Value: []*armappplatform.CustomDomainResource{
	// 		{
	// 			Name: to.Ptr("mydomain.com"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/domains"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.CustomDomainProperties{
	// 				AppName: to.Ptr("myapp"),
	// 				CertName: to.Ptr("mycert"),
	// 				ProvisioningState: to.Ptr(armappplatform.CustomDomainResourceProvisioningStateSucceeded),
	// 				Thumbprint: to.Ptr("934367bf1c97033f877db0f15cb1b586957d3133"),
	// 			},
	// 	}},
	// }
}

Output:

type CustomDomainsClientBeginCreateOrUpdateOptions 

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

CustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomDomainsClient.BeginCreateOrUpdate method.

type CustomDomainsClientBeginDeleteOptions 

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

CustomDomainsClientBeginDeleteOptions contains the optional parameters for the CustomDomainsClient.BeginDelete method.

type CustomDomainsClientBeginUpdateOptions 

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

CustomDomainsClientBeginUpdateOptions contains the optional parameters for the CustomDomainsClient.BeginUpdate method.

type CustomDomainsClientCreateOrUpdateResponse 

type CustomDomainsClientCreateOrUpdateResponse struct {
	// Custom domain resource payload.
	CustomDomainResource
}

CustomDomainsClientCreateOrUpdateResponse contains the response from method CustomDomainsClient.BeginCreateOrUpdate.

type CustomDomainsClientDeleteResponse 

type CustomDomainsClientDeleteResponse struct {
}

CustomDomainsClientDeleteResponse contains the response from method CustomDomainsClient.BeginDelete.

type CustomDomainsClientGetOptions 

type CustomDomainsClientGetOptions struct {
}

CustomDomainsClientGetOptions contains the optional parameters for the CustomDomainsClient.Get method.

type CustomDomainsClientGetResponse 

type CustomDomainsClientGetResponse struct {
	// Custom domain resource payload.
	CustomDomainResource
}

CustomDomainsClientGetResponse contains the response from method CustomDomainsClient.Get.

type CustomDomainsClientListOptions 

type CustomDomainsClientListOptions struct {
}

CustomDomainsClientListOptions contains the optional parameters for the CustomDomainsClient.NewListPager method.

type CustomDomainsClientListResponse 

type CustomDomainsClientListResponse struct {
	// Collection compose of a custom domain resources list and a possible link for next page.
	CustomDomainResourceCollection
}

CustomDomainsClientListResponse contains the response from method CustomDomainsClient.NewListPager.

type CustomDomainsClientUpdateResponse 

type CustomDomainsClientUpdateResponse struct {
	// Custom domain resource payload.
	CustomDomainResource
}

CustomDomainsClientUpdateResponse contains the response from method CustomDomainsClient.BeginUpdate.

type CustomPersistentDiskProperties 

type CustomPersistentDiskProperties struct {
	// REQUIRED; The mount path of the persistent disk.
	MountPath *string

	// REQUIRED; The type of the underlying resource to mount as a persistent disk.
	Type *Type

	// If set to true, it will create and mount a dedicated directory for every individual app instance.
	EnableSubPath *bool

	// These are the mount options for a persistent disk.
	MountOptions []*string

	// Indicates whether the persistent disk is a readOnly one.
	ReadOnly *bool
}

CustomPersistentDiskProperties - Custom persistent disk resource payload.

func (*CustomPersistentDiskProperties) GetCustomPersistentDiskProperties 

func (c *CustomPersistentDiskProperties) GetCustomPersistentDiskProperties() *CustomPersistentDiskProperties

GetCustomPersistentDiskProperties implements the CustomPersistentDiskPropertiesClassification interface for type CustomPersistentDiskProperties.

func (CustomPersistentDiskProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomPersistentDiskProperties.

func (*CustomPersistentDiskProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomPersistentDiskProperties.

type CustomPersistentDiskPropertiesClassification 

type CustomPersistentDiskPropertiesClassification interface {
	// GetCustomPersistentDiskProperties returns the CustomPersistentDiskProperties content of the underlying type.
	GetCustomPersistentDiskProperties() *CustomPersistentDiskProperties
}

CustomPersistentDiskPropertiesClassification provides polymorphic access to related types. Call the interface's GetCustomPersistentDiskProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureFileVolume, *CustomPersistentDiskProperties

type CustomPersistentDiskResource 

type CustomPersistentDiskResource struct {
	// REQUIRED; The resource id of Azure Spring Apps Storage resource.
	StorageID *string

	// Properties of the custom persistent disk resource payload.
	CustomPersistentDiskProperties CustomPersistentDiskPropertiesClassification
}

CustomPersistentDiskResource - Custom persistent disk resource payload.

func (CustomPersistentDiskResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomPersistentDiskResource.

func (*CustomPersistentDiskResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomPersistentDiskResource.

type CustomizedAcceleratorProperties 

type CustomizedAcceleratorProperties struct {
	// REQUIRED
	GitRepository   *AcceleratorGitRepository
	AcceleratorTags []*string

	// Type of the customized accelerator.
	AcceleratorType *CustomizedAcceleratorType
	Description     *string
	DisplayName     *string
	IconURL         *string

	// READ-ONLY; Imports references all imports that this accelerator/fragment depends upon.
	Imports []*string

	// READ-ONLY; State of the customized accelerator.
	ProvisioningState *CustomizedAcceleratorProvisioningState
}

CustomizedAcceleratorProperties - Customized accelerator properties payload

func (CustomizedAcceleratorProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomizedAcceleratorProperties.

func (*CustomizedAcceleratorProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomizedAcceleratorProperties.

type CustomizedAcceleratorProvisioningState 

type CustomizedAcceleratorProvisioningState string

CustomizedAcceleratorProvisioningState - State of the customized accelerator. 

const (
	CustomizedAcceleratorProvisioningStateCanceled  CustomizedAcceleratorProvisioningState = "Canceled"
	CustomizedAcceleratorProvisioningStateCreating  CustomizedAcceleratorProvisioningState = "Creating"
	CustomizedAcceleratorProvisioningStateDeleting  CustomizedAcceleratorProvisioningState = "Deleting"
	CustomizedAcceleratorProvisioningStateFailed    CustomizedAcceleratorProvisioningState = "Failed"
	CustomizedAcceleratorProvisioningStateSucceeded CustomizedAcceleratorProvisioningState = "Succeeded"
	CustomizedAcceleratorProvisioningStateUpdating  CustomizedAcceleratorProvisioningState = "Updating"
)

func PossibleCustomizedAcceleratorProvisioningStateValues 

func PossibleCustomizedAcceleratorProvisioningStateValues() []CustomizedAcceleratorProvisioningState

PossibleCustomizedAcceleratorProvisioningStateValues returns the possible values for the CustomizedAcceleratorProvisioningState const type.

type CustomizedAcceleratorResource 

type CustomizedAcceleratorResource struct {
	// Customized accelerator properties payload
	Properties *CustomizedAcceleratorProperties

	// Sku of the customized accelerator resource
	SKU *SKU

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

CustomizedAcceleratorResource - Customized accelerator resource

func (CustomizedAcceleratorResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomizedAcceleratorResource.

func (*CustomizedAcceleratorResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomizedAcceleratorResource.

type CustomizedAcceleratorResourceCollection 

type CustomizedAcceleratorResourceCollection struct {
	NextLink *string
	Value    []*CustomizedAcceleratorResource
}

func (CustomizedAcceleratorResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomizedAcceleratorResourceCollection.

func (*CustomizedAcceleratorResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomizedAcceleratorResourceCollection.

type CustomizedAcceleratorType 

type CustomizedAcceleratorType string

CustomizedAcceleratorType - Type of the customized accelerator. 

const (
	CustomizedAcceleratorTypeAccelerator CustomizedAcceleratorType = "Accelerator"
	CustomizedAcceleratorTypeFragment    CustomizedAcceleratorType = "Fragment"
)

func PossibleCustomizedAcceleratorTypeValues 

func PossibleCustomizedAcceleratorTypeValues() []CustomizedAcceleratorType

PossibleCustomizedAcceleratorTypeValues returns the possible values for the CustomizedAcceleratorType const type.

type CustomizedAcceleratorValidateResult 

type CustomizedAcceleratorValidateResult struct {
	// The detail validation results
	ErrorMessage *string

	// State of the customized accelerator validation result
	State *CustomizedAcceleratorValidateResultState
}

CustomizedAcceleratorValidateResult - Validation result for customized accelerator properties

func (CustomizedAcceleratorValidateResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomizedAcceleratorValidateResult.

func (*CustomizedAcceleratorValidateResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomizedAcceleratorValidateResult.

type CustomizedAcceleratorValidateResultState 

type CustomizedAcceleratorValidateResultState string

CustomizedAcceleratorValidateResultState - State of the customized accelerator validation result 

const (
	// CustomizedAcceleratorValidateResultStateInvalid - Customized accelerator properties are invalid.
	CustomizedAcceleratorValidateResultStateInvalid CustomizedAcceleratorValidateResultState = "Invalid"
	// CustomizedAcceleratorValidateResultStateValid - Customized accelerator properties are valid.
	CustomizedAcceleratorValidateResultStateValid CustomizedAcceleratorValidateResultState = "Valid"
)

func PossibleCustomizedAcceleratorValidateResultStateValues 

func PossibleCustomizedAcceleratorValidateResultStateValues() []CustomizedAcceleratorValidateResultState

PossibleCustomizedAcceleratorValidateResultStateValues returns the possible values for the CustomizedAcceleratorValidateResultState const type.

type CustomizedAcceleratorsClient 

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

CustomizedAcceleratorsClient contains the methods for the CustomizedAccelerators group. Don't use this type directly, use NewCustomizedAcceleratorsClient() instead.

func NewCustomizedAcceleratorsClient 

func NewCustomizedAcceleratorsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CustomizedAcceleratorsClient, error)

NewCustomizedAcceleratorsClient creates a new instance of CustomizedAcceleratorsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*CustomizedAcceleratorsClient) BeginCreateOrUpdate 

func (client *CustomizedAcceleratorsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, customizedAcceleratorName string, customizedAcceleratorResource CustomizedAcceleratorResource, options *CustomizedAcceleratorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomizedAcceleratorsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • customizedAcceleratorName - The name of the customized accelerator.
  • customizedAcceleratorResource - The customized accelerator for the create or update operation
  • options - CustomizedAcceleratorsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomizedAcceleratorsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomizedAccelerators_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCustomizedAcceleratorsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "acc-name", armappplatform.CustomizedAcceleratorResource{
	Properties: &armappplatform.CustomizedAcceleratorProperties{
		Description: to.Ptr("acc-desc"),
		AcceleratorTags: []*string{
			to.Ptr("tag-a"),
			to.Ptr("tag-b")},
		DisplayName: to.Ptr("acc-name"),
		GitRepository: &armappplatform.AcceleratorGitRepository{
			AuthSetting: &armappplatform.AcceleratorSSHSetting{
				AuthType:         to.Ptr("SSH"),
				HostKey:          to.Ptr("git-auth-hostkey"),
				HostKeyAlgorithm: to.Ptr("git-auth-algorithm"),
				PrivateKey:       to.Ptr("git-auth-privatekey"),
			},
			Branch:            to.Ptr("git-branch"),
			Commit:            to.Ptr("12345"),
			GitTag:            to.Ptr("git-tag"),
			IntervalInSeconds: to.Ptr[int32](70),
			URL:               to.Ptr("git-url"),
		},
		IconURL: to.Ptr("acc-icon"),
	},
	SKU: &armappplatform.SKU{
		Name:     to.Ptr("E0"),
		Capacity: to.Ptr[int32](2),
		Tier:     to.Ptr("Enterprise"),
	},
}, 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.CustomizedAcceleratorResource = armappplatform.CustomizedAcceleratorResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators/acc-name"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.CustomizedAcceleratorProperties{
// 		Description: to.Ptr("acc-desc"),
// 		AcceleratorTags: []*string{
// 			to.Ptr("tag-a"),
// 			to.Ptr("tag-b")},
// 			DisplayName: to.Ptr("acc-name"),
// 			GitRepository: &armappplatform.AcceleratorGitRepository{
// 				AuthSetting: &armappplatform.AcceleratorSSHSetting{
// 					AuthType: to.Ptr("SSH"),
// 				},
// 				Branch: to.Ptr("git-branch"),
// 				Commit: to.Ptr("12345"),
// 				GitTag: to.Ptr("git-tag"),
// 				IntervalInSeconds: to.Ptr[int32](70),
// 				URL: to.Ptr("git-url"),
// 			},
// 			IconURL: to.Ptr("acc-icon"),
// 			ProvisioningState: to.Ptr(armappplatform.CustomizedAcceleratorProvisioningStateSucceeded),
// 		},
// 		SKU: &armappplatform.SKU{
// 			Name: to.Ptr("E0"),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr("Enterprise"),
// 		},
// 	}

Output:

func (*CustomizedAcceleratorsClient) BeginDelete 

func (client *CustomizedAcceleratorsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, customizedAcceleratorName string, options *CustomizedAcceleratorsClientBeginDeleteOptions) (*runtime.Poller[CustomizedAcceleratorsClientDeleteResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • customizedAcceleratorName - The name of the customized accelerator.
  • options - CustomizedAcceleratorsClientBeginDeleteOptions contains the optional parameters for the CustomizedAcceleratorsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomizedAccelerators_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCustomizedAcceleratorsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", "acc-name", 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 (*CustomizedAcceleratorsClient) BeginValidate 

func (client *CustomizedAcceleratorsClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, customizedAcceleratorName string, properties CustomizedAcceleratorProperties, options *CustomizedAcceleratorsClientBeginValidateOptions) (*runtime.Poller[CustomizedAcceleratorsClientValidateResponse], error)

BeginValidate - Check the customized accelerator are valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • customizedAcceleratorName - The name of the customized accelerator.
  • properties - Customized accelerator properties to be validated
  • options - CustomizedAcceleratorsClientBeginValidateOptions contains the optional parameters for the CustomizedAcceleratorsClient.BeginValidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomizedAccelerators_Validate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCustomizedAcceleratorsClient().BeginValidate(ctx, "myResourceGroup", "myservice", "default", "acc-name", armappplatform.CustomizedAcceleratorProperties{
	Description: to.Ptr("acc-desc"),
	AcceleratorTags: []*string{
		to.Ptr("tag-a"),
		to.Ptr("tag-b")},
	DisplayName: to.Ptr("acc-name"),
	GitRepository: &armappplatform.AcceleratorGitRepository{
		AuthSetting: &armappplatform.AcceleratorSSHSetting{
			AuthType:         to.Ptr("SSH"),
			HostKey:          to.Ptr("git-auth-hostkey"),
			HostKeyAlgorithm: to.Ptr("git-auth-algorithm"),
			PrivateKey:       to.Ptr("git-auth-privatekey"),
		},
		Branch:            to.Ptr("git-branch"),
		Commit:            to.Ptr("12345"),
		GitTag:            to.Ptr("git-tag"),
		IntervalInSeconds: to.Ptr[int32](70),
		URL:               to.Ptr("git-url"),
	},
	IconURL: to.Ptr("acc-icon"),
}, 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.CustomizedAcceleratorValidateResult = armappplatform.CustomizedAcceleratorValidateResult{
// 	ErrorMessage: to.Ptr(""),
// 	State: to.Ptr(armappplatform.CustomizedAcceleratorValidateResultStateValid),
// }

Output:

func (*CustomizedAcceleratorsClient) Get 

func (client *CustomizedAcceleratorsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, customizedAcceleratorName string, options *CustomizedAcceleratorsClientGetOptions) (CustomizedAcceleratorsClientGetResponse, error)

Get - Get the customized accelerator. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • customizedAcceleratorName - The name of the customized accelerator.
  • options - CustomizedAcceleratorsClientGetOptions contains the optional parameters for the CustomizedAcceleratorsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomizedAccelerators_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCustomizedAcceleratorsClient().Get(ctx, "myResourceGroup", "myservice", "default", "acc-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.CustomizedAcceleratorResource = armappplatform.CustomizedAcceleratorResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators/acc-name"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.CustomizedAcceleratorProperties{
// 		Description: to.Ptr("acc-desc"),
// 		AcceleratorTags: []*string{
// 			to.Ptr("tag-a"),
// 			to.Ptr("tag-b")},
// 			DisplayName: to.Ptr("acc-name"),
// 			GitRepository: &armappplatform.AcceleratorGitRepository{
// 				AuthSetting: &armappplatform.AcceleratorSSHSetting{
// 					AuthType: to.Ptr("SSH"),
// 				},
// 				Branch: to.Ptr("git-branch"),
// 				Commit: to.Ptr("12345"),
// 				GitTag: to.Ptr("git-tag"),
// 				IntervalInSeconds: to.Ptr[int32](70),
// 				URL: to.Ptr("git-url"),
// 			},
// 			IconURL: to.Ptr("acc-icon"),
// 			ProvisioningState: to.Ptr(armappplatform.CustomizedAcceleratorProvisioningStateSucceeded),
// 		},
// 		SKU: &armappplatform.SKU{
// 			Name: to.Ptr("E0"),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr("Enterprise"),
// 		},
// 	}

Output:

func (*CustomizedAcceleratorsClient) NewListPager 

func (client *CustomizedAcceleratorsClient) NewListPager(resourceGroupName string, serviceName string, applicationAcceleratorName string, options *CustomizedAcceleratorsClientListOptions) *runtime.Pager[CustomizedAcceleratorsClientListResponse]

NewListPager - Handle requests to list all customized accelerators.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • options - CustomizedAcceleratorsClientListOptions contains the optional parameters for the CustomizedAcceleratorsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/CustomizedAccelerators_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCustomizedAcceleratorsClient().NewListPager("myResourceGroup", "myservice", "default", 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.CustomizedAcceleratorResourceCollection = armappplatform.CustomizedAcceleratorResourceCollection{
	// 	Value: []*armappplatform.CustomizedAcceleratorResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators/customizedAccelerators"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/customizedAccelerators"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.CustomizedAcceleratorProperties{
	// 				Description: to.Ptr("acc-desc"),
	// 				AcceleratorTags: []*string{
	// 					to.Ptr("tag-a"),
	// 					to.Ptr("tag-b")},
	// 					DisplayName: to.Ptr("acc-name"),
	// 					GitRepository: &armappplatform.AcceleratorGitRepository{
	// 						AuthSetting: &armappplatform.AcceleratorSSHSetting{
	// 							AuthType: to.Ptr("SSH"),
	// 						},
	// 						Branch: to.Ptr("git-branch"),
	// 						Commit: to.Ptr("12345"),
	// 						GitTag: to.Ptr("git-tag"),
	// 						IntervalInSeconds: to.Ptr[int32](70),
	// 						URL: to.Ptr("git-url"),
	// 					},
	// 					IconURL: to.Ptr("acc-icon"),
	// 					ProvisioningState: to.Ptr(armappplatform.CustomizedAcceleratorProvisioningStateSucceeded),
	// 				},
	// 				SKU: &armappplatform.SKU{
	// 					Name: to.Ptr("E0"),
	// 					Capacity: to.Ptr[int32](2),
	// 					Tier: to.Ptr("Enterprise"),
	// 				},
	// 		}},
	// 	}
}

Output:

type CustomizedAcceleratorsClientBeginCreateOrUpdateOptions 

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

CustomizedAcceleratorsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomizedAcceleratorsClient.BeginCreateOrUpdate method.

type CustomizedAcceleratorsClientBeginDeleteOptions 

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

CustomizedAcceleratorsClientBeginDeleteOptions contains the optional parameters for the CustomizedAcceleratorsClient.BeginDelete method.

type CustomizedAcceleratorsClientBeginValidateOptions 

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

CustomizedAcceleratorsClientBeginValidateOptions contains the optional parameters for the CustomizedAcceleratorsClient.BeginValidate method.

type CustomizedAcceleratorsClientCreateOrUpdateResponse 

type CustomizedAcceleratorsClientCreateOrUpdateResponse struct {
	// Customized accelerator resource
	CustomizedAcceleratorResource
}

CustomizedAcceleratorsClientCreateOrUpdateResponse contains the response from method CustomizedAcceleratorsClient.BeginCreateOrUpdate.

type CustomizedAcceleratorsClientDeleteResponse 

type CustomizedAcceleratorsClientDeleteResponse struct {
}

CustomizedAcceleratorsClientDeleteResponse contains the response from method CustomizedAcceleratorsClient.BeginDelete.

type CustomizedAcceleratorsClientGetOptions 

type CustomizedAcceleratorsClientGetOptions struct {
}

CustomizedAcceleratorsClientGetOptions contains the optional parameters for the CustomizedAcceleratorsClient.Get method.

type CustomizedAcceleratorsClientGetResponse 

type CustomizedAcceleratorsClientGetResponse struct {
	// Customized accelerator resource
	CustomizedAcceleratorResource
}

CustomizedAcceleratorsClientGetResponse contains the response from method CustomizedAcceleratorsClient.Get.

type CustomizedAcceleratorsClientListOptions 

type CustomizedAcceleratorsClientListOptions struct {
}

CustomizedAcceleratorsClientListOptions contains the optional parameters for the CustomizedAcceleratorsClient.NewListPager method.

type CustomizedAcceleratorsClientListResponse 

type CustomizedAcceleratorsClientListResponse struct {
	CustomizedAcceleratorResourceCollection
}

CustomizedAcceleratorsClientListResponse contains the response from method CustomizedAcceleratorsClient.NewListPager.

type CustomizedAcceleratorsClientValidateResponse 

type CustomizedAcceleratorsClientValidateResponse struct {
	// Validation result for customized accelerator properties
	CustomizedAcceleratorValidateResult
}

CustomizedAcceleratorsClientValidateResponse contains the response from method CustomizedAcceleratorsClient.BeginValidate.

type DeploymentInstance 

type DeploymentInstance struct {
	// READ-ONLY; Discovery status of the deployment instance
	DiscoveryStatus *string

	// READ-ONLY; Name of the deployment instance
	Name *string

	// READ-ONLY; Failed reason of the deployment instance
	Reason *string

	// READ-ONLY; Start time of the deployment instance
	StartTime *string

	// READ-ONLY; Status of the deployment instance
	Status *string

	// READ-ONLY; Availability zone information of the deployment instance
	Zone *string
}

DeploymentInstance - Deployment instance payload

func (DeploymentInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentInstance.

func (*DeploymentInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentInstance.

type DeploymentList 

type DeploymentList struct {
	// A list of deployment resource ids.
	Deployments []*string
}

DeploymentList - A list of deployments resource ids.

func (DeploymentList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentList.

func (*DeploymentList) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentList.

type DeploymentResource 

type DeploymentResource struct {
	// Properties of the Deployment resource
	Properties *DeploymentResourceProperties

	// Sku of the Deployment resource
	SKU *SKU

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

DeploymentResource - Deployment resource payload

func (DeploymentResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentResource.

func (*DeploymentResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentResource.

type DeploymentResourceCollection 

type DeploymentResourceCollection 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 Deployment resources
	Value []*DeploymentResource
}

DeploymentResourceCollection - Object that includes an array of App resources and a possible link for next set

func (DeploymentResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentResourceCollection.

func (*DeploymentResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentResourceCollection.

type DeploymentResourceProperties 

type DeploymentResourceProperties struct {
	// Indicates whether the Deployment is active
	Active *bool

	// Deployment settings of the Deployment
	DeploymentSettings *DeploymentSettings

	// Uploaded source information of the deployment.
	Source UserSourceInfoClassification

	// READ-ONLY; Collection of instances belong to the Deployment
	Instances []*DeploymentInstance

	// READ-ONLY; Provisioning state of the Deployment
	ProvisioningState *DeploymentResourceProvisioningState

	// READ-ONLY; Status of the Deployment
	Status *DeploymentResourceStatus
}

DeploymentResourceProperties - Deployment resource properties payload

func (DeploymentResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentResourceProperties.

func (*DeploymentResourceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentResourceProperties.

type DeploymentResourceProvisioningState 

type DeploymentResourceProvisioningState string

DeploymentResourceProvisioningState - Provisioning state of the Deployment 

const (
	DeploymentResourceProvisioningStateCreating  DeploymentResourceProvisioningState = "Creating"
	DeploymentResourceProvisioningStateFailed    DeploymentResourceProvisioningState = "Failed"
	DeploymentResourceProvisioningStateSucceeded DeploymentResourceProvisioningState = "Succeeded"
	DeploymentResourceProvisioningStateUpdating  DeploymentResourceProvisioningState = "Updating"
)

func PossibleDeploymentResourceProvisioningStateValues 

func PossibleDeploymentResourceProvisioningStateValues() []DeploymentResourceProvisioningState

PossibleDeploymentResourceProvisioningStateValues returns the possible values for the DeploymentResourceProvisioningState const type.

type DeploymentResourceStatus 

type DeploymentResourceStatus string

DeploymentResourceStatus - Status of the Deployment 

const (
	DeploymentResourceStatusRunning DeploymentResourceStatus = "Running"
	DeploymentResourceStatusStopped DeploymentResourceStatus = "Stopped"
)

func PossibleDeploymentResourceStatusValues 

func PossibleDeploymentResourceStatusValues() []DeploymentResourceStatus

PossibleDeploymentResourceStatusValues returns the possible values for the DeploymentResourceStatus const type.

type DeploymentSettings 

type DeploymentSettings struct {
	// Collection of addons
	AddonConfigs map[string]any

	// Collection of ApmReferences
	Apms []*ApmReference

	// Container liveness and readiness probe settings
	ContainerProbeSettings *ContainerProbeSettings

	// Collection of environment variables
	EnvironmentVariables map[string]*string

	// Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
	LivenessProbe *Probe

	// Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails.
	// More info:
	// https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
	ReadinessProbe *Probe

	// The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required
	// CPU and Memory, the old field cpu and memoryInGB will be deprecated
	// later.
	ResourceRequests *ResourceRequests

	// StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until
	// this completes successfully. If this probe fails, the Pod will be restarted,
	// just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's
	// lifecycle, when it might take a long time to load data or warm a cache,
	// than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
	StartupProbe *Probe

	// Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. 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. The grace
	// period is the duration in seconds after the processes running in the App
	// Instance 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. Defaults to 90
	// seconds.
	TerminationGracePeriodSeconds *int32
}

DeploymentSettings - Deployment settings payload

func (DeploymentSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeploymentSettings.

func (*DeploymentSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentSettings.

type DeploymentsClient 

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

DeploymentsClient contains the methods for the Deployments group. Don't use this type directly, use NewDeploymentsClient() instead.

func NewDeploymentsClient 

func NewDeploymentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DeploymentsClient, error)

NewDeploymentsClient creates a new instance of DeploymentsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DeploymentsClient) BeginCreateOrUpdate 

func (client *DeploymentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, deploymentResource DeploymentResource, options *DeploymentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DeploymentsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • deploymentResource - Parameters for the create or update operation
  • options - DeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdate method.
Example (DeploymentsCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DeploymentResource{
	Properties: &armappplatform.DeploymentResourceProperties{
		DeploymentSettings: &armappplatform.DeploymentSettings{
			AddonConfigs: map[string]any{
				"ApplicationConfigurationService": map[string]any{
					"patterns": []any{
						"mypattern",
					},
				},
			},
			Apms: []*armappplatform.ApmReference{
				{
					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
				}},
			EnvironmentVariables: map[string]*string{
				"env": to.Ptr("test"),
			},
			LivenessProbe: &armappplatform.Probe{
				DisableProbe:        to.Ptr(false),
				FailureThreshold:    to.Ptr[int32](3),
				InitialDelaySeconds: to.Ptr[int32](30),
				PeriodSeconds:       to.Ptr[int32](10),
				ProbeAction: &armappplatform.HTTPGetAction{
					Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
					Path:   to.Ptr("/health"),
					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
				},
			},
			ReadinessProbe: &armappplatform.Probe{
				DisableProbe:        to.Ptr(false),
				FailureThreshold:    to.Ptr[int32](3),
				InitialDelaySeconds: to.Ptr[int32](30),
				PeriodSeconds:       to.Ptr[int32](10),
				ProbeAction: &armappplatform.HTTPGetAction{
					Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
					Path:   to.Ptr("/health"),
					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
				},
			},
			ResourceRequests: &armappplatform.ResourceRequests{
				CPU:    to.Ptr("1000m"),
				Memory: to.Ptr("3Gi"),
			},
			TerminationGracePeriodSeconds: to.Ptr[int32](30),
		},
		Source: &armappplatform.SourceUploadedUserSourceInfo{
			Type:             to.Ptr("Source"),
			Version:          to.Ptr("1.0"),
			RelativePath:     to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
			ArtifactSelector: to.Ptr("sub-module-1"),
		},
	},
	SKU: &armappplatform.SKU{
		Name:     to.Ptr("S0"),
		Capacity: to.Ptr[int32](1),
		Tier:     to.Ptr("Standard"),
	},
}, 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.DeploymentResource = armappplatform.DeploymentResource{
// 	Name: to.Ptr("mydeployment"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DeploymentResourceProperties{
// 		Active: to.Ptr(false),
// 		DeploymentSettings: &armappplatform.DeploymentSettings{
// 			Apms: []*armappplatform.ApmReference{
// 				{
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 			}},
// 			EnvironmentVariables: map[string]*string{
// 				"env": to.Ptr("test"),
// 			},
// 			LivenessProbe: &armappplatform.Probe{
// 				DisableProbe: to.Ptr(false),
// 				FailureThreshold: to.Ptr[int32](3),
// 				InitialDelaySeconds: to.Ptr[int32](30),
// 				PeriodSeconds: to.Ptr[int32](10),
// 				ProbeAction: &armappplatform.HTTPGetAction{
// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
// 					Path: to.Ptr("/health"),
// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
// 				},
// 			},
// 			ReadinessProbe: &armappplatform.Probe{
// 				DisableProbe: to.Ptr(false),
// 				FailureThreshold: to.Ptr[int32](3),
// 				InitialDelaySeconds: to.Ptr[int32](30),
// 				PeriodSeconds: to.Ptr[int32](10),
// 				ProbeAction: &armappplatform.HTTPGetAction{
// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
// 					Path: to.Ptr("/health"),
// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
// 				},
// 			},
// 			ResourceRequests: &armappplatform.ResourceRequests{
// 				CPU: to.Ptr("1000m"),
// 				Memory: to.Ptr("3Gi"),
// 			},
// 			TerminationGracePeriodSeconds: to.Ptr[int32](30),
// 		},
// 		Instances: []*armappplatform.DeploymentInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				DiscoveryStatus: to.Ptr("pending"),
// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
// 		Source: &armappplatform.SourceUploadedUserSourceInfo{
// 			Type: to.Ptr("Source"),
// 			Version: to.Ptr("1.0"),
// 			RelativePath: to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
// 			ArtifactSelector: to.Ptr("sub-module-1"),
// 		},
// 		Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("S0"),
// 		Capacity: to.Ptr[int32](1),
// 		Tier: to.Ptr("Standard"),
// 	},
// }

Output:
Example (DeploymentsCreateOrUpdateCustomContainer)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_CreateOrUpdate_CustomContainer.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DeploymentResource{
	Properties: &armappplatform.DeploymentResourceProperties{
		DeploymentSettings: &armappplatform.DeploymentSettings{
			EnvironmentVariables: map[string]*string{
				"env": to.Ptr("test"),
			},
			LivenessProbe: &armappplatform.Probe{
				DisableProbe:        to.Ptr(false),
				FailureThreshold:    to.Ptr[int32](3),
				InitialDelaySeconds: to.Ptr[int32](30),
				PeriodSeconds:       to.Ptr[int32](10),
				ProbeAction: &armappplatform.HTTPGetAction{
					Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
					Path:   to.Ptr("/health"),
					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
				},
			},
			ReadinessProbe: &armappplatform.Probe{
				DisableProbe:        to.Ptr(false),
				FailureThreshold:    to.Ptr[int32](3),
				InitialDelaySeconds: to.Ptr[int32](30),
				PeriodSeconds:       to.Ptr[int32](10),
				ProbeAction: &armappplatform.HTTPGetAction{
					Type:   to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
					Path:   to.Ptr("/health"),
					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
				},
			},
			ResourceRequests: &armappplatform.ResourceRequests{
				CPU:    to.Ptr("1000m"),
				Memory: to.Ptr("3Gi"),
			},
			TerminationGracePeriodSeconds: to.Ptr[int32](30),
		},
		Source: &armappplatform.CustomContainerUserSourceInfo{
			Type: to.Ptr("Container"),
			CustomContainer: &armappplatform.CustomContainer{
				Args: []*string{
					to.Ptr("-c"),
					to.Ptr("while true; do echo hello; sleep 10;done")},
				Command: []*string{
					to.Ptr("/bin/sh")},
				ContainerImage: to.Ptr("myContainerImage:v1"),
				ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
					Password: to.Ptr("myPassword"),
					Username: to.Ptr("myUsername"),
				},
				LanguageFramework: to.Ptr("springboot"),
				Server:            to.Ptr("myacr.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.DeploymentResource = armappplatform.DeploymentResource{
// 	Name: to.Ptr("mydeployment"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DeploymentResourceProperties{
// 		Active: to.Ptr(false),
// 		DeploymentSettings: &armappplatform.DeploymentSettings{
// 			Apms: []*armappplatform.ApmReference{
// 				{
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 			}},
// 			EnvironmentVariables: map[string]*string{
// 				"env": to.Ptr("test"),
// 			},
// 			LivenessProbe: &armappplatform.Probe{
// 				DisableProbe: to.Ptr(false),
// 				FailureThreshold: to.Ptr[int32](3),
// 				InitialDelaySeconds: to.Ptr[int32](30),
// 				PeriodSeconds: to.Ptr[int32](10),
// 				ProbeAction: &armappplatform.HTTPGetAction{
// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
// 					Path: to.Ptr("/health"),
// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
// 				},
// 			},
// 			ReadinessProbe: &armappplatform.Probe{
// 				DisableProbe: to.Ptr(false),
// 				FailureThreshold: to.Ptr[int32](3),
// 				InitialDelaySeconds: to.Ptr[int32](30),
// 				PeriodSeconds: to.Ptr[int32](10),
// 				ProbeAction: &armappplatform.HTTPGetAction{
// 					Type: to.Ptr(armappplatform.ProbeActionTypeHTTPGetAction),
// 					Path: to.Ptr("/health"),
// 					Scheme: to.Ptr(armappplatform.HTTPSchemeTypeHTTP),
// 				},
// 			},
// 			ResourceRequests: &armappplatform.ResourceRequests{
// 				CPU: to.Ptr("1000m"),
// 				Memory: to.Ptr("3Gi"),
// 			},
// 			TerminationGracePeriodSeconds: to.Ptr[int32](30),
// 		},
// 		Instances: []*armappplatform.DeploymentInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				DiscoveryStatus: to.Ptr("N/A"),
// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
// 		Source: &armappplatform.CustomContainerUserSourceInfo{
// 			Type: to.Ptr("Container"),
// 			CustomContainer: &armappplatform.CustomContainer{
// 				ContainerImage: to.Ptr("myContainerImage:v1"),
// 				ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
// 					Password: to.Ptr(""),
// 					Username: to.Ptr("myUsername"),
// 				},
// 				LanguageFramework: to.Ptr("springboot"),
// 				Server: to.Ptr("myacr.azurecr.io"),
// 			},
// 		},
// 		Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("S0"),
// 		Capacity: to.Ptr[int32](1),
// 		Tier: to.Ptr("Standard"),
// 	},
// }

Output:

func (*DeploymentsClient) BeginDelete 

func (client *DeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginDeleteOptions) (*runtime.Poller[DeploymentsClientDeleteResponse], error)

BeginDelete - Operation to delete a Deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientBeginDeleteOptions contains the optional parameters for the DeploymentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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 (*DeploymentsClient) BeginDisableRemoteDebugging 

func (client *DeploymentsClient) BeginDisableRemoteDebugging(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginDisableRemoteDebuggingOptions) (*runtime.Poller[DeploymentsClientDisableRemoteDebuggingResponse], error)

BeginDisableRemoteDebugging - Disable remote debugging. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientBeginDisableRemoteDebuggingOptions contains the optional parameters for the DeploymentsClient.BeginDisableRemoteDebugging method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_DisableRemoteDebugging.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginDisableRemoteDebugging(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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.RemoteDebugging = armappplatform.RemoteDebugging{
// 	Enabled: to.Ptr(false),
// 	Port: to.Ptr[int32](5005),
// }

Output:

func (*DeploymentsClient) BeginEnableRemoteDebugging 

func (client *DeploymentsClient) BeginEnableRemoteDebugging(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginEnableRemoteDebuggingOptions) (*runtime.Poller[DeploymentsClientEnableRemoteDebuggingResponse], error)

BeginEnableRemoteDebugging - Enable remote debugging. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientBeginEnableRemoteDebuggingOptions contains the optional parameters for the DeploymentsClient.BeginEnableRemoteDebugging method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_EnableRemoteDebugging.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginEnableRemoteDebugging(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", &armappplatform.DeploymentsClientBeginEnableRemoteDebuggingOptions{RemoteDebuggingPayload: &armappplatform.RemoteDebuggingPayload{}})
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.RemoteDebugging = armappplatform.RemoteDebugging{
// 	Enabled: to.Ptr(true),
// 	Port: to.Ptr[int32](5005),
// }

Output:

func (*DeploymentsClient) BeginGenerateHeapDump 

func (client *DeploymentsClient) BeginGenerateHeapDump(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, diagnosticParameters DiagnosticParameters, options *DeploymentsClientBeginGenerateHeapDumpOptions) (*runtime.Poller[DeploymentsClientGenerateHeapDumpResponse], error)

BeginGenerateHeapDump - Generate Heap Dump If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • diagnosticParameters - Parameters for the diagnostic operation
  • options - DeploymentsClientBeginGenerateHeapDumpOptions contains the optional parameters for the DeploymentsClient.BeginGenerateHeapDump method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_GenerateHeapDump.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginGenerateHeapDump(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DiagnosticParameters{
	AppInstance: to.Ptr("myappinstance"),
	FilePath:    to.Ptr("/byos/diagnose"),
}, 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 (*DeploymentsClient) BeginGenerateThreadDump 

func (client *DeploymentsClient) BeginGenerateThreadDump(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, diagnosticParameters DiagnosticParameters, options *DeploymentsClientBeginGenerateThreadDumpOptions) (*runtime.Poller[DeploymentsClientGenerateThreadDumpResponse], error)

BeginGenerateThreadDump - Generate Thread Dump If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • diagnosticParameters - Parameters for the diagnostic operation
  • options - DeploymentsClientBeginGenerateThreadDumpOptions contains the optional parameters for the DeploymentsClient.BeginGenerateThreadDump method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_GenerateThreadDump.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginGenerateThreadDump(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DiagnosticParameters{
	AppInstance: to.Ptr("myappinstance"),
	FilePath:    to.Ptr("/byos/diagnose"),
}, 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 (*DeploymentsClient) BeginRestart 

func (client *DeploymentsClient) BeginRestart(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginRestartOptions) (*runtime.Poller[DeploymentsClientRestartResponse], error)

BeginRestart - Restart the deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientBeginRestartOptions contains the optional parameters for the DeploymentsClient.BeginRestart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Restart.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginRestart(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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 (*DeploymentsClient) BeginStart 

func (client *DeploymentsClient) BeginStart(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginStartOptions) (*runtime.Poller[DeploymentsClientStartResponse], error)

BeginStart - Start the deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientBeginStartOptions contains the optional parameters for the DeploymentsClient.BeginStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Start.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginStart(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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 (*DeploymentsClient) BeginStartJFR 

func (client *DeploymentsClient) BeginStartJFR(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, diagnosticParameters DiagnosticParameters, options *DeploymentsClientBeginStartJFROptions) (*runtime.Poller[DeploymentsClientStartJFRResponse], error)

BeginStartJFR - Start JFR If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • diagnosticParameters - Parameters for the diagnostic operation
  • options - DeploymentsClientBeginStartJFROptions contains the optional parameters for the DeploymentsClient.BeginStartJFR method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_StartJFR.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginStartJFR(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DiagnosticParameters{
	AppInstance: to.Ptr("myappinstance"),
	Duration:    to.Ptr("60s"),
	FilePath:    to.Ptr("/byos/diagnose"),
}, 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 (*DeploymentsClient) BeginStop 

func (client *DeploymentsClient) BeginStop(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginStopOptions) (*runtime.Poller[DeploymentsClientStopResponse], error)

BeginStop - Stop the deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientBeginStopOptions contains the optional parameters for the DeploymentsClient.BeginStop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Stop.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginStop(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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 (*DeploymentsClient) BeginUpdate 

func (client *DeploymentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, deploymentResource DeploymentResource, options *DeploymentsClientBeginUpdateOptions) (*runtime.Poller[DeploymentsClientUpdateResponse], error)

BeginUpdate - Operation to update an exiting Deployment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • deploymentResource - Parameters for the update operation
  • options - DeploymentsClientBeginUpdateOptions contains the optional parameters for the DeploymentsClient.BeginUpdate method.
Example (DeploymentsUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DeploymentResource{
	Properties: &armappplatform.DeploymentResourceProperties{
		Source: &armappplatform.SourceUploadedUserSourceInfo{
			Type:             to.Ptr("Source"),
			Version:          to.Ptr("1.0"),
			RelativePath:     to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
			ArtifactSelector: to.Ptr("sub-module-1"),
		},
	},
}, 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.DeploymentResource = armappplatform.DeploymentResource{
// 	Name: to.Ptr("mydeployment"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DeploymentResourceProperties{
// 		Active: to.Ptr(true),
// 		DeploymentSettings: &armappplatform.DeploymentSettings{
// 			Apms: []*armappplatform.ApmReference{
// 				{
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 			}},
// 			EnvironmentVariables: map[string]*string{
// 				"env": to.Ptr("test"),
// 			},
// 			ResourceRequests: &armappplatform.ResourceRequests{
// 				CPU: to.Ptr("1000m"),
// 				Memory: to.Ptr("3Gi"),
// 			},
// 		},
// 		Instances: []*armappplatform.DeploymentInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				DiscoveryStatus: to.Ptr("pending"),
// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
// 		Source: &armappplatform.SourceUploadedUserSourceInfo{
// 			Type: to.Ptr("Source"),
// 			Version: to.Ptr("1.0"),
// 			RelativePath: to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
// 			ArtifactSelector: to.Ptr("sub-module-1"),
// 		},
// 		Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("S0"),
// 		Capacity: to.Ptr[int32](1),
// 		Tier: to.Ptr("Standard"),
// 	},
// }

Output:
Example (DeploymentsUpdateCustomContainer)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Update_CustomContainer.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDeploymentsClient().BeginUpdate(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", armappplatform.DeploymentResource{
	Properties: &armappplatform.DeploymentResourceProperties{
		Source: &armappplatform.CustomContainerUserSourceInfo{
			Type: to.Ptr("Container"),
			CustomContainer: &armappplatform.CustomContainer{
				Args: []*string{
					to.Ptr("-c"),
					to.Ptr("while true; do echo hello; sleep 10;done")},
				Command: []*string{
					to.Ptr("/bin/sh")},
				ContainerImage: to.Ptr("myNewContainerImage:v1"),
				ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
					Password: to.Ptr("<myNewPassword>"),
					Username: to.Ptr("myNewUsername"),
				},
				Server: to.Ptr("mynewacr.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.DeploymentResource = armappplatform.DeploymentResource{
// 	Name: to.Ptr("mydeployment"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DeploymentResourceProperties{
// 		Active: to.Ptr(false),
// 		DeploymentSettings: &armappplatform.DeploymentSettings{
// 			Apms: []*armappplatform.ApmReference{
// 				{
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 			}},
// 			EnvironmentVariables: map[string]*string{
// 				"env": to.Ptr("test"),
// 			},
// 			ResourceRequests: &armappplatform.ResourceRequests{
// 				CPU: to.Ptr("1000m"),
// 				Memory: to.Ptr("3Gi"),
// 			},
// 		},
// 		Instances: []*armappplatform.DeploymentInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				DiscoveryStatus: to.Ptr("N/A"),
// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
// 		Source: &armappplatform.CustomContainerUserSourceInfo{
// 			Type: to.Ptr("Container"),
// 			CustomContainer: &armappplatform.CustomContainer{
// 				ContainerImage: to.Ptr("myNewContainerImage:v1"),
// 				ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
// 					Password: to.Ptr(""),
// 					Username: to.Ptr("myNewUsername"),
// 				},
// 				Server: to.Ptr("mynewacr.azurecr.io"),
// 			},
// 		},
// 		Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("S0"),
// 		Capacity: to.Ptr[int32](1),
// 		Tier: to.Ptr("Standard"),
// 	},
// }

Output:

func (*DeploymentsClient) Get 

func (client *DeploymentsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientGetOptions) (DeploymentsClientGetResponse, error)

Get - Get a Deployment and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.
Example (DeploymentsGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeploymentsClient().Get(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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.DeploymentResource = armappplatform.DeploymentResource{
// 	Name: to.Ptr("mydeployment"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DeploymentResourceProperties{
// 		Active: to.Ptr(true),
// 		DeploymentSettings: &armappplatform.DeploymentSettings{
// 			Apms: []*armappplatform.ApmReference{
// 				{
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 			}},
// 			EnvironmentVariables: map[string]*string{
// 				"env": to.Ptr("test"),
// 			},
// 			ResourceRequests: &armappplatform.ResourceRequests{
// 				CPU: to.Ptr("1000m"),
// 				Memory: to.Ptr("3Gi"),
// 			},
// 		},
// 		Instances: []*armappplatform.DeploymentInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				DiscoveryStatus: to.Ptr("pending"),
// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
// 		Source: &armappplatform.SourceUploadedUserSourceInfo{
// 			Type: to.Ptr("Source"),
// 			Version: to.Ptr("1.0"),
// 			RelativePath: to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
// 			ArtifactSelector: to.Ptr("sub-module-1"),
// 		},
// 		Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("S0"),
// 		Capacity: to.Ptr[int32](1),
// 		Tier: to.Ptr("Standard"),
// 	},
// }

Output:
Example (DeploymentsGetCustomContainer)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_Get_CustomContainer.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeploymentsClient().Get(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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.DeploymentResource = armappplatform.DeploymentResource{
// 	Name: to.Ptr("mydeployment"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DeploymentResourceProperties{
// 		Active: to.Ptr(false),
// 		DeploymentSettings: &armappplatform.DeploymentSettings{
// 			Apms: []*armappplatform.ApmReference{
// 				{
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 			}},
// 			EnvironmentVariables: map[string]*string{
// 				"env": to.Ptr("test"),
// 			},
// 			ResourceRequests: &armappplatform.ResourceRequests{
// 				CPU: to.Ptr("1000m"),
// 				Memory: to.Ptr("3Gi"),
// 			},
// 		},
// 		Instances: []*armappplatform.DeploymentInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				DiscoveryStatus: to.Ptr("N/A"),
// 				StartTime: to.Ptr("2020-08-26T01:55:02Z"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
// 		Source: &armappplatform.CustomContainerUserSourceInfo{
// 			Type: to.Ptr("Container"),
// 			CustomContainer: &armappplatform.CustomContainer{
// 				Args: []*string{
// 					to.Ptr("-c"),
// 					to.Ptr("while true; do echo hello; sleep 10;done")},
// 					Command: []*string{
// 						to.Ptr("/bin/sh")},
// 						ContainerImage: to.Ptr("myContainerImage:v1"),
// 						ImageRegistryCredential: &armappplatform.ImageRegistryCredential{
// 							Password: to.Ptr(""),
// 							Username: to.Ptr("myUsername"),
// 						},
// 						LanguageFramework: to.Ptr("springboot"),
// 						Server: to.Ptr("myacr.azurecr.io"),
// 					},
// 				},
// 				Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
// 			},
// 			SKU: &armappplatform.SKU{
// 				Name: to.Ptr("S0"),
// 				Capacity: to.Ptr[int32](1),
// 				Tier: to.Ptr("Standard"),
// 			},
// 		}

Output:

func (*DeploymentsClient) GetLogFileURL 

func (client *DeploymentsClient) GetLogFileURL(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientGetLogFileURLOptions) (DeploymentsClientGetLogFileURLResponse, error)

GetLogFileURL - Get deployment log file URL If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientGetLogFileURLOptions contains the optional parameters for the DeploymentsClient.GetLogFileURL method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_GetLogFileUrl.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeploymentsClient().GetLogFileURL(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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.LogFileURLResponse = armappplatform.LogFileURLResponse{
// 	URL: to.Ptr("https://spring.blob.core.windows.net/logs/110ec0c337154d45b1f01daf2196c0bf/b58b0cb4ecdea3c65311b4ca8833fe47b6ae0a7500f87a8eb31e8379d3fe48f1-2019081312-42b7b90c-f108-4c09-b33d-1ea134f57f23?sv=2018-03-28&sr=b&sig=example-signature&se=2019-08-14T09%3A43%3A52Z&sp=r"),
// }

Output:

func (*DeploymentsClient) GetRemoteDebuggingConfig 

func (client *DeploymentsClient) GetRemoteDebuggingConfig(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientGetRemoteDebuggingConfigOptions) (DeploymentsClientGetRemoteDebuggingConfigResponse, error)

GetRemoteDebuggingConfig - Get remote debugging config. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • deploymentName - The name of the Deployment resource.
  • options - DeploymentsClientGetRemoteDebuggingConfigOptions contains the optional parameters for the DeploymentsClient.GetRemoteDebuggingConfig method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_GetRemoteDebuggingConfig.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeploymentsClient().GetRemoteDebuggingConfig(ctx, "myResourceGroup", "myservice", "myapp", "mydeployment", 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.RemoteDebugging = armappplatform.RemoteDebugging{
// 	Enabled: to.Ptr(true),
// 	Port: to.Ptr[int32](5005),
// }

Output:

func (*DeploymentsClient) NewListForClusterPager 

func (client *DeploymentsClient) NewListForClusterPager(resourceGroupName string, serviceName string, options *DeploymentsClientListForClusterOptions) *runtime.Pager[DeploymentsClientListForClusterResponse]

NewListForClusterPager - List deployments for a certain service

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - DeploymentsClientListForClusterOptions contains the optional parameters for the DeploymentsClient.NewListForClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_ListForCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDeploymentsClient().NewListForClusterPager("myResourceGroup", "myservice", &armappplatform.DeploymentsClientListForClusterOptions{Version: []string{},
	Expand: 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.DeploymentResourceCollection = armappplatform.DeploymentResourceCollection{
	// 	Value: []*armappplatform.DeploymentResource{
	// 		{
	// 			Name: to.Ptr("mydeployment"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.DeploymentResourceProperties{
	// 				Active: to.Ptr(true),
	// 				DeploymentSettings: &armappplatform.DeploymentSettings{
	// 					Apms: []*armappplatform.ApmReference{
	// 						{
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
	// 					}},
	// 					EnvironmentVariables: map[string]*string{
	// 						"env": to.Ptr("test"),
	// 					},
	// 					ResourceRequests: &armappplatform.ResourceRequests{
	// 						CPU: to.Ptr("1000m"),
	// 						Memory: to.Ptr("3Gi"),
	// 					},
	// 				},
	// 				Instances: []*armappplatform.DeploymentInstance{
	// 					{
	// 						Name: to.Ptr("instance1"),
	// 						DiscoveryStatus: to.Ptr("pending"),
	// 						StartTime: to.Ptr("2020-08-26T01:55:02Z"),
	// 						Status: to.Ptr("Running"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
	// 				Source: &armappplatform.SourceUploadedUserSourceInfo{
	// 					Type: to.Ptr("Source"),
	// 					Version: to.Ptr("1.0"),
	// 					RelativePath: to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
	// 					ArtifactSelector: to.Ptr("sub-module-1"),
	// 				},
	// 				Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
	// 			},
	// 			SKU: &armappplatform.SKU{
	// 				Name: to.Ptr("S0"),
	// 				Capacity: to.Ptr[int32](1),
	// 				Tier: to.Ptr("Standard"),
	// 			},
	// 	}},
	// }
}

Output:

func (*DeploymentsClient) NewListPager 

func (client *DeploymentsClient) NewListPager(resourceGroupName string, serviceName string, appName string, options *DeploymentsClientListOptions) *runtime.Pager[DeploymentsClientListResponse]

NewListPager - Handles requests to list all resources in an App.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • appName - The name of the App resource.
  • options - DeploymentsClientListOptions contains the optional parameters for the DeploymentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Deployments_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDeploymentsClient().NewListPager("myResourceGroup", "myservice", "myapp", &armappplatform.DeploymentsClientListOptions{Version: []string{}})
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.DeploymentResourceCollection = armappplatform.DeploymentResourceCollection{
	// 	Value: []*armappplatform.DeploymentResource{
	// 		{
	// 			Name: to.Ptr("mydeployment"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/apps/deployments"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.DeploymentResourceProperties{
	// 				Active: to.Ptr(true),
	// 				DeploymentSettings: &armappplatform.DeploymentSettings{
	// 					Apms: []*armappplatform.ApmReference{
	// 						{
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
	// 					}},
	// 					EnvironmentVariables: map[string]*string{
	// 						"env": to.Ptr("test"),
	// 					},
	// 					ResourceRequests: &armappplatform.ResourceRequests{
	// 						CPU: to.Ptr("1000m"),
	// 						Memory: to.Ptr("3Gi"),
	// 					},
	// 				},
	// 				Instances: []*armappplatform.DeploymentInstance{
	// 					{
	// 						Name: to.Ptr("instance1"),
	// 						DiscoveryStatus: to.Ptr("pending"),
	// 						StartTime: to.Ptr("2020-08-26T01:55:02Z"),
	// 						Status: to.Ptr("Running"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.DeploymentResourceProvisioningStateSucceeded),
	// 				Source: &armappplatform.SourceUploadedUserSourceInfo{
	// 					Type: to.Ptr("Source"),
	// 					Version: to.Ptr("1.0"),
	// 					RelativePath: to.Ptr("resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc"),
	// 					ArtifactSelector: to.Ptr("sub-module-1"),
	// 				},
	// 				Status: to.Ptr(armappplatform.DeploymentResourceStatusRunning),
	// 			},
	// 			SKU: &armappplatform.SKU{
	// 				Name: to.Ptr("S0"),
	// 				Capacity: to.Ptr[int32](1),
	// 				Tier: to.Ptr("Standard"),
	// 			},
	// 	}},
	// }
}

Output:

type DeploymentsClientBeginCreateOrUpdateOptions 

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

DeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdate method.

type DeploymentsClientBeginDeleteOptions 

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

DeploymentsClientBeginDeleteOptions contains the optional parameters for the DeploymentsClient.BeginDelete method.

type DeploymentsClientBeginDisableRemoteDebuggingOptions 

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

DeploymentsClientBeginDisableRemoteDebuggingOptions contains the optional parameters for the DeploymentsClient.BeginDisableRemoteDebugging method.

type DeploymentsClientBeginEnableRemoteDebuggingOptions 

type DeploymentsClientBeginEnableRemoteDebuggingOptions struct {
	// Parameters for enable remote debugging
	RemoteDebuggingPayload *RemoteDebuggingPayload

	// Resumes the LRO from the provided token.
	ResumeToken string
}

DeploymentsClientBeginEnableRemoteDebuggingOptions contains the optional parameters for the DeploymentsClient.BeginEnableRemoteDebugging method.

type DeploymentsClientBeginGenerateHeapDumpOptions 

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

DeploymentsClientBeginGenerateHeapDumpOptions contains the optional parameters for the DeploymentsClient.BeginGenerateHeapDump method.

type DeploymentsClientBeginGenerateThreadDumpOptions 

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

DeploymentsClientBeginGenerateThreadDumpOptions contains the optional parameters for the DeploymentsClient.BeginGenerateThreadDump method.

type DeploymentsClientBeginRestartOptions 

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

DeploymentsClientBeginRestartOptions contains the optional parameters for the DeploymentsClient.BeginRestart method.

type DeploymentsClientBeginStartJFROptions 

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

DeploymentsClientBeginStartJFROptions contains the optional parameters for the DeploymentsClient.BeginStartJFR method.

type DeploymentsClientBeginStartOptions 

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

DeploymentsClientBeginStartOptions contains the optional parameters for the DeploymentsClient.BeginStart method.

type DeploymentsClientBeginStopOptions 

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

DeploymentsClientBeginStopOptions contains the optional parameters for the DeploymentsClient.BeginStop method.

type DeploymentsClientBeginUpdateOptions 

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

DeploymentsClientBeginUpdateOptions contains the optional parameters for the DeploymentsClient.BeginUpdate method.

type DeploymentsClientCreateOrUpdateResponse 

type DeploymentsClientCreateOrUpdateResponse struct {
	// Deployment resource payload
	DeploymentResource
}

DeploymentsClientCreateOrUpdateResponse contains the response from method DeploymentsClient.BeginCreateOrUpdate.

type DeploymentsClientDeleteResponse 

type DeploymentsClientDeleteResponse struct {
}

DeploymentsClientDeleteResponse contains the response from method DeploymentsClient.BeginDelete.

type DeploymentsClientDisableRemoteDebuggingResponse 

type DeploymentsClientDisableRemoteDebuggingResponse struct {
	// Remote debugging config.
	RemoteDebugging
}

DeploymentsClientDisableRemoteDebuggingResponse contains the response from method DeploymentsClient.BeginDisableRemoteDebugging.

type DeploymentsClientEnableRemoteDebuggingResponse 

type DeploymentsClientEnableRemoteDebuggingResponse struct {
	// Remote debugging config.
	RemoteDebugging
}

DeploymentsClientEnableRemoteDebuggingResponse contains the response from method DeploymentsClient.BeginEnableRemoteDebugging.

type DeploymentsClientGenerateHeapDumpResponse 

type DeploymentsClientGenerateHeapDumpResponse struct {
}

DeploymentsClientGenerateHeapDumpResponse contains the response from method DeploymentsClient.BeginGenerateHeapDump.

type DeploymentsClientGenerateThreadDumpResponse 

type DeploymentsClientGenerateThreadDumpResponse struct {
}

DeploymentsClientGenerateThreadDumpResponse contains the response from method DeploymentsClient.BeginGenerateThreadDump.

type DeploymentsClientGetLogFileURLOptions 

type DeploymentsClientGetLogFileURLOptions struct {
}

DeploymentsClientGetLogFileURLOptions contains the optional parameters for the DeploymentsClient.GetLogFileURL method.

type DeploymentsClientGetLogFileURLResponse 

type DeploymentsClientGetLogFileURLResponse struct {
	// Log file URL payload
	LogFileURLResponse
}

DeploymentsClientGetLogFileURLResponse contains the response from method DeploymentsClient.GetLogFileURL.

type DeploymentsClientGetOptions 

type DeploymentsClientGetOptions struct {
}

DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.

type DeploymentsClientGetRemoteDebuggingConfigOptions 

type DeploymentsClientGetRemoteDebuggingConfigOptions struct {
}

DeploymentsClientGetRemoteDebuggingConfigOptions contains the optional parameters for the DeploymentsClient.GetRemoteDebuggingConfig method.

type DeploymentsClientGetRemoteDebuggingConfigResponse 

type DeploymentsClientGetRemoteDebuggingConfigResponse struct {
	// Remote debugging config.
	RemoteDebugging
}

DeploymentsClientGetRemoteDebuggingConfigResponse contains the response from method DeploymentsClient.GetRemoteDebuggingConfig.

type DeploymentsClientGetResponse 

type DeploymentsClientGetResponse struct {
	// Deployment resource payload
	DeploymentResource
}

DeploymentsClientGetResponse contains the response from method DeploymentsClient.Get.

type DeploymentsClientListForClusterOptions 

type DeploymentsClientListForClusterOptions struct {
	// The expand expression to apply on the operation.
	Expand *string

	// Version of the deployments to be listed
	Version []string
}

DeploymentsClientListForClusterOptions contains the optional parameters for the DeploymentsClient.NewListForClusterPager method.

type DeploymentsClientListForClusterResponse 

type DeploymentsClientListForClusterResponse struct {
	// Object that includes an array of App resources and a possible link for next set
	DeploymentResourceCollection
}

DeploymentsClientListForClusterResponse contains the response from method DeploymentsClient.NewListForClusterPager.

type DeploymentsClientListOptions 

type DeploymentsClientListOptions struct {
	// Version of the deployments to be listed
	Version []string
}

DeploymentsClientListOptions contains the optional parameters for the DeploymentsClient.NewListPager method.

type DeploymentsClientListResponse 

type DeploymentsClientListResponse struct {
	// Object that includes an array of App resources and a possible link for next set
	DeploymentResourceCollection
}

DeploymentsClientListResponse contains the response from method DeploymentsClient.NewListPager.

type DeploymentsClientRestartResponse 

type DeploymentsClientRestartResponse struct {
}

DeploymentsClientRestartResponse contains the response from method DeploymentsClient.BeginRestart.

type DeploymentsClientStartJFRResponse 

type DeploymentsClientStartJFRResponse struct {
}

DeploymentsClientStartJFRResponse contains the response from method DeploymentsClient.BeginStartJFR.

type DeploymentsClientStartResponse 

type DeploymentsClientStartResponse struct {
}

DeploymentsClientStartResponse contains the response from method DeploymentsClient.BeginStart.

type DeploymentsClientStopResponse 

type DeploymentsClientStopResponse struct {
}

DeploymentsClientStopResponse contains the response from method DeploymentsClient.BeginStop.

type DeploymentsClientUpdateResponse 

type DeploymentsClientUpdateResponse struct {
	// Deployment resource payload
	DeploymentResource
}

DeploymentsClientUpdateResponse contains the response from method DeploymentsClient.BeginUpdate.

type DevToolPortalComponent 

type DevToolPortalComponent struct {
	// READ-ONLY; Collection of instances belong to Dev Tool Portal.
	Instances []*DevToolPortalInstance

	// READ-ONLY
	Name *string

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *DevToolPortalResourceRequests
}

func (DevToolPortalComponent) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalComponent.

func (*DevToolPortalComponent) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalComponent.

type DevToolPortalFeatureDetail 

type DevToolPortalFeatureDetail struct {
	// State of the plugin
	State *DevToolPortalFeatureState

	// READ-ONLY; Route path to visit the plugin
	Route *string
}

DevToolPortalFeatureDetail - Detail settings for Dev Tool Portal feature

func (DevToolPortalFeatureDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalFeatureDetail.

func (*DevToolPortalFeatureDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalFeatureDetail.

type DevToolPortalFeatureSettings 

type DevToolPortalFeatureSettings struct {
	// Detail of Accelerator plugin
	ApplicationAccelerator *DevToolPortalFeatureDetail

	// Detail of App Live View plugin
	ApplicationLiveView *DevToolPortalFeatureDetail
}

DevToolPortalFeatureSettings - Settings for Dev Tool Portal

func (DevToolPortalFeatureSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalFeatureSettings.

func (*DevToolPortalFeatureSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalFeatureSettings.

type DevToolPortalFeatureState 

type DevToolPortalFeatureState string

DevToolPortalFeatureState - State of the plugin 

const (
	// DevToolPortalFeatureStateDisabled - Disable the plugin in Dev Tool Portal.
	DevToolPortalFeatureStateDisabled DevToolPortalFeatureState = "Disabled"
	// DevToolPortalFeatureStateEnabled - Enable the plugin in Dev Tool Portal.
	DevToolPortalFeatureStateEnabled DevToolPortalFeatureState = "Enabled"
)

func PossibleDevToolPortalFeatureStateValues 

func PossibleDevToolPortalFeatureStateValues() []DevToolPortalFeatureState

PossibleDevToolPortalFeatureStateValues returns the possible values for the DevToolPortalFeatureState const type.

type DevToolPortalInstance 

type DevToolPortalInstance struct {
	// READ-ONLY; Name of the Dev Tool Portal instance.
	Name *string

	// READ-ONLY; Status of the Dev Tool Portal instance. It can be Pending, Running, Succeeded, Failed, Unknown.
	Status *string
}

DevToolPortalInstance - Collection of instances belong to the Dev Tool Portal.

func (DevToolPortalInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalInstance.

func (*DevToolPortalInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalInstance.

type DevToolPortalProperties 

type DevToolPortalProperties struct {
	// Settings for Dev Tool Portal
	Features *DevToolPortalFeatureSettings

	// Indicates whether the resource exposes public endpoint
	Public *bool

	// Single sign-on related configuration
	SsoProperties *DevToolPortalSsoProperties

	// READ-ONLY; Collection of components belong to Dev Tool Portal.
	Components []*DevToolPortalComponent

	// READ-ONLY; State of the Dev Tool Portal.
	ProvisioningState *DevToolPortalProvisioningState

	// READ-ONLY; URL of the resource, exposed when 'public' is true.
	URL *string
}

DevToolPortalProperties - Dev Tool Portal properties payload

func (DevToolPortalProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalProperties.

func (*DevToolPortalProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalProperties.

type DevToolPortalProvisioningState 

type DevToolPortalProvisioningState string

DevToolPortalProvisioningState - State of the Dev Tool Portal. 

const (
	DevToolPortalProvisioningStateCanceled  DevToolPortalProvisioningState = "Canceled"
	DevToolPortalProvisioningStateCreating  DevToolPortalProvisioningState = "Creating"
	DevToolPortalProvisioningStateDeleting  DevToolPortalProvisioningState = "Deleting"
	DevToolPortalProvisioningStateFailed    DevToolPortalProvisioningState = "Failed"
	DevToolPortalProvisioningStateSucceeded DevToolPortalProvisioningState = "Succeeded"
	DevToolPortalProvisioningStateUpdating  DevToolPortalProvisioningState = "Updating"
)

func PossibleDevToolPortalProvisioningStateValues 

func PossibleDevToolPortalProvisioningStateValues() []DevToolPortalProvisioningState

PossibleDevToolPortalProvisioningStateValues returns the possible values for the DevToolPortalProvisioningState const type.

type DevToolPortalResource 

type DevToolPortalResource struct {
	// Dev Tool Portal properties payload
	Properties *DevToolPortalProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

DevToolPortalResource - Dev Tool Portal resource

func (DevToolPortalResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalResource.

func (*DevToolPortalResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalResource.

type DevToolPortalResourceCollection 

type DevToolPortalResourceCollection 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 Dev Tool Portal resources
	Value []*DevToolPortalResource
}

DevToolPortalResourceCollection - Object that includes an array of Dev Tool Portal resources and a possible link for next set

func (DevToolPortalResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalResourceCollection.

func (*DevToolPortalResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalResourceCollection.

type DevToolPortalResourceRequests 

type DevToolPortalResourceRequests struct {
	// READ-ONLY; Cpu quantity allocated to each Dev Tool Portal instance. 1 core can be represented by 1 or 1000m
	CPU *string

	// READ-ONLY; Desired instance count of Dev Tool Portal.
	InstanceCount *int32

	// READ-ONLY; Memory quantity allocated to each Dev Tool Portal instance. 1 GB can be represented by 1Gi or 1024Mi.
	Memory *string
}

DevToolPortalResourceRequests - The resource quantity for required CPU and Memory of Dev Tool Portal

func (DevToolPortalResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalResourceRequests.

func (*DevToolPortalResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalResourceRequests.

type DevToolPortalSsoProperties 

type DevToolPortalSsoProperties struct {
	// The public identifier for the application
	ClientID *string

	// The secret known only to the application and the authorization server
	ClientSecret *string

	// The URI of a JSON file with generic OIDC provider configuration.
	MetadataURL *string

	// It defines the specific actions applications can be allowed to do on a user's behalf
	Scopes []*string
}

DevToolPortalSsoProperties - Single sign-on related configuration

func (DevToolPortalSsoProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DevToolPortalSsoProperties.

func (*DevToolPortalSsoProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DevToolPortalSsoProperties.

type DevToolPortalsClient 

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

DevToolPortalsClient contains the methods for the DevToolPortals group. Don't use this type directly, use NewDevToolPortalsClient() instead.

func NewDevToolPortalsClient 

func NewDevToolPortalsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DevToolPortalsClient, error)

NewDevToolPortalsClient creates a new instance of DevToolPortalsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DevToolPortalsClient) BeginCreateOrUpdate 

func (client *DevToolPortalsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, devToolPortalName string, devToolPortalResource DevToolPortalResource, options *DevToolPortalsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DevToolPortalsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default Dev Tool Portal or update the existing Dev Tool Portal. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • devToolPortalName - The name of Dev Tool Portal.
  • devToolPortalResource - Parameters for the create or update operation
  • options - DevToolPortalsClientBeginCreateOrUpdateOptions contains the optional parameters for the DevToolPortalsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/DevToolPortals_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDevToolPortalsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.DevToolPortalResource{
	Properties: &armappplatform.DevToolPortalProperties{
		Features: &armappplatform.DevToolPortalFeatureSettings{
			ApplicationAccelerator: &armappplatform.DevToolPortalFeatureDetail{
				State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
			},
			ApplicationLiveView: &armappplatform.DevToolPortalFeatureDetail{
				State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
			},
		},
		Public: to.Ptr(true),
		SsoProperties: &armappplatform.DevToolPortalSsoProperties{
			ClientID:     to.Ptr("00000000-0000-0000-0000-000000000000"),
			ClientSecret: to.Ptr("xxxxx"),
			MetadataURL:  to.Ptr("https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration"),
			Scopes: []*string{
				to.Ptr("openid")},
		},
	},
}, 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.DevToolPortalResource = armappplatform.DevToolPortalResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DevToolPortalProperties{
// 		Components: []*armappplatform.DevToolPortalComponent{
// 			{
// 				Name: to.Ptr("server"),
// 				Instances: []*armappplatform.DevToolPortalInstance{
// 					{
// 						Name: to.Ptr("dev-tool-portal-server-name"),
// 						Status: to.Ptr("Running"),
// 				}},
// 				ResourceRequests: &armappplatform.DevToolPortalResourceRequests{
// 					CPU: to.Ptr("1"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("1Gi"),
// 				},
// 		}},
// 		Features: &armappplatform.DevToolPortalFeatureSettings{
// 			ApplicationAccelerator: &armappplatform.DevToolPortalFeatureDetail{
// 				Route: to.Ptr("create"),
// 				State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
// 			},
// 			ApplicationLiveView: &armappplatform.DevToolPortalFeatureDetail{
// 				Route: to.Ptr("appliveview"),
// 				State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.DevToolPortalProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		SsoProperties: &armappplatform.DevToolPortalSsoProperties{
// 			ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			MetadataURL: to.Ptr("https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration"),
// 			Scopes: []*string{
// 				to.Ptr("openid")},
// 			},
// 			URL: to.Ptr("aaa.com"),
// 		},
// 	}

Output:

func (*DevToolPortalsClient) BeginDelete 

func (client *DevToolPortalsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, devToolPortalName string, options *DevToolPortalsClientBeginDeleteOptions) (*runtime.Poller[DevToolPortalsClientDeleteResponse], error)

BeginDelete - Disable the default Dev Tool Portal. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • devToolPortalName - The name of Dev Tool Portal.
  • options - DevToolPortalsClientBeginDeleteOptions contains the optional parameters for the DevToolPortalsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/DevToolPortal_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDevToolPortalsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*DevToolPortalsClient) Get 

func (client *DevToolPortalsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, devToolPortalName string, options *DevToolPortalsClientGetOptions) (DevToolPortalsClientGetResponse, error)

Get - Get the Application Live and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • devToolPortalName - The name of Dev Tool Portal.
  • options - DevToolPortalsClientGetOptions contains the optional parameters for the DevToolPortalsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/DevToolPortals_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDevToolPortalsClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.DevToolPortalResource = armappplatform.DevToolPortalResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.DevToolPortalProperties{
// 		Components: []*armappplatform.DevToolPortalComponent{
// 			{
// 				Name: to.Ptr("server"),
// 				Instances: []*armappplatform.DevToolPortalInstance{
// 					{
// 						Name: to.Ptr("dev-tool-portal-server-name"),
// 						Status: to.Ptr("Running"),
// 				}},
// 				ResourceRequests: &armappplatform.DevToolPortalResourceRequests{
// 					CPU: to.Ptr("1"),
// 					InstanceCount: to.Ptr[int32](1),
// 					Memory: to.Ptr("1Gi"),
// 				},
// 		}},
// 		Features: &armappplatform.DevToolPortalFeatureSettings{
// 			ApplicationAccelerator: &armappplatform.DevToolPortalFeatureDetail{
// 				Route: to.Ptr("create"),
// 				State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
// 			},
// 			ApplicationLiveView: &armappplatform.DevToolPortalFeatureDetail{
// 				Route: to.Ptr("appliveview"),
// 				State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.DevToolPortalProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		SsoProperties: &armappplatform.DevToolPortalSsoProperties{
// 			ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			MetadataURL: to.Ptr("https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration"),
// 			Scopes: []*string{
// 				to.Ptr("openid")},
// 			},
// 			URL: to.Ptr("aaa.com"),
// 		},
// 	}

Output:

func (*DevToolPortalsClient) NewListPager 

func (client *DevToolPortalsClient) NewListPager(resourceGroupName string, serviceName string, options *DevToolPortalsClientListOptions) *runtime.Pager[DevToolPortalsClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - DevToolPortalsClientListOptions contains the optional parameters for the DevToolPortalsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/DevToolPortals_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDevToolPortalsClient().NewListPager("myResourceGroup", "myservice", 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.DevToolPortalResourceCollection = armappplatform.DevToolPortalResourceCollection{
	// 	Value: []*armappplatform.DevToolPortalResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.DevToolPortalProperties{
	// 				Components: []*armappplatform.DevToolPortalComponent{
	// 					{
	// 						Name: to.Ptr("server"),
	// 						Instances: []*armappplatform.DevToolPortalInstance{
	// 							{
	// 								Name: to.Ptr("dev-tool-portal-server-name"),
	// 								Status: to.Ptr("Running"),
	// 						}},
	// 						ResourceRequests: &armappplatform.DevToolPortalResourceRequests{
	// 							CPU: to.Ptr("1"),
	// 							InstanceCount: to.Ptr[int32](1),
	// 							Memory: to.Ptr("1Gi"),
	// 						},
	// 				}},
	// 				Features: &armappplatform.DevToolPortalFeatureSettings{
	// 					ApplicationAccelerator: &armappplatform.DevToolPortalFeatureDetail{
	// 						Route: to.Ptr("create"),
	// 						State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
	// 					},
	// 					ApplicationLiveView: &armappplatform.DevToolPortalFeatureDetail{
	// 						Route: to.Ptr("appliveview"),
	// 						State: to.Ptr(armappplatform.DevToolPortalFeatureStateEnabled),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.DevToolPortalProvisioningStateSucceeded),
	// 				Public: to.Ptr(true),
	// 				SsoProperties: &armappplatform.DevToolPortalSsoProperties{
	// 					ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					MetadataURL: to.Ptr("https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0/.well-known/openid-configuration"),
	// 					Scopes: []*string{
	// 						to.Ptr("openid")},
	// 					},
	// 					URL: to.Ptr("aaa.com"),
	// 				},
	// 		}},
	// 	}
}

Output:

type DevToolPortalsClientBeginCreateOrUpdateOptions 

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

DevToolPortalsClientBeginCreateOrUpdateOptions contains the optional parameters for the DevToolPortalsClient.BeginCreateOrUpdate method.

type DevToolPortalsClientBeginDeleteOptions 

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

DevToolPortalsClientBeginDeleteOptions contains the optional parameters for the DevToolPortalsClient.BeginDelete method.

type DevToolPortalsClientCreateOrUpdateResponse 

type DevToolPortalsClientCreateOrUpdateResponse struct {
	// Dev Tool Portal resource
	DevToolPortalResource
}

DevToolPortalsClientCreateOrUpdateResponse contains the response from method DevToolPortalsClient.BeginCreateOrUpdate.

type DevToolPortalsClientDeleteResponse 

type DevToolPortalsClientDeleteResponse struct {
}

DevToolPortalsClientDeleteResponse contains the response from method DevToolPortalsClient.BeginDelete.

type DevToolPortalsClientGetOptions 

type DevToolPortalsClientGetOptions struct {
}

DevToolPortalsClientGetOptions contains the optional parameters for the DevToolPortalsClient.Get method.

type DevToolPortalsClientGetResponse 

type DevToolPortalsClientGetResponse struct {
	// Dev Tool Portal resource
	DevToolPortalResource
}

DevToolPortalsClientGetResponse contains the response from method DevToolPortalsClient.Get.

type DevToolPortalsClientListOptions 

type DevToolPortalsClientListOptions struct {
}

DevToolPortalsClientListOptions contains the optional parameters for the DevToolPortalsClient.NewListPager method.

type DevToolPortalsClientListResponse 

type DevToolPortalsClientListResponse struct {
	// Object that includes an array of Dev Tool Portal resources and a possible link for next set
	DevToolPortalResourceCollection
}

DevToolPortalsClientListResponse contains the response from method DevToolPortalsClient.NewListPager.

type DiagnosticParameters 

type DiagnosticParameters struct {
	// App instance name
	AppInstance *string

	// Duration of your JFR. 1 min can be represented by 1m or 60s.
	Duration *string

	// Your target file path in your own BYOS
	FilePath *string
}

DiagnosticParameters - Diagnostic parameters of diagnostic operations

func (DiagnosticParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnosticParameters.

func (*DiagnosticParameters) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnosticParameters.

type Error 

type Error struct {
	// The code of error.
	Code *string

	// The message of error.
	Message *string
}

Error - The error code compose of code and message.

func (Error) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type ExecAction 

type ExecAction struct {
	// REQUIRED; The type of the action to take to perform the health check.
	Type *ProbeActionType

	// Command is the command line to execute inside the container, the working directory for the command is root ('/') in the
	// container's filesystem. The command is not run inside a shell, so traditional
	// shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of
	// 0 is treated as live/healthy and non-zero is unhealthy.
	Command []*string
}

ExecAction describes a "run in container" action.

func (*ExecAction) GetProbeAction 

func (e *ExecAction) GetProbeAction() *ProbeAction

GetProbeAction implements the ProbeActionClassification interface for type ExecAction.

func (ExecAction) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExecAction.

func (*ExecAction) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExecAction.

type GatewayAPIMetadataProperties 

type GatewayAPIMetadataProperties struct {
	// Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes
	// the API routes configured.)
	Description *string

	// Location of additional documentation for the APIs available on the Gateway instance
	Documentation *string

	// Base URL that API consumers will use to access APIs on the Gateway instance.
	ServerURL *string

	// Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
	Title *string

	// Version of APIs available on this Gateway instance (default: unspecified).
	Version *string
}

GatewayAPIMetadataProperties - API metadata property for Spring Cloud Gateway

func (GatewayAPIMetadataProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayAPIMetadataProperties.

func (*GatewayAPIMetadataProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayAPIMetadataProperties.

type GatewayAPIRoute 

type GatewayAPIRoute struct {
	// A description, will be applied to methods in the generated OpenAPI documentation.
	Description *string

	// To modify the request before sending it to the target endpoint, or the received response.
	Filters []*string

	// Route processing order.
	Order *int32

	// A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and
	// parameter values. All of the predicates associated with a route must evaluate
	// to true for the route to be matched to the request.
	Predicates []*string

	// Enable sso validation.
	SsoEnabled *bool

	// Classification tags, will be applied to methods in the generated OpenAPI documentation.
	Tags []*string

	// A title, will be applied to methods in the generated OpenAPI documentation.
	Title *string

	// Pass currently-authenticated user's identity token to application service, default is 'false'
	TokenRelay *bool

	// Full uri, will override appName.
	URI *string
}

GatewayAPIRoute - API route config of the Spring Cloud Gateway

func (GatewayAPIRoute) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayAPIRoute.

func (*GatewayAPIRoute) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayAPIRoute.

type GatewayCertificateVerification 

type GatewayCertificateVerification string

GatewayCertificateVerification - Whether to enable certificate verification or not 

const (
	// GatewayCertificateVerificationDisabled - Disable certificate verification in Spring Cloud Gateway.
	GatewayCertificateVerificationDisabled GatewayCertificateVerification = "Disabled"
	// GatewayCertificateVerificationEnabled - Enable certificate verification in Spring Cloud Gateway.
	GatewayCertificateVerificationEnabled GatewayCertificateVerification = "Enabled"
)

func PossibleGatewayCertificateVerificationValues 

func PossibleGatewayCertificateVerificationValues() []GatewayCertificateVerification

PossibleGatewayCertificateVerificationValues returns the possible values for the GatewayCertificateVerification const type.

type GatewayCorsProperties 

type GatewayCorsProperties struct {
	// Whether user credentials are supported on cross-site requests. Valid values: true, false.
	AllowCredentials *bool

	// Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
	AllowedHeaders []*string

	// Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed
	// by default.
	AllowedMethods []*string

	// Allowed origin patterns to make cross-site requests.
	AllowedOriginPatterns []*string

	// Allowed origins to make cross-site requests. The special value * allows all domains.
	AllowedOrigins []*string

	// HTTP response headers to expose for cross-site requests.
	ExposedHeaders []*string

	// How long, in seconds, the response from a pre-flight request can be cached by clients.
	MaxAge *int32
}

GatewayCorsProperties - Cross-Origin Resource Sharing property

func (GatewayCorsProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayCorsProperties.

func (*GatewayCorsProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayCorsProperties.

type GatewayCustomDomainProperties 

type GatewayCustomDomainProperties struct {
	// The thumbprint of bound certificate.
	Thumbprint *string
}

GatewayCustomDomainProperties - The properties of custom domain for Spring Cloud Gateway

func (GatewayCustomDomainProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayCustomDomainProperties.

func (*GatewayCustomDomainProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayCustomDomainProperties.

type GatewayCustomDomainResource 

type GatewayCustomDomainResource struct {
	// The properties of custom domain for Spring Cloud Gateway
	Properties *GatewayCustomDomainProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

GatewayCustomDomainResource - Custom domain of the Spring Cloud Gateway

func (GatewayCustomDomainResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayCustomDomainResource.

func (*GatewayCustomDomainResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayCustomDomainResource.

type GatewayCustomDomainResourceCollection 

type GatewayCustomDomainResourceCollection 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 Spring Cloud Gateway custom domain resources
	Value []*GatewayCustomDomainResource
}

GatewayCustomDomainResourceCollection - Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set

func (GatewayCustomDomainResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayCustomDomainResourceCollection.

func (*GatewayCustomDomainResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayCustomDomainResourceCollection.

type GatewayCustomDomainsClient 

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

GatewayCustomDomainsClient contains the methods for the GatewayCustomDomains group. Don't use this type directly, use NewGatewayCustomDomainsClient() instead.

func NewGatewayCustomDomainsClient 

func NewGatewayCustomDomainsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GatewayCustomDomainsClient, error)

NewGatewayCustomDomainsClient creates a new instance of GatewayCustomDomainsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*GatewayCustomDomainsClient) BeginCreateOrUpdate 

func (client *GatewayCustomDomainsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, domainName string, gatewayCustomDomainResource GatewayCustomDomainResource, options *GatewayCustomDomainsClientBeginCreateOrUpdateOptions) (*runtime.Poller[GatewayCustomDomainsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update the Spring Cloud Gateway custom domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • domainName - The name of the Spring Cloud Gateway custom domain.
  • gatewayCustomDomainResource - The gateway custom domain resource for the create or update operation
  • options - GatewayCustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewayCustomDomainsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayCustomDomains_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewayCustomDomainsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "myDomainName", armappplatform.GatewayCustomDomainResource{
	Properties: &armappplatform.GatewayCustomDomainProperties{
		Thumbprint: to.Ptr("*"),
	},
}, 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.GatewayCustomDomainResource = armappplatform.GatewayCustomDomainResource{
// 	Name: to.Ptr("myDomainName"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomainName"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.GatewayCustomDomainProperties{
// 		Thumbprint: to.Ptr("*"),
// 	},
// }

Output:

func (*GatewayCustomDomainsClient) BeginDelete 

func (client *GatewayCustomDomainsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, domainName string, options *GatewayCustomDomainsClientBeginDeleteOptions) (*runtime.Poller[GatewayCustomDomainsClientDeleteResponse], error)

BeginDelete - Delete the Spring Cloud Gateway custom domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • domainName - The name of the Spring Cloud Gateway custom domain.
  • options - GatewayCustomDomainsClientBeginDeleteOptions contains the optional parameters for the GatewayCustomDomainsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayCustomDomains_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewayCustomDomainsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", "myDomainName", 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 (*GatewayCustomDomainsClient) Get 

func (client *GatewayCustomDomainsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, domainName string, options *GatewayCustomDomainsClientGetOptions) (GatewayCustomDomainsClientGetResponse, error)

Get - Get the Spring Cloud Gateway custom domain. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • domainName - The name of the Spring Cloud Gateway custom domain.
  • options - GatewayCustomDomainsClientGetOptions contains the optional parameters for the GatewayCustomDomainsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayCustomDomains_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewGatewayCustomDomainsClient().Get(ctx, "myResourceGroup", "myservice", "default", "myDomainName", 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.GatewayCustomDomainResource = armappplatform.GatewayCustomDomainResource{
// 	Name: to.Ptr("myDomainName"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/domains"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomainName"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.GatewayCustomDomainProperties{
// 		Thumbprint: to.Ptr("*"),
// 	},
// }

Output:

func (*GatewayCustomDomainsClient) NewListPager 

func (client *GatewayCustomDomainsClient) NewListPager(resourceGroupName string, serviceName string, gatewayName string, options *GatewayCustomDomainsClientListOptions) *runtime.Pager[GatewayCustomDomainsClientListResponse]

NewListPager - Handle requests to list all Spring Cloud Gateway custom domains.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • options - GatewayCustomDomainsClientListOptions contains the optional parameters for the GatewayCustomDomainsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayCustomDomains_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewGatewayCustomDomainsClient().NewListPager("myResourceGroup", "myservice", "default", 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.GatewayCustomDomainResourceCollection = armappplatform.GatewayCustomDomainResourceCollection{
	// 	Value: []*armappplatform.GatewayCustomDomainResource{
	// 		{
	// 			Name: to.Ptr("myDomain"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/domains"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomain"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.GatewayCustomDomainProperties{
	// 				Thumbprint: to.Ptr("*"),
	// 			},
	// 	}},
	// }
}

Output:

type GatewayCustomDomainsClientBeginCreateOrUpdateOptions 

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

GatewayCustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewayCustomDomainsClient.BeginCreateOrUpdate method.

type GatewayCustomDomainsClientBeginDeleteOptions 

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

GatewayCustomDomainsClientBeginDeleteOptions contains the optional parameters for the GatewayCustomDomainsClient.BeginDelete method.

type GatewayCustomDomainsClientCreateOrUpdateResponse 

type GatewayCustomDomainsClientCreateOrUpdateResponse struct {
	// Custom domain of the Spring Cloud Gateway
	GatewayCustomDomainResource
}

GatewayCustomDomainsClientCreateOrUpdateResponse contains the response from method GatewayCustomDomainsClient.BeginCreateOrUpdate.

type GatewayCustomDomainsClientDeleteResponse 

type GatewayCustomDomainsClientDeleteResponse struct {
}

GatewayCustomDomainsClientDeleteResponse contains the response from method GatewayCustomDomainsClient.BeginDelete.

type GatewayCustomDomainsClientGetOptions 

type GatewayCustomDomainsClientGetOptions struct {
}

GatewayCustomDomainsClientGetOptions contains the optional parameters for the GatewayCustomDomainsClient.Get method.

type GatewayCustomDomainsClientGetResponse 

type GatewayCustomDomainsClientGetResponse struct {
	// Custom domain of the Spring Cloud Gateway
	GatewayCustomDomainResource
}

GatewayCustomDomainsClientGetResponse contains the response from method GatewayCustomDomainsClient.Get.

type GatewayCustomDomainsClientListOptions 

type GatewayCustomDomainsClientListOptions struct {
}

GatewayCustomDomainsClientListOptions contains the optional parameters for the GatewayCustomDomainsClient.NewListPager method.

type GatewayCustomDomainsClientListResponse 

type GatewayCustomDomainsClientListResponse struct {
	// Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set
	GatewayCustomDomainResourceCollection
}

GatewayCustomDomainsClientListResponse contains the response from method GatewayCustomDomainsClient.NewListPager.

type GatewayInstance 

type GatewayInstance struct {
	// READ-ONLY; Name of the Spring Cloud Gateway instance
	Name *string

	// READ-ONLY; Status of the Spring Cloud Gateway instance
	Status *string
}

GatewayInstance - Collection of instances belong to the Spring Cloud Gateway

func (GatewayInstance) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayInstance.

func (*GatewayInstance) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayInstance.

type GatewayOperatorProperties 

type GatewayOperatorProperties struct {
	// READ-ONLY; Collection of instances belong to Spring Cloud Gateway operator.
	Instances []*GatewayInstance

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *GatewayOperatorResourceRequests
}

GatewayOperatorProperties - Properties of the Spring Cloud Gateway Operator.

func (GatewayOperatorProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayOperatorProperties.

func (*GatewayOperatorProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayOperatorProperties.

type GatewayOperatorResourceRequests 

type GatewayOperatorResourceRequests struct {
	// READ-ONLY; Cpu allocated to each Spring Cloud Gateway Operator instance.
	CPU *string

	// READ-ONLY; Instance count of the Spring Cloud Gateway Operator.
	InstanceCount *int32

	// READ-ONLY; Memory allocated to each Spring Cloud Gateway Operator instance.
	Memory *string
}

GatewayOperatorResourceRequests - Properties of the Spring Cloud Gateway Operator.

func (GatewayOperatorResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayOperatorResourceRequests.

func (*GatewayOperatorResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayOperatorResourceRequests.

type GatewayProperties 

type GatewayProperties struct {
	// API metadata property for Spring Cloud Gateway
	APIMetadataProperties *GatewayAPIMetadataProperties

	// Collection of ApmReferences in service level
	Apms []*ApmReference

	// Client-Certification Authentication.
	ClientAuth *GatewayPropertiesClientAuth

	// Cross-Origin Resource Sharing property
	CorsProperties *GatewayCorsProperties

	// Environment variables of Spring Cloud Gateway
	EnvironmentVariables *GatewayPropertiesEnvironmentVariables

	// Indicate if only https is allowed.
	HTTPSOnly *bool

	// Indicates whether the Spring Cloud Gateway exposes endpoint.
	Public *bool

	// The requested resource quantity for required CPU and Memory.
	ResourceRequests *GatewayResourceRequests

	// Single sign-on related configuration
	SsoProperties *SsoProperties

	// READ-ONLY; Collection of instances belong to Spring Cloud Gateway.
	Instances []*GatewayInstance

	// READ-ONLY; Properties of the Spring Cloud Gateway Operator.
	OperatorProperties *GatewayOperatorProperties

	// READ-ONLY; State of the Spring Cloud Gateway.
	ProvisioningState *GatewayProvisioningState

	// READ-ONLY; URL of the Spring Cloud Gateway, exposed when 'public' is true.
	URL *string
}

GatewayProperties - Spring Cloud Gateway properties payload

func (GatewayProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayProperties.

func (*GatewayProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayProperties.

type GatewayPropertiesClientAuth 

type GatewayPropertiesClientAuth struct {
	// Whether to enable certificate verification or not
	CertificateVerification *GatewayCertificateVerification

	// Collection of certificate resource Ids in Azure Spring Apps.
	Certificates []*string
}

GatewayPropertiesClientAuth - Client-Certification Authentication.

func (GatewayPropertiesClientAuth) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayPropertiesClientAuth.

func (*GatewayPropertiesClientAuth) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayPropertiesClientAuth.

type GatewayPropertiesEnvironmentVariables 

type GatewayPropertiesEnvironmentVariables struct {
	// Non-sensitive properties
	Properties map[string]*string

	// Sensitive properties
	Secrets map[string]*string
}

GatewayPropertiesEnvironmentVariables - Environment variables of Spring Cloud Gateway

func (GatewayPropertiesEnvironmentVariables) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayPropertiesEnvironmentVariables.

func (*GatewayPropertiesEnvironmentVariables) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayPropertiesEnvironmentVariables.

type GatewayProvisioningState 

type GatewayProvisioningState string

GatewayProvisioningState - State of the Spring Cloud Gateway. 

const (
	GatewayProvisioningStateCreating  GatewayProvisioningState = "Creating"
	GatewayProvisioningStateDeleting  GatewayProvisioningState = "Deleting"
	GatewayProvisioningStateFailed    GatewayProvisioningState = "Failed"
	GatewayProvisioningStateSucceeded GatewayProvisioningState = "Succeeded"
	GatewayProvisioningStateUpdating  GatewayProvisioningState = "Updating"
)

func PossibleGatewayProvisioningStateValues 

func PossibleGatewayProvisioningStateValues() []GatewayProvisioningState

PossibleGatewayProvisioningStateValues returns the possible values for the GatewayProvisioningState const type.

type GatewayResource 

type GatewayResource struct {
	// Spring Cloud Gateway properties payload
	Properties *GatewayProperties

	// Sku of the Spring Cloud Gateway resource
	SKU *SKU

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

GatewayResource - Spring Cloud Gateway resource

func (GatewayResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayResource.

func (*GatewayResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayResource.

type GatewayResourceCollection 

type GatewayResourceCollection 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 gateway resources
	Value []*GatewayResource
}

GatewayResourceCollection - Object that includes an array of gateway resources and a possible link for next set

func (GatewayResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayResourceCollection.

func (*GatewayResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayResourceCollection.

type GatewayResourceRequests 

type GatewayResourceRequests struct {
	// Cpu allocated to each Spring Cloud Gateway instance.
	CPU *string

	// Memory allocated to each Spring Cloud Gateway instance.
	Memory *string
}

GatewayResourceRequests - Resource request payload of Spring Cloud Gateway.

func (GatewayResourceRequests) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayResourceRequests.

func (*GatewayResourceRequests) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayResourceRequests.

type GatewayRouteConfigOpenAPIProperties 

type GatewayRouteConfigOpenAPIProperties struct {
	// The URI of OpenAPI specification.
	URI *string
}

GatewayRouteConfigOpenAPIProperties - OpenAPI properties of Spring Cloud Gateway route config.

func (GatewayRouteConfigOpenAPIProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayRouteConfigOpenAPIProperties.

func (*GatewayRouteConfigOpenAPIProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayRouteConfigOpenAPIProperties.

type GatewayRouteConfigProperties 

type GatewayRouteConfigProperties struct {
	// The resource Id of the Azure Spring Apps app, required unless route defines uri.
	AppResourceID *string

	// To modify the request before sending it to the target endpoint, or the received response in app level.
	Filters []*string

	// OpenAPI properties of Spring Cloud Gateway route config.
	OpenAPI *GatewayRouteConfigOpenAPIProperties

	// A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request
	// headers and parameter values. All of the predicates associated with a route
	// must evaluate to true for the route to be matched to the request.
	Predicates []*string

	// Protocol of routed Azure Spring Apps applications.
	Protocol *GatewayRouteConfigProtocol

	// Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
	Routes []*GatewayAPIRoute

	// Enable Single Sign-On in app level.
	SsoEnabled *bool

	// READ-ONLY; State of the Spring Cloud Gateway route config.
	ProvisioningState *GatewayProvisioningState
}

GatewayRouteConfigProperties - API route config of the Spring Cloud Gateway

func (GatewayRouteConfigProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayRouteConfigProperties.

func (*GatewayRouteConfigProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayRouteConfigProperties.

type GatewayRouteConfigProtocol 

type GatewayRouteConfigProtocol string

GatewayRouteConfigProtocol - Protocol of routed Azure Spring Apps applications. 

const (
	GatewayRouteConfigProtocolHTTP  GatewayRouteConfigProtocol = "HTTP"
	GatewayRouteConfigProtocolHTTPS GatewayRouteConfigProtocol = "HTTPS"
)

func PossibleGatewayRouteConfigProtocolValues 

func PossibleGatewayRouteConfigProtocolValues() []GatewayRouteConfigProtocol

PossibleGatewayRouteConfigProtocolValues returns the possible values for the GatewayRouteConfigProtocol const type.

type GatewayRouteConfigResource 

type GatewayRouteConfigResource struct {
	// API route config of the Spring Cloud Gateway
	Properties *GatewayRouteConfigProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

GatewayRouteConfigResource - Spring Cloud Gateway route config resource

func (GatewayRouteConfigResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayRouteConfigResource.

func (*GatewayRouteConfigResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayRouteConfigResource.

type GatewayRouteConfigResourceCollection 

type GatewayRouteConfigResourceCollection 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 Spring Cloud Gateway route config resources
	Value []*GatewayRouteConfigResource
}

GatewayRouteConfigResourceCollection - Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set

func (GatewayRouteConfigResourceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GatewayRouteConfigResourceCollection.

func (*GatewayRouteConfigResourceCollection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayRouteConfigResourceCollection.

type GatewayRouteConfigsClient 

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

GatewayRouteConfigsClient contains the methods for the GatewayRouteConfigs group. Don't use this type directly, use NewGatewayRouteConfigsClient() instead.

func NewGatewayRouteConfigsClient 

func NewGatewayRouteConfigsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GatewayRouteConfigsClient, error)

NewGatewayRouteConfigsClient creates a new instance of GatewayRouteConfigsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*GatewayRouteConfigsClient) BeginCreateOrUpdate 

func (client *GatewayRouteConfigsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, routeConfigName string, gatewayRouteConfigResource GatewayRouteConfigResource, options *GatewayRouteConfigsClientBeginCreateOrUpdateOptions) (*runtime.Poller[GatewayRouteConfigsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • routeConfigName - The name of the Spring Cloud Gateway route config.
  • gatewayRouteConfigResource - The Spring Cloud Gateway route config for the create or update operation
  • options - GatewayRouteConfigsClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewayRouteConfigsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewayRouteConfigsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "myRouteConfig", armappplatform.GatewayRouteConfigResource{
	Properties: &armappplatform.GatewayRouteConfigProperties{
		AppResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
		OpenAPI: &armappplatform.GatewayRouteConfigOpenAPIProperties{
			URI: to.Ptr("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
		},
		Routes: []*armappplatform.GatewayAPIRoute{
			{
				Filters: []*string{
					to.Ptr("StripPrefix=2"),
					to.Ptr("RateLimit=1,1s")},
				Predicates: []*string{
					to.Ptr("Path=/api5/customer/**")},
				SsoEnabled: to.Ptr(true),
				Title:      to.Ptr("myApp route config"),
			}},
		Protocol: to.Ptr(armappplatform.GatewayRouteConfigProtocolHTTPS),
	},
}, 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.GatewayRouteConfigResource = armappplatform.GatewayRouteConfigResource{
// 	Name: to.Ptr("myRouteConfig"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/routeConfigs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.GatewayRouteConfigProperties{
// 		AppResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
// 		OpenAPI: &armappplatform.GatewayRouteConfigOpenAPIProperties{
// 			URI: to.Ptr("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
// 		Routes: []*armappplatform.GatewayAPIRoute{
// 			{
// 				Filters: []*string{
// 					to.Ptr("StripPrefix=2"),
// 					to.Ptr("RateLimit=1,1s")},
// 					Predicates: []*string{
// 						to.Ptr("Path=/api5/customer/**")},
// 						SsoEnabled: to.Ptr(true),
// 						Title: to.Ptr("myApp route config"),
// 				}},
// 				Protocol: to.Ptr(armappplatform.GatewayRouteConfigProtocolHTTPS),
// 			},
// 		}

Output:

func (*GatewayRouteConfigsClient) BeginDelete 

func (client *GatewayRouteConfigsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, routeConfigName string, options *GatewayRouteConfigsClientBeginDeleteOptions) (*runtime.Poller[GatewayRouteConfigsClientDeleteResponse], error)

BeginDelete - Delete the Spring Cloud Gateway route config. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • routeConfigName - The name of the Spring Cloud Gateway route config.
  • options - GatewayRouteConfigsClientBeginDeleteOptions contains the optional parameters for the GatewayRouteConfigsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewayRouteConfigsClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", "myRouteConfig", 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 (*GatewayRouteConfigsClient) Get 

func (client *GatewayRouteConfigsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, routeConfigName string, options *GatewayRouteConfigsClientGetOptions) (GatewayRouteConfigsClientGetResponse, error)

Get - Get the Spring Cloud Gateway route configs. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • routeConfigName - The name of the Spring Cloud Gateway route config.
  • options - GatewayRouteConfigsClientGetOptions contains the optional parameters for the GatewayRouteConfigsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewGatewayRouteConfigsClient().Get(ctx, "myResourceGroup", "myservice", "default", "myRouteConfig", 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.GatewayRouteConfigResource = armappplatform.GatewayRouteConfigResource{
// 	Name: to.Ptr("myRouteConfig"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/routeConfigs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.GatewayRouteConfigProperties{
// 		AppResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
// 		OpenAPI: &armappplatform.GatewayRouteConfigOpenAPIProperties{
// 			URI: to.Ptr("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
// 		Routes: []*armappplatform.GatewayAPIRoute{
// 			{
// 				Filters: []*string{
// 					to.Ptr("StripPrefix=2"),
// 					to.Ptr("RateLimit=1,1s")},
// 					Predicates: []*string{
// 						to.Ptr("Path=/api5/customer/**")},
// 						SsoEnabled: to.Ptr(true),
// 						Title: to.Ptr("myApp route config"),
// 				}},
// 				Protocol: to.Ptr(armappplatform.GatewayRouteConfigProtocolHTTPS),
// 			},
// 		}

Output:

func (*GatewayRouteConfigsClient) NewListPager 

func (client *GatewayRouteConfigsClient) NewListPager(resourceGroupName string, serviceName string, gatewayName string, options *GatewayRouteConfigsClientListOptions) *runtime.Pager[GatewayRouteConfigsClientListResponse]

NewListPager - Handle requests to list all Spring Cloud Gateway route configs.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • options - GatewayRouteConfigsClientListOptions contains the optional parameters for the GatewayRouteConfigsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewGatewayRouteConfigsClient().NewListPager("myResourceGroup", "myservice", "default", 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.GatewayRouteConfigResourceCollection = armappplatform.GatewayRouteConfigResourceCollection{
	// 	Value: []*armappplatform.GatewayRouteConfigResource{
	// 		{
	// 			Name: to.Ptr("myRouteConfig"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/routeConfigs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.GatewayRouteConfigProperties{
	// 				AppResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
	// 				OpenAPI: &armappplatform.GatewayRouteConfigOpenAPIProperties{
	// 					URI: to.Ptr("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
	// 				Routes: []*armappplatform.GatewayAPIRoute{
	// 					{
	// 						Filters: []*string{
	// 							to.Ptr("StripPrefix=2"),
	// 							to.Ptr("RateLimit=1,1s")},
	// 							Predicates: []*string{
	// 								to.Ptr("Path=/api5/customer/**")},
	// 								SsoEnabled: to.Ptr(true),
	// 								Title: to.Ptr("myApp route config"),
	// 						}},
	// 						Protocol: to.Ptr(armappplatform.GatewayRouteConfigProtocolHTTPS),
	// 					},
	// 			}},
	// 		}
}

Output:

type GatewayRouteConfigsClientBeginCreateOrUpdateOptions 

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

GatewayRouteConfigsClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewayRouteConfigsClient.BeginCreateOrUpdate method.

type GatewayRouteConfigsClientBeginDeleteOptions 

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

GatewayRouteConfigsClientBeginDeleteOptions contains the optional parameters for the GatewayRouteConfigsClient.BeginDelete method.

type GatewayRouteConfigsClientCreateOrUpdateResponse 

type GatewayRouteConfigsClientCreateOrUpdateResponse struct {
	// Spring Cloud Gateway route config resource
	GatewayRouteConfigResource
}

GatewayRouteConfigsClientCreateOrUpdateResponse contains the response from method GatewayRouteConfigsClient.BeginCreateOrUpdate.

type GatewayRouteConfigsClientDeleteResponse 

type GatewayRouteConfigsClientDeleteResponse struct {
}

GatewayRouteConfigsClientDeleteResponse contains the response from method GatewayRouteConfigsClient.BeginDelete.

type GatewayRouteConfigsClientGetOptions 

type GatewayRouteConfigsClientGetOptions struct {
}

GatewayRouteConfigsClientGetOptions contains the optional parameters for the GatewayRouteConfigsClient.Get method.

type GatewayRouteConfigsClientGetResponse 

type GatewayRouteConfigsClientGetResponse struct {
	// Spring Cloud Gateway route config resource
	GatewayRouteConfigResource
}

GatewayRouteConfigsClientGetResponse contains the response from method GatewayRouteConfigsClient.Get.

type GatewayRouteConfigsClientListOptions 

type GatewayRouteConfigsClientListOptions struct {
}

GatewayRouteConfigsClientListOptions contains the optional parameters for the GatewayRouteConfigsClient.NewListPager method.

type GatewayRouteConfigsClientListResponse 

type GatewayRouteConfigsClientListResponse struct {
	// Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set
	GatewayRouteConfigResourceCollection
}

GatewayRouteConfigsClientListResponse contains the response from method GatewayRouteConfigsClient.NewListPager.

type GatewaysClient 

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

GatewaysClient contains the methods for the Gateways group. Don't use this type directly, use NewGatewaysClient() instead.

func NewGatewaysClient 

func NewGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GatewaysClient, error)

NewGatewaysClient creates a new instance of GatewaysClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*GatewaysClient) BeginCreateOrUpdate 

func (client *GatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, gatewayResource GatewayResource, options *GatewaysClientBeginCreateOrUpdateOptions) (*runtime.Poller[GatewaysClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • gatewayResource - The gateway for the create or update operation
  • options - GatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewaysClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewaysClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", armappplatform.GatewayResource{
	Properties: &armappplatform.GatewayProperties{
		Apms: []*armappplatform.ApmReference{
			{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
			}},
		Public: to.Ptr(true),
		ResourceRequests: &armappplatform.GatewayResourceRequests{
			CPU:    to.Ptr("1"),
			Memory: to.Ptr("1G"),
		},
	},
	SKU: &armappplatform.SKU{
		Name:     to.Ptr("E0"),
		Capacity: to.Ptr[int32](2),
		Tier:     to.Ptr("Enterprise"),
	},
}, 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.GatewayResource = armappplatform.GatewayResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.GatewayProperties{
// 		Apms: []*armappplatform.ApmReference{
// 			{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
// 		}},
// 		Instances: []*armappplatform.GatewayInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				Status: to.Ptr("Running"),
// 			},
// 			{
// 				Name: to.Ptr("instance2"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		OperatorProperties: &armappplatform.GatewayOperatorProperties{
// 			Instances: []*armappplatform.GatewayInstance{
// 				{
// 					Name: to.Ptr("instance1"),
// 					Status: to.Ptr("Running"),
// 				},
// 				{
// 					Name: to.Ptr("instance2"),
// 					Status: to.Ptr("Running"),
// 			}},
// 			ResourceRequests: &armappplatform.GatewayOperatorResourceRequests{
// 				CPU: to.Ptr("1"),
// 				InstanceCount: to.Ptr[int32](2),
// 				Memory: to.Ptr("1G"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		ResourceRequests: &armappplatform.GatewayResourceRequests{
// 			CPU: to.Ptr("1"),
// 			Memory: to.Ptr("1G"),
// 		},
// 		URL: to.Ptr("test-url"),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("E0"),
// 		Capacity: to.Ptr[int32](2),
// 		Tier: to.Ptr("Enterprise"),
// 	},
// }

Output:

func (*GatewaysClient) BeginDelete 

func (client *GatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, options *GatewaysClientBeginDeleteOptions) (*runtime.Poller[GatewaysClientDeleteResponse], error)

BeginDelete - Disable the default Spring Cloud Gateway. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • options - GatewaysClientBeginDeleteOptions contains the optional parameters for the GatewaysClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewaysClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*GatewaysClient) BeginRestart 

func (client *GatewaysClient) BeginRestart(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, options *GatewaysClientBeginRestartOptions) (*runtime.Poller[GatewaysClientRestartResponse], error)

BeginRestart - Restart the Spring Cloud Gateway. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • options - GatewaysClientBeginRestartOptions contains the optional parameters for the GatewaysClient.BeginRestart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_Restart.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewGatewaysClient().BeginRestart(ctx, "myResourceGroup", "myservice", "default", 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 (*GatewaysClient) Get 

func (client *GatewaysClient) Get(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, options *GatewaysClientGetOptions) (GatewaysClientGetResponse, error)

Get - Get the Spring Cloud Gateway and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • options - GatewaysClientGetOptions contains the optional parameters for the GatewaysClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewGatewaysClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.GatewayResource = armappplatform.GatewayResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.GatewayProperties{
// 		Instances: []*armappplatform.GatewayInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				Status: to.Ptr("Running"),
// 			},
// 			{
// 				Name: to.Ptr("instance2"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		OperatorProperties: &armappplatform.GatewayOperatorProperties{
// 			Instances: []*armappplatform.GatewayInstance{
// 				{
// 					Name: to.Ptr("instance1"),
// 					Status: to.Ptr("Running"),
// 				},
// 				{
// 					Name: to.Ptr("instance2"),
// 					Status: to.Ptr("Running"),
// 			}},
// 			ResourceRequests: &armappplatform.GatewayOperatorResourceRequests{
// 				CPU: to.Ptr("1"),
// 				InstanceCount: to.Ptr[int32](2),
// 				Memory: to.Ptr("1G"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
// 		Public: to.Ptr(true),
// 		ResourceRequests: &armappplatform.GatewayResourceRequests{
// 			CPU: to.Ptr("1"),
// 			Memory: to.Ptr("1G"),
// 		},
// 		URL: to.Ptr("test-url"),
// 	},
// 	SKU: &armappplatform.SKU{
// 		Name: to.Ptr("E0"),
// 		Capacity: to.Ptr[int32](2),
// 		Tier: to.Ptr("Enterprise"),
// 	},
// }

Output:

func (*GatewaysClient) ListEnvSecrets 

func (client *GatewaysClient) ListEnvSecrets(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, options *GatewaysClientListEnvSecretsOptions) (GatewaysClientListEnvSecretsResponse, error)

ListEnvSecrets - List sensitive environment variables of Spring Cloud Gateway. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • options - GatewaysClientListEnvSecretsOptions contains the optional parameters for the GatewaysClient.ListEnvSecrets method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_ListEnvSecrets.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewGatewaysClient().ListEnvSecrets(ctx, "myResourceGroup", "myservice", "default", 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 = map[string]*string{
// 	"key": to.Ptr("value"),
// }

Output:

func (*GatewaysClient) NewListPager 

func (client *GatewaysClient) NewListPager(resourceGroupName string, serviceName string, options *GatewaysClientListOptions) *runtime.Pager[GatewaysClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - GatewaysClientListOptions contains the optional parameters for the GatewaysClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewGatewaysClient().NewListPager("myResourceGroup", "myservice", 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.GatewayResourceCollection = armappplatform.GatewayResourceCollection{
	// 	Value: []*armappplatform.GatewayResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.GatewayProperties{
	// 				Instances: []*armappplatform.GatewayInstance{
	// 					{
	// 						Name: to.Ptr("instance1"),
	// 						Status: to.Ptr("Running"),
	// 					},
	// 					{
	// 						Name: to.Ptr("instance2"),
	// 						Status: to.Ptr("Running"),
	// 				}},
	// 				OperatorProperties: &armappplatform.GatewayOperatorProperties{
	// 					Instances: []*armappplatform.GatewayInstance{
	// 						{
	// 							Name: to.Ptr("instance1"),
	// 							Status: to.Ptr("Running"),
	// 						},
	// 						{
	// 							Name: to.Ptr("instance2"),
	// 							Status: to.Ptr("Running"),
	// 					}},
	// 					ResourceRequests: &armappplatform.GatewayOperatorResourceRequests{
	// 						CPU: to.Ptr("1"),
	// 						InstanceCount: to.Ptr[int32](2),
	// 						Memory: to.Ptr("1G"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
	// 				Public: to.Ptr(true),
	// 				ResourceRequests: &armappplatform.GatewayResourceRequests{
	// 					CPU: to.Ptr("1"),
	// 					Memory: to.Ptr("1G"),
	// 				},
	// 				URL: to.Ptr("test-url"),
	// 			},
	// 			SKU: &armappplatform.SKU{
	// 				Name: to.Ptr("E0"),
	// 				Capacity: to.Ptr[int32](2),
	// 				Tier: to.Ptr("Enterprise"),
	// 			},
	// 	}},
	// }
}

Output:

func (*GatewaysClient) ValidateDomain 

func (client *GatewaysClient) ValidateDomain(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, validatePayload CustomDomainValidatePayload, options *GatewaysClientValidateDomainOptions) (GatewaysClientValidateDomainResponse, error)

ValidateDomain - Check the domains are valid as well as not in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • gatewayName - The name of Spring Cloud Gateway.
  • validatePayload - Custom domain payload to be validated
  • options - GatewaysClientValidateDomainOptions contains the optional parameters for the GatewaysClient.ValidateDomain method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Gateways_ValidateDomain.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewGatewaysClient().ValidateDomain(ctx, "myResourceGroup", "myservice", "default", armappplatform.CustomDomainValidatePayload{
	Name: to.Ptr("mydomain.io"),
}, 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.CustomDomainValidateResult = armappplatform.CustomDomainValidateResult{
// 	IsValid: to.Ptr(false),
// 	Message: to.Ptr("Certificate is invalid, please check if it is a self signed cert or if it contains a suitable dns name"),
// }

Output:

type GatewaysClientBeginCreateOrUpdateOptions 

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

GatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewaysClient.BeginCreateOrUpdate method.

type GatewaysClientBeginDeleteOptions 

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

GatewaysClientBeginDeleteOptions contains the optional parameters for the GatewaysClient.BeginDelete method.

type GatewaysClientBeginRestartOptions 

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

GatewaysClientBeginRestartOptions contains the optional parameters for the GatewaysClient.BeginRestart method.

type GatewaysClientCreateOrUpdateResponse 

type GatewaysClientCreateOrUpdateResponse struct {
	// Spring Cloud Gateway resource
	GatewayResource
}

GatewaysClientCreateOrUpdateResponse contains the response from method GatewaysClient.BeginCreateOrUpdate.

type GatewaysClientDeleteResponse 

type GatewaysClientDeleteResponse struct {
}

GatewaysClientDeleteResponse contains the response from method GatewaysClient.BeginDelete.

type GatewaysClientGetOptions 

type GatewaysClientGetOptions struct {
}

GatewaysClientGetOptions contains the optional parameters for the GatewaysClient.Get method.

type GatewaysClientGetResponse 

type GatewaysClientGetResponse struct {
	// Spring Cloud Gateway resource
	GatewayResource
}

GatewaysClientGetResponse contains the response from method GatewaysClient.Get.

type GatewaysClientListEnvSecretsOptions 

type GatewaysClientListEnvSecretsOptions struct {
}

GatewaysClientListEnvSecretsOptions contains the optional parameters for the GatewaysClient.ListEnvSecrets method.

type GatewaysClientListEnvSecretsResponse 

type GatewaysClientListEnvSecretsResponse struct {
	// Sensitive properties for Spring Cloud Gateway
	Value map[string]*string
}

GatewaysClientListEnvSecretsResponse contains the response from method GatewaysClient.ListEnvSecrets.

type GatewaysClientListOptions 

type GatewaysClientListOptions struct {
}

GatewaysClientListOptions contains the optional parameters for the GatewaysClient.NewListPager method.

type GatewaysClientListResponse 

type GatewaysClientListResponse struct {
	// Object that includes an array of gateway resources and a possible link for next set
	GatewayResourceCollection
}

GatewaysClientListResponse contains the response from method GatewaysClient.NewListPager.

type GatewaysClientRestartResponse 

type GatewaysClientRestartResponse struct {
}

GatewaysClientRestartResponse contains the response from method GatewaysClient.BeginRestart.

type GatewaysClientValidateDomainOptions 

type GatewaysClientValidateDomainOptions struct {
}

GatewaysClientValidateDomainOptions contains the optional parameters for the GatewaysClient.ValidateDomain method.

type GatewaysClientValidateDomainResponse 

type GatewaysClientValidateDomainResponse struct {
	// Validation result for custom domain.
	CustomDomainValidateResult
}

GatewaysClientValidateDomainResponse contains the response from method GatewaysClient.ValidateDomain.

type GitImplementation 

type GitImplementation string

GitImplementation - Git libraries used to support various repository providers 

const (
	GitImplementationGoGit   GitImplementation = "go-git"
	GitImplementationLibgit2 GitImplementation = "libgit2"
)

func PossibleGitImplementationValues 

func PossibleGitImplementationValues() []GitImplementation

PossibleGitImplementationValues returns the possible values for the GitImplementation const type.

type GitPatternRepository 

type GitPatternRepository struct {
	// REQUIRED; Name of the repository
	Name *string

	// REQUIRED; URI of the repository
	URI *string

	// Public sshKey of git repository.
	HostKey *string

	// SshKey algorithm of git repository.
	HostKeyAlgorithm *string

	// Label of the repository
	Label *string

	// Password of git repository basic auth.
	Password *string

	// Collection of pattern of the repository
	Pattern []*string

	// Private sshKey algorithm of git repository.
	PrivateKey *string

	// Searching path of the repository
	SearchPaths []*string

	// Strict host key checking or not.
	StrictHostKeyChecking *bool

	// Username of git repository basic auth.
	Username *string
}

GitPatternRepository - Git repository property payload for config server

func (GitPatternRepository) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GitPatternRepository.

func (*GitPatternRepository) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GitPatternRepository.

type GloballyEnabledApms 

type GloballyEnabledApms struct {
	// Collection of the globally enabled APMs
	Value []*string
}

GloballyEnabledApms - Globally enabled APMs payload

func (GloballyEnabledApms) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GloballyEnabledApms.

func (*GloballyEnabledApms) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GloballyEnabledApms.

type HTTPGetAction 

type HTTPGetAction struct {
	// REQUIRED; The type of the action to take to perform the health check.
	Type *ProbeActionType

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

	// Scheme to use for connecting to the host. Defaults to HTTP.
	// Possible enum values:
	// * "HTTP" means that the scheme used will be http://
	// * "HTTPS" means that the scheme used will be https://
	Scheme *HTTPSchemeType
}

HTTPGetAction describes an action based on HTTP Get requests.

func (*HTTPGetAction) GetProbeAction 

func (h *HTTPGetAction) GetProbeAction() *ProbeAction

GetProbeAction implements the ProbeActionClassification interface for type HTTPGetAction.

func (HTTPGetAction) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPGetAction.

func (*HTTPGetAction) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPGetAction.

type HTTPSchemeType 

type HTTPSchemeType string

HTTPSchemeType - Scheme to use for connecting to the host. Defaults to HTTP. Possible enum values: * "HTTP" means that the scheme used will be http:// * "HTTPS" means that the scheme used will be https:// 

const (
	HTTPSchemeTypeHTTP  HTTPSchemeType = "HTTP"
	HTTPSchemeTypeHTTPS HTTPSchemeType = "HTTPS"
)

func PossibleHTTPSchemeTypeValues 

func PossibleHTTPSchemeTypeValues() []HTTPSchemeType

PossibleHTTPSchemeTypeValues returns the possible values for the HTTPSchemeType const type.

type ImageRegistryCredential 

type ImageRegistryCredential struct {
	// The password of the image registry credential
	Password *string

	// The username of the image registry credential
	Username *string
}

ImageRegistryCredential - Credential of the image registry

func (ImageRegistryCredential) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ImageRegistryCredential.

func (*ImageRegistryCredential) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ImageRegistryCredential.

type IngressConfig 

type IngressConfig struct {
	// Ingress read time out in seconds.
	ReadTimeoutInSeconds *int32
}

IngressConfig - Ingress configuration payload for Azure Spring Apps resource.

func (IngressConfig) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IngressConfig.

func (*IngressConfig) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IngressConfig.

type IngressSettings 

type IngressSettings struct {
	// How ingress should communicate with this app backend service.
	BackendProtocol *BackendProtocol

	// Client-Certification Authentication.
	ClientAuth *IngressSettingsClientAuth

	// Ingress read time out in seconds.
	ReadTimeoutInSeconds *int32

	// Ingress send time out in seconds.
	SendTimeoutInSeconds *int32

	// Type of the affinity, set this to Cookie to enable session affinity.
	SessionAffinity *SessionAffinity

	// Time in seconds until the cookie expires.
	SessionCookieMaxAge *int32
}

IngressSettings - App ingress settings payload.

func (IngressSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IngressSettings.

func (*IngressSettings) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IngressSettings.

type IngressSettingsClientAuth 

type IngressSettingsClientAuth struct {
	// Collection of certificate resource id.
	Certificates []*string
}

IngressSettingsClientAuth - Client-Certification Authentication.

func (IngressSettingsClientAuth) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IngressSettingsClientAuth.

func (*IngressSettingsClientAuth) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IngressSettingsClientAuth.

type JarUploadedUserSourceInfo 

type JarUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// JVM parameter
	JvmOptions *string

	// Relative path of the storage which stores the source
	RelativePath *string

	// Runtime version of the Jar file
	RuntimeVersion *string

	// Version of the source
	Version *string
}

JarUploadedUserSourceInfo - Uploaded Jar binary for a deployment

func (*JarUploadedUserSourceInfo) GetUploadedUserSourceInfo 

func (j *JarUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type JarUploadedUserSourceInfo.

func (*JarUploadedUserSourceInfo) GetUserSourceInfo 

func (j *JarUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type JarUploadedUserSourceInfo.

func (JarUploadedUserSourceInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JarUploadedUserSourceInfo.

func (*JarUploadedUserSourceInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JarUploadedUserSourceInfo.

type KPackBuildStageProvisioningState 

type KPackBuildStageProvisioningState string

KPackBuildStageProvisioningState - The provisioning state of this build stage resource. 

const (
	KPackBuildStageProvisioningStateFailed     KPackBuildStageProvisioningState = "Failed"
	KPackBuildStageProvisioningStateNotStarted KPackBuildStageProvisioningState = "NotStarted"
	KPackBuildStageProvisioningStateRunning    KPackBuildStageProvisioningState = "Running"
	KPackBuildStageProvisioningStateSucceeded  KPackBuildStageProvisioningState = "Succeeded"
)

func PossibleKPackBuildStageProvisioningStateValues 

func PossibleKPackBuildStageProvisioningStateValues() []KPackBuildStageProvisioningState

PossibleKPackBuildStageProvisioningStateValues returns the possible values for the KPackBuildStageProvisioningState const type.

type KeyVaultCertificateAutoSync 

type KeyVaultCertificateAutoSync string

KeyVaultCertificateAutoSync - Indicates whether to automatically synchronize certificate from key vault or not. 

const (
	KeyVaultCertificateAutoSyncDisabled KeyVaultCertificateAutoSync = "Disabled"
	KeyVaultCertificateAutoSyncEnabled  KeyVaultCertificateAutoSync = "Enabled"
)

func PossibleKeyVaultCertificateAutoSyncValues 

func PossibleKeyVaultCertificateAutoSyncValues() []KeyVaultCertificateAutoSync

PossibleKeyVaultCertificateAutoSyncValues returns the possible values for the KeyVaultCertificateAutoSync const type.

type KeyVaultCertificateProperties 

type KeyVaultCertificateProperties struct {
	// REQUIRED; The certificate name of key vault.
	KeyVaultCertName *string

	// REQUIRED; The type of the certificate source.
	Type *string

	// REQUIRED; The vault uri of user key vault.
	VaultURI *string

	// Indicates whether to automatically synchronize certificate from key vault or not.
	AutoSync *KeyVaultCertificateAutoSync

	// The certificate version of key vault.
	CertVersion *string

	// Optional. If set to true, it will not import private key from key vault.
	ExcludePrivateKey *bool

	// READ-ONLY; The activate date of certificate.
	ActivateDate *string

	// READ-ONLY; The domain list of certificate.
	DNSNames []*string

	// READ-ONLY; The expiration date of certificate.
	ExpirationDate *string

	// READ-ONLY; The issue date of certificate.
	IssuedDate *string

	// READ-ONLY; The issuer of certificate.
	Issuer *string

	// READ-ONLY; Provisioning state of the Certificate
	ProvisioningState *CertificateResourceProvisioningState

	// READ-ONLY; The subject name of certificate.
	SubjectName *string

	// READ-ONLY; The thumbprint of certificate.
	Thumbprint *string
}

KeyVaultCertificateProperties - Properties of certificate imported from key vault.

func (*KeyVaultCertificateProperties) GetCertificateProperties 

func (k *KeyVaultCertificateProperties) GetCertificateProperties() *CertificateProperties

GetCertificateProperties implements the CertificatePropertiesClassification interface for type KeyVaultCertificateProperties.

func (KeyVaultCertificateProperties) MarshalJSON 

func (k KeyVaultCertificateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultCertificateProperties.

func (*KeyVaultCertificateProperties) UnmarshalJSON 

func (k *KeyVaultCertificateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultCertificateProperties.

type LastModifiedByType 

type LastModifiedByType string

LastModifiedByType - The type of identity that last modified the resource. 

const (
	LastModifiedByTypeApplication     LastModifiedByType = "Application"
	LastModifiedByTypeKey             LastModifiedByType = "Key"
	LastModifiedByTypeManagedIdentity LastModifiedByType = "ManagedIdentity"
	LastModifiedByTypeUser            LastModifiedByType = "User"
)

func PossibleLastModifiedByTypeValues 

func PossibleLastModifiedByTypeValues() []LastModifiedByType

PossibleLastModifiedByTypeValues returns the possible values for the LastModifiedByType const type.

type LoadedCertificate 

type LoadedCertificate struct {
	// REQUIRED; Resource Id of loaded certificate
	ResourceID *string

	// Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.
	LoadTrustStore *bool
}

LoadedCertificate - Loaded certificate payload

func (LoadedCertificate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type LoadedCertificate.

func (*LoadedCertificate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type LoadedCertificate.

type LogFileURLResponse 

type LogFileURLResponse struct {
	// REQUIRED; URL of the log file
	URL *string
}

LogFileURLResponse - Log file URL payload

func (LogFileURLResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type LogFileURLResponse.

func (*LogFileURLResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type LogFileURLResponse.

type LogSpecification 

type LogSpecification struct {
	// Blob duration of the log
	BlobDuration *string

	// Localized friendly display name of the log
	DisplayName *string

	// Name of the log
	Name *string
}

LogSpecification - Specifications of the Log for Azure Monitoring

func (LogSpecification) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type LogSpecification.

func (*LogSpecification) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type LogSpecification.

type ManagedIdentityProperties 

type ManagedIdentityProperties struct {
	// Principal Id of system-assigned managed identity.
	PrincipalID *string

	// Tenant Id of system-assigned managed identity.
	TenantID *string

	// Type of the managed identity
	Type *ManagedIdentityType

	// Properties of user-assigned managed identities
	UserAssignedIdentities map[string]*UserAssignedManagedIdentity
}

ManagedIdentityProperties - Managed identity properties retrieved from ARM request headers.

func (ManagedIdentityProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManagedIdentityProperties.

func (*ManagedIdentityProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentityProperties.

type ManagedIdentityType 

type ManagedIdentityType string

ManagedIdentityType - Type of the managed identity 

const (
	ManagedIdentityTypeNone                       ManagedIdentityType = "None"
	ManagedIdentityTypeSystemAssigned             ManagedIdentityType = "SystemAssigned"
	ManagedIdentityTypeSystemAssignedUserAssigned ManagedIdentityType = "SystemAssigned,UserAssigned"
	ManagedIdentityTypeUserAssigned               ManagedIdentityType = "UserAssigned"
)

func PossibleManagedIdentityTypeValues 

func PossibleManagedIdentityTypeValues() []ManagedIdentityType

PossibleManagedIdentityTypeValues returns the possible values for the ManagedIdentityType const type.

type MarketplaceResource 

type MarketplaceResource struct {
	// The plan id of the 3rd Party Artifact that is being procured.
	Plan *string

	// The 3rd Party artifact that is being procured.
	Product *string

	// The publisher id of the 3rd Party Artifact that is being bought.
	Publisher *string
}

MarketplaceResource - Purchasing 3rd Party product for one Azure Spring Apps instance

func (MarketplaceResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MarketplaceResource.

func (*MarketplaceResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MarketplaceResource.

type MetricDimension 

type MetricDimension struct {
	// Localized friendly display name of the dimension
	DisplayName *string

	// Name of the dimension
	Name *string

	// Whether this dimension should be included for the Shoebox export scenario
	ToBeExportedForShoebox *bool
}

MetricDimension - Specifications of the Dimension of metrics

func (MetricDimension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MetricDimension.

func (*MetricDimension) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MetricDimension.

type MetricSpecification 

type MetricSpecification struct {
	// Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
	AggregationType *string

	// Name of the metric category that the metric belongs to. A metric can only belong to a single category.
	Category *string

	// Dimensions of the metric
	Dimensions []*MetricDimension

	// Localized friendly description of the metric
	DisplayDescription *string

	// Localized friendly display name of the metric
	DisplayName *string

	// Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
	FillGapWithZero *bool

	// Name of the metric
	Name *string

	// Name of the MDM namespace. Optional.
	SourceMdmNamespace *string

	// Supported aggregation types
	SupportedAggregationTypes []*string

	// Supported time grain types
	SupportedTimeGrainTypes []*string

	// Unit that makes sense for the metric
	Unit *string
}

MetricSpecification - Specifications of the Metrics for Azure Monitoring

func (MetricSpecification) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MetricSpecification.

func (*MetricSpecification) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MetricSpecification.

type MonitoringSettingProperties 

type MonitoringSettingProperties struct {
	// Indicates the versions of application insight agent
	AppInsightsAgentVersions *ApplicationInsightsAgentVersions

	// Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
	AppInsightsInstrumentationKey *string

	// Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
	AppInsightsSamplingRate *float64

	// Error when apply Monitoring Setting changes.
	Error *Error

	// Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please
	// leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled
	// or not
	TraceEnabled *bool

	// READ-ONLY; State of the Monitoring Setting.
	ProvisioningState *MonitoringSettingState
}

MonitoringSettingProperties - Monitoring Setting properties payload

func (MonitoringSettingProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MonitoringSettingProperties.

func (*MonitoringSettingProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MonitoringSettingProperties.

type MonitoringSettingResource 

type MonitoringSettingResource struct {
	// Properties of the Monitoring Setting resource
	Properties *MonitoringSettingProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

MonitoringSettingResource - Monitoring Setting resource

func (MonitoringSettingResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MonitoringSettingResource.

func (*MonitoringSettingResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MonitoringSettingResource.

type MonitoringSettingState 

type MonitoringSettingState string

MonitoringSettingState - State of the Monitoring Setting. 

const (
	MonitoringSettingStateFailed       MonitoringSettingState = "Failed"
	MonitoringSettingStateNotAvailable MonitoringSettingState = "NotAvailable"
	MonitoringSettingStateSucceeded    MonitoringSettingState = "Succeeded"
	MonitoringSettingStateUpdating     MonitoringSettingState = "Updating"
)

func PossibleMonitoringSettingStateValues 

func PossibleMonitoringSettingStateValues() []MonitoringSettingState

PossibleMonitoringSettingStateValues returns the possible values for the MonitoringSettingState const type.

type MonitoringSettingsClient 

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

MonitoringSettingsClient contains the methods for the MonitoringSettings group. Don't use this type directly, use NewMonitoringSettingsClient() instead.

func NewMonitoringSettingsClient 

func NewMonitoringSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*MonitoringSettingsClient, error)

NewMonitoringSettingsClient creates a new instance of MonitoringSettingsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*MonitoringSettingsClient) BeginUpdatePatch 

func (client *MonitoringSettingsClient) BeginUpdatePatch(ctx context.Context, resourceGroupName string, serviceName string, monitoringSettingResource MonitoringSettingResource, options *MonitoringSettingsClientBeginUpdatePatchOptions) (*runtime.Poller[MonitoringSettingsClientUpdatePatchResponse], error)

BeginUpdatePatch - Update the Monitoring Setting. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • monitoringSettingResource - Parameters for the update operation
  • options - MonitoringSettingsClientBeginUpdatePatchOptions contains the optional parameters for the MonitoringSettingsClient.BeginUpdatePatch method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/MonitoringSettings_UpdatePatch.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewMonitoringSettingsClient().BeginUpdatePatch(ctx, "myResourceGroup", "myservice", armappplatform.MonitoringSettingResource{
	Properties: &armappplatform.MonitoringSettingProperties{
		AppInsightsInstrumentationKey: to.Ptr("00000000-0000-0000-0000-000000000000"),
		AppInsightsSamplingRate:       to.Ptr[float64](10),
		TraceEnabled:                  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.MonitoringSettingResource = armappplatform.MonitoringSettingResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/monitoringSettings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.MonitoringSettingProperties{
// 		AppInsightsAgentVersions: &armappplatform.ApplicationInsightsAgentVersions{
// 			Java: to.Ptr("3.0.0"),
// 		},
// 		AppInsightsInstrumentationKey: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		AppInsightsSamplingRate: to.Ptr[float64](10),
// 		ProvisioningState: to.Ptr(armappplatform.MonitoringSettingStateSucceeded),
// 		TraceEnabled: to.Ptr(true),
// 	},
// }

Output:

func (*MonitoringSettingsClient) BeginUpdatePut 

func (client *MonitoringSettingsClient) BeginUpdatePut(ctx context.Context, resourceGroupName string, serviceName string, monitoringSettingResource MonitoringSettingResource, options *MonitoringSettingsClientBeginUpdatePutOptions) (*runtime.Poller[MonitoringSettingsClientUpdatePutResponse], error)

BeginUpdatePut - Update the Monitoring Setting. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • monitoringSettingResource - Parameters for the update operation
  • options - MonitoringSettingsClientBeginUpdatePutOptions contains the optional parameters for the MonitoringSettingsClient.BeginUpdatePut method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/MonitoringSettings_UpdatePut.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewMonitoringSettingsClient().BeginUpdatePut(ctx, "myResourceGroup", "myservice", armappplatform.MonitoringSettingResource{
	Properties: &armappplatform.MonitoringSettingProperties{
		AppInsightsInstrumentationKey: to.Ptr("00000000-0000-0000-0000-000000000000"),
		AppInsightsSamplingRate:       to.Ptr[float64](10),
		TraceEnabled:                  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.MonitoringSettingResource = armappplatform.MonitoringSettingResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/monitoringSettings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.MonitoringSettingProperties{
// 		AppInsightsAgentVersions: &armappplatform.ApplicationInsightsAgentVersions{
// 			Java: to.Ptr("3.0.0"),
// 		},
// 		AppInsightsInstrumentationKey: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		AppInsightsSamplingRate: to.Ptr[float64](10),
// 		ProvisioningState: to.Ptr(armappplatform.MonitoringSettingStateSucceeded),
// 		TraceEnabled: to.Ptr(true),
// 	},
// }

Output:

func (*MonitoringSettingsClient) Get 

func (client *MonitoringSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *MonitoringSettingsClientGetOptions) (MonitoringSettingsClientGetResponse, error)

Get - Get the Monitoring Setting and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - MonitoringSettingsClientGetOptions contains the optional parameters for the MonitoringSettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/MonitoringSettings_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewMonitoringSettingsClient().Get(ctx, "myResourceGroup", "myservice", 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.MonitoringSettingResource = armappplatform.MonitoringSettingResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/monitoringSettings"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/monitoringSettings/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.MonitoringSettingProperties{
// 		AppInsightsAgentVersions: &armappplatform.ApplicationInsightsAgentVersions{
// 			Java: to.Ptr("3.0.0"),
// 		},
// 		AppInsightsInstrumentationKey: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 		AppInsightsSamplingRate: to.Ptr[float64](10),
// 		ProvisioningState: to.Ptr(armappplatform.MonitoringSettingStateSucceeded),
// 		TraceEnabled: to.Ptr(true),
// 	},
// }

Output:

type MonitoringSettingsClientBeginUpdatePatchOptions 

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

MonitoringSettingsClientBeginUpdatePatchOptions contains the optional parameters for the MonitoringSettingsClient.BeginUpdatePatch method.

type MonitoringSettingsClientBeginUpdatePutOptions 

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

MonitoringSettingsClientBeginUpdatePutOptions contains the optional parameters for the MonitoringSettingsClient.BeginUpdatePut method.

type MonitoringSettingsClientGetOptions 

type MonitoringSettingsClientGetOptions struct {
}

MonitoringSettingsClientGetOptions contains the optional parameters for the MonitoringSettingsClient.Get method.

type MonitoringSettingsClientGetResponse 

type MonitoringSettingsClientGetResponse struct {
	// Monitoring Setting resource
	MonitoringSettingResource
}

MonitoringSettingsClientGetResponse contains the response from method MonitoringSettingsClient.Get.

type MonitoringSettingsClientUpdatePatchResponse 

type MonitoringSettingsClientUpdatePatchResponse struct {
	// Monitoring Setting resource
	MonitoringSettingResource
}

MonitoringSettingsClientUpdatePatchResponse contains the response from method MonitoringSettingsClient.BeginUpdatePatch.

type MonitoringSettingsClientUpdatePutResponse 

type MonitoringSettingsClientUpdatePutResponse struct {
	// Monitoring Setting resource
	MonitoringSettingResource
}

MonitoringSettingsClientUpdatePutResponse contains the response from method MonitoringSettingsClient.BeginUpdatePut.

type NameAvailability 

type NameAvailability struct {
	// Message why the name is not available
	Message *string

	// Indicates whether the name is available
	NameAvailable *bool

	// Reason why the name is not available
	Reason *string
}

NameAvailability - Name availability result payload

func (NameAvailability) MarshalJSON 

func (n NameAvailability) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NameAvailability.

func (*NameAvailability) UnmarshalJSON 

func (n *NameAvailability) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NameAvailability.

type NameAvailabilityParameters 

type NameAvailabilityParameters struct {
	// REQUIRED; Name to be checked
	Name *string

	// REQUIRED; Type of the resource to check name availability
	Type *string
}

NameAvailabilityParameters - Name availability parameters payload

func (NameAvailabilityParameters) MarshalJSON 

func (n NameAvailabilityParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NameAvailabilityParameters.

func (*NameAvailabilityParameters) UnmarshalJSON 

func (n *NameAvailabilityParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NameAvailabilityParameters.

type NetCoreZipUploadedUserSourceInfo 

type NetCoreZipUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// The path to the .NET executable relative to zip root
	NetCoreMainEntryPath *string

	// Relative path of the storage which stores the source
	RelativePath *string

	// Runtime version of the .Net file
	RuntimeVersion *string

	// Version of the source
	Version *string
}

NetCoreZipUploadedUserSourceInfo - Uploaded Jar binary for a deployment

func (*NetCoreZipUploadedUserSourceInfo) GetUploadedUserSourceInfo 

func (n *NetCoreZipUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type NetCoreZipUploadedUserSourceInfo.

func (*NetCoreZipUploadedUserSourceInfo) GetUserSourceInfo 

func (n *NetCoreZipUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type NetCoreZipUploadedUserSourceInfo.

func (NetCoreZipUploadedUserSourceInfo) MarshalJSON 

func (n NetCoreZipUploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetCoreZipUploadedUserSourceInfo.

func (*NetCoreZipUploadedUserSourceInfo) UnmarshalJSON 

func (n *NetCoreZipUploadedUserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetCoreZipUploadedUserSourceInfo.

type NetworkProfile 

type NetworkProfile struct {
	// Name of the resource group containing network resources for customer apps in Azure Spring Apps
	AppNetworkResourceGroup *string

	// Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps
	AppSubnetID *string

	// Ingress configuration payload for Azure Spring Apps resource.
	IngressConfig *IngressConfig

	// The egress traffic type of Azure Spring Apps VNet instances.
	OutboundType *string

	// Azure Spring Apps service reserved CIDR
	ServiceCidr *string

	// Name of the resource group containing network resources of Azure Spring Apps Service Runtime
	ServiceRuntimeNetworkResourceGroup *string

	// Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime
	ServiceRuntimeSubnetID *string

	// READ-ONLY; Desired outbound IP resources for Azure Spring Apps resource.
	OutboundIPs *NetworkProfileOutboundIPs

	// READ-ONLY; Required inbound or outbound traffics for Azure Spring Apps resource.
	RequiredTraffics []*RequiredTraffic
}

NetworkProfile - Service network profile payload

func (NetworkProfile) MarshalJSON 

func (n NetworkProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkProfile.

func (*NetworkProfile) UnmarshalJSON 

func (n *NetworkProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkProfile.

type NetworkProfileOutboundIPs 

type NetworkProfileOutboundIPs struct {
	// READ-ONLY; A list of public IP addresses.
	PublicIPs []*string
}

NetworkProfileOutboundIPs - Desired outbound IP resources for Azure Spring Apps resource.

func (NetworkProfileOutboundIPs) MarshalJSON 

func (n NetworkProfileOutboundIPs) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkProfileOutboundIPs.

func (*NetworkProfileOutboundIPs) UnmarshalJSON 

func (n *NetworkProfileOutboundIPs) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkProfileOutboundIPs.

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

	// Properties of the operation
	Properties *OperationProperties

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType
}

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 OperationProperties 

type OperationProperties struct {
	// Service specifications of the operation
	ServiceSpecification *ServiceSpecification
}

OperationProperties - Extra Operation properties

func (OperationProperties) MarshalJSON 

func (o OperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationProperties.

func (*OperationProperties) UnmarshalJSON 

func (o *OperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationProperties.

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 REST API operations of the Microsoft.AppPlatform provider.

Generated from API version 2023-12-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/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 := armappplatform.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 = armappplatform.AvailableOperations{
	// 	Value: []*armappplatform.OperationDetail{
	// 		{
	// 			Name: to.Ptr("Microsoft.AppPlatform/Spring/read"),
	// 			Display: &armappplatform.OperationDisplay{
	// 				Description: to.Ptr("Create or Update Managed Applications"),
	// 				Operation: to.Ptr("Create or Update Managed Applications"),
	// 				Provider: to.Ptr("Microsoft Azure Distributed Managed Service for Spring"),
	// 				Resource: to.Ptr("Managed Applications"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Origin: to.Ptr("user,system"),
	// 			Properties: &armappplatform.OperationProperties{
	// 			},
	// 	}},
	// }
}

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 PersistentDisk 

type PersistentDisk struct {
	// Mount path of the persistent disk
	MountPath *string

	// Size of the persistent disk in GB
	SizeInGB *int32

	// READ-ONLY; Size of the used persistent disk in GB
	UsedInGB *int32
}

PersistentDisk - Persistent disk payload

func (PersistentDisk) MarshalJSON 

func (p PersistentDisk) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PersistentDisk.

func (*PersistentDisk) UnmarshalJSON 

func (p *PersistentDisk) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PersistentDisk.

type PowerState 

type PowerState string

PowerState - Power state of the Service 

const (
	PowerStateRunning PowerState = "Running"
	PowerStateStopped PowerState = "Stopped"
)

func PossiblePowerStateValues 

func PossiblePowerStateValues() []PowerState

PossiblePowerStateValues returns the possible values for the PowerState const type.

type PredefinedAcceleratorProperties 

type PredefinedAcceleratorProperties struct {
	// State of the predefined accelerator.
	State *PredefinedAcceleratorState

	// READ-ONLY
	AcceleratorTags []*string

	// READ-ONLY
	Description *string

	// READ-ONLY
	DisplayName *string

	// READ-ONLY
	IconURL *string

	// READ-ONLY; Provisioning state of the predefined accelerator.
	ProvisioningState *PredefinedAcceleratorProvisioningState
}

PredefinedAcceleratorProperties - Predefined accelerator properties payload

func (PredefinedAcceleratorProperties) MarshalJSON 

func (p PredefinedAcceleratorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredefinedAcceleratorProperties.

func (*PredefinedAcceleratorProperties) UnmarshalJSON 

func (p *PredefinedAcceleratorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredefinedAcceleratorProperties.

type PredefinedAcceleratorProvisioningState 

type PredefinedAcceleratorProvisioningState string

PredefinedAcceleratorProvisioningState - Provisioning state of the predefined accelerator. 

const (
	PredefinedAcceleratorProvisioningStateCanceled  PredefinedAcceleratorProvisioningState = "Canceled"
	PredefinedAcceleratorProvisioningStateCreating  PredefinedAcceleratorProvisioningState = "Creating"
	PredefinedAcceleratorProvisioningStateFailed    PredefinedAcceleratorProvisioningState = "Failed"
	PredefinedAcceleratorProvisioningStateSucceeded PredefinedAcceleratorProvisioningState = "Succeeded"
	PredefinedAcceleratorProvisioningStateUpdating  PredefinedAcceleratorProvisioningState = "Updating"
)

func PossiblePredefinedAcceleratorProvisioningStateValues 

func PossiblePredefinedAcceleratorProvisioningStateValues() []PredefinedAcceleratorProvisioningState

PossiblePredefinedAcceleratorProvisioningStateValues returns the possible values for the PredefinedAcceleratorProvisioningState const type.

type PredefinedAcceleratorResource 

type PredefinedAcceleratorResource struct {
	// Predefined accelerator properties payload
	Properties *PredefinedAcceleratorProperties

	// Sku of the predefined accelerator resource
	SKU *SKU

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

PredefinedAcceleratorResource - Predefined accelerator resource

func (PredefinedAcceleratorResource) MarshalJSON 

func (p PredefinedAcceleratorResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredefinedAcceleratorResource.

func (*PredefinedAcceleratorResource) UnmarshalJSON 

func (p *PredefinedAcceleratorResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredefinedAcceleratorResource.

type PredefinedAcceleratorResourceCollection 

type PredefinedAcceleratorResourceCollection struct {
	NextLink *string
	Value    []*PredefinedAcceleratorResource
}

func (PredefinedAcceleratorResourceCollection) MarshalJSON 

func (p PredefinedAcceleratorResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PredefinedAcceleratorResourceCollection.

func (*PredefinedAcceleratorResourceCollection) UnmarshalJSON 

func (p *PredefinedAcceleratorResourceCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PredefinedAcceleratorResourceCollection.

type PredefinedAcceleratorState 

type PredefinedAcceleratorState string

PredefinedAcceleratorState - State of the predefined accelerator. 

const (
	// PredefinedAcceleratorStateDisabled - Disable the predefined accelerator.
	PredefinedAcceleratorStateDisabled PredefinedAcceleratorState = "Disabled"
	// PredefinedAcceleratorStateEnabled - Enable the predefined accelerator.
	PredefinedAcceleratorStateEnabled PredefinedAcceleratorState = "Enabled"
)

func PossiblePredefinedAcceleratorStateValues 

func PossiblePredefinedAcceleratorStateValues() []PredefinedAcceleratorState

PossiblePredefinedAcceleratorStateValues returns the possible values for the PredefinedAcceleratorState const type.

type PredefinedAcceleratorsClient 

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

PredefinedAcceleratorsClient contains the methods for the PredefinedAccelerators group. Don't use this type directly, use NewPredefinedAcceleratorsClient() instead.

func NewPredefinedAcceleratorsClient 

func NewPredefinedAcceleratorsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PredefinedAcceleratorsClient, error)

NewPredefinedAcceleratorsClient creates a new instance of PredefinedAcceleratorsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PredefinedAcceleratorsClient) BeginDisable 

func (client *PredefinedAcceleratorsClient) BeginDisable(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, predefinedAcceleratorName string, options *PredefinedAcceleratorsClientBeginDisableOptions) (*runtime.Poller[PredefinedAcceleratorsClientDisableResponse], error)

BeginDisable - Disable predefined accelerator. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • predefinedAcceleratorName - The name of the predefined accelerator.
  • options - PredefinedAcceleratorsClientBeginDisableOptions contains the optional parameters for the PredefinedAcceleratorsClient.BeginDisable method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/PredefinedAccelerators_Disable.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPredefinedAcceleratorsClient().BeginDisable(ctx, "myResourceGroup", "myservice", "default", "acc-name", 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 (*PredefinedAcceleratorsClient) BeginEnable 

func (client *PredefinedAcceleratorsClient) BeginEnable(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, predefinedAcceleratorName string, options *PredefinedAcceleratorsClientBeginEnableOptions) (*runtime.Poller[PredefinedAcceleratorsClientEnableResponse], error)

BeginEnable - Enable predefined accelerator. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • predefinedAcceleratorName - The name of the predefined accelerator.
  • options - PredefinedAcceleratorsClientBeginEnableOptions contains the optional parameters for the PredefinedAcceleratorsClient.BeginEnable method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/PredefinedAccelerators_Enable.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPredefinedAcceleratorsClient().BeginEnable(ctx, "myResourceGroup", "myservice", "default", "acc-name", 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 (*PredefinedAcceleratorsClient) Get 

func (client *PredefinedAcceleratorsClient) Get(ctx context.Context, resourceGroupName string, serviceName string, applicationAcceleratorName string, predefinedAcceleratorName string, options *PredefinedAcceleratorsClientGetOptions) (PredefinedAcceleratorsClientGetResponse, error)

Get - Get the predefined accelerator. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • predefinedAcceleratorName - The name of the predefined accelerator.
  • options - PredefinedAcceleratorsClientGetOptions contains the optional parameters for the PredefinedAcceleratorsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/PredefinedAccelerators_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPredefinedAcceleratorsClient().Get(ctx, "myResourceGroup", "myservice", "default", "acc-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.PredefinedAcceleratorResource = armappplatform.PredefinedAcceleratorResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators/predefinedAccelerators"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/predefinedAccelerators/acc-name"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.PredefinedAcceleratorProperties{
// 		Description: to.Ptr("acc-desc"),
// 		AcceleratorTags: []*string{
// 			to.Ptr("tag-a"),
// 			to.Ptr("tag-b")},
// 			DisplayName: to.Ptr("acc-name"),
// 			IconURL: to.Ptr("acc-icon"),
// 			ProvisioningState: to.Ptr(armappplatform.PredefinedAcceleratorProvisioningStateSucceeded),
// 			State: to.Ptr(armappplatform.PredefinedAcceleratorStateEnabled),
// 		},
// 		SKU: &armappplatform.SKU{
// 			Name: to.Ptr("E0"),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr("Enterprise"),
// 		},
// 	}

Output:

func (*PredefinedAcceleratorsClient) NewListPager 

func (client *PredefinedAcceleratorsClient) NewListPager(resourceGroupName string, serviceName string, applicationAcceleratorName string, options *PredefinedAcceleratorsClientListOptions) *runtime.Pager[PredefinedAcceleratorsClientListResponse]

NewListPager - Handle requests to list all predefined accelerators.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • applicationAcceleratorName - The name of the application accelerator.
  • options - PredefinedAcceleratorsClientListOptions contains the optional parameters for the PredefinedAcceleratorsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/PredefinedAccelerators_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPredefinedAcceleratorsClient().NewListPager("myResourceGroup", "myservice", "default", 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.PredefinedAcceleratorResourceCollection = armappplatform.PredefinedAcceleratorResourceCollection{
	// 	Value: []*armappplatform.PredefinedAcceleratorResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationAccelerators/predefinedAccelerators"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationAccelerators/default/predefinedAccelerators"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.PredefinedAcceleratorProperties{
	// 				Description: to.Ptr("acc-desc"),
	// 				AcceleratorTags: []*string{
	// 					to.Ptr("tag-a"),
	// 					to.Ptr("tag-b")},
	// 					DisplayName: to.Ptr("acc-name"),
	// 					IconURL: to.Ptr("acc-icon"),
	// 					ProvisioningState: to.Ptr(armappplatform.PredefinedAcceleratorProvisioningStateSucceeded),
	// 					State: to.Ptr(armappplatform.PredefinedAcceleratorStateEnabled),
	// 				},
	// 				SKU: &armappplatform.SKU{
	// 					Name: to.Ptr("E0"),
	// 					Capacity: to.Ptr[int32](2),
	// 					Tier: to.Ptr("Enterprise"),
	// 				},
	// 		}},
	// 	}
}

Output:

type PredefinedAcceleratorsClientBeginDisableOptions 

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

PredefinedAcceleratorsClientBeginDisableOptions contains the optional parameters for the PredefinedAcceleratorsClient.BeginDisable method.

type PredefinedAcceleratorsClientBeginEnableOptions 

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

PredefinedAcceleratorsClientBeginEnableOptions contains the optional parameters for the PredefinedAcceleratorsClient.BeginEnable method.

type PredefinedAcceleratorsClientDisableResponse 

type PredefinedAcceleratorsClientDisableResponse struct {
}

PredefinedAcceleratorsClientDisableResponse contains the response from method PredefinedAcceleratorsClient.BeginDisable.

type PredefinedAcceleratorsClientEnableResponse 

type PredefinedAcceleratorsClientEnableResponse struct {
}

PredefinedAcceleratorsClientEnableResponse contains the response from method PredefinedAcceleratorsClient.BeginEnable.

type PredefinedAcceleratorsClientGetOptions 

type PredefinedAcceleratorsClientGetOptions struct {
}

PredefinedAcceleratorsClientGetOptions contains the optional parameters for the PredefinedAcceleratorsClient.Get method.

type PredefinedAcceleratorsClientGetResponse 

type PredefinedAcceleratorsClientGetResponse struct {
	// Predefined accelerator resource
	PredefinedAcceleratorResource
}

PredefinedAcceleratorsClientGetResponse contains the response from method PredefinedAcceleratorsClient.Get.

type PredefinedAcceleratorsClientListOptions 

type PredefinedAcceleratorsClientListOptions struct {
}

PredefinedAcceleratorsClientListOptions contains the optional parameters for the PredefinedAcceleratorsClient.NewListPager method.

type PredefinedAcceleratorsClientListResponse 

type PredefinedAcceleratorsClientListResponse struct {
	PredefinedAcceleratorResourceCollection
}

PredefinedAcceleratorsClientListResponse contains the response from method PredefinedAcceleratorsClient.NewListPager.

type Probe 

type Probe struct {
	// REQUIRED; Indicate whether the probe is disabled.
	DisableProbe *bool

	// Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.
	FailureThreshold *int32

	// Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
	InitialDelaySeconds *int32

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

	// The action of the probe.
	ProbeAction ProbeActionClassification

	// Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and
	// startup. Minimum value is 1.
	SuccessThreshold *int32

	// Number of seconds after which the probe times out. Minimum value is 1.
	TimeoutSeconds *int32
}

Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.

func (Probe) MarshalJSON 

func (p Probe) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Probe.

func (*Probe) UnmarshalJSON 

func (p *Probe) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Probe.

type ProbeAction 

type ProbeAction struct {
	// REQUIRED; The type of the action to take to perform the health check.
	Type *ProbeActionType
}

ProbeAction - The action of the probe.

func (*ProbeAction) GetProbeAction 

func (p *ProbeAction) GetProbeAction() *ProbeAction

GetProbeAction implements the ProbeActionClassification interface for type ProbeAction.

func (ProbeAction) MarshalJSON 

func (p ProbeAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProbeAction.

func (*ProbeAction) UnmarshalJSON 

func (p *ProbeAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProbeAction.

type ProbeActionClassification 

type ProbeActionClassification interface {
	// GetProbeAction returns the ProbeAction content of the underlying type.
	GetProbeAction() *ProbeAction
}

ProbeActionClassification provides polymorphic access to related types. Call the interface's GetProbeAction() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ExecAction, *HTTPGetAction, *ProbeAction, *TCPSocketAction

type ProbeActionType 

type ProbeActionType string

ProbeActionType - The type of the action to take to perform the health check. 

const (
	ProbeActionTypeExecAction      ProbeActionType = "ExecAction"
	ProbeActionTypeHTTPGetAction   ProbeActionType = "HTTPGetAction"
	ProbeActionTypeTCPSocketAction ProbeActionType = "TCPSocketAction"
)

func PossibleProbeActionTypeValues 

func PossibleProbeActionTypeValues() []ProbeActionType

PossibleProbeActionTypeValues returns the possible values for the ProbeActionType const type.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the Service 

const (
	ProvisioningStateCreating   ProvisioningState = "Creating"
	ProvisioningStateDeleted    ProvisioningState = "Deleted"
	ProvisioningStateDeleting   ProvisioningState = "Deleting"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateMoveFailed ProvisioningState = "MoveFailed"
	ProvisioningStateMoved      ProvisioningState = "Moved"
	ProvisioningStateMoving     ProvisioningState = "Moving"
	ProvisioningStateStarting   ProvisioningState = "Starting"
	ProvisioningStateStopping   ProvisioningState = "Stopping"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
	ProvisioningStateUpdating   ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ProxyResource - The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

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 RegenerateTestKeyRequestPayload 

type RegenerateTestKeyRequestPayload struct {
	// REQUIRED; Type of the test key
	KeyType *TestKeyType
}

RegenerateTestKeyRequestPayload - Regenerate test key request payload

func (RegenerateTestKeyRequestPayload) MarshalJSON 

func (r RegenerateTestKeyRequestPayload) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegenerateTestKeyRequestPayload.

func (*RegenerateTestKeyRequestPayload) UnmarshalJSON 

func (r *RegenerateTestKeyRequestPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegenerateTestKeyRequestPayload.

type RemoteDebugging 

type RemoteDebugging struct {
	// Indicate if remote debugging is enabled
	Enabled *bool

	// Application debugging port
	Port *int32
}

RemoteDebugging - Remote debugging config.

func (RemoteDebugging) MarshalJSON 

func (r RemoteDebugging) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RemoteDebugging.

func (*RemoteDebugging) UnmarshalJSON 

func (r *RemoteDebugging) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteDebugging.

type RemoteDebuggingPayload 

type RemoteDebuggingPayload struct {
	// Application debugging port.
	Port *int32
}

RemoteDebuggingPayload - Remote debugging payload.

func (RemoteDebuggingPayload) MarshalJSON 

func (r RemoteDebuggingPayload) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RemoteDebuggingPayload.

func (*RemoteDebuggingPayload) UnmarshalJSON 

func (r *RemoteDebuggingPayload) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemoteDebuggingPayload.

type RequiredTraffic 

type RequiredTraffic struct {
	// READ-ONLY; The direction of required traffic
	Direction *TrafficDirection

	// READ-ONLY; The FQDN list of required traffic
	Fqdns []*string

	// READ-ONLY; The ip list of required traffic
	IPs []*string

	// READ-ONLY; The port of required traffic
	Port *int32

	// READ-ONLY; The protocol of required traffic
	Protocol *string
}

RequiredTraffic - Required inbound or outbound traffic for Azure Spring Apps resource.

func (RequiredTraffic) MarshalJSON 

func (r RequiredTraffic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequiredTraffic.

func (*RequiredTraffic) UnmarshalJSON 

func (r *RequiredTraffic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RequiredTraffic.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

Resource - The core properties of ARM 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 ResourceRequests 

type ResourceRequests struct {
	// Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4}
	// for Standard tier.
	CPU *string

	// Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi,
	// 1Gi, 2Gi, …, 8Gi} for Standard tier.
	Memory *string
}

ResourceRequests - Deployment resource request payload

func (ResourceRequests) MarshalJSON 

func (r ResourceRequests) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceRequests.

func (*ResourceRequests) UnmarshalJSON 

func (r *ResourceRequests) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceRequests.

type ResourceSKU 

type ResourceSKU struct {
	// Gets the capacity of SKU.
	Capacity *SKUCapacity

	// Gets a list of locations and availability zones in those locations where the SKU is available.
	LocationInfo []*ResourceSKULocationInfo

	// Gets the set of locations that the SKU is available.
	Locations []*string

	// Gets the name of SKU.
	Name *string

	// Gets the type of resource the SKU applies to.
	ResourceType *string

	// Gets the restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions []*ResourceSKURestrictions

	// Gets the tier of SKU.
	Tier *string
}

ResourceSKU - Describes an available Azure Spring Apps SKU.

func (ResourceSKU) MarshalJSON 

func (r ResourceSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKU.

func (*ResourceSKU) UnmarshalJSON 

func (r *ResourceSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKU.

type ResourceSKUCapabilities 

type ResourceSKUCapabilities struct {
	// Gets an invariant to describe the feature.
	Name *string

	// Gets an invariant if the feature is measured by quantity.
	Value *string
}

func (ResourceSKUCapabilities) MarshalJSON 

func (r ResourceSKUCapabilities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUCapabilities.

func (*ResourceSKUCapabilities) UnmarshalJSON 

func (r *ResourceSKUCapabilities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKUCapabilities.

type ResourceSKUCollection 

type ResourceSKUCollection 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 resource SKU
	Value []*ResourceSKU
}

ResourceSKUCollection - Object that includes an array of Azure Spring Apps SKU and a possible link for next set

func (ResourceSKUCollection) MarshalJSON 

func (r ResourceSKUCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUCollection.

func (*ResourceSKUCollection) UnmarshalJSON 

func (r *ResourceSKUCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKUCollection.

type ResourceSKULocationInfo 

type ResourceSKULocationInfo struct {
	// Gets location of the SKU
	Location *string

	// Gets details of capabilities available to a SKU in specific zones.
	ZoneDetails []*ResourceSKUZoneDetails

	// Gets list of availability zones where the SKU is supported.
	Zones []*string
}

ResourceSKULocationInfo - Locations and availability zones where the SKU is available

func (ResourceSKULocationInfo) MarshalJSON 

func (r ResourceSKULocationInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKULocationInfo.

func (*ResourceSKULocationInfo) UnmarshalJSON 

func (r *ResourceSKULocationInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKULocationInfo.

type ResourceSKURestrictionInfo 

type ResourceSKURestrictionInfo struct {
	// Gets locations where the SKU is restricted
	Locations []*string

	// Gets list of availability zones where the SKU is restricted.
	Zones []*string
}

ResourceSKURestrictionInfo - Information about the restriction where the SKU cannot be used

func (ResourceSKURestrictionInfo) MarshalJSON 

func (r ResourceSKURestrictionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKURestrictionInfo.

func (*ResourceSKURestrictionInfo) UnmarshalJSON 

func (r *ResourceSKURestrictionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKURestrictionInfo.

type ResourceSKURestrictions 

type ResourceSKURestrictions struct {
	// Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription'
	ReasonCode *ResourceSKURestrictionsReasonCode

	// Gets the information about the restriction where the SKU cannot be used.
	RestrictionInfo *ResourceSKURestrictionInfo

	// Gets the type of restrictions. Possible values include: 'Location', 'Zone'
	Type *ResourceSKURestrictionsType

	// Gets the value of restrictions. If the restriction type is set to location. This would be different locations where the
	// SKU is restricted.
	Values []*string
}

ResourceSKURestrictions - Restrictions where the SKU cannot be used

func (ResourceSKURestrictions) MarshalJSON 

func (r ResourceSKURestrictions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKURestrictions.

func (*ResourceSKURestrictions) UnmarshalJSON 

func (r *ResourceSKURestrictions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKURestrictions.

type ResourceSKURestrictionsReasonCode 

type ResourceSKURestrictionsReasonCode string

ResourceSKURestrictionsReasonCode - Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription' 

const (
	ResourceSKURestrictionsReasonCodeNotAvailableForSubscription ResourceSKURestrictionsReasonCode = "NotAvailableForSubscription"
	ResourceSKURestrictionsReasonCodeQuotaID                     ResourceSKURestrictionsReasonCode = "QuotaId"
)

func PossibleResourceSKURestrictionsReasonCodeValues 

func PossibleResourceSKURestrictionsReasonCodeValues() []ResourceSKURestrictionsReasonCode

PossibleResourceSKURestrictionsReasonCodeValues returns the possible values for the ResourceSKURestrictionsReasonCode const type.

type ResourceSKURestrictionsType 

type ResourceSKURestrictionsType string

ResourceSKURestrictionsType - Gets the type of restrictions. Possible values include: 'Location', 'Zone' 

const (
	ResourceSKURestrictionsTypeLocation ResourceSKURestrictionsType = "Location"
	ResourceSKURestrictionsTypeZone     ResourceSKURestrictionsType = "Zone"
)

func PossibleResourceSKURestrictionsTypeValues 

func PossibleResourceSKURestrictionsTypeValues() []ResourceSKURestrictionsType

PossibleResourceSKURestrictionsTypeValues returns the possible values for the ResourceSKURestrictionsType const type.

type ResourceSKUZoneDetails 

type ResourceSKUZoneDetails struct {
	// Gets a list of capabilities that are available for the SKU in the specified list of zones.
	Capabilities []*ResourceSKUCapabilities

	// Gets the set of zones that the SKU is available in with the specified capabilities.
	Name []*string
}

ResourceSKUZoneDetails - Details of capabilities available to a SKU in specific zones

func (ResourceSKUZoneDetails) MarshalJSON 

func (r ResourceSKUZoneDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUZoneDetails.

func (*ResourceSKUZoneDetails) UnmarshalJSON 

func (r *ResourceSKUZoneDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKUZoneDetails.

type ResourceUploadDefinition 

type ResourceUploadDefinition struct {
	// Source relative path
	RelativePath *string

	// Upload URL
	UploadURL *string
}

ResourceUploadDefinition - Resource upload definition payload

func (ResourceUploadDefinition) MarshalJSON 

func (r ResourceUploadDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceUploadDefinition.

func (*ResourceUploadDefinition) UnmarshalJSON 

func (r *ResourceUploadDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceUploadDefinition.

type RuntimeVersionsClient 

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

RuntimeVersionsClient contains the methods for the RuntimeVersions group. Don't use this type directly, use NewRuntimeVersionsClient() instead.

func NewRuntimeVersionsClient 

func NewRuntimeVersionsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*RuntimeVersionsClient, error)

NewRuntimeVersionsClient creates a new instance of RuntimeVersionsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RuntimeVersionsClient) ListRuntimeVersions 

func (client *RuntimeVersionsClient) ListRuntimeVersions(ctx context.Context, options *RuntimeVersionsClientListRuntimeVersionsOptions) (RuntimeVersionsClientListRuntimeVersionsResponse, error)

ListRuntimeVersions - Lists all of the available runtime versions supported by Microsoft.AppPlatform provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • options - RuntimeVersionsClientListRuntimeVersionsOptions contains the optional parameters for the RuntimeVersionsClient.ListRuntimeVersions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/RuntimeVersions_ListRuntimeVersions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewRuntimeVersionsClient().ListRuntimeVersions(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.AvailableRuntimeVersions = armappplatform.AvailableRuntimeVersions{
// 	Value: []*armappplatform.SupportedRuntimeVersion{
// 		{
// 			Platform: to.Ptr(armappplatform.SupportedRuntimePlatformJava),
// 			Value: to.Ptr(armappplatform.SupportedRuntimeValueJava8),
// 			Version: to.Ptr("8"),
// 		},
// 		{
// 			Platform: to.Ptr(armappplatform.SupportedRuntimePlatformJava),
// 			Value: to.Ptr(armappplatform.SupportedRuntimeValueJava11),
// 			Version: to.Ptr("11"),
// 		},
// 		{
// 			Platform: to.Ptr(armappplatform.SupportedRuntimePlatformJava),
// 			Value: to.Ptr(armappplatform.SupportedRuntimeValueJava17),
// 			Version: to.Ptr("17"),
// 		},
// 		{
// 			Platform: to.Ptr(armappplatform.SupportedRuntimePlatformNETCore),
// 			Value: to.Ptr(armappplatform.SupportedRuntimeValueNetCore31),
// 			Version: to.Ptr("3.1"),
// 	}},
// }

Output:

type RuntimeVersionsClientListRuntimeVersionsOptions 

type RuntimeVersionsClientListRuntimeVersionsOptions struct {
}

RuntimeVersionsClientListRuntimeVersionsOptions contains the optional parameters for the RuntimeVersionsClient.ListRuntimeVersions method.

type RuntimeVersionsClientListRuntimeVersionsResponse 

type RuntimeVersionsClientListRuntimeVersionsResponse struct {
	AvailableRuntimeVersions
}

RuntimeVersionsClientListRuntimeVersionsResponse contains the response from method RuntimeVersionsClient.ListRuntimeVersions.

type SKU 

type SKU struct {
	// Current capacity of the target resource
	Capacity *int32

	// Name of the Sku
	Name *string

	// Tier of the Sku
	Tier *string
}

SKU - Sku of Azure Spring Apps

func (SKU) MarshalJSON 

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUCapacity 

type SKUCapacity struct {
	// REQUIRED; Gets or sets the minimum.
	Minimum *int32

	// Gets or sets the default.
	Default *int32

	// Gets or sets the maximum.
	Maximum *int32

	// Gets or sets the type of the scale.
	ScaleType *SKUScaleType
}

SKUCapacity - The SKU capacity

func (SKUCapacity) MarshalJSON 

func (s SKUCapacity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUCapacity.

func (*SKUCapacity) UnmarshalJSON 

func (s *SKUCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCapacity.

type SKUObject 

type SKUObject struct {
	// Sku of the Spring Cloud Gateway resource
	SKU *SKU
}

SKUObject - Resource Sku object used for scaling out and scaling in.

func (SKUObject) MarshalJSON 

func (s SKUObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUObject.

func (*SKUObject) UnmarshalJSON 

func (s *SKUObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUObject.

type SKUScaleType 

type SKUScaleType string

SKUScaleType - Gets or sets the type of the scale. 

const (
	SKUScaleTypeAutomatic SKUScaleType = "Automatic"
	SKUScaleTypeManual    SKUScaleType = "Manual"
	SKUScaleTypeNone      SKUScaleType = "None"
)

func PossibleSKUScaleTypeValues 

func PossibleSKUScaleTypeValues() []SKUScaleType

PossibleSKUScaleTypeValues returns the possible values for the SKUScaleType const type.

type SKUsClient 

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

SKUsClient contains the methods for the SKUs group. Don't use this type directly, use NewSKUsClient() instead.

func NewSKUsClient 

func NewSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SKUsClient, error)

NewSKUsClient creates a new instance of SKUsClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SKUsClient) NewListPager 

func (client *SKUsClient) NewListPager(options *SKUsClientListOptions) *runtime.Pager[SKUsClientListResponse]

NewListPager - Lists all of the available skus of the Microsoft.AppPlatform provider.

Generated from API version 2023-12-01

  • options - SKUsClientListOptions contains the optional parameters for the SKUsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Skus_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSKUsClient().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.ResourceSKUCollection = armappplatform.ResourceSKUCollection{
	// 	Value: []*armappplatform.ResourceSKU{
	// 		{
	// 			Name: to.Ptr("B0"),
	// 			Capacity: &armappplatform.SKUCapacity{
	// 				Default: to.Ptr[int32](1),
	// 				Maximum: to.Ptr[int32](20),
	// 				Minimum: to.Ptr[int32](1),
	// 				ScaleType: to.Ptr(armappplatform.SKUScaleTypeAutomatic),
	// 			},
	// 			LocationInfo: []*armappplatform.ResourceSKULocationInfo{
	// 				{
	// 					Location: to.Ptr("eastus"),
	// 					ZoneDetails: []*armappplatform.ResourceSKUZoneDetails{
	// 					},
	// 					Zones: []*string{
	// 					},
	// 			}},
	// 			Locations: []*string{
	// 				to.Ptr("eastus")},
	// 				ResourceType: to.Ptr("Spring"),
	// 				Restrictions: []*armappplatform.ResourceSKURestrictions{
	// 				},
	// 				Tier: to.Ptr("Basic"),
	// 		}},
	// 	}
}

Output:

type SKUsClientListOptions 

type SKUsClientListOptions struct {
}

SKUsClientListOptions contains the optional parameters for the SKUsClient.NewListPager method.

type SKUsClientListResponse 

type SKUsClientListResponse struct {
	// Object that includes an array of Azure Spring Apps SKU and a possible link for next set
	ResourceSKUCollection
}

SKUsClientListResponse contains the response from method SKUsClient.NewListPager.

type ServiceRegistriesClient 

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

ServiceRegistriesClient contains the methods for the ServiceRegistries group. Don't use this type directly, use NewServiceRegistriesClient() instead.

func NewServiceRegistriesClient 

func NewServiceRegistriesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ServiceRegistriesClient, error)

NewServiceRegistriesClient creates a new instance of ServiceRegistriesClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ServiceRegistriesClient) BeginCreateOrUpdate 

func (client *ServiceRegistriesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, serviceRegistryName string, options *ServiceRegistriesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ServiceRegistriesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the default Service Registry or update the existing Service Registry. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • serviceRegistryName - The name of Service Registry.
  • options - ServiceRegistriesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceRegistriesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ServiceRegistries_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServiceRegistriesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", 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.ServiceRegistryResource = armappplatform.ServiceRegistryResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/serviceRegistries"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ServiceRegistryProperties{
// 		Instances: []*armappplatform.ServiceRegistryInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				Status: to.Ptr("Running"),
// 			},
// 			{
// 				Name: to.Ptr("instance2"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ServiceRegistryProvisioningStateSucceeded),
// 		ResourceRequests: &armappplatform.ServiceRegistryResourceRequests{
// 			CPU: to.Ptr("1"),
// 			InstanceCount: to.Ptr[int32](2),
// 			Memory: to.Ptr("1G"),
// 		},
// 	},
// }

Output:

func (*ServiceRegistriesClient) BeginDelete 

func (client *ServiceRegistriesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, serviceRegistryName string, options *ServiceRegistriesClientBeginDeleteOptions) (*runtime.Poller[ServiceRegistriesClientDeleteResponse], error)

BeginDelete - Disable the default Service Registry. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • serviceRegistryName - The name of Service Registry.
  • options - ServiceRegistriesClientBeginDeleteOptions contains the optional parameters for the ServiceRegistriesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ServiceRegistries_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServiceRegistriesClient().BeginDelete(ctx, "myResourceGroup", "myservice", "default", 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 (*ServiceRegistriesClient) Get 

func (client *ServiceRegistriesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, serviceRegistryName string, options *ServiceRegistriesClientGetOptions) (ServiceRegistriesClientGetResponse, error)

Get - Get the Service Registry and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • serviceRegistryName - The name of Service Registry.
  • options - ServiceRegistriesClientGetOptions contains the optional parameters for the ServiceRegistriesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ServiceRegistries_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServiceRegistriesClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.ServiceRegistryResource = armappplatform.ServiceRegistryResource{
// 	Name: to.Ptr("default"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/serviceRegistries"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.ServiceRegistryProperties{
// 		Instances: []*armappplatform.ServiceRegistryInstance{
// 			{
// 				Name: to.Ptr("instance1"),
// 				Status: to.Ptr("Running"),
// 			},
// 			{
// 				Name: to.Ptr("instance2"),
// 				Status: to.Ptr("Running"),
// 		}},
// 		ProvisioningState: to.Ptr(armappplatform.ServiceRegistryProvisioningStateSucceeded),
// 		ResourceRequests: &armappplatform.ServiceRegistryResourceRequests{
// 			CPU: to.Ptr("1"),
// 			InstanceCount: to.Ptr[int32](2),
// 			Memory: to.Ptr("1G"),
// 		},
// 	},
// }

Output:

func (*ServiceRegistriesClient) NewListPager 

func (client *ServiceRegistriesClient) NewListPager(resourceGroupName string, serviceName string, options *ServiceRegistriesClientListOptions) *runtime.Pager[ServiceRegistriesClientListResponse]

NewListPager - Handles requests to list all resources in a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServiceRegistriesClientListOptions contains the optional parameters for the ServiceRegistriesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ServiceRegistries_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewServiceRegistriesClient().NewListPager("myResourceGroup", "myservice", 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.ServiceRegistryResourceCollection = armappplatform.ServiceRegistryResourceCollection{
	// 	Value: []*armappplatform.ServiceRegistryResource{
	// 		{
	// 			Name: to.Ptr("default"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/serviceRegistries"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.ServiceRegistryProperties{
	// 				Instances: []*armappplatform.ServiceRegistryInstance{
	// 					{
	// 						Name: to.Ptr("instance1"),
	// 						Status: to.Ptr("Running"),
	// 					},
	// 					{
	// 						Name: to.Ptr("instance2"),
	// 						Status: to.Ptr("Running"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armappplatform.ServiceRegistryProvisioningStateSucceeded),
	// 				ResourceRequests: &armappplatform.ServiceRegistryResourceRequests{
	// 					CPU: to.Ptr("1"),
	// 					InstanceCount: to.Ptr[int32](2),
	// 					Memory: to.Ptr("1G"),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type ServiceRegistriesClientBeginCreateOrUpdateOptions 

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

ServiceRegistriesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceRegistriesClient.BeginCreateOrUpdate method.

type ServiceRegistriesClientBeginDeleteOptions 

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

ServiceRegistriesClientBeginDeleteOptions contains the optional parameters for the ServiceRegistriesClient.BeginDelete method.

type ServiceRegistriesClientCreateOrUpdateResponse 

type ServiceRegistriesClientCreateOrUpdateResponse struct {
	// Service Registry resource
	ServiceRegistryResource
}

ServiceRegistriesClientCreateOrUpdateResponse contains the response from method ServiceRegistriesClient.BeginCreateOrUpdate.

type ServiceRegistriesClientDeleteResponse 

type ServiceRegistriesClientDeleteResponse struct {
}

ServiceRegistriesClientDeleteResponse contains the response from method ServiceRegistriesClient.BeginDelete.

type ServiceRegistriesClientGetOptions 

type ServiceRegistriesClientGetOptions struct {
}

ServiceRegistriesClientGetOptions contains the optional parameters for the ServiceRegistriesClient.Get method.

type ServiceRegistriesClientGetResponse 

type ServiceRegistriesClientGetResponse struct {
	// Service Registry resource
	ServiceRegistryResource
}

ServiceRegistriesClientGetResponse contains the response from method ServiceRegistriesClient.Get.

type ServiceRegistriesClientListOptions 

type ServiceRegistriesClientListOptions struct {
}

ServiceRegistriesClientListOptions contains the optional parameters for the ServiceRegistriesClient.NewListPager method.

type ServiceRegistriesClientListResponse 

type ServiceRegistriesClientListResponse struct {
	// Object that includes an array of Service Registry resources and a possible link for next set
	ServiceRegistryResourceCollection
}

ServiceRegistriesClientListResponse contains the response from method ServiceRegistriesClient.NewListPager.

type ServiceRegistryInstance 

type ServiceRegistryInstance struct {
	// READ-ONLY; Name of the Service Registry instance
	Name *string

	// READ-ONLY; Status of the Service Registry instance
	Status *string
}

ServiceRegistryInstance - Collection of instances belong to the Service Registry

func (ServiceRegistryInstance) MarshalJSON 

func (s ServiceRegistryInstance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryInstance.

func (*ServiceRegistryInstance) UnmarshalJSON 

func (s *ServiceRegistryInstance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceRegistryInstance.

type ServiceRegistryProperties 

type ServiceRegistryProperties struct {
	// READ-ONLY; Collection of instances belong to Service Registry.
	Instances []*ServiceRegistryInstance

	// READ-ONLY; State of the Service Registry.
	ProvisioningState *ServiceRegistryProvisioningState

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *ServiceRegistryResourceRequests
}

ServiceRegistryProperties - Service Registry properties payload

func (ServiceRegistryProperties) MarshalJSON 

func (s ServiceRegistryProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryProperties.

func (*ServiceRegistryProperties) UnmarshalJSON 

func (s *ServiceRegistryProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceRegistryProperties.

type ServiceRegistryProvisioningState 

type ServiceRegistryProvisioningState string

ServiceRegistryProvisioningState - State of the Service Registry. 

const (
	ServiceRegistryProvisioningStateCreating  ServiceRegistryProvisioningState = "Creating"
	ServiceRegistryProvisioningStateDeleting  ServiceRegistryProvisioningState = "Deleting"
	ServiceRegistryProvisioningStateFailed    ServiceRegistryProvisioningState = "Failed"
	ServiceRegistryProvisioningStateSucceeded ServiceRegistryProvisioningState = "Succeeded"
	ServiceRegistryProvisioningStateUpdating  ServiceRegistryProvisioningState = "Updating"
)

func PossibleServiceRegistryProvisioningStateValues 

func PossibleServiceRegistryProvisioningStateValues() []ServiceRegistryProvisioningState

PossibleServiceRegistryProvisioningStateValues returns the possible values for the ServiceRegistryProvisioningState const type.

type ServiceRegistryResource 

type ServiceRegistryResource struct {
	// Service Registry properties payload
	Properties *ServiceRegistryProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ServiceRegistryResource - Service Registry resource

func (ServiceRegistryResource) MarshalJSON 

func (s ServiceRegistryResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryResource.

func (*ServiceRegistryResource) UnmarshalJSON 

func (s *ServiceRegistryResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceRegistryResource.

type ServiceRegistryResourceCollection 

type ServiceRegistryResourceCollection 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 Service Registry resources
	Value []*ServiceRegistryResource
}

ServiceRegistryResourceCollection - Object that includes an array of Service Registry resources and a possible link for next set

func (ServiceRegistryResourceCollection) MarshalJSON 

func (s ServiceRegistryResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryResourceCollection.

func (*ServiceRegistryResourceCollection) UnmarshalJSON 

func (s *ServiceRegistryResourceCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceRegistryResourceCollection.

type ServiceRegistryResourceRequests 

type ServiceRegistryResourceRequests struct {
	// READ-ONLY; Cpu allocated to each Service Registry instance
	CPU *string

	// READ-ONLY; Instance count of the Service Registry
	InstanceCount *int32

	// READ-ONLY; Memory allocated to each Service Registry instance
	Memory *string
}

ServiceRegistryResourceRequests - Resource request payload of Service Registry

func (ServiceRegistryResourceRequests) MarshalJSON 

func (s ServiceRegistryResourceRequests) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryResourceRequests.

func (*ServiceRegistryResourceRequests) UnmarshalJSON 

func (s *ServiceRegistryResourceRequests) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceRegistryResourceRequests.

type ServiceResource 

type ServiceResource struct {
	// The GEO location of the resource.
	Location *string

	// Properties of the Service resource
	Properties *ClusterResourceProperties

	// Sku of the Service resource
	SKU *SKU

	// Tags of the service which is a list of key value pairs that describe the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

ServiceResource - Service resource

func (ServiceResource) MarshalJSON 

func (s ServiceResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceResource.

func (*ServiceResource) UnmarshalJSON 

func (s *ServiceResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceResource.

type ServiceResourceList 

type ServiceResourceList 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 Service resources
	Value []*ServiceResource
}

ServiceResourceList - Object that includes an array of Service resources and a possible link for next set

func (ServiceResourceList) MarshalJSON 

func (s ServiceResourceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceResourceList.

func (*ServiceResourceList) UnmarshalJSON 

func (s *ServiceResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceResourceList.

type ServiceSpecification 

type ServiceSpecification struct {
	// Specifications of the Log for Azure Monitoring
	LogSpecifications []*LogSpecification

	// Specifications of the Metrics for Azure Monitoring
	MetricSpecifications []*MetricSpecification
}

ServiceSpecification - Service specification payload

func (ServiceSpecification) MarshalJSON 

func (s ServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

func (*ServiceSpecification) UnmarshalJSON 

func (s *ServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceSpecification.

type ServiceVNetAddons 

type ServiceVNetAddons struct {
	// Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could
	// be accessed from internet.
	DataPlanePublicEndpoint *bool

	// Indicates whether the log stream in vnet injection instance could be accessed from internet.
	LogStreamPublicEndpoint *bool
}

ServiceVNetAddons - Additional Service settings in vnet injection instance

func (ServiceVNetAddons) MarshalJSON 

func (s ServiceVNetAddons) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceVNetAddons.

func (*ServiceVNetAddons) UnmarshalJSON 

func (s *ServiceVNetAddons) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceVNetAddons.

type ServicesClient 

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

ServicesClient contains the methods for the Services group. Don't use this type directly, use NewServicesClient() instead.

func NewServicesClient 

func NewServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ServicesClient, error)

NewServicesClient creates a new instance of ServicesClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ServicesClient) BeginCreateOrUpdate 

func (client *ServicesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, resource ServiceResource, options *ServicesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ServicesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • resource - Parameters for the create or update operation
  • options - ServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServicesClient.BeginCreateOrUpdate method.
Example (ServicesCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", armappplatform.ServiceResource{
	Location: to.Ptr("eastus"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	SKU: &armappplatform.SKU{
		Name: to.Ptr("S0"),
		Tier: to.Ptr("Standard"),
	},
}, 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.ServiceResource = armappplatform.ServiceResource{
// 	Name: to.Ptr("myservice"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 	},
// 	Properties: &armappplatform.ClusterResourceProperties{
// 		NetworkProfile: &armappplatform.NetworkProfile{
// 			OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
// 				PublicIPs: []*string{
// 					to.Ptr("20.39.3.173"),
// 					to.Ptr("40.64.67.13")},
// 				},
// 				RequiredTraffics: []*armappplatform.RequiredTraffic{
// 					{
// 						Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 						IPs: []*string{
// 							to.Ptr("20.62.211.25"),
// 							to.Ptr("52.188.47.226")},
// 							Port: to.Ptr[int32](443),
// 							Protocol: to.Ptr("TCP"),
// 						},
// 						{
// 							Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 							IPs: []*string{
// 								to.Ptr("20.62.211.25"),
// 								to.Ptr("52.188.47.226")},
// 								Port: to.Ptr[int32](1194),
// 								Protocol: to.Ptr("UDP"),
// 							},
// 							{
// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 								IPs: []*string{
// 									to.Ptr("20.62.211.25"),
// 									to.Ptr("52.188.47.226")},
// 									Port: to.Ptr[int32](9000),
// 									Protocol: to.Ptr("TCP"),
// 							}},
// 						},
// 						ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
// 						ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
// 					},
// 					SKU: &armappplatform.SKU{
// 						Name: to.Ptr("S0"),
// 						Tier: to.Ptr("Standard"),
// 					},
// 				}

Output:
Example (ServicesCreateOrUpdateEnterprise)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_CreateOrUpdate_Enterprise.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", armappplatform.ServiceResource{
	Location: to.Ptr("eastus"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armappplatform.ClusterResourceProperties{
		MarketplaceResource: &armappplatform.MarketplaceResource{
			Plan:      to.Ptr("tanzu-asc-ent-mtr"),
			Product:   to.Ptr("azure-spring-cloud-vmware-tanzu-2"),
			Publisher: to.Ptr("vmware-inc"),
		},
	},
	SKU: &armappplatform.SKU{
		Name: to.Ptr("E0"),
		Tier: to.Ptr("Enterprise"),
	},
}, 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.ServiceResource = armappplatform.ServiceResource{
// 	Name: to.Ptr("myservice"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 	},
// 	Properties: &armappplatform.ClusterResourceProperties{
// 		MarketplaceResource: &armappplatform.MarketplaceResource{
// 			Plan: to.Ptr("tanzu-asc-ent-mtr"),
// 			Product: to.Ptr("azure-spring-cloud-vmware-tanzu-2"),
// 			Publisher: to.Ptr("vmware-inc"),
// 		},
// 		NetworkProfile: &armappplatform.NetworkProfile{
// 			OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
// 				PublicIPs: []*string{
// 					to.Ptr("20.39.3.173"),
// 					to.Ptr("40.64.67.13")},
// 				},
// 				RequiredTraffics: []*armappplatform.RequiredTraffic{
// 					{
// 						Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 						IPs: []*string{
// 							to.Ptr("20.62.211.25"),
// 							to.Ptr("52.188.47.226")},
// 							Port: to.Ptr[int32](443),
// 							Protocol: to.Ptr("TCP"),
// 						},
// 						{
// 							Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 							IPs: []*string{
// 								to.Ptr("20.62.211.25"),
// 								to.Ptr("52.188.47.226")},
// 								Port: to.Ptr[int32](1194),
// 								Protocol: to.Ptr("UDP"),
// 							},
// 							{
// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 								IPs: []*string{
// 									to.Ptr("20.62.211.25"),
// 									to.Ptr("52.188.47.226")},
// 									Port: to.Ptr[int32](9000),
// 									Protocol: to.Ptr("TCP"),
// 							}},
// 						},
// 						ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
// 						ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
// 					},
// 					SKU: &armappplatform.SKU{
// 						Name: to.Ptr("E0"),
// 						Tier: to.Ptr("Enterprise"),
// 					},
// 				}

Output:
Example (ServicesCreateOrUpdateVNetInjection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_CreateOrUpdate_VNetInjection.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", armappplatform.ServiceResource{
	Location: to.Ptr("eastus"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armappplatform.ClusterResourceProperties{
		NetworkProfile: &armappplatform.NetworkProfile{
			AppNetworkResourceGroup: to.Ptr("my-app-network-rg"),
			AppSubnetID:             to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps"),
			IngressConfig: &armappplatform.IngressConfig{
				ReadTimeoutInSeconds: to.Ptr[int32](300),
			},
			ServiceCidr:                        to.Ptr("10.8.0.0/16,10.244.0.0/16,10.245.0.1/16"),
			ServiceRuntimeNetworkResourceGroup: to.Ptr("my-service-runtime-network-rg"),
			ServiceRuntimeSubnetID:             to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime"),
		},
		VnetAddons: &armappplatform.ServiceVNetAddons{
			DataPlanePublicEndpoint: to.Ptr(true),
			LogStreamPublicEndpoint: to.Ptr(true),
		},
	},
	SKU: &armappplatform.SKU{
		Name: to.Ptr("S0"),
		Tier: to.Ptr("Standard"),
	},
}, 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.ServiceResource = armappplatform.ServiceResource{
// 	Name: to.Ptr("myservice"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 	},
// 	Properties: &armappplatform.ClusterResourceProperties{
// 		NetworkProfile: &armappplatform.NetworkProfile{
// 			AppNetworkResourceGroup: to.Ptr("my-app-network-rg"),
// 			AppSubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps"),
// 			OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
// 				PublicIPs: []*string{
// 					to.Ptr("40.64.67.13")},
// 				},
// 				RequiredTraffics: []*armappplatform.RequiredTraffic{
// 					{
// 						Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 						IPs: []*string{
// 							to.Ptr("20.62.211.25"),
// 							to.Ptr("52.188.47.226")},
// 							Port: to.Ptr[int32](443),
// 							Protocol: to.Ptr("TCP"),
// 						},
// 						{
// 							Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 							IPs: []*string{
// 								to.Ptr("20.62.211.25"),
// 								to.Ptr("52.188.47.226")},
// 								Port: to.Ptr[int32](1194),
// 								Protocol: to.Ptr("UDP"),
// 							},
// 							{
// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 								IPs: []*string{
// 									to.Ptr("20.62.211.25"),
// 									to.Ptr("52.188.47.226")},
// 									Port: to.Ptr[int32](9000),
// 									Protocol: to.Ptr("TCP"),
// 							}},
// 							ServiceCidr: to.Ptr("10.8.0.0/16,10.244.0.0/16,10.245.0.1/16"),
// 							ServiceRuntimeNetworkResourceGroup: to.Ptr("my-service-runtime-network-rg"),
// 							ServiceRuntimeSubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime"),
// 						},
// 						ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
// 						ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
// 						VnetAddons: &armappplatform.ServiceVNetAddons{
// 							DataPlanePublicEndpoint: to.Ptr(true),
// 							LogStreamPublicEndpoint: to.Ptr(true),
// 						},
// 					},
// 					SKU: &armappplatform.SKU{
// 						Name: to.Ptr("S0"),
// 						Tier: to.Ptr("Standard"),
// 					},
// 				}

Output:

func (*ServicesClient) BeginDelete 

func (client *ServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginDeleteOptions) (*runtime.Poller[ServicesClientDeleteResponse], error)

BeginDelete - Operation to delete a Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginDelete(ctx, "myResourceGroup", "myservice", 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 (*ServicesClient) BeginDisableApmGlobally 

func (client *ServicesClient) BeginDisableApmGlobally(ctx context.Context, resourceGroupName string, serviceName string, apm ApmReference, options *ServicesClientBeginDisableApmGloballyOptions) (*runtime.Poller[ServicesClientDisableApmGloballyResponse], error)

BeginDisableApmGlobally - Disable an APM globally. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apm - The target APM for the disable operation
  • options - ServicesClientBeginDisableApmGloballyOptions contains the optional parameters for the ServicesClient.BeginDisableApmGlobally method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_DisableApmGlobally.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginDisableApmGlobally(ctx, "myResourceGroup", "myservice", armappplatform.ApmReference{
	ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
}, 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 (*ServicesClient) BeginEnableApmGlobally 

func (client *ServicesClient) BeginEnableApmGlobally(ctx context.Context, resourceGroupName string, serviceName string, apm ApmReference, options *ServicesClientBeginEnableApmGloballyOptions) (*runtime.Poller[ServicesClientEnableApmGloballyResponse], error)

BeginEnableApmGlobally - Enable an APM globally. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • apm - The target APM for the enable operation
  • options - ServicesClientBeginEnableApmGloballyOptions contains the optional parameters for the ServicesClient.BeginEnableApmGlobally method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_EnableApmGlobally.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginEnableApmGlobally(ctx, "myResourceGroup", "myservice", armappplatform.ApmReference{
	ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"),
}, 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 (*ServicesClient) BeginFlushVnetDNSSetting 

func (client *ServicesClient) BeginFlushVnetDNSSetting(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginFlushVnetDNSSettingOptions) (*runtime.Poller[ServicesClientFlushVnetDNSSettingResponse], error)

BeginFlushVnetDNSSetting - Flush Virtual Network DNS settings for a VNET injected Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientBeginFlushVnetDNSSettingOptions contains the optional parameters for the ServicesClient.BeginFlushVnetDNSSetting method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_FlushVnetDnsSetting.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginFlushVnetDNSSetting(ctx, "myResourceGroup", "myservice", 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 (*ServicesClient) BeginStart 

func (client *ServicesClient) BeginStart(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginStartOptions) (*runtime.Poller[ServicesClientStartResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientBeginStartOptions contains the optional parameters for the ServicesClient.BeginStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_Start.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginStart(ctx, "myResourceGroup", "myservice", 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 (*ServicesClient) BeginStop 

func (client *ServicesClient) BeginStop(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginStopOptions) (*runtime.Poller[ServicesClientStopResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientBeginStopOptions contains the optional parameters for the ServicesClient.BeginStop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_Stop.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginStop(ctx, "myResourceGroup", "myservice", 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 (*ServicesClient) BeginUpdate 

func (client *ServicesClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, resource ServiceResource, options *ServicesClientBeginUpdateOptions) (*runtime.Poller[ServicesClientUpdateResponse], error)

BeginUpdate - Operation to update an exiting Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • resource - Parameters for the update operation
  • options - ServicesClientBeginUpdateOptions contains the optional parameters for the ServicesClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServicesClient().BeginUpdate(ctx, "myResourceGroup", "myservice", armappplatform.ServiceResource{
	Location: to.Ptr("eastus"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armappplatform.ClusterResourceProperties{},
	SKU: &armappplatform.SKU{
		Name: to.Ptr("S0"),
		Tier: to.Ptr("Standard"),
	},
}, 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.ServiceResource = armappplatform.ServiceResource{
// 	Name: to.Ptr("myservice"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 	},
// 	Properties: &armappplatform.ClusterResourceProperties{
// 		NetworkProfile: &armappplatform.NetworkProfile{
// 			OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
// 				PublicIPs: []*string{
// 					to.Ptr("20.39.3.173"),
// 					to.Ptr("40.64.67.13")},
// 				},
// 				RequiredTraffics: []*armappplatform.RequiredTraffic{
// 					{
// 						Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 						IPs: []*string{
// 							to.Ptr("20.62.211.25"),
// 							to.Ptr("52.188.47.226")},
// 							Port: to.Ptr[int32](443),
// 							Protocol: to.Ptr("TCP"),
// 						},
// 						{
// 							Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 							IPs: []*string{
// 								to.Ptr("20.62.211.25"),
// 								to.Ptr("52.188.47.226")},
// 								Port: to.Ptr[int32](1194),
// 								Protocol: to.Ptr("UDP"),
// 							},
// 							{
// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 								IPs: []*string{
// 									to.Ptr("20.62.211.25"),
// 									to.Ptr("52.188.47.226")},
// 									Port: to.Ptr[int32](9000),
// 									Protocol: to.Ptr("TCP"),
// 							}},
// 						},
// 						ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
// 						ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
// 					},
// 					SKU: &armappplatform.SKU{
// 						Name: to.Ptr("S0"),
// 						Tier: to.Ptr("Standard"),
// 					},
// 				}

Output:

func (*ServicesClient) CheckNameAvailability 

func (client *ServicesClient) CheckNameAvailability(ctx context.Context, location string, availabilityParameters NameAvailabilityParameters, options *ServicesClientCheckNameAvailabilityOptions) (ServicesClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the resource name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • location - the region
  • availabilityParameters - Parameters supplied to the operation.
  • options - ServicesClientCheckNameAvailabilityOptions contains the optional parameters for the ServicesClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_CheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().CheckNameAvailability(ctx, "eastus", armappplatform.NameAvailabilityParameters{
	Name: to.Ptr("myservice"),
	Type: to.Ptr("Microsoft.AppPlatform/Spring"),
}, 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.NameAvailability = armappplatform.NameAvailability{
// 	Message: to.Ptr("The name is already used."),
// 	NameAvailable: to.Ptr(false),
// 	Reason: to.Ptr("AlreadyExists"),
// }

Output:

func (*ServicesClient) DisableTestEndpoint 

func (client *ServicesClient) DisableTestEndpoint(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientDisableTestEndpointOptions) (ServicesClientDisableTestEndpointResponse, error)

DisableTestEndpoint - Disable test endpoint functionality for a Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientDisableTestEndpointOptions contains the optional parameters for the ServicesClient.DisableTestEndpoint method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_DisableTestEndpoint.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewServicesClient().DisableTestEndpoint(ctx, "myResourceGroup", "myservice", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*ServicesClient) EnableTestEndpoint 

func (client *ServicesClient) EnableTestEndpoint(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientEnableTestEndpointOptions) (ServicesClientEnableTestEndpointResponse, error)

EnableTestEndpoint - Enable test endpoint functionality for a Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientEnableTestEndpointOptions contains the optional parameters for the ServicesClient.EnableTestEndpoint method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_EnableTestEndpoint.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().EnableTestEndpoint(ctx, "myResourceGroup", "myservice", 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.TestKeys = armappplatform.TestKeys{
// 	Enabled: to.Ptr(true),
// 	PrimaryKey: to.Ptr("<primaryKey>"),
// 	PrimaryTestEndpoint: to.Ptr("<primaryTestEndpoint>"),
// 	SecondaryKey: to.Ptr("<secondaryKey>"),
// 	SecondaryTestEndpoint: to.Ptr("<secondaryTestEndpoint>"),
// }

Output:

func (*ServicesClient) Get 

func (client *ServicesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientGetOptions) (ServicesClientGetResponse, error)

Get - Get a Service and its properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Get(ctx, "myResourceGroup", "myservice", 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.ServiceResource = armappplatform.ServiceResource{
// 	Name: to.Ptr("myservice"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"key1": to.Ptr("value1"),
// 	},
// 	Properties: &armappplatform.ClusterResourceProperties{
// 		NetworkProfile: &armappplatform.NetworkProfile{
// 			IngressConfig: &armappplatform.IngressConfig{
// 				ReadTimeoutInSeconds: to.Ptr[int32](300),
// 			},
// 			OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
// 				PublicIPs: []*string{
// 					to.Ptr("20.39.3.173"),
// 					to.Ptr("40.64.67.13")},
// 				},
// 				RequiredTraffics: []*armappplatform.RequiredTraffic{
// 					{
// 						Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 						IPs: []*string{
// 							to.Ptr("20.62.211.25"),
// 							to.Ptr("52.188.47.226")},
// 							Port: to.Ptr[int32](443),
// 							Protocol: to.Ptr("TCP"),
// 						},
// 						{
// 							Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 							IPs: []*string{
// 								to.Ptr("20.62.211.25"),
// 								to.Ptr("52.188.47.226")},
// 								Port: to.Ptr[int32](1194),
// 								Protocol: to.Ptr("UDP"),
// 							},
// 							{
// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
// 								IPs: []*string{
// 									to.Ptr("20.62.211.25"),
// 									to.Ptr("52.188.47.226")},
// 									Port: to.Ptr[int32](9000),
// 									Protocol: to.Ptr("TCP"),
// 							}},
// 						},
// 						ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
// 						ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
// 					},
// 					SKU: &armappplatform.SKU{
// 						Name: to.Ptr("S0"),
// 						Tier: to.Ptr("Standard"),
// 					},
// 				}

Output:

func (*ServicesClient) ListGloballyEnabledApms 

func (client *ServicesClient) ListGloballyEnabledApms(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientListGloballyEnabledApmsOptions) (ServicesClientListGloballyEnabledApmsResponse, error)

ListGloballyEnabledApms - List globally enabled APMs for a Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientListGloballyEnabledApmsOptions contains the optional parameters for the ServicesClient.ListGloballyEnabledApms method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListGloballyEnabledApms.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().ListGloballyEnabledApms(ctx, "myResourceGroup", "myservice", 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.GloballyEnabledApms = armappplatform.GloballyEnabledApms{
// 	Value: []*string{
// 		to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights")},
// 	}

Output:

func (*ServicesClient) ListTestKeys 

func (client *ServicesClient) ListTestKeys(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientListTestKeysOptions) (ServicesClientListTestKeysResponse, error)

ListTestKeys - List test keys for a Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientListTestKeysOptions contains the optional parameters for the ServicesClient.ListTestKeys method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListTestKeys.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().ListTestKeys(ctx, "myResourceGroup", "myservice", 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.TestKeys = armappplatform.TestKeys{
// 	Enabled: to.Ptr(true),
// 	PrimaryKey: to.Ptr("<primaryKey>"),
// 	PrimaryTestEndpoint: to.Ptr("<primaryTestEndpoint>"),
// 	SecondaryKey: to.Ptr("<secondaryKey>"),
// 	SecondaryTestEndpoint: to.Ptr("<secondaryTestEndpoint>"),
// }

Output:

func (*ServicesClient) NewListBySubscriptionPager 

func (client *ServicesClient) NewListBySubscriptionPager(options *ServicesClientListBySubscriptionOptions) *runtime.Pager[ServicesClientListBySubscriptionResponse]

NewListBySubscriptionPager - Handles requests to list all resources in a subscription.

Generated from API version 2023-12-01

  • options - ServicesClientListBySubscriptionOptions contains the optional parameters for the ServicesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewServicesClient().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.ServiceResourceList = armappplatform.ServiceResourceList{
	// 	Value: []*armappplatform.ServiceResource{
	// 		{
	// 			Name: to.Ptr("myservice"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("value1"),
	// 			},
	// 			Properties: &armappplatform.ClusterResourceProperties{
	// 				NetworkProfile: &armappplatform.NetworkProfile{
	// 					IngressConfig: &armappplatform.IngressConfig{
	// 						ReadTimeoutInSeconds: to.Ptr[int32](300),
	// 					},
	// 					OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
	// 						PublicIPs: []*string{
	// 							to.Ptr("20.39.3.173"),
	// 							to.Ptr("40.64.67.13")},
	// 						},
	// 						RequiredTraffics: []*armappplatform.RequiredTraffic{
	// 							{
	// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
	// 								IPs: []*string{
	// 									to.Ptr("20.62.211.25"),
	// 									to.Ptr("52.188.47.226")},
	// 									Port: to.Ptr[int32](443),
	// 									Protocol: to.Ptr("TCP"),
	// 								},
	// 								{
	// 									Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
	// 									IPs: []*string{
	// 										to.Ptr("20.62.211.25"),
	// 										to.Ptr("52.188.47.226")},
	// 										Port: to.Ptr[int32](1194),
	// 										Protocol: to.Ptr("UDP"),
	// 									},
	// 									{
	// 										Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
	// 										IPs: []*string{
	// 											to.Ptr("20.62.211.25"),
	// 											to.Ptr("52.188.47.226")},
	// 											Port: to.Ptr[int32](9000),
	// 											Protocol: to.Ptr("TCP"),
	// 									}},
	// 								},
	// 								ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
	// 								ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
	// 							},
	// 							SKU: &armappplatform.SKU{
	// 								Name: to.Ptr("S0"),
	// 								Tier: to.Ptr("Standard"),
	// 							},
	// 					}},
	// 				}
}

Output:

func (*ServicesClient) NewListPager 

func (client *ServicesClient) NewListPager(resourceGroupName string, options *ServicesClientListOptions) *runtime.Pager[ServicesClientListResponse]

NewListPager - Handles requests to list all resources in a resource group.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • options - ServicesClientListOptions contains the optional parameters for the ServicesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewServicesClient().NewListPager("myResourceGroup", 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.ServiceResourceList = armappplatform.ServiceResourceList{
	// 	Value: []*armappplatform.ServiceResource{
	// 		{
	// 			Name: to.Ptr("myservice"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("value1"),
	// 			},
	// 			Properties: &armappplatform.ClusterResourceProperties{
	// 				NetworkProfile: &armappplatform.NetworkProfile{
	// 					IngressConfig: &armappplatform.IngressConfig{
	// 						ReadTimeoutInSeconds: to.Ptr[int32](300),
	// 					},
	// 					OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
	// 						PublicIPs: []*string{
	// 							to.Ptr("20.39.3.173"),
	// 							to.Ptr("40.64.67.13")},
	// 						},
	// 						RequiredTraffics: []*armappplatform.RequiredTraffic{
	// 							{
	// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
	// 								IPs: []*string{
	// 									to.Ptr("20.62.211.25"),
	// 									to.Ptr("52.188.47.226")},
	// 									Port: to.Ptr[int32](443),
	// 									Protocol: to.Ptr("TCP"),
	// 								},
	// 								{
	// 									Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
	// 									IPs: []*string{
	// 										to.Ptr("20.62.211.25"),
	// 										to.Ptr("52.188.47.226")},
	// 										Port: to.Ptr[int32](1194),
	// 										Protocol: to.Ptr("UDP"),
	// 									},
	// 									{
	// 										Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
	// 										IPs: []*string{
	// 											to.Ptr("20.62.211.25"),
	// 											to.Ptr("52.188.47.226")},
	// 											Port: to.Ptr[int32](9000),
	// 											Protocol: to.Ptr("TCP"),
	// 									}},
	// 								},
	// 								ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
	// 								ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
	// 							},
	// 							SKU: &armappplatform.SKU{
	// 								Name: to.Ptr("S0"),
	// 								Tier: to.Ptr("Standard"),
	// 							},
	// 					}},
	// 				}
}

Output:

func (*ServicesClient) NewListSupportedApmTypesPager 

func (client *ServicesClient) NewListSupportedApmTypesPager(resourceGroupName string, serviceName string, options *ServicesClientListSupportedApmTypesOptions) *runtime.Pager[ServicesClientListSupportedApmTypesResponse]

NewListSupportedApmTypesPager - List supported APM types for a Service.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientListSupportedApmTypesOptions contains the optional parameters for the ServicesClient.NewListSupportedApmTypesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListSupportedApmTypes.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewServicesClient().NewListSupportedApmTypesPager("myResourceGroup", "myservice", 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.SupportedApmTypes = armappplatform.SupportedApmTypes{
	// 	Value: []*armappplatform.SupportedApmType{
	// 		{
	// 			Name: to.Ptr("AppDynamics"),
	// 		},
	// 		{
	// 			Name: to.Ptr("ApplicationInsights"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Dynatrace"),
	// 		},
	// 		{
	// 			Name: to.Ptr("ElasticAPM"),
	// 		},
	// 		{
	// 			Name: to.Ptr("NewRelic"),
	// 	}},
	// }
}

Output:

func (*ServicesClient) NewListSupportedServerVersionsPager 

func (client *ServicesClient) NewListSupportedServerVersionsPager(resourceGroupName string, serviceName string, options *ServicesClientListSupportedServerVersionsOptions) *runtime.Pager[ServicesClientListSupportedServerVersionsResponse]

NewListSupportedServerVersionsPager - Lists all of the available server versions supported by Microsoft.AppPlatform provider.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - ServicesClientListSupportedServerVersionsOptions contains the optional parameters for the ServicesClient.NewListSupportedServerVersionsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListSupportedServerVersions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewServicesClient().NewListSupportedServerVersionsPager("myResourceGroup", "myservice", 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.SupportedServerVersions = armappplatform.SupportedServerVersions{
	// 	Value: []*armappplatform.SupportedServerVersion{
	// 		{
	// 			Server: to.Ptr("Tomcat"),
	// 			Value: to.Ptr("Tomcat_9"),
	// 			Version: to.Ptr("9"),
	// 		},
	// 		{
	// 			Server: to.Ptr("Tomcat"),
	// 			Value: to.Ptr("Tomcat_10"),
	// 			Version: to.Ptr("10"),
	// 	}},
	// }
}

Output:

func (*ServicesClient) RegenerateTestKey 

func (client *ServicesClient) RegenerateTestKey(ctx context.Context, resourceGroupName string, serviceName string, regenerateTestKeyRequest RegenerateTestKeyRequestPayload, options *ServicesClientRegenerateTestKeyOptions) (ServicesClientRegenerateTestKeyResponse, error)

RegenerateTestKey - Regenerate a test key for a Service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • regenerateTestKeyRequest - Parameters for the operation
  • options - ServicesClientRegenerateTestKeyOptions contains the optional parameters for the ServicesClient.RegenerateTestKey method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_RegenerateTestKey.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().RegenerateTestKey(ctx, "myResourceGroup", "myservice", armappplatform.RegenerateTestKeyRequestPayload{
	KeyType: to.Ptr(armappplatform.TestKeyTypePrimary),
}, 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.TestKeys = armappplatform.TestKeys{
// 	Enabled: to.Ptr(true),
// 	PrimaryKey: to.Ptr("<primaryKey>"),
// 	PrimaryTestEndpoint: to.Ptr("<primaryTestEndpoint>"),
// 	SecondaryKey: to.Ptr("<secondaryKey>"),
// 	SecondaryTestEndpoint: to.Ptr("<secondaryTestEndpoint>"),
// }

Output:

type ServicesClientBeginCreateOrUpdateOptions 

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

ServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServicesClient.BeginCreateOrUpdate method.

type ServicesClientBeginDeleteOptions 

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

ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.

type ServicesClientBeginDisableApmGloballyOptions 

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

ServicesClientBeginDisableApmGloballyOptions contains the optional parameters for the ServicesClient.BeginDisableApmGlobally method.

type ServicesClientBeginEnableApmGloballyOptions 

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

ServicesClientBeginEnableApmGloballyOptions contains the optional parameters for the ServicesClient.BeginEnableApmGlobally method.

type ServicesClientBeginFlushVnetDNSSettingOptions 

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

ServicesClientBeginFlushVnetDNSSettingOptions contains the optional parameters for the ServicesClient.BeginFlushVnetDNSSetting method.

type ServicesClientBeginStartOptions 

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

ServicesClientBeginStartOptions contains the optional parameters for the ServicesClient.BeginStart method.

type ServicesClientBeginStopOptions 

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

ServicesClientBeginStopOptions contains the optional parameters for the ServicesClient.BeginStop method.

type ServicesClientBeginUpdateOptions 

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

ServicesClientBeginUpdateOptions contains the optional parameters for the ServicesClient.BeginUpdate method.

type ServicesClientCheckNameAvailabilityOptions 

type ServicesClientCheckNameAvailabilityOptions struct {
}

ServicesClientCheckNameAvailabilityOptions contains the optional parameters for the ServicesClient.CheckNameAvailability method.

type ServicesClientCheckNameAvailabilityResponse 

type ServicesClientCheckNameAvailabilityResponse struct {
	// Name availability result payload
	NameAvailability
}

ServicesClientCheckNameAvailabilityResponse contains the response from method ServicesClient.CheckNameAvailability.

type ServicesClientCreateOrUpdateResponse 

type ServicesClientCreateOrUpdateResponse struct {
	// Service resource
	ServiceResource
}

ServicesClientCreateOrUpdateResponse contains the response from method ServicesClient.BeginCreateOrUpdate.

type ServicesClientDeleteResponse 

type ServicesClientDeleteResponse struct {
}

ServicesClientDeleteResponse contains the response from method ServicesClient.BeginDelete.

type ServicesClientDisableApmGloballyResponse 

type ServicesClientDisableApmGloballyResponse struct {
}

ServicesClientDisableApmGloballyResponse contains the response from method ServicesClient.BeginDisableApmGlobally.

type ServicesClientDisableTestEndpointOptions 

type ServicesClientDisableTestEndpointOptions struct {
}

ServicesClientDisableTestEndpointOptions contains the optional parameters for the ServicesClient.DisableTestEndpoint method.

type ServicesClientDisableTestEndpointResponse 

type ServicesClientDisableTestEndpointResponse struct {
}

ServicesClientDisableTestEndpointResponse contains the response from method ServicesClient.DisableTestEndpoint.

type ServicesClientEnableApmGloballyResponse 

type ServicesClientEnableApmGloballyResponse struct {
}

ServicesClientEnableApmGloballyResponse contains the response from method ServicesClient.BeginEnableApmGlobally.

type ServicesClientEnableTestEndpointOptions 

type ServicesClientEnableTestEndpointOptions struct {
}

ServicesClientEnableTestEndpointOptions contains the optional parameters for the ServicesClient.EnableTestEndpoint method.

type ServicesClientEnableTestEndpointResponse 

type ServicesClientEnableTestEndpointResponse struct {
	// Test keys payload
	TestKeys
}

ServicesClientEnableTestEndpointResponse contains the response from method ServicesClient.EnableTestEndpoint.

type ServicesClientFlushVnetDNSSettingResponse 

type ServicesClientFlushVnetDNSSettingResponse struct {
}

ServicesClientFlushVnetDNSSettingResponse contains the response from method ServicesClient.BeginFlushVnetDNSSetting.

type ServicesClientGetOptions 

type ServicesClientGetOptions struct {
}

ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.

type ServicesClientGetResponse 

type ServicesClientGetResponse struct {
	// Service resource
	ServiceResource
}

ServicesClientGetResponse contains the response from method ServicesClient.Get.

type ServicesClientListBySubscriptionOptions 

type ServicesClientListBySubscriptionOptions struct {
}

ServicesClientListBySubscriptionOptions contains the optional parameters for the ServicesClient.NewListBySubscriptionPager method.

type ServicesClientListBySubscriptionResponse 

type ServicesClientListBySubscriptionResponse struct {
	// Object that includes an array of Service resources and a possible link for next set
	ServiceResourceList
}

ServicesClientListBySubscriptionResponse contains the response from method ServicesClient.NewListBySubscriptionPager.

type ServicesClientListGloballyEnabledApmsOptions 

type ServicesClientListGloballyEnabledApmsOptions struct {
}

ServicesClientListGloballyEnabledApmsOptions contains the optional parameters for the ServicesClient.ListGloballyEnabledApms method.

type ServicesClientListGloballyEnabledApmsResponse 

type ServicesClientListGloballyEnabledApmsResponse struct {
	// Globally enabled APMs payload
	GloballyEnabledApms
}

ServicesClientListGloballyEnabledApmsResponse contains the response from method ServicesClient.ListGloballyEnabledApms.

type ServicesClientListOptions 

type ServicesClientListOptions struct {
}

ServicesClientListOptions contains the optional parameters for the ServicesClient.NewListPager method.

type ServicesClientListResponse 

type ServicesClientListResponse struct {
	// Object that includes an array of Service resources and a possible link for next set
	ServiceResourceList
}

ServicesClientListResponse contains the response from method ServicesClient.NewListPager.

type ServicesClientListSupportedApmTypesOptions 

type ServicesClientListSupportedApmTypesOptions struct {
}

ServicesClientListSupportedApmTypesOptions contains the optional parameters for the ServicesClient.NewListSupportedApmTypesPager method.

type ServicesClientListSupportedApmTypesResponse 

type ServicesClientListSupportedApmTypesResponse struct {
	// Supported APM types payload
	SupportedApmTypes
}

ServicesClientListSupportedApmTypesResponse contains the response from method ServicesClient.NewListSupportedApmTypesPager.

type ServicesClientListSupportedServerVersionsOptions 

type ServicesClientListSupportedServerVersionsOptions struct {
}

ServicesClientListSupportedServerVersionsOptions contains the optional parameters for the ServicesClient.NewListSupportedServerVersionsPager method.

type ServicesClientListSupportedServerVersionsResponse 

type ServicesClientListSupportedServerVersionsResponse struct {
	// Supported server versions.
	SupportedServerVersions
}

ServicesClientListSupportedServerVersionsResponse contains the response from method ServicesClient.NewListSupportedServerVersionsPager.

type ServicesClientListTestKeysOptions 

type ServicesClientListTestKeysOptions struct {
}

ServicesClientListTestKeysOptions contains the optional parameters for the ServicesClient.ListTestKeys method.

type ServicesClientListTestKeysResponse 

type ServicesClientListTestKeysResponse struct {
	// Test keys payload
	TestKeys
}

ServicesClientListTestKeysResponse contains the response from method ServicesClient.ListTestKeys.

type ServicesClientRegenerateTestKeyOptions 

type ServicesClientRegenerateTestKeyOptions struct {
}

ServicesClientRegenerateTestKeyOptions contains the optional parameters for the ServicesClient.RegenerateTestKey method.

type ServicesClientRegenerateTestKeyResponse 

type ServicesClientRegenerateTestKeyResponse struct {
	// Test keys payload
	TestKeys
}

ServicesClientRegenerateTestKeyResponse contains the response from method ServicesClient.RegenerateTestKey.

type ServicesClientStartResponse 

type ServicesClientStartResponse struct {
}

ServicesClientStartResponse contains the response from method ServicesClient.BeginStart.

type ServicesClientStopResponse 

type ServicesClientStopResponse struct {
}

ServicesClientStopResponse contains the response from method ServicesClient.BeginStop.

type ServicesClientUpdateResponse 

type ServicesClientUpdateResponse struct {
	// Service resource
	ServiceResource
}

ServicesClientUpdateResponse contains the response from method ServicesClient.BeginUpdate.

type SessionAffinity 

type SessionAffinity string

SessionAffinity - Type of the affinity, set this to Cookie to enable session affinity. 

const (
	SessionAffinityCookie SessionAffinity = "Cookie"
	SessionAffinityNone   SessionAffinity = "None"
)

func PossibleSessionAffinityValues 

func PossibleSessionAffinityValues() []SessionAffinity

PossibleSessionAffinityValues returns the possible values for the SessionAffinity const type.

type SourceUploadedUserSourceInfo 

type SourceUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to
	// the target module/project.
	ArtifactSelector *string

	// Relative path of the storage which stores the source
	RelativePath *string

	// Runtime version of the source file
	RuntimeVersion *string

	// Version of the source
	Version *string
}

SourceUploadedUserSourceInfo - Uploaded Java source code binary for a deployment

func (*SourceUploadedUserSourceInfo) GetUploadedUserSourceInfo 

func (s *SourceUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type SourceUploadedUserSourceInfo.

func (*SourceUploadedUserSourceInfo) GetUserSourceInfo 

func (s *SourceUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type SourceUploadedUserSourceInfo.

func (SourceUploadedUserSourceInfo) MarshalJSON 

func (s SourceUploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceUploadedUserSourceInfo.

func (*SourceUploadedUserSourceInfo) UnmarshalJSON 

func (s *SourceUploadedUserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceUploadedUserSourceInfo.

type SsoProperties 

type SsoProperties struct {
	// The public identifier for the application
	ClientID *string

	// The secret known only to the application and the authorization server
	ClientSecret *string

	// The URI of Issuer Identifier
	IssuerURI *string

	// It defines the specific actions applications can be allowed to do on a user's behalf
	Scope []*string
}

SsoProperties - Single sign-on related configuration

func (SsoProperties) MarshalJSON 

func (s SsoProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsoProperties.

func (*SsoProperties) UnmarshalJSON 

func (s *SsoProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsoProperties.

type StackProperties 

type StackProperties struct {
	// Id of the ClusterStack.
	ID *string

	// Version of the ClusterStack
	Version *string
}

StackProperties - KPack ClusterStack properties payload

func (StackProperties) MarshalJSON 

func (s StackProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StackProperties.

func (*StackProperties) UnmarshalJSON 

func (s *StackProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StackProperties.

type StorageAccount 

type StorageAccount struct {
	// REQUIRED; The account key of the Azure Storage Account.
	AccountKey *string

	// REQUIRED; The account name of the Azure Storage Account.
	AccountName *string

	// REQUIRED; The type of the storage.
	StorageType *StorageType
}

StorageAccount - storage resource of type Azure Storage Account.

func (*StorageAccount) GetStorageProperties 

func (s *StorageAccount) GetStorageProperties() *StorageProperties

GetStorageProperties implements the StoragePropertiesClassification interface for type StorageAccount.

func (StorageAccount) MarshalJSON 

func (s StorageAccount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccount.

func (*StorageAccount) UnmarshalJSON 

func (s *StorageAccount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccount.

type StorageProperties 

type StorageProperties struct {
	// REQUIRED; The type of the storage.
	StorageType *StorageType
}

StorageProperties - Storage resource payload.

func (*StorageProperties) GetStorageProperties 

func (s *StorageProperties) GetStorageProperties() *StorageProperties

GetStorageProperties implements the StoragePropertiesClassification interface for type StorageProperties.

func (StorageProperties) MarshalJSON 

func (s StorageProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageProperties.

func (*StorageProperties) UnmarshalJSON 

func (s *StorageProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageProperties.

type StoragePropertiesClassification 

type StoragePropertiesClassification interface {
	// GetStorageProperties returns the StorageProperties content of the underlying type.
	GetStorageProperties() *StorageProperties
}

StoragePropertiesClassification provides polymorphic access to related types. Call the interface's GetStorageProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *StorageAccount, *StorageProperties

type StorageResource 

type StorageResource struct {
	// Properties of the storage resource payload.
	Properties StoragePropertiesClassification

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

StorageResource - Storage resource payload.

func (StorageResource) MarshalJSON 

func (s StorageResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageResource.

func (*StorageResource) UnmarshalJSON 

func (s *StorageResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageResource.

type StorageResourceCollection 

type StorageResourceCollection struct {
	// The link to next page of storage list.
	NextLink *string

	// The storage resources list.
	Value []*StorageResource
}

StorageResourceCollection - Collection compose of storage resources list and a possible link for next page.

func (StorageResourceCollection) MarshalJSON 

func (s StorageResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageResourceCollection.

func (*StorageResourceCollection) UnmarshalJSON 

func (s *StorageResourceCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageResourceCollection.

type StorageType 

type StorageType string

StorageType - The type of the storage. 

const (
	StorageTypeStorageAccount StorageType = "StorageAccount"
)

func PossibleStorageTypeValues 

func PossibleStorageTypeValues() []StorageType

PossibleStorageTypeValues returns the possible values for the StorageType const type.

type StoragesClient 

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

StoragesClient contains the methods for the Storages group. Don't use this type directly, use NewStoragesClient() instead.

func NewStoragesClient 

func NewStoragesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StoragesClient, error)

NewStoragesClient creates a new instance of StoragesClient with the specified values.

  • subscriptionID - Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*StoragesClient) BeginCreateOrUpdate 

func (client *StoragesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, storageName string, storageResource StorageResource, options *StoragesClientBeginCreateOrUpdateOptions) (*runtime.Poller[StoragesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • storageName - The name of the storage resource.
  • storageResource - Parameters for the create or update operation
  • options - StoragesClientBeginCreateOrUpdateOptions contains the optional parameters for the StoragesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Storages_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewStoragesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "mystorage", armappplatform.StorageResource{
	Properties: &armappplatform.StorageAccount{
		StorageType: to.Ptr(armappplatform.StorageTypeStorageAccount),
		AccountKey:  to.Ptr("account-key-of-storage-account"),
		AccountName: to.Ptr("storage-account-name"),
	},
}, 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.StorageResource = armappplatform.StorageResource{
// 	Name: to.Ptr("mystorage"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/storages"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.StorageAccount{
// 		StorageType: to.Ptr(armappplatform.StorageTypeStorageAccount),
// 		AccountName: to.Ptr("storage-account-name"),
// 	},
// }

Output:

func (*StoragesClient) BeginDelete 

func (client *StoragesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, storageName string, options *StoragesClientBeginDeleteOptions) (*runtime.Poller[StoragesClientDeleteResponse], error)

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

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • storageName - The name of the storage resource.
  • options - StoragesClientBeginDeleteOptions contains the optional parameters for the StoragesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Storages_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewStoragesClient().BeginDelete(ctx, "myResourceGroup", "myservice", "mystorage", 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 (*StoragesClient) Get 

func (client *StoragesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, storageName string, options *StoragesClientGetOptions) (StoragesClientGetResponse, error)

Get - Get the storage resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • storageName - The name of the storage resource.
  • options - StoragesClientGetOptions contains the optional parameters for the StoragesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Storages_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewStoragesClient().Get(ctx, "myResourceGroup", "myservice", "mystorage", 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.StorageResource = armappplatform.StorageResource{
// 	Name: to.Ptr("mystorage"),
// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/storages"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage"),
// 	SystemData: &armappplatform.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
// 		CreatedBy: to.Ptr("sample-user"),
// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
// 		LastModifiedBy: to.Ptr("sample-user"),
// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
// 	},
// 	Properties: &armappplatform.StorageAccount{
// 		StorageType: to.Ptr(armappplatform.StorageTypeStorageAccount),
// 		AccountName: to.Ptr("storage-account-name"),
// 	},
// }

Output:

func (*StoragesClient) NewListPager 

func (client *StoragesClient) NewListPager(resourceGroupName string, serviceName string, options *StoragesClientListOptions) *runtime.Pager[StoragesClientListResponse]

NewListPager - List all the storages of one Azure Spring Apps resource.

Generated from API version 2023-12-01

  • resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serviceName - The name of the Service resource.
  • options - StoragesClientListOptions contains the optional parameters for the StoragesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Storages_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewStoragesClient().NewListPager("myResourceGroup", "myservice", 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.StorageResourceCollection = armappplatform.StorageResourceCollection{
	// 	Value: []*armappplatform.StorageResource{
	// 		{
	// 			Name: to.Ptr("mystorage"),
	// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/storages"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/storages/mystorage"),
	// 			SystemData: &armappplatform.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 				CreatedBy: to.Ptr("sample-user"),
	// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("sample-user"),
	// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 			},
	// 			Properties: &armappplatform.StorageAccount{
	// 				StorageType: to.Ptr(armappplatform.StorageTypeStorageAccount),
	// 				AccountName: to.Ptr("storage-account-name"),
	// 			},
	// 	}},
	// }
}

Output:

type StoragesClientBeginCreateOrUpdateOptions 

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

StoragesClientBeginCreateOrUpdateOptions contains the optional parameters for the StoragesClient.BeginCreateOrUpdate method.

type StoragesClientBeginDeleteOptions 

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

StoragesClientBeginDeleteOptions contains the optional parameters for the StoragesClient.BeginDelete method.

type StoragesClientCreateOrUpdateResponse 

type StoragesClientCreateOrUpdateResponse struct {
	// Storage resource payload.
	StorageResource
}

StoragesClientCreateOrUpdateResponse contains the response from method StoragesClient.BeginCreateOrUpdate.

type StoragesClientDeleteResponse 

type StoragesClientDeleteResponse struct {
}

StoragesClientDeleteResponse contains the response from method StoragesClient.BeginDelete.

type StoragesClientGetOptions 

type StoragesClientGetOptions struct {
}

StoragesClientGetOptions contains the optional parameters for the StoragesClient.Get method.

type StoragesClientGetResponse 

type StoragesClientGetResponse struct {
	// Storage resource payload.
	StorageResource
}

StoragesClientGetResponse contains the response from method StoragesClient.Get.

type StoragesClientListOptions 

type StoragesClientListOptions struct {
}

StoragesClientListOptions contains the optional parameters for the StoragesClient.NewListPager method.

type StoragesClientListResponse 

type StoragesClientListResponse struct {
	// Collection compose of storage resources list and a possible link for next page.
	StorageResourceCollection
}

StoragesClientListResponse contains the response from method StoragesClient.NewListPager.

type SupportedApmType 

type SupportedApmType struct {
	// The name of the supported APM type
	Name *string
}

SupportedApmType - Supported APM type

func (SupportedApmType) MarshalJSON 

func (s SupportedApmType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedApmType.

func (*SupportedApmType) UnmarshalJSON 

func (s *SupportedApmType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedApmType.

type SupportedApmTypes 

type SupportedApmTypes 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 the supported APM type
	Value []*SupportedApmType
}

SupportedApmTypes - Supported APM types payload

func (SupportedApmTypes) MarshalJSON 

func (s SupportedApmTypes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedApmTypes.

func (*SupportedApmTypes) UnmarshalJSON 

func (s *SupportedApmTypes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedApmTypes.

type SupportedBuildpackResource 

type SupportedBuildpackResource struct {
	// Supported buildpack resource properties
	Properties *SupportedBuildpackResourceProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

SupportedBuildpackResource - Supported buildpack resource payload

func (SupportedBuildpackResource) MarshalJSON 

func (s SupportedBuildpackResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedBuildpackResource.

func (*SupportedBuildpackResource) UnmarshalJSON 

func (s *SupportedBuildpackResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedBuildpackResource.

type SupportedBuildpackResourceProperties 

type SupportedBuildpackResourceProperties struct {
	// The id of supported buildpack
	BuildpackID *string
}

SupportedBuildpackResourceProperties - Supported buildpack resource properties

func (SupportedBuildpackResourceProperties) MarshalJSON 

func (s SupportedBuildpackResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedBuildpackResourceProperties.

func (*SupportedBuildpackResourceProperties) UnmarshalJSON 

func (s *SupportedBuildpackResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedBuildpackResourceProperties.

type SupportedBuildpacksCollection 

type SupportedBuildpacksCollection 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 supported buildpacks resources
	Value []*SupportedBuildpackResource
}

SupportedBuildpacksCollection - Object that includes an array of supported buildpacks resources and a possible link for next set

func (SupportedBuildpacksCollection) MarshalJSON 

func (s SupportedBuildpacksCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedBuildpacksCollection.

func (*SupportedBuildpacksCollection) UnmarshalJSON 

func (s *SupportedBuildpacksCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedBuildpacksCollection.

type SupportedRuntimePlatform 

type SupportedRuntimePlatform string

SupportedRuntimePlatform - The platform of this runtime version (possible values: "Java" or ".NET"). 

const (
	SupportedRuntimePlatformJava    SupportedRuntimePlatform = "Java"
	SupportedRuntimePlatformNETCore SupportedRuntimePlatform = ".NET Core"
)

func PossibleSupportedRuntimePlatformValues 

func PossibleSupportedRuntimePlatformValues() []SupportedRuntimePlatform

PossibleSupportedRuntimePlatformValues returns the possible values for the SupportedRuntimePlatform const type.

type SupportedRuntimeValue 

type SupportedRuntimeValue string

SupportedRuntimeValue - The raw value which could be passed to deployment CRUD operations. 

const (
	SupportedRuntimeValueJava11    SupportedRuntimeValue = "Java_11"
	SupportedRuntimeValueJava17    SupportedRuntimeValue = "Java_17"
	SupportedRuntimeValueJava8     SupportedRuntimeValue = "Java_8"
	SupportedRuntimeValueNetCore31 SupportedRuntimeValue = "NetCore_31"
)

func PossibleSupportedRuntimeValueValues 

func PossibleSupportedRuntimeValueValues() []SupportedRuntimeValue

PossibleSupportedRuntimeValueValues returns the possible values for the SupportedRuntimeValue const type.

type SupportedRuntimeVersion 

type SupportedRuntimeVersion struct {
	// The platform of this runtime version (possible values: "Java" or ".NET").
	Platform *SupportedRuntimePlatform

	// The raw value which could be passed to deployment CRUD operations.
	Value *SupportedRuntimeValue

	// The detailed version (major.minor) of the platform.
	Version *string
}

SupportedRuntimeVersion - Supported deployment runtime version descriptor.

func (SupportedRuntimeVersion) MarshalJSON 

func (s SupportedRuntimeVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedRuntimeVersion.

func (*SupportedRuntimeVersion) UnmarshalJSON 

func (s *SupportedRuntimeVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedRuntimeVersion.

type SupportedServerVersion 

type SupportedServerVersion struct {
	// The server name.
	Server *string

	// The raw server version value which could be passed to deployment CRUD operations.
	Value *string

	// The Server version.
	Version *string
}

SupportedServerVersion - Supported server version.

func (SupportedServerVersion) MarshalJSON 

func (s SupportedServerVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedServerVersion.

func (*SupportedServerVersion) UnmarshalJSON 

func (s *SupportedServerVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedServerVersion.

type SupportedServerVersions 

type SupportedServerVersions 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 the supported server versions.
	Value []*SupportedServerVersion
}

SupportedServerVersions - Supported server versions.

func (SupportedServerVersions) MarshalJSON 

func (s SupportedServerVersions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedServerVersions.

func (*SupportedServerVersions) UnmarshalJSON 

func (s *SupportedServerVersions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedServerVersions.

type SupportedStackResource 

type SupportedStackResource struct {
	// Supported stack resource properties
	Properties *SupportedStackResourceProperties

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

SupportedStackResource - Supported stack resource payload

func (SupportedStackResource) MarshalJSON 

func (s SupportedStackResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedStackResource.

func (*SupportedStackResource) UnmarshalJSON 

func (s *SupportedStackResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedStackResource.

type SupportedStackResourceProperties 

type SupportedStackResourceProperties struct {
	// The id of supported stack
	StackID *string

	// The version of supported stack
	Version *string
}

SupportedStackResourceProperties - Supported stack resource properties

func (SupportedStackResourceProperties) MarshalJSON 

func (s SupportedStackResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedStackResourceProperties.

func (*SupportedStackResourceProperties) UnmarshalJSON 

func (s *SupportedStackResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedStackResourceProperties.

type SupportedStacksCollection 

type SupportedStacksCollection 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 supported stacks resources
	Value []*SupportedStackResource
}

SupportedStacksCollection - Object that includes an array of supported stacks resources and a possible link for next set

func (SupportedStacksCollection) MarshalJSON 

func (s SupportedStacksCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedStacksCollection.

func (*SupportedStacksCollection) UnmarshalJSON 

func (s *SupportedStacksCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SupportedStacksCollection.

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 modification (UTC).
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *LastModifiedByType
}

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 TCPSocketAction 

type TCPSocketAction struct {
	// REQUIRED; The type of the action to take to perform the health check.
	Type *ProbeActionType
}

TCPSocketAction describes an action based on opening a socket

func (*TCPSocketAction) GetProbeAction 

func (t *TCPSocketAction) GetProbeAction() *ProbeAction

GetProbeAction implements the ProbeActionClassification interface for type TCPSocketAction.

func (TCPSocketAction) MarshalJSON 

func (t TCPSocketAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TCPSocketAction.

func (*TCPSocketAction) UnmarshalJSON 

func (t *TCPSocketAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TCPSocketAction.

type TemporaryDisk 

type TemporaryDisk struct {
	// Mount path of the temporary disk
	MountPath *string

	// Size of the temporary disk in GB
	SizeInGB *int32
}

TemporaryDisk - Temporary disk payload

func (TemporaryDisk) MarshalJSON 

func (t TemporaryDisk) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TemporaryDisk.

func (*TemporaryDisk) UnmarshalJSON 

func (t *TemporaryDisk) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TemporaryDisk.

type TestKeyType 

type TestKeyType string

TestKeyType - Type of the test key 

const (
	TestKeyTypePrimary   TestKeyType = "Primary"
	TestKeyTypeSecondary TestKeyType = "Secondary"
)

func PossibleTestKeyTypeValues 

func PossibleTestKeyTypeValues() []TestKeyType

PossibleTestKeyTypeValues returns the possible values for the TestKeyType const type.

type TestKeys 

type TestKeys struct {
	// Indicates whether the test endpoint feature enabled or not
	Enabled *bool

	// Primary key
	PrimaryKey *string

	// Primary test endpoint
	PrimaryTestEndpoint *string

	// Secondary key
	SecondaryKey *string

	// Secondary test endpoint
	SecondaryTestEndpoint *string
}

TestKeys - Test keys payload

func (TestKeys) MarshalJSON 

func (t TestKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TestKeys.

func (*TestKeys) UnmarshalJSON 

func (t *TestKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TestKeys.

type TrackedResource 

type TrackedResource struct {
	// The GEO location of the resource.
	Location *string

	// Tags of the service which is a list of key value pairs that describe the resource.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

TrackedResource - The resource model definition for a ARM tracked top level resource.

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 TrafficDirection 

type TrafficDirection string

TrafficDirection - The direction of required traffic 

const (
	TrafficDirectionInbound  TrafficDirection = "Inbound"
	TrafficDirectionOutbound TrafficDirection = "Outbound"
)

func PossibleTrafficDirectionValues 

func PossibleTrafficDirectionValues() []TrafficDirection

PossibleTrafficDirectionValues returns the possible values for the TrafficDirection const type.

type TriggeredBuildResult 

type TriggeredBuildResult struct {
	// The unique build id of this build result
	ID *string

	// The container image of this build result
	Image *string

	// The last transition reason of this build result
	LastTransitionReason *string

	// The last transition status of this build result
	LastTransitionStatus *string

	// The last transition time of this build result
	LastTransitionTime *time.Time

	// READ-ONLY; The provisioning state of this build result
	ProvisioningState *TriggeredBuildResultProvisioningState
}

TriggeredBuildResult - The build result triggered by a build

func (TriggeredBuildResult) MarshalJSON 

func (t TriggeredBuildResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggeredBuildResult.

func (*TriggeredBuildResult) UnmarshalJSON 

func (t *TriggeredBuildResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggeredBuildResult.

type TriggeredBuildResultProvisioningState 

type TriggeredBuildResultProvisioningState string

TriggeredBuildResultProvisioningState - The provisioning state of this build result 

const (
	TriggeredBuildResultProvisioningStateBuilding  TriggeredBuildResultProvisioningState = "Building"
	TriggeredBuildResultProvisioningStateCanceled  TriggeredBuildResultProvisioningState = "Canceled"
	TriggeredBuildResultProvisioningStateDeleting  TriggeredBuildResultProvisioningState = "Deleting"
	TriggeredBuildResultProvisioningStateFailed    TriggeredBuildResultProvisioningState = "Failed"
	TriggeredBuildResultProvisioningStateQueuing   TriggeredBuildResultProvisioningState = "Queuing"
	TriggeredBuildResultProvisioningStateSucceeded TriggeredBuildResultProvisioningState = "Succeeded"
)

func PossibleTriggeredBuildResultProvisioningStateValues 

func PossibleTriggeredBuildResultProvisioningStateValues() []TriggeredBuildResultProvisioningState

PossibleTriggeredBuildResultProvisioningStateValues returns the possible values for the TriggeredBuildResultProvisioningState const type.

type Type 

type Type string

Type - The type of the underlying resource to mount as a persistent disk. 

const (
	TypeAzureFileVolume Type = "AzureFileVolume"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UploadedUserSourceInfo 

type UploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// Relative path of the storage which stores the source
	RelativePath *string

	// Version of the source
	Version *string
}

UploadedUserSourceInfo - Source with uploaded location

func (*UploadedUserSourceInfo) GetUploadedUserSourceInfo 

func (u *UploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type UploadedUserSourceInfo.

func (*UploadedUserSourceInfo) GetUserSourceInfo 

func (u *UploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type UploadedUserSourceInfo.

func (UploadedUserSourceInfo) MarshalJSON 

func (u UploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UploadedUserSourceInfo.

func (*UploadedUserSourceInfo) UnmarshalJSON 

func (u *UploadedUserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadedUserSourceInfo.

type UploadedUserSourceInfoClassification 

type UploadedUserSourceInfoClassification interface {
	UserSourceInfoClassification
	// GetUploadedUserSourceInfo returns the UploadedUserSourceInfo content of the underlying type.
	GetUploadedUserSourceInfo() *UploadedUserSourceInfo
}

UploadedUserSourceInfoClassification provides polymorphic access to related types. Call the interface's GetUploadedUserSourceInfo() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *JarUploadedUserSourceInfo, *NetCoreZipUploadedUserSourceInfo, *SourceUploadedUserSourceInfo, *UploadedUserSourceInfo, - *WarUploadedUserSourceInfo

type UserAssignedManagedIdentity 

type UserAssignedManagedIdentity struct {
	// READ-ONLY; Client Id of user-assigned managed identity.
	ClientID *string

	// READ-ONLY; Principal Id of user-assigned managed identity.
	PrincipalID *string
}

UserAssignedManagedIdentity - The details of the user-assigned managed identity assigned to an App.

func (UserAssignedManagedIdentity) MarshalJSON 

func (u UserAssignedManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedManagedIdentity.

func (*UserAssignedManagedIdentity) UnmarshalJSON 

func (u *UserAssignedManagedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedManagedIdentity.

type UserSourceInfo 

type UserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// Version of the source
	Version *string
}

UserSourceInfo - Source information for a deployment

func (*UserSourceInfo) GetUserSourceInfo 

func (u *UserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type UserSourceInfo.

func (UserSourceInfo) MarshalJSON 

func (u UserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserSourceInfo.

func (*UserSourceInfo) UnmarshalJSON 

func (u *UserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserSourceInfo.

type UserSourceInfoClassification 

type UserSourceInfoClassification interface {
	// GetUserSourceInfo returns the UserSourceInfo content of the underlying type.
	GetUserSourceInfo() *UserSourceInfo
}

UserSourceInfoClassification provides polymorphic access to related types. Call the interface's GetUserSourceInfo() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BuildResultUserSourceInfo, *CustomContainerUserSourceInfo, *JarUploadedUserSourceInfo, *NetCoreZipUploadedUserSourceInfo, - *SourceUploadedUserSourceInfo, *UploadedUserSourceInfo, *UserSourceInfo, *WarUploadedUserSourceInfo

type ValidationMessages 

type ValidationMessages struct {
	// Detailed validation messages.
	Messages []*string

	// The name of the configuration service git repository.
	Name *string
}

ValidationMessages - Validate messages of the configuration service git repositories

func (ValidationMessages) MarshalJSON 

func (v ValidationMessages) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidationMessages.

func (*ValidationMessages) UnmarshalJSON 

func (v *ValidationMessages) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValidationMessages.

type WarUploadedUserSourceInfo 

type WarUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string

	// JVM parameter
	JvmOptions *string

	// Relative path of the storage which stores the source
	RelativePath *string

	// Runtime version of the war file
	RuntimeVersion *string

	// Server version, currently only Apache Tomcat is supported
	ServerVersion *string

	// Version of the source
	Version *string
}

WarUploadedUserSourceInfo - Uploaded War binary for a deployment

func (*WarUploadedUserSourceInfo) GetUploadedUserSourceInfo 

func (w *WarUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type WarUploadedUserSourceInfo.

func (*WarUploadedUserSourceInfo) GetUserSourceInfo 

func (w *WarUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type WarUploadedUserSourceInfo.

func (WarUploadedUserSourceInfo) MarshalJSON 

func (w WarUploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WarUploadedUserSourceInfo.

func (*WarUploadedUserSourceInfo) UnmarshalJSON 

func (w *WarUploadedUserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WarUploadedUserSourceInfo.

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.