armappplatform

package module
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2022 License: MIT Imports: 15 Imported by: 4

README

Azure App Platform Module for Go

PkgGoDev

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

Source code

Getting started

Prerequisites

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

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.

Clients

Azure App Platform modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armappplatform.NewSKUsClient(<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,
    },
}
client, err := armappplatform.NewSKUsClient(<subscription ID>, cred, &options)

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 APIPortalCustomDomainProperties added in v0.3.0 

type APIPortalCustomDomainProperties struct {
	// The thumbprint of bound certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
}

APIPortalCustomDomainProperties - The properties of custom domain for API portal

type APIPortalCustomDomainResource added in v0.3.0 

type APIPortalCustomDomainResource struct {
	// The properties of custom domain for API portal
	Properties *APIPortalCustomDomainProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

APIPortalCustomDomainResource - Custom domain of the API portal

type APIPortalCustomDomainResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of API portal custom domain resources
	Value []*APIPortalCustomDomainResource `json:"value,omitempty"`
}

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

func (APIPortalCustomDomainResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalCustomDomainResourceCollection.

type APIPortalCustomDomainsClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

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

BeginCreateOrUpdate - Create or update the API portal custom domain. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortalCustomDomains_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		"<domain-name>",
		armappplatform.APIPortalCustomDomainResource{
			Properties: &armappplatform.APIPortalCustomDomainProperties{
				Thumbprint: to.Ptr("<thumbprint>"),
			},
		},
		&armappplatform.APIPortalCustomDomainsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*APIPortalCustomDomainsClient) BeginDelete added in v0.3.0 

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

BeginDelete - Delete the API portal custom domain. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortalCustomDomains_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		"<domain-name>",
		&armappplatform.APIPortalCustomDomainsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*APIPortalCustomDomainsClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortalCustomDomains_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		"<domain-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*APIPortalCustomDomainsClient) NewListPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortalCustomDomains_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type APIPortalCustomDomainsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type APIPortalCustomDomainsClientBeginDeleteOptions added in v0.3.0 

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

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

type APIPortalCustomDomainsClientCreateOrUpdateResponse added in v0.3.0 

type APIPortalCustomDomainsClientCreateOrUpdateResponse struct {
	APIPortalCustomDomainResource
}

APIPortalCustomDomainsClientCreateOrUpdateResponse contains the response from method APIPortalCustomDomainsClient.CreateOrUpdate.

type APIPortalCustomDomainsClientDeleteResponse added in v0.3.0 

type APIPortalCustomDomainsClientDeleteResponse struct {
}

APIPortalCustomDomainsClientDeleteResponse contains the response from method APIPortalCustomDomainsClient.Delete.

type APIPortalCustomDomainsClientGetOptions added in v0.3.0 

type APIPortalCustomDomainsClientGetOptions struct {
}

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

type APIPortalCustomDomainsClientGetResponse added in v0.3.0 

type APIPortalCustomDomainsClientGetResponse struct {
	APIPortalCustomDomainResource
}

APIPortalCustomDomainsClientGetResponse contains the response from method APIPortalCustomDomainsClient.Get.

type APIPortalCustomDomainsClientListOptions added in v0.3.0 

type APIPortalCustomDomainsClientListOptions struct {
}

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

type APIPortalCustomDomainsClientListResponse added in v0.3.0 

type APIPortalCustomDomainsClientListResponse struct {
	APIPortalCustomDomainResourceCollection
}

APIPortalCustomDomainsClientListResponse contains the response from method APIPortalCustomDomainsClient.List.

type APIPortalInstance added in v0.3.0 

type APIPortalInstance struct {
	// READ-ONLY; Name of the API portal instance
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Status of the API portal instance
	Status *string `json:"status,omitempty" azure:"ro"`
}

APIPortalInstance - Collection of instances belong to the API portal

type APIPortalProperties added in v0.3.0 

type APIPortalProperties struct {
	// The array of resource Ids of gateway to integrate with API portal.
	GatewayIDs []*string `json:"gatewayIds,omitempty"`

	// Indicate if only https is allowed.
	HTTPSOnly *bool `json:"httpsOnly,omitempty"`

	// Indicates whether the API portal exposes endpoint.
	Public *bool `json:"public,omitempty"`

	// Collection of OpenAPI source URL locations.
	SourceUrls []*string `json:"sourceUrls,omitempty"`

	// Single sign-on related configuration
	SsoProperties *SsoProperties `json:"ssoProperties,omitempty"`

	// READ-ONLY; Collection of instances belong to API portal.
	Instances []*APIPortalInstance `json:"instances,omitempty" azure:"ro"`

	// READ-ONLY; State of the API portal.
	ProvisioningState *APIPortalProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *APIPortalResourceRequests `json:"resourceRequests,omitempty" azure:"ro"`

	// READ-ONLY; URL of the API portal, exposed when 'public' is true.
	URL *string `json:"url,omitempty" azure:"ro"`
}

APIPortalProperties - API portal properties payload

func (APIPortalProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalProperties.

type APIPortalProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleAPIPortalProvisioningStateValues() []APIPortalProvisioningState

PossibleAPIPortalProvisioningStateValues returns the possible values for the APIPortalProvisioningState const type.

type APIPortalResource added in v0.3.0 

type APIPortalResource struct {
	// API portal properties payload
	Properties *APIPortalProperties `json:"properties,omitempty"`

	// Sku of the API portal resource
	SKU *SKU `json:"sku,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

APIPortalResource - API portal resource

type APIPortalResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of API portal resources
	Value []*APIPortalResource `json:"value,omitempty"`
}

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

func (APIPortalResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type APIPortalResourceCollection.

type APIPortalResourceRequests added in v0.3.0 

type APIPortalResourceRequests struct {
	// READ-ONLY; Cpu allocated to each API portal instance
	CPU *string `json:"cpu,omitempty" azure:"ro"`

	// READ-ONLY; Memory allocated to each API portal instance
	Memory *string `json:"memory,omitempty" azure:"ro"`
}

APIPortalResourceRequests - Resource requests of the API portal

type APIPortalsClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *APIPortalsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiPortalName string, apiPortalResource APIPortalResource, options *APIPortalsClientBeginCreateOrUpdateOptions) (*armruntime.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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortals_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		armappplatform.APIPortalResource{
			Properties: &armappplatform.APIPortalProperties{
				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("<name>"),
				Capacity: to.Ptr[int32](2),
				Tier:     to.Ptr("<tier>"),
			},
		},
		&armappplatform.APIPortalsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*APIPortalsClient) BeginDelete added in v0.3.0 

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

BeginDelete - Delete the default API portal. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortals_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		&armappplatform.APIPortalsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*APIPortalsClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortals_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*APIPortalsClient) NewListPager added in v0.5.0 

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

NewListPager - Handles requests to list all resources in a Service. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortals_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*APIPortalsClient) ValidateDomain added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ApiPortals_ValidateDomain.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAPIPortalsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ValidateDomain(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<api-portal-name>",
		armappplatform.CustomDomainValidatePayload{
			Name: to.Ptr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type APIPortalsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type APIPortalsClientBeginDeleteOptions added in v0.3.0 

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

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

type APIPortalsClientCreateOrUpdateResponse added in v0.3.0 

type APIPortalsClientCreateOrUpdateResponse struct {
	APIPortalResource
}

APIPortalsClientCreateOrUpdateResponse contains the response from method APIPortalsClient.CreateOrUpdate.

type APIPortalsClientDeleteResponse added in v0.3.0 

type APIPortalsClientDeleteResponse struct {
}

APIPortalsClientDeleteResponse contains the response from method APIPortalsClient.Delete.

type APIPortalsClientGetOptions added in v0.3.0 

type APIPortalsClientGetOptions struct {
}

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

type APIPortalsClientGetResponse added in v0.3.0 

type APIPortalsClientGetResponse struct {
	APIPortalResource
}

APIPortalsClientGetResponse contains the response from method APIPortalsClient.Get.

type APIPortalsClientListOptions added in v0.3.0 

type APIPortalsClientListOptions struct {
}

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

type APIPortalsClientListResponse added in v0.3.0 

type APIPortalsClientListResponse struct {
	APIPortalResourceCollection
}

APIPortalsClientListResponse contains the response from method APIPortalsClient.List.

type APIPortalsClientValidateDomainOptions added in v0.3.0 

type APIPortalsClientValidateDomainOptions struct {
}

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

type APIPortalsClientValidateDomainResponse added in v0.3.0 

type APIPortalsClientValidateDomainResponse struct {
	CustomDomainValidateResult
}

APIPortalsClientValidateDomainResponse contains the response from method APIPortalsClient.ValidateDomain.

type ActionType added in v0.4.0 

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 added in v0.4.0 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ActiveDeploymentCollection added in v0.3.0 

type ActiveDeploymentCollection struct {
	// Collection of Deployment name.
	ActiveDeploymentNames []*string `json:"activeDeploymentNames,omitempty"`
}

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

func (ActiveDeploymentCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type ActiveDeploymentCollection.

type AppResource 

type AppResource struct {
	// The Managed Identity type of the app resource
	Identity *ManagedIdentityProperties `json:"identity,omitempty"`

	// The GEO location of the application, always the same with its parent resource
	Location *string `json:"location,omitempty"`

	// Properties of the App resource
	Properties *AppResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

AppResource - App resource payload

func (AppResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 `json:"nextLink,omitempty"`

	// Collection of App resources
	Value []*AppResource `json:"value,omitempty"`
}

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.

type AppResourceProperties 

type AppResourceProperties struct {
	// Collection of addons
	AddonConfigs map[string]map[string]interface{} `json:"addonConfigs,omitempty"`

	// List of custom persistent disks
	CustomPersistentDisks []*CustomPersistentDiskResource `json:"customPersistentDisks,omitempty"`

	// Indicate if end to end TLS is enabled.
	EnableEndToEndTLS *bool `json:"enableEndToEndTLS,omitempty"`

	// Fully qualified dns Name.
	Fqdn *string `json:"fqdn,omitempty"`

	// Indicate if only https is allowed.
	HTTPSOnly *bool `json:"httpsOnly,omitempty"`

	// Collection of loaded certificates
	LoadedCertificates []*LoadedCertificate `json:"loadedCertificates,omitempty"`

	// Persistent disk settings
	PersistentDisk *PersistentDisk `json:"persistentDisk,omitempty"`

	// Indicates whether the App exposes public endpoint
	Public *bool `json:"public,omitempty"`

	// Temporary disk settings
	TemporaryDisk *TemporaryDisk `json:"temporaryDisk,omitempty"`

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

	// READ-ONLY; URL of the App
	URL *string `json:"url,omitempty" azure:"ro"`
}

AppResourceProperties - App resource properties payload

func (AppResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 ApplicationInsightsAgentVersions 

type ApplicationInsightsAgentVersions struct {
	// READ-ONLY; Indicates the version of application insight java agent
	Java *string `json:"java,omitempty" azure:"ro"`
}

ApplicationInsightsAgentVersions - Application Insights agent versions properties payload

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) (*armruntime.Poller[AppsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a new App or update an exiting App. If the operation fails it returns an *azcore.ResponseError type. 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		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("<location>"),
			Properties: &armappplatform.AppResourceProperties{
				AddonConfigs: map[string]map[string]interface{}{
					"ApplicationConfigurationService": {
						"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configurationServices/myacs",
					},
					"ServiceRegistry": {
						"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("<mount-path>"),
							ShareName: to.Ptr("<share-name>"),
						},
						StorageID: to.Ptr("<storage-id>"),
					}},
				EnableEndToEndTLS: to.Ptr(false),
				Fqdn:              to.Ptr("<fqdn>"),
				HTTPSOnly:         to.Ptr(false),
				LoadedCertificates: []*armappplatform.LoadedCertificate{
					{
						LoadTrustStore: to.Ptr(false),
						ResourceID:     to.Ptr("<resource-id>"),
					},
					{
						LoadTrustStore: to.Ptr(true),
						ResourceID:     to.Ptr("<resource-id>"),
					}},
				PersistentDisk: &armappplatform.PersistentDisk{
					MountPath: to.Ptr("<mount-path>"),
					SizeInGB:  to.Ptr[int32](2),
				},
				Public: to.Ptr(true),
				TemporaryDisk: &armappplatform.TemporaryDisk{
					MountPath: to.Ptr("<mount-path>"),
					SizeInGB:  to.Ptr[int32](2),
				},
			},
		},
		&armappplatform.AppsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppsClient) BeginDelete 

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

BeginDelete - Operation to delete an App. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		&armappplatform.AppsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*AppsClient) BeginSetActiveDeployments added in v0.3.0 

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

BeginSetActiveDeployments - Set existing Deployment under the app as active If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_SetActiveDeployments.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginSetActiveDeployments(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		armappplatform.ActiveDeploymentCollection{
			ActiveDeploymentNames: []*string{
				to.Ptr("default")},
		},
		&armappplatform.AppsClientBeginSetActiveDeploymentsOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AppsClient) BeginUpdate 

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

BeginUpdate - Operation to update an exiting App. If the operation fails it returns an *azcore.ResponseError type. 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_Update.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		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("<location>"),
			Properties: &armappplatform.AppResourceProperties{
				CustomPersistentDisks: []*armappplatform.CustomPersistentDiskResource{
					{
						CustomPersistentDiskProperties: &armappplatform.AzureFileVolume{
							Type:         to.Ptr(armappplatform.TypeAzureFileVolume),
							MountOptions: []*string{},
							MountPath:    to.Ptr("<mount-path>"),
							ShareName:    to.Ptr("<share-name>"),
						},
						StorageID: to.Ptr("<storage-id>"),
					}},
				EnableEndToEndTLS: to.Ptr(false),
				Fqdn:              to.Ptr("<fqdn>"),
				HTTPSOnly:         to.Ptr(false),
				PersistentDisk: &armappplatform.PersistentDisk{
					MountPath: to.Ptr("<mount-path>"),
					SizeInGB:  to.Ptr[int32](2),
				},
				Public: to.Ptr(true),
				TemporaryDisk: &armappplatform.TemporaryDisk{
					MountPath: to.Ptr("<mount-path>"),
					SizeInGB:  to.Ptr[int32](2),
				},
			},
		},
		&armappplatform.AppsClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		&armappplatform.AppsClientGetOptions{SyncStatus: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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

func (*AppsClient) NewListPager added in v0.5.0 

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

NewListPager - Handles requests to list all resources in a Service. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Apps_ValidateDomain.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewAppsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ValidateDomain(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		armappplatform.CustomDomainValidatePayload{
			Name: to.Ptr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type AppsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type AppsClientBeginDeleteOptions added in v0.3.0 

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

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

type AppsClientBeginSetActiveDeploymentsOptions added in v0.3.0 

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

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

type AppsClientBeginUpdateOptions added in v0.3.0 

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

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

type AppsClientCreateOrUpdateResponse added in v0.3.0 

type AppsClientCreateOrUpdateResponse struct {
	AppResource
}

AppsClientCreateOrUpdateResponse contains the response from method AppsClient.CreateOrUpdate.

type AppsClientDeleteResponse added in v0.3.0 

type AppsClientDeleteResponse struct {
}

AppsClientDeleteResponse contains the response from method AppsClient.Delete.

type AppsClientGetOptions added in v0.3.0 

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

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

type AppsClientGetResourceUploadURLOptions added in v0.3.0 

type AppsClientGetResourceUploadURLOptions struct {
}

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

type AppsClientGetResourceUploadURLResponse added in v0.3.0 

type AppsClientGetResourceUploadURLResponse struct {
	ResourceUploadDefinition
}

AppsClientGetResourceUploadURLResponse contains the response from method AppsClient.GetResourceUploadURL.

type AppsClientGetResponse added in v0.3.0 

type AppsClientGetResponse struct {
	AppResource
}

AppsClientGetResponse contains the response from method AppsClient.Get.

type AppsClientListOptions added in v0.3.0 

type AppsClientListOptions struct {
}

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

type AppsClientListResponse added in v0.3.0 

type AppsClientListResponse struct {
	AppResourceCollection
}

AppsClientListResponse contains the response from method AppsClient.List.

type AppsClientSetActiveDeploymentsResponse added in v0.3.0 

type AppsClientSetActiveDeploymentsResponse struct {
	AppResource
}

AppsClientSetActiveDeploymentsResponse contains the response from method AppsClient.SetActiveDeployments.

type AppsClientUpdateResponse added in v0.3.0 

type AppsClientUpdateResponse struct {
	AppResource
}

AppsClientUpdateResponse contains the response from method AppsClient.Update.

type AppsClientValidateDomainOptions added in v0.3.0 

type AppsClientValidateDomainOptions struct {
}

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

type AppsClientValidateDomainResponse added in v0.3.0 

type AppsClientValidateDomainResponse struct {
	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 `json:"nextLink,omitempty"`

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

AvailableOperations - Available operations of the service

func (AvailableOperations) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableOperations.

type AvailableRuntimeVersions 

type AvailableRuntimeVersions struct {
	// READ-ONLY; A list of all supported runtime versions.
	Value []*SupportedRuntimeVersion `json:"value,omitempty" azure:"ro"`
}

func (AvailableRuntimeVersions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AvailableRuntimeVersions.

type AzureFileVolume added in v0.2.0 

type AzureFileVolume struct {
	// REQUIRED; The mount path of the persistent disk.
	MountPath *string `json:"mountPath,omitempty"`

	// REQUIRED; The share name of the Azure File share.
	ShareName *string `json:"shareName,omitempty"`

	// REQUIRED; The type of the underlying resource to mount as a persistent disk.
	Type *Type `json:"type,omitempty"`

	// These are the mount options for a persistent disk.
	MountOptions []*string `json:"mountOptions,omitempty"`

	// Indicates whether the persistent disk is a readOnly one.
	ReadOnly *bool `json:"readOnly,omitempty"`
}

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

func (*AzureFileVolume) GetCustomPersistentDiskProperties added in v0.3.0 

func (a *AzureFileVolume) GetCustomPersistentDiskProperties() *CustomPersistentDiskProperties

GetCustomPersistentDiskProperties implements the CustomPersistentDiskPropertiesClassification interface for type AzureFileVolume.

func (AzureFileVolume) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type AzureFileVolume.

func (*AzureFileVolume) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFileVolume.

type BindingResource 

type BindingResource struct {
	// Properties of the Binding resource
	Properties *BindingResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BindingResource - Binding resource payload

func (BindingResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 `json:"nextLink,omitempty"`

	// Collection of Binding resources
	Value []*BindingResource `json:"value,omitempty"`
}

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.

type BindingResourceProperties 

type BindingResourceProperties struct {
	// Binding parameters of the Binding resource
	BindingParameters map[string]interface{} `json:"bindingParameters,omitempty"`

	// The key of the bound resource
	Key *string `json:"key,omitempty"`

	// The Azure resource id of the bound resource
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Creation time of the Binding resource
	CreatedAt *string `json:"createdAt,omitempty" azure:"ro"`

	// READ-ONLY; The generated Spring Boot property file for this binding. The secret will be deducted.
	GeneratedProperties *string `json:"generatedProperties,omitempty" azure:"ro"`

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

	// READ-ONLY; The standard Azure resource type of the bound resource
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; Update time of the Binding resource
	UpdatedAt *string `json:"updatedAt,omitempty" azure:"ro"`
}

BindingResourceProperties - Binding resource properties payload

func (BindingResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BindingResourceProperties.

type BindingType added in v0.3.0 

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 added in v0.3.0 

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) (*armruntime.Poller[BindingsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a new Binding or update an exiting Binding. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Bindings_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBindingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<binding-name>",
		armappplatform.BindingResource{
			Properties: &armappplatform.BindingResourceProperties{
				BindingParameters: map[string]interface{}{
					"apiType":      "SQL",
					"databaseName": "db1",
				},
				Key:        to.Ptr("<key>"),
				ResourceID: to.Ptr("<resource-id>"),
			},
		},
		&armappplatform.BindingsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BindingsClient) BeginDelete 

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

BeginDelete - Operation to delete a Binding. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Bindings_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBindingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<binding-name>",
		&armappplatform.BindingsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*BindingsClient) BeginUpdate 

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

BeginUpdate - Operation to update an exiting Binding. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Bindings_Update.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBindingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<binding-name>",
		armappplatform.BindingResource{
			Properties: &armappplatform.BindingResourceProperties{
				BindingParameters: map[string]interface{}{
					"apiType":      "SQL",
					"databaseName": "db1",
				},
				Key: to.Ptr("<key>"),
			},
		},
		&armappplatform.BindingsClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Bindings_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBindingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<binding-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BindingsClient) NewListPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Bindings_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBindingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<app-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type BindingsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type BindingsClientBeginDeleteOptions added in v0.3.0 

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

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

type BindingsClientBeginUpdateOptions added in v0.3.0 

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

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

type BindingsClientCreateOrUpdateResponse added in v0.3.0 

type BindingsClientCreateOrUpdateResponse struct {
	BindingResource
}

BindingsClientCreateOrUpdateResponse contains the response from method BindingsClient.CreateOrUpdate.

type BindingsClientDeleteResponse added in v0.3.0 

type BindingsClientDeleteResponse struct {
}

BindingsClientDeleteResponse contains the response from method BindingsClient.Delete.

type BindingsClientGetOptions added in v0.3.0 

type BindingsClientGetOptions struct {
}

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

type BindingsClientGetResponse added in v0.3.0 

type BindingsClientGetResponse struct {
	BindingResource
}

BindingsClientGetResponse contains the response from method BindingsClient.Get.

type BindingsClientListOptions added in v0.3.0 

type BindingsClientListOptions struct {
}

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

type BindingsClientListResponse added in v0.3.0 

type BindingsClientListResponse struct {
	BindingResourceCollection
}

BindingsClientListResponse contains the response from method BindingsClient.List.

type BindingsClientUpdateResponse added in v0.3.0 

type BindingsClientUpdateResponse struct {
	BindingResource
}

BindingsClientUpdateResponse contains the response from method BindingsClient.Update.

type Build added in v0.3.0 

type Build struct {
	// Properties of the build resource
	Properties *BuildProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Build resource payload

type BuildCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Build resources
	Value []*Build `json:"value,omitempty"`
}

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

func (BuildCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildCollection.

type BuildProperties added in v0.3.0 

type BuildProperties struct {
	// The resource id of agent pool
	AgentPool *string `json:"agentPool,omitempty"`

	// The resource id of builder to build the source code
	Builder *string `json:"builder,omitempty"`

	// The environment variables for this build
	Env map[string]*string `json:"env,omitempty"`

	// The relative path of source code
	RelativePath *string `json:"relativePath,omitempty"`

	// READ-ONLY; Provisioning state of the KPack build result
	ProvisioningState *BuildProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The build result triggered by this build
	TriggeredBuildResult *TriggeredBuildResult `json:"triggeredBuildResult,omitempty" azure:"ro"`
}

BuildProperties - Build resource properties payload

func (BuildProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildProperties.

type BuildProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleBuildProvisioningStateValues() []BuildProvisioningState

PossibleBuildProvisioningStateValues returns the possible values for the BuildProvisioningState const type.

type BuildResult added in v0.3.0 

type BuildResult struct {
	// Properties of the build result resource
	Properties *BuildResultProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BuildResult - Build result resource payload

type BuildResultCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Build result resources
	Value []*BuildResult `json:"value,omitempty"`
}

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

func (BuildResultCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultCollection.

type BuildResultLog added in v0.3.0 

type BuildResultLog struct {
	// The public download URL of this build result log
	BlobURL *string `json:"blobUrl,omitempty"`
}

BuildResultLog - Build result log resource properties payload

type BuildResultProperties added in v0.3.0 

type BuildResultProperties struct {
	// The build pod name which can be used to get the build log streaming.
	BuildPodName *string `json:"buildPodName,omitempty"`

	// The name of this build result
	Name *string `json:"name,omitempty"`

	// READ-ONLY; All of the build stage (init-container and container) resources in build pod.
	BuildStages []*BuildStageProperties `json:"buildStages,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the KPack build result
	ProvisioningState *BuildResultProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BuildResultProperties - Build result resource properties payload

func (BuildResultProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultProperties.

type BuildResultProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleBuildResultProvisioningStateValues() []BuildResultProvisioningState

PossibleBuildResultProvisioningStateValues returns the possible values for the BuildResultProvisioningState const type.

type BuildResultUserSourceInfo added in v0.3.0 

type BuildResultUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// Resource id of an existing succeeded build result under the same Spring instance.
	BuildResultID *string `json:"buildResultId,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

BuildResultUserSourceInfo - Reference to a build result

func (*BuildResultUserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (b *BuildResultUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type BuildResultUserSourceInfo.

func (BuildResultUserSourceInfo) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildResultUserSourceInfo.

func (*BuildResultUserSourceInfo) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildResultUserSourceInfo.

type BuildService added in v0.3.0 

type BuildService struct {
	// Properties of the build resource
	Properties *BuildServiceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BuildService - Build service resource payload

type BuildServiceAgentPoolClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

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

BeginUpdatePut - Create or update build service agent pool. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceAgentPool_UpdatePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceAgentPoolClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdatePut(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<agent-pool-name>",
		armappplatform.BuildServiceAgentPoolResource{
			Properties: &armappplatform.BuildServiceAgentPoolProperties{
				PoolSize: &armappplatform.BuildServiceAgentPoolSizeProperties{
					Name: to.Ptr("<name>"),
				},
			},
		},
		&armappplatform.BuildServiceAgentPoolClientBeginUpdatePutOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceAgentPoolClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceAgentPool_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceAgentPoolClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<agent-pool-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceAgentPoolClient) NewListPager added in v0.5.0 

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

NewListPager - List build service agent pool. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceAgentPool_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceAgentPoolClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type BuildServiceAgentPoolClientBeginUpdatePutOptions added in v0.3.0 

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

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

type BuildServiceAgentPoolClientGetOptions added in v0.3.0 

type BuildServiceAgentPoolClientGetOptions struct {
}

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

type BuildServiceAgentPoolClientGetResponse added in v0.3.0 

type BuildServiceAgentPoolClientGetResponse struct {
	BuildServiceAgentPoolResource
}

BuildServiceAgentPoolClientGetResponse contains the response from method BuildServiceAgentPoolClient.Get.

type BuildServiceAgentPoolClientListOptions added in v0.3.0 

type BuildServiceAgentPoolClientListOptions struct {
}

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

type BuildServiceAgentPoolClientListResponse added in v0.3.0 

type BuildServiceAgentPoolClientListResponse struct {
	BuildServiceAgentPoolResourceCollection
}

BuildServiceAgentPoolClientListResponse contains the response from method BuildServiceAgentPoolClient.List.

type BuildServiceAgentPoolClientUpdatePutResponse added in v0.3.0 

type BuildServiceAgentPoolClientUpdatePutResponse struct {
	BuildServiceAgentPoolResource
}

BuildServiceAgentPoolClientUpdatePutResponse contains the response from method BuildServiceAgentPoolClient.UpdatePut.

type BuildServiceAgentPoolProperties added in v0.3.0 

type BuildServiceAgentPoolProperties struct {
	// build service agent pool size properties
	PoolSize *BuildServiceAgentPoolSizeProperties `json:"poolSize,omitempty"`

	// READ-ONLY; Provisioning state of the build service agent pool
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

BuildServiceAgentPoolProperties - Build service agent pool properties

type BuildServiceAgentPoolResource added in v0.3.0 

type BuildServiceAgentPoolResource struct {
	// build service agent pool properties
	Properties *BuildServiceAgentPoolProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BuildServiceAgentPoolResource - The build service agent pool resource

type BuildServiceAgentPoolResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of build service agent pool resource
	Value []*BuildServiceAgentPoolResource `json:"value,omitempty"`
}

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

func (BuildServiceAgentPoolResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceAgentPoolResourceCollection.

type BuildServiceAgentPoolSizeProperties added in v0.3.0 

type BuildServiceAgentPoolSizeProperties struct {
	// The name of build service agent pool size
	Name *string `json:"name,omitempty"`

	// READ-ONLY; The cpu property of build service agent pool size
	CPU *string `json:"cpu,omitempty" azure:"ro"`

	// READ-ONLY; The memory property of build service agent pool size
	Memory *string `json:"memory,omitempty" azure:"ro"`
}

BuildServiceAgentPoolSizeProperties - Build service agent pool size properties

type BuildServiceBuilderClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

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

BeginCreateOrUpdate - Create or update a KPack builder. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceBuilder_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceBuilderClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		armappplatform.BuilderResource{
			Properties: &armappplatform.BuilderProperties{
				BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
					{
						Name: to.Ptr("<name>"),
						Buildpacks: []*armappplatform.BuildpackProperties{
							{
								ID: to.Ptr("<id>"),
							}},
					}},
				Stack: &armappplatform.StackProperties{
					ID:      to.Ptr("<id>"),
					Version: to.Ptr("<version>"),
				},
			},
		},
		&armappplatform.BuildServiceBuilderClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceBuilderClient) BeginDelete added in v0.3.0 

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

BeginDelete - Delete a KPack builder. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceBuilder_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceBuilderClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		&armappplatform.BuildServiceBuilderClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*BuildServiceBuilderClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceBuilder_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceBuilderClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceBuilderClient) NewListPager added in v0.5.0 

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

NewListPager - List KPack builders result. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildServiceBuilder_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceBuilderClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type BuildServiceBuilderClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type BuildServiceBuilderClientBeginDeleteOptions added in v0.3.0 

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

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

type BuildServiceBuilderClientCreateOrUpdateResponse added in v0.3.0 

type BuildServiceBuilderClientCreateOrUpdateResponse struct {
	BuilderResource
}

BuildServiceBuilderClientCreateOrUpdateResponse contains the response from method BuildServiceBuilderClient.CreateOrUpdate.

type BuildServiceBuilderClientDeleteResponse added in v0.3.0 

type BuildServiceBuilderClientDeleteResponse struct {
}

BuildServiceBuilderClientDeleteResponse contains the response from method BuildServiceBuilderClient.Delete.

type BuildServiceBuilderClientGetOptions added in v0.3.0 

type BuildServiceBuilderClientGetOptions struct {
}

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

type BuildServiceBuilderClientGetResponse added in v0.3.0 

type BuildServiceBuilderClientGetResponse struct {
	BuilderResource
}

BuildServiceBuilderClientGetResponse contains the response from method BuildServiceBuilderClient.Get.

type BuildServiceBuilderClientListOptions added in v0.3.0 

type BuildServiceBuilderClientListOptions struct {
}

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

type BuildServiceBuilderClientListResponse added in v0.3.0 

type BuildServiceBuilderClientListResponse struct {
	BuilderResourceCollection
}

BuildServiceBuilderClientListResponse contains the response from method BuildServiceBuilderClient.List.

type BuildServiceClient added in v0.3.0 

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 added in v0.3.0 

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) CreateOrUpdateBuild added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_CreateOrUpdateBuild.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.CreateOrUpdateBuild(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<build-name>",
		armappplatform.Build{
			Properties: &armappplatform.BuildProperties{
				AgentPool: to.Ptr("<agent-pool>"),
				Builder:   to.Ptr("<builder>"),
				Env: map[string]*string{
					"environmentVariable": to.Ptr("test"),
				},
				RelativePath: to.Ptr("<relative-path>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) GetBuild added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_GetBuild.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetBuild(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<build-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) GetBuildResult added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_GetBuildResult.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetBuildResult(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<build-name>",
		"<build-result-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) GetBuildResultLog added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_GetBuildResultLog.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetBuildResultLog(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<build-name>",
		"<build-result-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) GetBuildService added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_GetBuildService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetBuildService(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) GetResourceUploadURL added in v0.3.0 

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

func (*BuildServiceClient) GetSupportedBuildpack added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_GetSupportedBuildpack.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetSupportedBuildpack(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<buildpack-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) GetSupportedStack added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_GetSupportedStack.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.GetSupportedStack(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<stack-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) ListSupportedBuildpacks added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_ListSupportedBuildpacks.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListSupportedBuildpacks(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) ListSupportedStacks added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_ListSupportedStacks.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListSupportedStacks(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildServiceClient) NewListBuildResultsPager added in v0.5.0 

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

NewListBuildResultsPager - List KPack build results. If the operation fails it returns an *azcore.ResponseError type. 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.ListBuildResults method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_ListBuildResults.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListBuildResultsPager("<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<build-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*BuildServiceClient) NewListBuildServicesPager added in v0.5.0 

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

NewListBuildServicesPager - List build services resource. If the operation fails it returns an *azcore.ResponseError type. 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.ListBuildServices method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_ListBuildServices.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListBuildServicesPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*BuildServiceClient) NewListBuildsPager added in v0.5.0 

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

NewListBuildsPager - List KPack builds. If the operation fails it returns an *azcore.ResponseError type. 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.ListBuilds method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildService_ListBuilds.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildServiceClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListBuildsPager("<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type BuildServiceClientCreateOrUpdateBuildOptions added in v0.3.0 

type BuildServiceClientCreateOrUpdateBuildOptions struct {
}

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

type BuildServiceClientCreateOrUpdateBuildResponse added in v0.3.0 

type BuildServiceClientCreateOrUpdateBuildResponse struct {
	Build
}

BuildServiceClientCreateOrUpdateBuildResponse contains the response from method BuildServiceClient.CreateOrUpdateBuild.

type BuildServiceClientGetBuildOptions added in v0.3.0 

type BuildServiceClientGetBuildOptions struct {
}

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

type BuildServiceClientGetBuildResponse added in v0.3.0 

type BuildServiceClientGetBuildResponse struct {
	Build
}

BuildServiceClientGetBuildResponse contains the response from method BuildServiceClient.GetBuild.

type BuildServiceClientGetBuildResultLogOptions added in v0.3.0 

type BuildServiceClientGetBuildResultLogOptions struct {
}

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

type BuildServiceClientGetBuildResultLogResponse added in v0.3.0 

type BuildServiceClientGetBuildResultLogResponse struct {
	BuildResultLog
}

BuildServiceClientGetBuildResultLogResponse contains the response from method BuildServiceClient.GetBuildResultLog.

type BuildServiceClientGetBuildResultOptions added in v0.3.0 

type BuildServiceClientGetBuildResultOptions struct {
}

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

type BuildServiceClientGetBuildResultResponse added in v0.3.0 

type BuildServiceClientGetBuildResultResponse struct {
	BuildResult
}

BuildServiceClientGetBuildResultResponse contains the response from method BuildServiceClient.GetBuildResult.

type BuildServiceClientGetBuildServiceOptions added in v0.3.0 

type BuildServiceClientGetBuildServiceOptions struct {
}

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

type BuildServiceClientGetBuildServiceResponse added in v0.3.0 

type BuildServiceClientGetBuildServiceResponse struct {
	BuildService
}

BuildServiceClientGetBuildServiceResponse contains the response from method BuildServiceClient.GetBuildService.

type BuildServiceClientGetResourceUploadURLOptions added in v0.3.0 

type BuildServiceClientGetResourceUploadURLOptions struct {
}

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

type BuildServiceClientGetResourceUploadURLResponse added in v0.3.0 

type BuildServiceClientGetResourceUploadURLResponse struct {
	ResourceUploadDefinition
}

BuildServiceClientGetResourceUploadURLResponse contains the response from method BuildServiceClient.GetResourceUploadURL.

type BuildServiceClientGetSupportedBuildpackOptions added in v0.3.0 

type BuildServiceClientGetSupportedBuildpackOptions struct {
}

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

type BuildServiceClientGetSupportedBuildpackResponse added in v0.3.0 

type BuildServiceClientGetSupportedBuildpackResponse struct {
	SupportedBuildpackResource
}

BuildServiceClientGetSupportedBuildpackResponse contains the response from method BuildServiceClient.GetSupportedBuildpack.

type BuildServiceClientGetSupportedStackOptions added in v0.3.0 

type BuildServiceClientGetSupportedStackOptions struct {
}

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

type BuildServiceClientGetSupportedStackResponse added in v0.3.0 

type BuildServiceClientGetSupportedStackResponse struct {
	SupportedStackResource
}

BuildServiceClientGetSupportedStackResponse contains the response from method BuildServiceClient.GetSupportedStack.

type BuildServiceClientListBuildResultsOptions added in v0.3.0 

type BuildServiceClientListBuildResultsOptions struct {
}

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

type BuildServiceClientListBuildResultsResponse added in v0.3.0 

type BuildServiceClientListBuildResultsResponse struct {
	BuildResultCollection
}

BuildServiceClientListBuildResultsResponse contains the response from method BuildServiceClient.ListBuildResults.

type BuildServiceClientListBuildServicesOptions added in v0.3.0 

type BuildServiceClientListBuildServicesOptions struct {
}

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

type BuildServiceClientListBuildServicesResponse added in v0.3.0 

type BuildServiceClientListBuildServicesResponse struct {
	BuildServiceCollection
}

BuildServiceClientListBuildServicesResponse contains the response from method BuildServiceClient.ListBuildServices.

type BuildServiceClientListBuildsOptions added in v0.3.0 

type BuildServiceClientListBuildsOptions struct {
}

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

type BuildServiceClientListBuildsResponse added in v0.3.0 

type BuildServiceClientListBuildsResponse struct {
	BuildCollection
}

BuildServiceClientListBuildsResponse contains the response from method BuildServiceClient.ListBuilds.

type BuildServiceClientListSupportedBuildpacksOptions added in v0.3.0 

type BuildServiceClientListSupportedBuildpacksOptions struct {
}

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

type BuildServiceClientListSupportedBuildpacksResponse added in v0.3.0 

type BuildServiceClientListSupportedBuildpacksResponse struct {
	SupportedBuildpacksCollection
}

BuildServiceClientListSupportedBuildpacksResponse contains the response from method BuildServiceClient.ListSupportedBuildpacks.

type BuildServiceClientListSupportedStacksOptions added in v0.3.0 

type BuildServiceClientListSupportedStacksOptions struct {
}

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

type BuildServiceClientListSupportedStacksResponse added in v0.3.0 

type BuildServiceClientListSupportedStacksResponse struct {
	SupportedStacksCollection
}

BuildServiceClientListSupportedStacksResponse contains the response from method BuildServiceClient.ListSupportedStacks.

type BuildServiceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Build service resources
	Value []*BuildService `json:"value,omitempty"`
}

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

func (BuildServiceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildServiceCollection.

type BuildServiceProperties added in v0.3.0 

type BuildServiceProperties struct {
	// The installed KPack version in this build service.
	KPackVersion *string `json:"kPackVersion,omitempty"`

	// The runtime resource configuration of this build service.
	ResourceRequests *BuildServicePropertiesResourceRequests `json:"resourceRequests,omitempty"`

	// READ-ONLY; Provisioning state of the KPack build result
	ProvisioningState *BuildServiceProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BuildServiceProperties - Build service resource properties payload

type BuildServicePropertiesResourceRequests added in v0.3.0 

type BuildServicePropertiesResourceRequests struct {
	// READ-ONLY; vCPU allocated to the entire build service node pool.
	CPU *string `json:"cpu,omitempty" azure:"ro"`

	// READ-ONLY; Memory allocated to the entire build service node pool.
	Memory *string `json:"memory,omitempty" azure:"ro"`
}

BuildServicePropertiesResourceRequests - The runtime resource configuration of this build service.

type BuildServiceProvisioningState added in v0.3.0 

type BuildServiceProvisioningState string

BuildServiceProvisioningState - Provisioning state of the KPack build result 

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

func PossibleBuildServiceProvisioningStateValues added in v0.3.0 

func PossibleBuildServiceProvisioningStateValues() []BuildServiceProvisioningState

PossibleBuildServiceProvisioningStateValues returns the possible values for the BuildServiceProvisioningState const type.

type BuildStageProperties added in v0.3.0 

type BuildStageProperties struct {
	// READ-ONLY; The name of this build stage resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of this build stage resource.
	Status *KPackBuildStageProvisioningState `json:"status,omitempty" azure:"ro"`
}

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

type BuilderProperties added in v0.3.0 

type BuilderProperties struct {
	// Builder buildpack groups.
	BuildpackGroups []*BuildpacksGroupProperties `json:"buildpackGroups,omitempty"`

	// Builder cluster stack property.
	Stack *StackProperties `json:"stack,omitempty"`

	// READ-ONLY; Builder provision status.
	ProvisioningState *BuilderProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BuilderProperties - KPack Builder properties payload

func (BuilderProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuilderProperties.

type BuilderProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleBuilderProvisioningStateValues() []BuilderProvisioningState

PossibleBuilderProvisioningStateValues returns the possible values for the BuilderProvisioningState const type.

type BuilderResource added in v0.3.0 

type BuilderResource struct {
	// Property of the Builder resource.
	Properties *BuilderProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BuilderResource - KPack Builder resource

type BuilderResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Builder resources
	Value []*BuilderResource `json:"value,omitempty"`
}

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

func (BuilderResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuilderResourceCollection.

type BuildpackBindingClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *BuildpackBindingClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, buildpackBindingName string, buildpackBinding BuildpackBindingResource, options *BuildpackBindingClientBeginCreateOrUpdateOptions) (*armruntime.Poller[BuildpackBindingClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a buildpack binding. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildpackBinding_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildpackBindingClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		"<buildpack-binding-name>",
		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"),
					},
				},
			},
		},
		&armappplatform.BuildpackBindingClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildpackBindingClient) BeginDelete added in v0.3.0 

func (client *BuildpackBindingClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, buildServiceName string, builderName string, buildpackBindingName string, options *BuildpackBindingClientBeginDeleteOptions) (*armruntime.Poller[BuildpackBindingClientDeleteResponse], error)

BeginDelete - Operation to delete a Buildpack Binding If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildpackBinding_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildpackBindingClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		"<buildpack-binding-name>",
		&armappplatform.BuildpackBindingClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*BuildpackBindingClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildpackBinding_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildpackBindingClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		"<buildpack-binding-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*BuildpackBindingClient) NewListPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/BuildpackBinding_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewBuildpackBindingClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<build-service-name>",
		"<builder-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type BuildpackBindingClientBeginCreateOrUpdateOptions added in v0.3.0 

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

BuildpackBindingClientBeginCreateOrUpdateOptions contains the optional parameters for the BuildpackBindingClient.BeginCreateOrUpdate method.

type BuildpackBindingClientBeginDeleteOptions added in v0.3.0 

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

BuildpackBindingClientBeginDeleteOptions contains the optional parameters for the BuildpackBindingClient.BeginDelete method.

type BuildpackBindingClientCreateOrUpdateResponse added in v0.3.0 

type BuildpackBindingClientCreateOrUpdateResponse struct {
	BuildpackBindingResource
}

BuildpackBindingClientCreateOrUpdateResponse contains the response from method BuildpackBindingClient.CreateOrUpdate.

type BuildpackBindingClientDeleteResponse added in v0.3.0 

type BuildpackBindingClientDeleteResponse struct {
}

BuildpackBindingClientDeleteResponse contains the response from method BuildpackBindingClient.Delete.

type BuildpackBindingClientGetOptions added in v0.3.0 

type BuildpackBindingClientGetOptions struct {
}

BuildpackBindingClientGetOptions contains the optional parameters for the BuildpackBindingClient.Get method.

type BuildpackBindingClientGetResponse added in v0.3.0 

type BuildpackBindingClientGetResponse struct {
	BuildpackBindingResource
}

BuildpackBindingClientGetResponse contains the response from method BuildpackBindingClient.Get.

type BuildpackBindingClientListOptions added in v0.3.0 

type BuildpackBindingClientListOptions struct {
}

BuildpackBindingClientListOptions contains the optional parameters for the BuildpackBindingClient.List method.

type BuildpackBindingClientListResponse added in v0.3.0 

type BuildpackBindingClientListResponse struct {
	BuildpackBindingResourceCollection
}

BuildpackBindingClientListResponse contains the response from method BuildpackBindingClient.List.

type BuildpackBindingLaunchProperties added in v0.3.0 

type BuildpackBindingLaunchProperties struct {
	// Non-sensitive properties for launchProperties
	Properties map[string]*string `json:"properties,omitempty"`

	// Sensitive properties for launchProperties
	Secrets map[string]*string `json:"secrets,omitempty"`
}

BuildpackBindingLaunchProperties - Buildpack Binding Launch Properties

func (BuildpackBindingLaunchProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackBindingLaunchProperties.

type BuildpackBindingProperties added in v0.3.0 

type BuildpackBindingProperties struct {
	// Buildpack Binding Type
	BindingType *BindingType `json:"bindingType,omitempty"`

	// The object describes the buildpack binding launch properties
	LaunchProperties *BuildpackBindingLaunchProperties `json:"launchProperties,omitempty"`

	// READ-ONLY; State of the Buildpack Binding.
	ProvisioningState *BuildpackBindingProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BuildpackBindingProperties - Properties of a buildpack binding

type BuildpackBindingProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleBuildpackBindingProvisioningStateValues() []BuildpackBindingProvisioningState

PossibleBuildpackBindingProvisioningStateValues returns the possible values for the BuildpackBindingProvisioningState const type.

type BuildpackBindingResource added in v0.3.0 

type BuildpackBindingResource struct {
	// Properties of a buildpack binding
	Properties *BuildpackBindingProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BuildpackBindingResource - Buildpack Binding Resource object

type BuildpackBindingResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of BuildpackBinding resources
	Value []*BuildpackBindingResource `json:"value,omitempty"`
}

BuildpackBindingResourceCollection - Object that includes an array of BuildpackBinding resources and a possible link for next set

func (BuildpackBindingResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildpackBindingResourceCollection.

type BuildpackProperties added in v0.3.0 

type BuildpackProperties struct {
	// Id of the buildpack
	ID *string `json:"id,omitempty"`
}

BuildpackProperties - Buildpack properties payload

type BuildpacksGroupProperties added in v0.3.0 

type BuildpacksGroupProperties struct {
	// Buildpacks in the buildpack group
	Buildpacks []*BuildpackProperties `json:"buildpacks,omitempty"`

	// Buildpack group name
	Name *string `json:"name,omitempty"`
}

BuildpacksGroupProperties - Buildpack group properties of the Builder

func (BuildpacksGroupProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type BuildpacksGroupProperties.

type CertificateProperties 

type CertificateProperties struct {
	// REQUIRED; The type of the certificate source.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; The activate date of certificate.
	ActivateDate *string `json:"activateDate,omitempty" azure:"ro"`

	// READ-ONLY; The domain list of certificate.
	DNSNames []*string `json:"dnsNames,omitempty" azure:"ro"`

	// READ-ONLY; The expiration date of certificate.
	ExpirationDate *string `json:"expirationDate,omitempty" azure:"ro"`

	// READ-ONLY; The issue date of certificate.
	IssuedDate *string `json:"issuedDate,omitempty" azure:"ro"`

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

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

	// READ-ONLY; The thumbprint of certificate.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`
}

CertificateProperties - Certificate resource payload.

func (*CertificateProperties) GetCertificateProperties added in v0.2.0 

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.

type CertificatePropertiesClassification added in v0.2.0 

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 CertificateResource 

type CertificateResource struct {
	// Properties of the certificate resource payload.
	Properties CertificatePropertiesClassification `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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 added in v0.2.0 

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 `json:"nextLink,omitempty"`

	// The certificate resources list.
	Value []*CertificateResource `json:"value,omitempty"`
}

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.

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) (*armruntime.Poller[CertificatesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update certificate resource. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Certificates_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCertificatesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<certificate-name>",
		armappplatform.CertificateResource{
			Properties: &armappplatform.KeyVaultCertificateProperties{
				Type:             to.Ptr("<type>"),
				CertVersion:      to.Ptr("<cert-version>"),
				KeyVaultCertName: to.Ptr("<key-vault-cert-name>"),
				VaultURI:         to.Ptr("<vault-uri>"),
			},
		},
		&armappplatform.CertificatesClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CertificatesClient) BeginDelete 

func (client *CertificatesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, certificateName string, options *CertificatesClientBeginDeleteOptions) (*armruntime.Poller[CertificatesClientDeleteResponse], error)

BeginDelete - Delete the certificate resource. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Certificates_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCertificatesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<certificate-name>",
		&armappplatform.CertificatesClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Certificates_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCertificatesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<certificate-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CertificatesClient) NewListPager added in v0.5.0 

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

NewListPager - List all the certificates of one user. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Certificates_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCertificatesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type CertificatesClientBeginCreateOrUpdateOptions added in v0.3.0 

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

CertificatesClientBeginCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.BeginCreateOrUpdate method.

type CertificatesClientBeginDeleteOptions added in v0.3.0 

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

CertificatesClientBeginDeleteOptions contains the optional parameters for the CertificatesClient.BeginDelete method.

type CertificatesClientCreateOrUpdateResponse added in v0.3.0 

type CertificatesClientCreateOrUpdateResponse struct {
	CertificateResource
}

CertificatesClientCreateOrUpdateResponse contains the response from method CertificatesClient.CreateOrUpdate.

type CertificatesClientDeleteResponse added in v0.3.0 

type CertificatesClientDeleteResponse struct {
}

CertificatesClientDeleteResponse contains the response from method CertificatesClient.Delete.

type CertificatesClientGetOptions added in v0.3.0 

type CertificatesClientGetOptions struct {
}

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

type CertificatesClientGetResponse added in v0.3.0 

type CertificatesClientGetResponse struct {
	CertificateResource
}

CertificatesClientGetResponse contains the response from method CertificatesClient.Get.

type CertificatesClientListOptions added in v0.3.0 

type CertificatesClientListOptions struct {
}

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

type CertificatesClientListResponse added in v0.3.0 

type CertificatesClientListResponse struct {
	CertificateResourceCollection
}

CertificatesClientListResponse contains the response from method CertificatesClient.List.

type CloudError 

type CloudError struct {
	// An error response from the service.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError - An error response from the service.

type CloudErrorBody 

type CloudErrorBody struct {
	// An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`

	// A list of additional details about the error.
	Details []*CloudErrorBody `json:"details,omitempty"`

	// A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`

	// The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
}

CloudErrorBody - An error response from the service.

func (CloudErrorBody) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudErrorBody.

type ClusterResourceProperties 

type ClusterResourceProperties struct {
	// Network profile of the Service
	NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
	ZoneRedundant  *bool           `json:"zoneRedundant,omitempty"`

	// READ-ONLY; Fully qualified dns name of the service instance
	Fqdn *string `json:"fqdn,omitempty" azure:"ro"`

	// READ-ONLY; Power state of the Service
	PowerState *PowerState `json:"powerState,omitempty" azure:"ro"`

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

	// READ-ONLY; ServiceInstanceEntity GUID which uniquely identifies a created resource
	ServiceID *string `json:"serviceId,omitempty" azure:"ro"`

	// READ-ONLY; Version of the Service
	Version *int32 `json:"version,omitempty" azure:"ro"`
}

ClusterResourceProperties - Service properties payload

type ConfigServerGitProperty 

type ConfigServerGitProperty struct {
	// REQUIRED; URI of the repository
	URI *string `json:"uri,omitempty"`

	// Public sshKey of git repository.
	HostKey *string `json:"hostKey,omitempty"`

	// SshKey algorithm of git repository.
	HostKeyAlgorithm *string `json:"hostKeyAlgorithm,omitempty"`

	// Label of the repository
	Label *string `json:"label,omitempty"`

	// Password of git repository basic auth.
	Password *string `json:"password,omitempty"`

	// Private sshKey algorithm of git repository.
	PrivateKey *string `json:"privateKey,omitempty"`

	// Repositories of git.
	Repositories []*GitPatternRepository `json:"repositories,omitempty"`

	// Searching path of the repository
	SearchPaths []*string `json:"searchPaths,omitempty"`

	// Strict host key checking or not.
	StrictHostKeyChecking *bool `json:"strictHostKeyChecking,omitempty"`

	// Username of git repository basic auth.
	Username *string `json:"username,omitempty"`
}

ConfigServerGitProperty - Property of git.

func (ConfigServerGitProperty) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerGitProperty.

type ConfigServerProperties 

type ConfigServerProperties struct {
	// Settings of config server.
	ConfigServer *ConfigServerSettings `json:"configServer,omitempty"`

	// Error when apply config server settings.
	Error *Error `json:"error,omitempty"`

	// READ-ONLY; State of the config server.
	ProvisioningState *ConfigServerState `json:"provisioningState,omitempty" azure:"ro"`
}

ConfigServerProperties - Config server git properties payload

type ConfigServerResource 

type ConfigServerResource struct {
	// Properties of the Config Server resource
	Properties *ConfigServerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ConfigServerResource - Config Server resource

func (ConfigServerResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigServerResource.

type ConfigServerSettings 

type ConfigServerSettings struct {
	// Property of git environment.
	GitProperty *ConfigServerGitProperty `json:"gitProperty,omitempty"`
}

ConfigServerSettings - The settings of config server.

type ConfigServerSettingsErrorRecord 

type ConfigServerSettingsErrorRecord struct {
	// The detail error messages of the record
	Messages []*string `json:"messages,omitempty"`

	// The name of the config server settings error record
	Name *string `json:"name,omitempty"`

	// The uri of the config server settings error record
	URI *string `json:"uri,omitempty"`
}

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.

type ConfigServerSettingsValidateResult 

type ConfigServerSettingsValidateResult struct {
	// The detail validation results
	Details []*ConfigServerSettingsErrorRecord `json:"details,omitempty"`

	// Indicate if the config server settings are valid
	IsValid *bool `json:"isValid,omitempty"`
}

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.

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) (*armruntime.Poller[ConfigServersClientUpdatePatchResponse], error)

BeginUpdatePatch - Update the config server. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigServers_UpdatePatch.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigServersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdatePatch(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.ConfigServerResource{
			Properties: &armappplatform.ConfigServerProperties{
				ConfigServer: &armappplatform.ConfigServerSettings{
					GitProperty: &armappplatform.ConfigServerGitProperty{
						Label: to.Ptr("<label>"),
						SearchPaths: []*string{
							to.Ptr("/")},
						URI: to.Ptr("<uri>"),
					},
				},
			},
		},
		&armappplatform.ConfigServersClientBeginUpdatePatchOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConfigServersClient) BeginUpdatePut 

func (client *ConfigServersClient) BeginUpdatePut(ctx context.Context, resourceGroupName string, serviceName string, configServerResource ConfigServerResource, options *ConfigServersClientBeginUpdatePutOptions) (*armruntime.Poller[ConfigServersClientUpdatePutResponse], error)

BeginUpdatePut - Update the config server. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigServers_UpdatePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigServersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdatePut(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.ConfigServerResource{
			Properties: &armappplatform.ConfigServerProperties{
				ConfigServer: &armappplatform.ConfigServerSettings{
					GitProperty: &armappplatform.ConfigServerGitProperty{
						Label: to.Ptr("<label>"),
						SearchPaths: []*string{
							to.Ptr("/")},
						URI: to.Ptr("<uri>"),
					},
				},
			},
		},
		&armappplatform.ConfigServersClientBeginUpdatePutOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConfigServersClient) BeginValidate 

func (client *ConfigServersClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, configServerSettings ConfigServerSettings, options *ConfigServersClientBeginValidateOptions) (*armruntime.Poller[ConfigServersClientValidateResponse], error)

BeginValidate - Check if the config server settings are valid. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigServers_Validate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigServersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginValidate(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.ConfigServerSettings{
			GitProperty: &armappplatform.ConfigServerGitProperty{
				Label: to.Ptr("<label>"),
				SearchPaths: []*string{
					to.Ptr("/")},
				URI: to.Ptr("<uri>"),
			},
		},
		&armappplatform.ConfigServersClientBeginValidateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigServers_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigServersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type ConfigServersClientBeginUpdatePatchOptions added in v0.3.0 

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

ConfigServersClientBeginUpdatePatchOptions contains the optional parameters for the ConfigServersClient.BeginUpdatePatch method.

type ConfigServersClientBeginUpdatePutOptions added in v0.3.0 

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

ConfigServersClientBeginUpdatePutOptions contains the optional parameters for the ConfigServersClient.BeginUpdatePut method.

type ConfigServersClientBeginValidateOptions added in v0.3.0 

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

ConfigServersClientBeginValidateOptions contains the optional parameters for the ConfigServersClient.BeginValidate method.

type ConfigServersClientGetOptions added in v0.3.0 

type ConfigServersClientGetOptions struct {
}

ConfigServersClientGetOptions contains the optional parameters for the ConfigServersClient.Get method.

type ConfigServersClientGetResponse added in v0.3.0 

type ConfigServersClientGetResponse struct {
	ConfigServerResource
}

ConfigServersClientGetResponse contains the response from method ConfigServersClient.Get.

type ConfigServersClientUpdatePatchResponse added in v0.3.0 

type ConfigServersClientUpdatePatchResponse struct {
	ConfigServerResource
}

ConfigServersClientUpdatePatchResponse contains the response from method ConfigServersClient.UpdatePatch.

type ConfigServersClientUpdatePutResponse added in v0.3.0 

type ConfigServersClientUpdatePutResponse struct {
	ConfigServerResource
}

ConfigServersClientUpdatePutResponse contains the response from method ConfigServersClient.UpdatePut.

type ConfigServersClientValidateResponse added in v0.3.0 

type ConfigServersClientValidateResponse struct {
	ConfigServerSettingsValidateResult
}

ConfigServersClientValidateResponse contains the response from method ConfigServersClient.Validate.

type ConfigurationServiceGitProperty added in v0.3.0 

type ConfigurationServiceGitProperty struct {
	// Repositories of Application Configuration Service git property.
	Repositories []*ConfigurationServiceGitRepository `json:"repositories,omitempty"`
}

ConfigurationServiceGitProperty - Property of git environment.

func (ConfigurationServiceGitProperty) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceGitProperty.

type ConfigurationServiceGitPropertyValidateResult added in v0.3.0 

type ConfigurationServiceGitPropertyValidateResult struct {
	// The detail validation results
	GitReposValidationResult []*ValidationMessages `json:"gitReposValidationResult,omitempty"`

	// Indicate if the configuration service settings are valid
	IsValid *bool `json:"isValid,omitempty"`
}

ConfigurationServiceGitPropertyValidateResult - Validation result for configuration service settings

func (ConfigurationServiceGitPropertyValidateResult) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceGitPropertyValidateResult.

type ConfigurationServiceGitRepository added in v0.3.0 

type ConfigurationServiceGitRepository struct {
	// REQUIRED; Label of the repository
	Label *string `json:"label,omitempty"`

	// REQUIRED; Name of the repository
	Name *string `json:"name,omitempty"`

	// REQUIRED; Collection of patterns of the repository
	Patterns []*string `json:"patterns,omitempty"`

	// REQUIRED; URI of the repository
	URI *string `json:"uri,omitempty"`

	// Public sshKey of git repository.
	HostKey *string `json:"hostKey,omitempty"`

	// SshKey algorithm of git repository.
	HostKeyAlgorithm *string `json:"hostKeyAlgorithm,omitempty"`

	// Password of git repository basic auth.
	Password *string `json:"password,omitempty"`

	// Private sshKey algorithm of git repository.
	PrivateKey *string `json:"privateKey,omitempty"`

	// Searching path of the repository
	SearchPaths []*string `json:"searchPaths,omitempty"`

	// Strict host key checking or not.
	StrictHostKeyChecking *bool `json:"strictHostKeyChecking,omitempty"`

	// Username of git repository basic auth.
	Username *string `json:"username,omitempty"`
}

ConfigurationServiceGitRepository - Git repository property payload for Application Configuration Service

func (ConfigurationServiceGitRepository) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceGitRepository.

type ConfigurationServiceInstance added in v0.3.0 

type ConfigurationServiceInstance struct {
	// READ-ONLY; Name of the Application Configuration Service instance
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Status of the Application Configuration Service instance
	Status *string `json:"status,omitempty" azure:"ro"`
}

ConfigurationServiceInstance - Collection of instances belong to the Application Configuration Service

type ConfigurationServiceProperties added in v0.3.0 

type ConfigurationServiceProperties struct {
	// The settings of Application Configuration Service.
	Settings *ConfigurationServiceSettings `json:"settings,omitempty"`

	// READ-ONLY; Collection of instances belong to Application Configuration Service.
	Instances []*ConfigurationServiceInstance `json:"instances,omitempty" azure:"ro"`

	// READ-ONLY; State of the Application Configuration Service.
	ProvisioningState *ConfigurationServiceProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *ConfigurationServiceResourceRequests `json:"resourceRequests,omitempty" azure:"ro"`
}

ConfigurationServiceProperties - Application Configuration Service properties payload

func (ConfigurationServiceProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceProperties.

type ConfigurationServiceProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleConfigurationServiceProvisioningStateValues() []ConfigurationServiceProvisioningState

PossibleConfigurationServiceProvisioningStateValues returns the possible values for the ConfigurationServiceProvisioningState const type.

type ConfigurationServiceResource added in v0.3.0 

type ConfigurationServiceResource struct {
	// Application Configuration Service properties payload
	Properties *ConfigurationServiceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ConfigurationServiceResource - Application Configuration Service resource

type ConfigurationServiceResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of configuration service resources
	Value []*ConfigurationServiceResource `json:"value,omitempty"`
}

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

func (ConfigurationServiceResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationServiceResourceCollection.

type ConfigurationServiceResourceRequests added in v0.3.0 

type ConfigurationServiceResourceRequests struct {
	// READ-ONLY; Cpu allocated to each Application Configuration Service instance
	CPU *string `json:"cpu,omitempty" azure:"ro"`

	// READ-ONLY; Instance count of the Application Configuration Service
	InstanceCount *int32 `json:"instanceCount,omitempty" azure:"ro"`

	// READ-ONLY; Memory allocated to each Application Configuration Service instance
	Memory *string `json:"memory,omitempty" azure:"ro"`
}

ConfigurationServiceResourceRequests - Resource request payload of Application Configuration Service

type ConfigurationServiceSettings added in v0.3.0 

type ConfigurationServiceSettings struct {
	// Property of git environment.
	GitProperty *ConfigurationServiceGitProperty `json:"gitProperty,omitempty"`
}

ConfigurationServiceSettings - The settings of Application Configuration Service.

type ConfigurationServiceSettingsValidateResult added in v0.3.0 

type ConfigurationServiceSettingsValidateResult struct {
	// Validation result for configuration service settings
	GitPropertyValidationResult *ConfigurationServiceGitPropertyValidateResult `json:"gitPropertyValidationResult,omitempty"`
}

ConfigurationServiceSettingsValidateResult - Validation result for configuration service settings

type ConfigurationServicesClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *ConfigurationServicesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, configurationServiceResource ConfigurationServiceResource, options *ConfigurationServicesClientBeginCreateOrUpdateOptions) (*armruntime.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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigurationServices_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigurationServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<configuration-service-name>",
		armappplatform.ConfigurationServiceResource{
			Properties: &armappplatform.ConfigurationServiceProperties{
				Settings: &armappplatform.ConfigurationServiceSettings{
					GitProperty: &armappplatform.ConfigurationServiceGitProperty{
						Repositories: []*armappplatform.ConfigurationServiceGitRepository{
							{
								Name:  to.Ptr("<name>"),
								Label: to.Ptr("<label>"),
								Patterns: []*string{
									to.Ptr("app/dev")},
								URI: to.Ptr("<uri>"),
							}},
					},
				},
			},
		},
		&armappplatform.ConfigurationServicesClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConfigurationServicesClient) BeginDelete added in v0.3.0 

func (client *ConfigurationServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, options *ConfigurationServicesClientBeginDeleteOptions) (*armruntime.Poller[ConfigurationServicesClientDeleteResponse], error)

BeginDelete - Disable the default Application Configuration Service. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigurationServices_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigurationServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<configuration-service-name>",
		&armappplatform.ConfigurationServicesClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ConfigurationServicesClient) BeginValidate added in v0.3.0 

func (client *ConfigurationServicesClient) BeginValidate(ctx context.Context, resourceGroupName string, serviceName string, configurationServiceName string, settings ConfigurationServiceSettings, options *ConfigurationServicesClientBeginValidateOptions) (*armruntime.Poller[ConfigurationServicesClientValidateResponse], error)

BeginValidate - Check if the Application Configuration Service settings are valid. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigurationServices_Validate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigurationServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginValidate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<configuration-service-name>",
		armappplatform.ConfigurationServiceSettings{
			GitProperty: &armappplatform.ConfigurationServiceGitProperty{
				Repositories: []*armappplatform.ConfigurationServiceGitRepository{
					{
						Name:  to.Ptr("<name>"),
						Label: to.Ptr("<label>"),
						Patterns: []*string{
							to.Ptr("app/dev")},
						URI: to.Ptr("<uri>"),
					}},
			},
		},
		&armappplatform.ConfigurationServicesClientBeginValidateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConfigurationServicesClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigurationServices_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigurationServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<configuration-service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConfigurationServicesClient) NewListPager added in v0.5.0 

func (client *ConfigurationServicesClient) NewListPager(resourceGroupName string, serviceName string, options *ConfigurationServicesClientListOptions) *runtime.Pager[ConfigurationServicesClientListResponse]

NewListPager - Handles requests to list all resources in a Service. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ConfigurationServices_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewConfigurationServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ConfigurationServicesClientBeginCreateOrUpdateOptions added in v0.3.0 

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

ConfigurationServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationServicesClient.BeginCreateOrUpdate method.

type ConfigurationServicesClientBeginDeleteOptions added in v0.3.0 

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

ConfigurationServicesClientBeginDeleteOptions contains the optional parameters for the ConfigurationServicesClient.BeginDelete method.

type ConfigurationServicesClientBeginValidateOptions added in v0.3.0 

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

ConfigurationServicesClientBeginValidateOptions contains the optional parameters for the ConfigurationServicesClient.BeginValidate method.

type ConfigurationServicesClientCreateOrUpdateResponse added in v0.3.0 

type ConfigurationServicesClientCreateOrUpdateResponse struct {
	ConfigurationServiceResource
}

ConfigurationServicesClientCreateOrUpdateResponse contains the response from method ConfigurationServicesClient.CreateOrUpdate.

type ConfigurationServicesClientDeleteResponse added in v0.3.0 

type ConfigurationServicesClientDeleteResponse struct {
}

ConfigurationServicesClientDeleteResponse contains the response from method ConfigurationServicesClient.Delete.

type ConfigurationServicesClientGetOptions added in v0.3.0 

type ConfigurationServicesClientGetOptions struct {
}

ConfigurationServicesClientGetOptions contains the optional parameters for the ConfigurationServicesClient.Get method.

type ConfigurationServicesClientGetResponse added in v0.3.0 

type ConfigurationServicesClientGetResponse struct {
	ConfigurationServiceResource
}

ConfigurationServicesClientGetResponse contains the response from method ConfigurationServicesClient.Get.

type ConfigurationServicesClientListOptions added in v0.3.0 

type ConfigurationServicesClientListOptions struct {
}

ConfigurationServicesClientListOptions contains the optional parameters for the ConfigurationServicesClient.List method.

type ConfigurationServicesClientListResponse added in v0.3.0 

type ConfigurationServicesClientListResponse struct {
	ConfigurationServiceResourceCollection
}

ConfigurationServicesClientListResponse contains the response from method ConfigurationServicesClient.List.

type ConfigurationServicesClientValidateResponse added in v0.3.0 

type ConfigurationServicesClientValidateResponse struct {
	ConfigurationServiceSettingsValidateResult
}

ConfigurationServicesClientValidateResponse contains the response from method ConfigurationServicesClient.Validate.

type ContainerProbeSettings added in v0.3.0 

type ContainerProbeSettings struct {
	// Indicates whether disable the liveness and readiness probe
	DisableProbe *bool `json:"disableProbe,omitempty"`
}

ContainerProbeSettings - Container liveness and readiness probe settings

type ContentCertificateProperties added in v0.2.0 

type ContentCertificateProperties struct {
	// REQUIRED; The type of the certificate source.
	Type *string `json:"type,omitempty"`

	// The content of uploaded certificate.
	Content *string `json:"content,omitempty"`

	// READ-ONLY; The activate date of certificate.
	ActivateDate *string `json:"activateDate,omitempty" azure:"ro"`

	// READ-ONLY; The domain list of certificate.
	DNSNames []*string `json:"dnsNames,omitempty" azure:"ro"`

	// READ-ONLY; The expiration date of certificate.
	ExpirationDate *string `json:"expirationDate,omitempty" azure:"ro"`

	// READ-ONLY; The issue date of certificate.
	IssuedDate *string `json:"issuedDate,omitempty" azure:"ro"`

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

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

	// READ-ONLY; The thumbprint of certificate.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`
}

ContentCertificateProperties - Properties of certificate imported from key vault.

func (*ContentCertificateProperties) GetCertificateProperties added in v0.3.0 

func (c *ContentCertificateProperties) GetCertificateProperties() *CertificateProperties

GetCertificateProperties implements the CertificatePropertiesClassification interface for type ContentCertificateProperties.

func (ContentCertificateProperties) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ContentCertificateProperties.

func (*ContentCertificateProperties) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContentCertificateProperties.

type CreatedByType added in v0.2.0 

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 added in v0.2.0 

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 `json:"args,omitempty"`

	// Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
	Command []*string `json:"command,omitempty"`

	// Container image of the custom container. This should be in the form of : without the server name of the registry
	ContainerImage *string `json:"containerImage,omitempty"`

	// Credential of the image registry
	ImageRegistryCredential *ImageRegistryCredential `json:"imageRegistryCredential,omitempty"`

	// Language framework of the container image uploaded
	LanguageFramework *string `json:"languageFramework,omitempty"`

	// The name of the registry that contains the container image
	Server *string `json:"server,omitempty"`
}

CustomContainer - Custom container payload

func (CustomContainer) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomContainer.

type CustomContainerUserSourceInfo added in v0.3.0 

type CustomContainerUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// Custom container payload
	CustomContainer *CustomContainer `json:"customContainer,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

CustomContainerUserSourceInfo - Custom container user source info

func (*CustomContainerUserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (c *CustomContainerUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type CustomContainerUserSourceInfo.

func (CustomContainerUserSourceInfo) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type CustomContainerUserSourceInfo.

func (*CustomContainerUserSourceInfo) UnmarshalJSON added in v0.3.0 

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 `json:"certName,omitempty"`

	// The thumbprint of bound certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`

	// READ-ONLY; The app name of domain.
	AppName *string `json:"appName,omitempty" azure:"ro"`
}

CustomDomainProperties - Custom domain of app resource payload.

type CustomDomainResource 

type CustomDomainResource struct {
	// Properties of the custom domain resource.
	Properties *CustomDomainProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

CustomDomainResource - Custom domain resource payload.

func (CustomDomainResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomDomainResource.

type CustomDomainResourceCollection 

type CustomDomainResourceCollection struct {
	// The link to next page of custom domain list.
	NextLink *string `json:"nextLink,omitempty"`

	// The custom domain resources list.
	Value []*CustomDomainResource `json:"value,omitempty"`
}

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.

type CustomDomainValidatePayload 

type CustomDomainValidatePayload struct {
	// REQUIRED; Name to be validated
	Name *string `json:"name,omitempty"`
}

CustomDomainValidatePayload - Custom domain validate payload.

type CustomDomainValidateResult 

type CustomDomainValidateResult struct {
	// Indicates if domain name is valid.
	IsValid *bool `json:"isValid,omitempty"`

	// Message of why domain name is invalid.
	Message *string `json:"message,omitempty"`
}

CustomDomainValidateResult - Validation result for custom domain.

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) (*armruntime.Poller[CustomDomainsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/CustomDomains_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<domain-name>",
		armappplatform.CustomDomainResource{
			Properties: &armappplatform.CustomDomainProperties{
				CertName:   to.Ptr("<cert-name>"),
				Thumbprint: to.Ptr("<thumbprint>"),
			},
		},
		&armappplatform.CustomDomainsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CustomDomainsClient) BeginDelete 

func (client *CustomDomainsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, appName string, domainName string, options *CustomDomainsClientBeginDeleteOptions) (*armruntime.Poller[CustomDomainsClientDeleteResponse], error)

BeginDelete - Delete the custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/CustomDomains_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<domain-name>",
		&armappplatform.CustomDomainsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*CustomDomainsClient) BeginUpdate 

func (client *CustomDomainsClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, domainName string, domainResource CustomDomainResource, options *CustomDomainsClientBeginUpdateOptions) (*armruntime.Poller[CustomDomainsClientUpdateResponse], error)

BeginUpdate - Update custom domain of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/CustomDomains_Update.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<domain-name>",
		armappplatform.CustomDomainResource{
			Properties: &armappplatform.CustomDomainProperties{
				CertName:   to.Ptr("<cert-name>"),
				Thumbprint: to.Ptr("<thumbprint>"),
			},
		},
		&armappplatform.CustomDomainsClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/CustomDomains_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<domain-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CustomDomainsClient) NewListPager added in v0.5.0 

func (client *CustomDomainsClient) NewListPager(resourceGroupName string, serviceName string, appName string, options *CustomDomainsClientListOptions) *runtime.Pager[CustomDomainsClientListResponse]

NewListPager - List the custom domains of one lifecycle application. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/CustomDomains_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<app-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type CustomDomainsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

CustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomDomainsClient.BeginCreateOrUpdate method.

type CustomDomainsClientBeginDeleteOptions added in v0.3.0 

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

CustomDomainsClientBeginDeleteOptions contains the optional parameters for the CustomDomainsClient.BeginDelete method.

type CustomDomainsClientBeginUpdateOptions added in v0.3.0 

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

CustomDomainsClientBeginUpdateOptions contains the optional parameters for the CustomDomainsClient.BeginUpdate method.

type CustomDomainsClientCreateOrUpdateResponse added in v0.3.0 

type CustomDomainsClientCreateOrUpdateResponse struct {
	CustomDomainResource
}

CustomDomainsClientCreateOrUpdateResponse contains the response from method CustomDomainsClient.CreateOrUpdate.

type CustomDomainsClientDeleteResponse added in v0.3.0 

type CustomDomainsClientDeleteResponse struct {
}

CustomDomainsClientDeleteResponse contains the response from method CustomDomainsClient.Delete.

type CustomDomainsClientGetOptions added in v0.3.0 

type CustomDomainsClientGetOptions struct {
}

CustomDomainsClientGetOptions contains the optional parameters for the CustomDomainsClient.Get method.

type CustomDomainsClientGetResponse added in v0.3.0 

type CustomDomainsClientGetResponse struct {
	CustomDomainResource
}

CustomDomainsClientGetResponse contains the response from method CustomDomainsClient.Get.

type CustomDomainsClientListOptions added in v0.3.0 

type CustomDomainsClientListOptions struct {
}

CustomDomainsClientListOptions contains the optional parameters for the CustomDomainsClient.List method.

type CustomDomainsClientListResponse added in v0.3.0 

type CustomDomainsClientListResponse struct {
	CustomDomainResourceCollection
}

CustomDomainsClientListResponse contains the response from method CustomDomainsClient.List.

type CustomDomainsClientUpdateResponse added in v0.3.0 

type CustomDomainsClientUpdateResponse struct {
	CustomDomainResource
}

CustomDomainsClientUpdateResponse contains the response from method CustomDomainsClient.Update.

type CustomPersistentDiskProperties added in v0.2.0 

type CustomPersistentDiskProperties struct {
	// REQUIRED; The mount path of the persistent disk.
	MountPath *string `json:"mountPath,omitempty"`

	// REQUIRED; The type of the underlying resource to mount as a persistent disk.
	Type *Type `json:"type,omitempty"`

	// These are the mount options for a persistent disk.
	MountOptions []*string `json:"mountOptions,omitempty"`

	// Indicates whether the persistent disk is a readOnly one.
	ReadOnly *bool `json:"readOnly,omitempty"`
}

CustomPersistentDiskProperties - Custom persistent disk resource payload.

func (*CustomPersistentDiskProperties) GetCustomPersistentDiskProperties added in v0.2.0 

func (c *CustomPersistentDiskProperties) GetCustomPersistentDiskProperties() *CustomPersistentDiskProperties

GetCustomPersistentDiskProperties implements the CustomPersistentDiskPropertiesClassification interface for type CustomPersistentDiskProperties.

func (CustomPersistentDiskProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type CustomPersistentDiskProperties.

type CustomPersistentDiskPropertiesClassification added in v0.2.0 

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 added in v0.2.0 

type CustomPersistentDiskResource struct {
	// REQUIRED; The resource id of Azure Spring Cloud Storage resource.
	StorageID *string `json:"storageId,omitempty"`

	// Properties of the custom persistent disk resource payload.
	CustomPersistentDiskProperties CustomPersistentDiskPropertiesClassification `json:"customPersistentDiskProperties,omitempty"`
}

CustomPersistentDiskResource - Custom persistent disk resource payload.

func (CustomPersistentDiskResource) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type CustomPersistentDiskResource.

func (*CustomPersistentDiskResource) UnmarshalJSON added in v0.2.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomPersistentDiskResource.

type DeploymentInstance 

type DeploymentInstance struct {
	// READ-ONLY; Discovery status of the deployment instance
	DiscoveryStatus *string `json:"discoveryStatus,omitempty" azure:"ro"`

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

	// READ-ONLY; Failed reason of the deployment instance
	Reason *string `json:"reason,omitempty" azure:"ro"`

	// READ-ONLY; Start time of the deployment instance
	StartTime *string `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; Status of the deployment instance
	Status *string `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; Availability zone information of the deployment instance
	Zone *string `json:"zone,omitempty" azure:"ro"`
}

DeploymentInstance - Deployment instance payload

type DeploymentResource 

type DeploymentResource struct {
	// Properties of the Deployment resource
	Properties *DeploymentResourceProperties `json:"properties,omitempty"`

	// Sku of the Deployment resource
	SKU *SKU `json:"sku,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DeploymentResource - Deployment resource payload

func (DeploymentResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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 `json:"nextLink,omitempty"`

	// Collection of Deployment resources
	Value []*DeploymentResource `json:"value,omitempty"`
}

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.

type DeploymentResourceProperties 

type DeploymentResourceProperties struct {
	// Indicates whether the Deployment is active
	Active *bool `json:"active,omitempty"`

	// Deployment settings of the Deployment
	DeploymentSettings *DeploymentSettings `json:"deploymentSettings,omitempty"`

	// Uploaded source information of the deployment.
	Source UserSourceInfoClassification `json:"source,omitempty"`

	// READ-ONLY; Collection of instances belong to the Deployment
	Instances []*DeploymentInstance `json:"instances,omitempty" azure:"ro"`

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

	// READ-ONLY; Status of the Deployment
	Status *DeploymentResourceStatus `json:"status,omitempty" azure:"ro"`
}

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]map[string]interface{} `json:"addonConfigs,omitempty"`

	// Container liveness and readiness probe settings
	ContainerProbeSettings *ContainerProbeSettings `json:"containerProbeSettings,omitempty"`

	// Collection of environment variables
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// 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 `json:"resourceRequests,omitempty"`
}

DeploymentSettings - Deployment settings payload

func (DeploymentSettings) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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) (*armruntime.Poller[DeploymentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a new Deployment or update an exiting Deployment. If the operation fails it returns an *azcore.ResponseError type. 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		armappplatform.DeploymentResource{
			Properties: &armappplatform.DeploymentResourceProperties{
				DeploymentSettings: &armappplatform.DeploymentSettings{
					AddonConfigs: map[string]map[string]interface{}{
						"ApplicationConfigurationService": {
							"patterns": []interface{}{
								"mypattern",
							},
						},
					},
					EnvironmentVariables: map[string]*string{
						"env": to.Ptr("test"),
					},
					ResourceRequests: &armappplatform.ResourceRequests{
						CPU:    to.Ptr("<cpu>"),
						Memory: to.Ptr("<memory>"),
					},
				},
				Source: &armappplatform.SourceUploadedUserSourceInfo{
					Type:             to.Ptr("<type>"),
					Version:          to.Ptr("<version>"),
					RelativePath:     to.Ptr("<relative-path>"),
					ArtifactSelector: to.Ptr("<artifact-selector>"),
				},
			},
			SKU: &armappplatform.SKU{
				Name:     to.Ptr("<name>"),
				Capacity: to.Ptr[int32](1),
				Tier:     to.Ptr("<tier>"),
			},
		},
		&armappplatform.DeploymentsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DeploymentsClient) BeginDelete 

func (client *DeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginDeleteOptions) (*armruntime.Poller[DeploymentsClientDeleteResponse], error)

BeginDelete - Operation to delete a Deployment. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		&armappplatform.DeploymentsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginGenerateHeapDump added in v0.2.0 

func (client *DeploymentsClient) BeginGenerateHeapDump(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, diagnosticParameters DiagnosticParameters, options *DeploymentsClientBeginGenerateHeapDumpOptions) (*armruntime.Poller[DeploymentsClientGenerateHeapDumpResponse], error)

BeginGenerateHeapDump - Generate Heap Dump If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_GenerateHeapDump.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginGenerateHeapDump(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		armappplatform.DiagnosticParameters{
			AppInstance: to.Ptr("<app-instance>"),
			FilePath:    to.Ptr("<file-path>"),
		},
		&armappplatform.DeploymentsClientBeginGenerateHeapDumpOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginGenerateThreadDump added in v0.2.0 

func (client *DeploymentsClient) BeginGenerateThreadDump(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, diagnosticParameters DiagnosticParameters, options *DeploymentsClientBeginGenerateThreadDumpOptions) (*armruntime.Poller[DeploymentsClientGenerateThreadDumpResponse], error)

BeginGenerateThreadDump - Generate Thread Dump If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_GenerateThreadDump.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginGenerateThreadDump(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		armappplatform.DiagnosticParameters{
			AppInstance: to.Ptr("<app-instance>"),
			FilePath:    to.Ptr("<file-path>"),
		},
		&armappplatform.DeploymentsClientBeginGenerateThreadDumpOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginRestart 

func (client *DeploymentsClient) BeginRestart(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginRestartOptions) (*armruntime.Poller[DeploymentsClientRestartResponse], error)

BeginRestart - Restart the deployment. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_Restart.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginRestart(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		&armappplatform.DeploymentsClientBeginRestartOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginStart 

func (client *DeploymentsClient) BeginStart(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginStartOptions) (*armruntime.Poller[DeploymentsClientStartResponse], error)

BeginStart - Start the deployment. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_Start.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginStart(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		&armappplatform.DeploymentsClientBeginStartOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginStartJFR added in v0.2.0 

func (client *DeploymentsClient) BeginStartJFR(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, diagnosticParameters DiagnosticParameters, options *DeploymentsClientBeginStartJFROptions) (*armruntime.Poller[DeploymentsClientStartJFRResponse], error)

BeginStartJFR - Start JFR If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_StartJFR.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginStartJFR(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		armappplatform.DiagnosticParameters{
			AppInstance: to.Ptr("<app-instance>"),
			Duration:    to.Ptr("<duration>"),
			FilePath:    to.Ptr("<file-path>"),
		},
		&armappplatform.DeploymentsClientBeginStartJFROptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginStop 

func (client *DeploymentsClient) BeginStop(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, options *DeploymentsClientBeginStopOptions) (*armruntime.Poller[DeploymentsClientStopResponse], error)

BeginStop - Stop the deployment. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_Stop.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginStop(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		&armappplatform.DeploymentsClientBeginStopOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*DeploymentsClient) BeginUpdate 

func (client *DeploymentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, appName string, deploymentName string, deploymentResource DeploymentResource, options *DeploymentsClientBeginUpdateOptions) (*armruntime.Poller[DeploymentsClientUpdateResponse], error)

BeginUpdate - Operation to update an exiting Deployment. If the operation fails it returns an *azcore.ResponseError type. 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_Update.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		armappplatform.DeploymentResource{
			Properties: &armappplatform.DeploymentResourceProperties{
				Source: &armappplatform.SourceUploadedUserSourceInfo{
					Type:             to.Ptr("<type>"),
					Version:          to.Ptr("<version>"),
					RelativePath:     to.Ptr("<relative-path>"),
					ArtifactSelector: to.Ptr("<artifact-selector>"),
				},
			},
		},
		&armappplatform.DeploymentsClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<app-name>",
		"<deployment-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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

func (*DeploymentsClient) NewListForClusterPager added in v0.5.0 

func (client *DeploymentsClient) NewListForClusterPager(resourceGroupName string, serviceName string, options *DeploymentsClientListForClusterOptions) *runtime.Pager[DeploymentsClientListForClusterResponse]

NewListForClusterPager - List deployments for a certain service If the operation fails it returns an *azcore.ResponseError type. 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.ListForCluster method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_ListForCluster.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListForClusterPager("<resource-group-name>",
		"<service-name>",
		&armappplatform.DeploymentsClientListForClusterOptions{Version: []string{}})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*DeploymentsClient) NewListPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Deployments_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewDeploymentsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<app-name>",
		&armappplatform.DeploymentsClientListOptions{Version: []string{}})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type DeploymentsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

DeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DeploymentsClient.BeginCreateOrUpdate method.

type DeploymentsClientBeginDeleteOptions added in v0.3.0 

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

DeploymentsClientBeginDeleteOptions contains the optional parameters for the DeploymentsClient.BeginDelete method.

type DeploymentsClientBeginGenerateHeapDumpOptions added in v0.3.0 

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

DeploymentsClientBeginGenerateHeapDumpOptions contains the optional parameters for the DeploymentsClient.BeginGenerateHeapDump method.

type DeploymentsClientBeginGenerateThreadDumpOptions added in v0.3.0 

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

DeploymentsClientBeginGenerateThreadDumpOptions contains the optional parameters for the DeploymentsClient.BeginGenerateThreadDump method.

type DeploymentsClientBeginRestartOptions added in v0.3.0 

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

DeploymentsClientBeginRestartOptions contains the optional parameters for the DeploymentsClient.BeginRestart method.

type DeploymentsClientBeginStartJFROptions added in v0.3.0 

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

DeploymentsClientBeginStartJFROptions contains the optional parameters for the DeploymentsClient.BeginStartJFR method.

type DeploymentsClientBeginStartOptions added in v0.3.0 

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

DeploymentsClientBeginStartOptions contains the optional parameters for the DeploymentsClient.BeginStart method.

type DeploymentsClientBeginStopOptions added in v0.3.0 

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

DeploymentsClientBeginStopOptions contains the optional parameters for the DeploymentsClient.BeginStop method.

type DeploymentsClientBeginUpdateOptions added in v0.3.0 

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

DeploymentsClientBeginUpdateOptions contains the optional parameters for the DeploymentsClient.BeginUpdate method.

type DeploymentsClientCreateOrUpdateResponse added in v0.3.0 

type DeploymentsClientCreateOrUpdateResponse struct {
	DeploymentResource
}

DeploymentsClientCreateOrUpdateResponse contains the response from method DeploymentsClient.CreateOrUpdate.

type DeploymentsClientDeleteResponse added in v0.3.0 

type DeploymentsClientDeleteResponse struct {
}

DeploymentsClientDeleteResponse contains the response from method DeploymentsClient.Delete.

type DeploymentsClientGenerateHeapDumpResponse added in v0.3.0 

type DeploymentsClientGenerateHeapDumpResponse struct {
}

DeploymentsClientGenerateHeapDumpResponse contains the response from method DeploymentsClient.GenerateHeapDump.

type DeploymentsClientGenerateThreadDumpResponse added in v0.3.0 

type DeploymentsClientGenerateThreadDumpResponse struct {
}

DeploymentsClientGenerateThreadDumpResponse contains the response from method DeploymentsClient.GenerateThreadDump.

type DeploymentsClientGetLogFileURLOptions added in v0.3.0 

type DeploymentsClientGetLogFileURLOptions struct {
}

DeploymentsClientGetLogFileURLOptions contains the optional parameters for the DeploymentsClient.GetLogFileURL method.

type DeploymentsClientGetLogFileURLResponse added in v0.3.0 

type DeploymentsClientGetLogFileURLResponse struct {
	LogFileURLResponse
}

DeploymentsClientGetLogFileURLResponse contains the response from method DeploymentsClient.GetLogFileURL.

type DeploymentsClientGetOptions added in v0.3.0 

type DeploymentsClientGetOptions struct {
}

DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.

type DeploymentsClientGetResponse added in v0.3.0 

type DeploymentsClientGetResponse struct {
	DeploymentResource
}

DeploymentsClientGetResponse contains the response from method DeploymentsClient.Get.

type DeploymentsClientListForClusterOptions added in v0.3.0 

type DeploymentsClientListForClusterOptions struct {
	// Version of the deployments to be listed
	Version []string
}

DeploymentsClientListForClusterOptions contains the optional parameters for the DeploymentsClient.ListForCluster method.

type DeploymentsClientListForClusterResponse added in v0.3.0 

type DeploymentsClientListForClusterResponse struct {
	DeploymentResourceCollection
}

DeploymentsClientListForClusterResponse contains the response from method DeploymentsClient.ListForCluster.

type DeploymentsClientListOptions added in v0.3.0 

type DeploymentsClientListOptions struct {
	// Version of the deployments to be listed
	Version []string
}

DeploymentsClientListOptions contains the optional parameters for the DeploymentsClient.List method.

type DeploymentsClientListResponse added in v0.3.0 

type DeploymentsClientListResponse struct {
	DeploymentResourceCollection
}

DeploymentsClientListResponse contains the response from method DeploymentsClient.List.

type DeploymentsClientRestartResponse added in v0.3.0 

type DeploymentsClientRestartResponse struct {
}

DeploymentsClientRestartResponse contains the response from method DeploymentsClient.Restart.

type DeploymentsClientStartJFRResponse added in v0.3.0 

type DeploymentsClientStartJFRResponse struct {
}

DeploymentsClientStartJFRResponse contains the response from method DeploymentsClient.StartJFR.

type DeploymentsClientStartResponse added in v0.3.0 

type DeploymentsClientStartResponse struct {
}

DeploymentsClientStartResponse contains the response from method DeploymentsClient.Start.

type DeploymentsClientStopResponse added in v0.3.0 

type DeploymentsClientStopResponse struct {
}

DeploymentsClientStopResponse contains the response from method DeploymentsClient.Stop.

type DeploymentsClientUpdateResponse added in v0.3.0 

type DeploymentsClientUpdateResponse struct {
	DeploymentResource
}

DeploymentsClientUpdateResponse contains the response from method DeploymentsClient.Update.

type DiagnosticParameters added in v0.2.0 

type DiagnosticParameters struct {
	// App instance name
	AppInstance *string `json:"appInstance,omitempty"`

	// Duration of your JFR. 1 min can be represented by 1m or 60s.
	Duration *string `json:"duration,omitempty"`

	// Your target file path in your own BYOS
	FilePath *string `json:"filePath,omitempty"`
}

DiagnosticParameters - Diagnostic parameters of diagnostic operations

type Error 

type Error struct {
	// The code of error.
	Code *string `json:"code,omitempty"`

	// The message of error.
	Message *string `json:"message,omitempty"`
}

Error - The error code compose of code and message.

type GatewayAPIMetadataProperties added in v0.3.0 

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 `json:"description,omitempty"`

	// Location of additional documentation for the APIs available on the Gateway instance
	Documentation *string `json:"documentation,omitempty"`

	// Base URL that API consumers will use to access APIs on the Gateway instance.
	ServerURL *string `json:"serverUrl,omitempty"`

	// Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
	Title *string `json:"title,omitempty"`

	// Version of APIs available on this Gateway instance (default: unspecified).
	Version *string `json:"version,omitempty"`
}

GatewayAPIMetadataProperties - API metadata property for Spring Cloud Gateway

type GatewayAPIRoute added in v0.3.0 

type GatewayAPIRoute struct {
	// A description, will be applied to methods in the generated OpenAPI documentation.
	Description *string `json:"description,omitempty"`

	// To modify the request before sending it to the target endpoint, or the received response.
	Filters []*string `json:"filters,omitempty"`

	// Route processing order.
	Order *int32 `json:"order,omitempty"`

	// 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 `json:"predicates,omitempty"`

	// Enable sso validation.
	SsoEnabled *bool `json:"ssoEnabled,omitempty"`

	// Classification tags, will be applied to methods in the generated OpenAPI documentation.
	Tags []*string `json:"tags,omitempty"`

	// A title, will be applied to methods in the generated OpenAPI documentation.
	Title *string `json:"title,omitempty"`

	// Pass currently-authenticated user's identity token to application service, default is 'false'
	TokenRelay *bool `json:"tokenRelay,omitempty"`

	// Full uri, will override appName.
	URI *string `json:"uri,omitempty"`
}

GatewayAPIRoute - API route config of the Spring Cloud Gateway

func (GatewayAPIRoute) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayAPIRoute.

type GatewayCorsProperties added in v0.3.0 

type GatewayCorsProperties struct {
	// Whether user credentials are supported on cross-site requests. Valid values: true, false.
	AllowCredentials *bool `json:"allowCredentials,omitempty"`

	// Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
	AllowedHeaders []*string `json:"allowedHeaders,omitempty"`

	// 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 `json:"allowedMethods,omitempty"`

	// Allowed origins to make cross-site requests. The special value * allows all domains.
	AllowedOrigins []*string `json:"allowedOrigins,omitempty"`

	// HTTP response headers to expose for cross-site requests.
	ExposedHeaders []*string `json:"exposedHeaders,omitempty"`

	// How long, in seconds, the response from a pre-flight request can be cached by clients.
	MaxAge *int32 `json:"maxAge,omitempty"`
}

GatewayCorsProperties - Cross-Origin Resource Sharing property

func (GatewayCorsProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayCorsProperties.

type GatewayCustomDomainProperties added in v0.3.0 

type GatewayCustomDomainProperties struct {
	// The thumbprint of bound certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
}

GatewayCustomDomainProperties - The properties of custom domain for Spring Cloud Gateway

type GatewayCustomDomainResource added in v0.3.0 

type GatewayCustomDomainResource struct {
	// The properties of custom domain for Spring Cloud Gateway
	Properties *GatewayCustomDomainProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

GatewayCustomDomainResource - Custom domain of the Spring Cloud Gateway

type GatewayCustomDomainResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Spring Cloud Gateway custom domain resources
	Value []*GatewayCustomDomainResource `json:"value,omitempty"`
}

GatewayCustomDomainResourceCollection - Object that includes an array of Spring Cloud Gateway custom domain resources and a possible link for next set

func (GatewayCustomDomainResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayCustomDomainResourceCollection.

type GatewayCustomDomainsClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *GatewayCustomDomainsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, domainName string, gatewayCustomDomainResource GatewayCustomDomainResource, options *GatewayCustomDomainsClientBeginCreateOrUpdateOptions) (*armruntime.Poller[GatewayCustomDomainsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update the Spring Cloud Gateway custom domain. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayCustomDomains_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		"<domain-name>",
		armappplatform.GatewayCustomDomainResource{
			Properties: &armappplatform.GatewayCustomDomainProperties{
				Thumbprint: to.Ptr("<thumbprint>"),
			},
		},
		&armappplatform.GatewayCustomDomainsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*GatewayCustomDomainsClient) BeginDelete added in v0.3.0 

func (client *GatewayCustomDomainsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, domainName string, options *GatewayCustomDomainsClientBeginDeleteOptions) (*armruntime.Poller[GatewayCustomDomainsClientDeleteResponse], error)

BeginDelete - Delete the Spring Cloud Gateway custom domain. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayCustomDomains_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		"<domain-name>",
		&armappplatform.GatewayCustomDomainsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*GatewayCustomDomainsClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayCustomDomains_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		"<domain-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*GatewayCustomDomainsClient) NewListPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayCustomDomains_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayCustomDomainsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type GatewayCustomDomainsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

GatewayCustomDomainsClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewayCustomDomainsClient.BeginCreateOrUpdate method.

type GatewayCustomDomainsClientBeginDeleteOptions added in v0.3.0 

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

GatewayCustomDomainsClientBeginDeleteOptions contains the optional parameters for the GatewayCustomDomainsClient.BeginDelete method.

type GatewayCustomDomainsClientCreateOrUpdateResponse added in v0.3.0 

type GatewayCustomDomainsClientCreateOrUpdateResponse struct {
	GatewayCustomDomainResource
}

GatewayCustomDomainsClientCreateOrUpdateResponse contains the response from method GatewayCustomDomainsClient.CreateOrUpdate.

type GatewayCustomDomainsClientDeleteResponse added in v0.3.0 

type GatewayCustomDomainsClientDeleteResponse struct {
}

GatewayCustomDomainsClientDeleteResponse contains the response from method GatewayCustomDomainsClient.Delete.

type GatewayCustomDomainsClientGetOptions added in v0.3.0 

type GatewayCustomDomainsClientGetOptions struct {
}

GatewayCustomDomainsClientGetOptions contains the optional parameters for the GatewayCustomDomainsClient.Get method.

type GatewayCustomDomainsClientGetResponse added in v0.3.0 

type GatewayCustomDomainsClientGetResponse struct {
	GatewayCustomDomainResource
}

GatewayCustomDomainsClientGetResponse contains the response from method GatewayCustomDomainsClient.Get.

type GatewayCustomDomainsClientListOptions added in v0.3.0 

type GatewayCustomDomainsClientListOptions struct {
}

GatewayCustomDomainsClientListOptions contains the optional parameters for the GatewayCustomDomainsClient.List method.

type GatewayCustomDomainsClientListResponse added in v0.3.0 

type GatewayCustomDomainsClientListResponse struct {
	GatewayCustomDomainResourceCollection
}

GatewayCustomDomainsClientListResponse contains the response from method GatewayCustomDomainsClient.List.

type GatewayInstance added in v0.3.0 

type GatewayInstance struct {
	// READ-ONLY; Name of the Spring Cloud Gateway instance
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Status of the Spring Cloud Gateway instance
	Status *string `json:"status,omitempty" azure:"ro"`
}

GatewayInstance - Collection of instances belong to the Spring Cloud Gateway

type GatewayOperatorProperties added in v0.3.0 

type GatewayOperatorProperties struct {
	// READ-ONLY; Collection of instances belong to Spring Cloud Gateway operator.
	Instances []*GatewayInstance `json:"instances,omitempty" azure:"ro"`

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *GatewayOperatorResourceRequests `json:"resourceRequests,omitempty" azure:"ro"`
}

GatewayOperatorProperties - Properties of the Spring Cloud Gateway Operator.

func (GatewayOperatorProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayOperatorProperties.

type GatewayOperatorResourceRequests added in v0.3.0 

type GatewayOperatorResourceRequests struct {
	// READ-ONLY; Cpu allocated to each Spring Cloud Gateway Operator instance.
	CPU *string `json:"cpu,omitempty" azure:"ro"`

	// READ-ONLY; Instance count of the Spring Cloud Gateway Operator.
	InstanceCount *int32 `json:"instanceCount,omitempty" azure:"ro"`

	// READ-ONLY; Memory allocated to each Spring Cloud Gateway Operator instance.
	Memory *string `json:"memory,omitempty" azure:"ro"`
}

GatewayOperatorResourceRequests - Properties of the Spring Cloud Gateway Operator.

type GatewayProperties added in v0.3.0 

type GatewayProperties struct {
	// API metadata property for Spring Cloud Gateway
	APIMetadataProperties *GatewayAPIMetadataProperties `json:"apiMetadataProperties,omitempty"`

	// Cross-Origin Resource Sharing property
	CorsProperties *GatewayCorsProperties `json:"corsProperties,omitempty"`

	// Indicate if only https is allowed.
	HTTPSOnly *bool `json:"httpsOnly,omitempty"`

	// Indicates whether the Spring Cloud Gateway exposes endpoint.
	Public *bool `json:"public,omitempty"`

	// The requested resource quantity for required CPU and Memory.
	ResourceRequests *GatewayResourceRequests `json:"resourceRequests,omitempty"`

	// Single sign-on related configuration
	SsoProperties *SsoProperties `json:"ssoProperties,omitempty"`

	// READ-ONLY; Collection of instances belong to Spring Cloud Gateway.
	Instances []*GatewayInstance `json:"instances,omitempty" azure:"ro"`

	// READ-ONLY; Properties of the Spring Cloud Gateway Operator.
	OperatorProperties *GatewayOperatorProperties `json:"operatorProperties,omitempty" azure:"ro"`

	// READ-ONLY; State of the Spring Cloud Gateway.
	ProvisioningState *GatewayProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; URL of the Spring Cloud Gateway, exposed when 'public' is true.
	URL *string `json:"url,omitempty" azure:"ro"`
}

GatewayProperties - Spring Cloud Gateway properties payload

func (GatewayProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayProperties.

type GatewayProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleGatewayProvisioningStateValues() []GatewayProvisioningState

PossibleGatewayProvisioningStateValues returns the possible values for the GatewayProvisioningState const type.

type GatewayResource added in v0.3.0 

type GatewayResource struct {
	// Spring Cloud Gateway properties payload
	Properties *GatewayProperties `json:"properties,omitempty"`

	// Sku of the Spring Cloud Gateway resource
	SKU *SKU `json:"sku,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

GatewayResource - Spring Cloud Gateway resource

type GatewayResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of gateway resources
	Value []*GatewayResource `json:"value,omitempty"`
}

GatewayResourceCollection - Object that includes an array of gateway resources and a possible link for next set

func (GatewayResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayResourceCollection.

type GatewayResourceRequests added in v0.3.0 

type GatewayResourceRequests struct {
	// Cpu allocated to each Spring Cloud Gateway instance.
	CPU *string `json:"cpu,omitempty"`

	// Memory allocated to each Spring Cloud Gateway instance.
	Memory *string `json:"memory,omitempty"`
}

GatewayResourceRequests - Resource request payload of Spring Cloud Gateway.

type GatewayRouteConfigProperties added in v0.3.0 

type GatewayRouteConfigProperties struct {
	// The resource Id of the Azure Spring Cloud app, required unless route defines uri.
	AppResourceID *string `json:"appResourceId,omitempty"`

	// Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
	Routes []*GatewayAPIRoute `json:"routes,omitempty"`

	// READ-ONLY; State of the Spring Cloud Gateway route config.
	ProvisioningState *GatewayProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

GatewayRouteConfigProperties - API route config of the Spring Cloud Gateway

func (GatewayRouteConfigProperties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayRouteConfigProperties.

type GatewayRouteConfigResource added in v0.3.0 

type GatewayRouteConfigResource struct {
	// API route config of the Spring Cloud Gateway
	Properties *GatewayRouteConfigProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

GatewayRouteConfigResource - Spring Cloud Gateway route config resource

type GatewayRouteConfigResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Spring Cloud Gateway route config resources
	Value []*GatewayRouteConfigResource `json:"value,omitempty"`
}

GatewayRouteConfigResourceCollection - Object that includes an array of Spring Cloud Gateway route config resources and a possible link for next set

func (GatewayRouteConfigResourceCollection) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type GatewayRouteConfigResourceCollection.

type GatewayRouteConfigsClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *GatewayRouteConfigsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, routeConfigName string, gatewayRouteConfigResource GatewayRouteConfigResource, options *GatewayRouteConfigsClientBeginCreateOrUpdateOptions) (*armruntime.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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayRouteConfigs_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayRouteConfigsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		"<route-config-name>",
		armappplatform.GatewayRouteConfigResource{
			Properties: &armappplatform.GatewayRouteConfigProperties{
				AppResourceID: to.Ptr("<app-resource-id>"),
				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("<title>"),
					}},
			},
		},
		&armappplatform.GatewayRouteConfigsClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*GatewayRouteConfigsClient) BeginDelete added in v0.3.0 

func (client *GatewayRouteConfigsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, routeConfigName string, options *GatewayRouteConfigsClientBeginDeleteOptions) (*armruntime.Poller[GatewayRouteConfigsClientDeleteResponse], error)

BeginDelete - Delete the Spring Cloud Gateway route config. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayRouteConfigs_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayRouteConfigsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		"<route-config-name>",
		&armappplatform.GatewayRouteConfigsClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*GatewayRouteConfigsClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayRouteConfigs_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayRouteConfigsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		"<route-config-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*GatewayRouteConfigsClient) NewListPager added in v0.5.0 

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. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/GatewayRouteConfigs_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewayRouteConfigsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type GatewayRouteConfigsClientBeginCreateOrUpdateOptions added in v0.3.0 

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

GatewayRouteConfigsClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewayRouteConfigsClient.BeginCreateOrUpdate method.

type GatewayRouteConfigsClientBeginDeleteOptions added in v0.3.0 

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

GatewayRouteConfigsClientBeginDeleteOptions contains the optional parameters for the GatewayRouteConfigsClient.BeginDelete method.

type GatewayRouteConfigsClientCreateOrUpdateResponse added in v0.3.0 

type GatewayRouteConfigsClientCreateOrUpdateResponse struct {
	GatewayRouteConfigResource
}

GatewayRouteConfigsClientCreateOrUpdateResponse contains the response from method GatewayRouteConfigsClient.CreateOrUpdate.

type GatewayRouteConfigsClientDeleteResponse added in v0.3.0 

type GatewayRouteConfigsClientDeleteResponse struct {
}

GatewayRouteConfigsClientDeleteResponse contains the response from method GatewayRouteConfigsClient.Delete.

type GatewayRouteConfigsClientGetOptions added in v0.3.0 

type GatewayRouteConfigsClientGetOptions struct {
}

GatewayRouteConfigsClientGetOptions contains the optional parameters for the GatewayRouteConfigsClient.Get method.

type GatewayRouteConfigsClientGetResponse added in v0.3.0 

type GatewayRouteConfigsClientGetResponse struct {
	GatewayRouteConfigResource
}

GatewayRouteConfigsClientGetResponse contains the response from method GatewayRouteConfigsClient.Get.

type GatewayRouteConfigsClientListOptions added in v0.3.0 

type GatewayRouteConfigsClientListOptions struct {
}

GatewayRouteConfigsClientListOptions contains the optional parameters for the GatewayRouteConfigsClient.List method.

type GatewayRouteConfigsClientListResponse added in v0.3.0 

type GatewayRouteConfigsClientListResponse struct {
	GatewayRouteConfigResourceCollection
}

GatewayRouteConfigsClientListResponse contains the response from method GatewayRouteConfigsClient.List.

type GatewaysClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *GatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, gatewayResource GatewayResource, options *GatewaysClientBeginCreateOrUpdateOptions) (*armruntime.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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Gateways_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewaysClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		armappplatform.GatewayResource{
			Properties: &armappplatform.GatewayProperties{
				Public: to.Ptr(true),
				ResourceRequests: &armappplatform.GatewayResourceRequests{
					CPU:    to.Ptr("<cpu>"),
					Memory: to.Ptr("<memory>"),
				},
			},
			SKU: &armappplatform.SKU{
				Name:     to.Ptr("<name>"),
				Capacity: to.Ptr[int32](2),
				Tier:     to.Ptr("<tier>"),
			},
		},
		&armappplatform.GatewaysClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*GatewaysClient) BeginDelete added in v0.3.0 

func (client *GatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, gatewayName string, options *GatewaysClientBeginDeleteOptions) (*armruntime.Poller[GatewaysClientDeleteResponse], error)

BeginDelete - Disable the default Spring Cloud Gateway. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Gateways_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewaysClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		&armappplatform.GatewaysClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*GatewaysClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Gateways_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewaysClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*GatewaysClient) NewListPager added in v0.5.0 

func (client *GatewaysClient) NewListPager(resourceGroupName string, serviceName string, options *GatewaysClientListOptions) *runtime.Pager[GatewaysClientListResponse]

NewListPager - Handles requests to list all resources in a Service. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Gateways_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewaysClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*GatewaysClient) ValidateDomain added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Gateways_ValidateDomain.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewGatewaysClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ValidateDomain(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<gateway-name>",
		armappplatform.CustomDomainValidatePayload{
			Name: to.Ptr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type GatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

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

GatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewaysClient.BeginCreateOrUpdate method.

type GatewaysClientBeginDeleteOptions added in v0.3.0 

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

GatewaysClientBeginDeleteOptions contains the optional parameters for the GatewaysClient.BeginDelete method.

type GatewaysClientCreateOrUpdateResponse added in v0.3.0 

type GatewaysClientCreateOrUpdateResponse struct {
	GatewayResource
}

GatewaysClientCreateOrUpdateResponse contains the response from method GatewaysClient.CreateOrUpdate.

type GatewaysClientDeleteResponse added in v0.3.0 

type GatewaysClientDeleteResponse struct {
}

GatewaysClientDeleteResponse contains the response from method GatewaysClient.Delete.

type GatewaysClientGetOptions added in v0.3.0 

type GatewaysClientGetOptions struct {
}

GatewaysClientGetOptions contains the optional parameters for the GatewaysClient.Get method.

type GatewaysClientGetResponse added in v0.3.0 

type GatewaysClientGetResponse struct {
	GatewayResource
}

GatewaysClientGetResponse contains the response from method GatewaysClient.Get.

type GatewaysClientListOptions added in v0.3.0 

type GatewaysClientListOptions struct {
}

GatewaysClientListOptions contains the optional parameters for the GatewaysClient.List method.

type GatewaysClientListResponse added in v0.3.0 

type GatewaysClientListResponse struct {
	GatewayResourceCollection
}

GatewaysClientListResponse contains the response from method GatewaysClient.List.

type GatewaysClientValidateDomainOptions added in v0.3.0 

type GatewaysClientValidateDomainOptions struct {
}

GatewaysClientValidateDomainOptions contains the optional parameters for the GatewaysClient.ValidateDomain method.

type GatewaysClientValidateDomainResponse added in v0.3.0 

type GatewaysClientValidateDomainResponse struct {
	CustomDomainValidateResult
}

GatewaysClientValidateDomainResponse contains the response from method GatewaysClient.ValidateDomain.

type GitPatternRepository 

type GitPatternRepository struct {
	// REQUIRED; Name of the repository
	Name *string `json:"name,omitempty"`

	// REQUIRED; URI of the repository
	URI *string `json:"uri,omitempty"`

	// Public sshKey of git repository.
	HostKey *string `json:"hostKey,omitempty"`

	// SshKey algorithm of git repository.
	HostKeyAlgorithm *string `json:"hostKeyAlgorithm,omitempty"`

	// Label of the repository
	Label *string `json:"label,omitempty"`

	// Password of git repository basic auth.
	Password *string `json:"password,omitempty"`

	// Collection of pattern of the repository
	Pattern []*string `json:"pattern,omitempty"`

	// Private sshKey algorithm of git repository.
	PrivateKey *string `json:"privateKey,omitempty"`

	// Searching path of the repository
	SearchPaths []*string `json:"searchPaths,omitempty"`

	// Strict host key checking or not.
	StrictHostKeyChecking *bool `json:"strictHostKeyChecking,omitempty"`

	// Username of git repository basic auth.
	Username *string `json:"username,omitempty"`
}

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.

type ImageRegistryCredential 

type ImageRegistryCredential struct {
	// The password of the image registry credential
	Password *string `json:"password,omitempty"`

	// The username of the image registry credential
	Username *string `json:"username,omitempty"`
}

ImageRegistryCredential - Credential of the image registry

type JarUploadedUserSourceInfo added in v0.3.0 

type JarUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// JVM parameter
	JvmOptions *string `json:"jvmOptions,omitempty"`

	// Relative path of the storage which stores the source
	RelativePath *string `json:"relativePath,omitempty"`

	// Runtime version of the Jar file
	RuntimeVersion *string `json:"runtimeVersion,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

JarUploadedUserSourceInfo - Uploaded Jar binary for a deployment

func (*JarUploadedUserSourceInfo) GetUploadedUserSourceInfo added in v0.3.0 

func (j *JarUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type JarUploadedUserSourceInfo.

func (*JarUploadedUserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (j *JarUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type JarUploadedUserSourceInfo.

func (JarUploadedUserSourceInfo) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type JarUploadedUserSourceInfo.

func (*JarUploadedUserSourceInfo) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JarUploadedUserSourceInfo.

type KPackBuildStageProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleKPackBuildStageProvisioningStateValues() []KPackBuildStageProvisioningState

PossibleKPackBuildStageProvisioningStateValues returns the possible values for the KPackBuildStageProvisioningState const type.

type KeyVaultCertificateProperties added in v0.2.0 

type KeyVaultCertificateProperties struct {
	// REQUIRED; The certificate name of key vault.
	KeyVaultCertName *string `json:"keyVaultCertName,omitempty"`

	// REQUIRED; The type of the certificate source.
	Type *string `json:"type,omitempty"`

	// REQUIRED; The vault uri of user key vault.
	VaultURI *string `json:"vaultUri,omitempty"`

	// The certificate version of key vault.
	CertVersion *string `json:"certVersion,omitempty"`

	// Optional. If set to true, it will not import private key from key vault.
	ExcludePrivateKey *bool `json:"excludePrivateKey,omitempty"`

	// READ-ONLY; The activate date of certificate.
	ActivateDate *string `json:"activateDate,omitempty" azure:"ro"`

	// READ-ONLY; The domain list of certificate.
	DNSNames []*string `json:"dnsNames,omitempty" azure:"ro"`

	// READ-ONLY; The expiration date of certificate.
	ExpirationDate *string `json:"expirationDate,omitempty" azure:"ro"`

	// READ-ONLY; The issue date of certificate.
	IssuedDate *string `json:"issuedDate,omitempty" azure:"ro"`

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

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

	// READ-ONLY; The thumbprint of certificate.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`
}

KeyVaultCertificateProperties - Properties of certificate imported from key vault.

func (*KeyVaultCertificateProperties) GetCertificateProperties added in v0.3.0 

func (k *KeyVaultCertificateProperties) GetCertificateProperties() *CertificateProperties

GetCertificateProperties implements the CertificatePropertiesClassification interface for type KeyVaultCertificateProperties.

func (KeyVaultCertificateProperties) MarshalJSON added in v0.2.0 

func (k KeyVaultCertificateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultCertificateProperties.

func (*KeyVaultCertificateProperties) UnmarshalJSON added in v0.2.0 

func (k *KeyVaultCertificateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultCertificateProperties.

type LastModifiedByType added in v0.3.0 

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 added in v0.3.0 

func PossibleLastModifiedByTypeValues() []LastModifiedByType

PossibleLastModifiedByTypeValues returns the possible values for the LastModifiedByType const type.

type LoadedCertificate added in v0.2.0 

type LoadedCertificate struct {
	// REQUIRED; Resource Id of loaded certificate
	ResourceID *string `json:"resourceId,omitempty"`

	// Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.
	LoadTrustStore *bool `json:"loadTrustStore,omitempty"`
}

LoadedCertificate - Loaded certificate payload

type LogFileURLResponse 

type LogFileURLResponse struct {
	// REQUIRED; URL of the log file
	URL *string `json:"url,omitempty"`
}

LogFileURLResponse - Log file URL payload

type LogSpecification 

type LogSpecification struct {
	// Blob duration of the log
	BlobDuration *string `json:"blobDuration,omitempty"`

	// Localized friendly display name of the log
	DisplayName *string `json:"displayName,omitempty"`

	// Name of the log
	Name *string `json:"name,omitempty"`
}

LogSpecification - Specifications of the Log for Azure Monitoring

type ManagedIdentityProperties 

type ManagedIdentityProperties struct {
	// Principal Id of system-assigned managed identity.
	PrincipalID *string `json:"principalId,omitempty"`

	// Tenant Id of system-assigned managed identity.
	TenantID *string `json:"tenantId,omitempty"`

	// Type of the managed identity
	Type *ManagedIdentityType `json:"type,omitempty"`

	// Properties of user-assigned managed identities
	UserAssignedIdentities map[string]*UserAssignedManagedIdentity `json:"userAssignedIdentities,omitempty"`
}

ManagedIdentityProperties - Managed identity properties retrieved from ARM request headers.

func (ManagedIdentityProperties) MarshalJSON added in v0.4.0 

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

MarshalJSON implements the json.Marshaller 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 MetricDimension 

type MetricDimension struct {
	// Localized friendly display name of the dimension
	DisplayName *string `json:"displayName,omitempty"`

	// Name of the dimension
	Name *string `json:"name,omitempty"`

	// Whether this dimension should be included for the Shoebox export scenario
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

MetricDimension - Specifications of the Dimension of metrics

type MetricSpecification 

type MetricSpecification struct {
	// Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
	AggregationType *string `json:"aggregationType,omitempty"`

	// Name of the metric category that the metric belongs to. A metric can only belong to a single category.
	Category *string `json:"category,omitempty"`

	// Dimensions of the metric
	Dimensions []*MetricDimension `json:"dimensions,omitempty"`

	// Localized friendly description of the metric
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// Localized friendly display name of the metric
	DisplayName *string `json:"displayName,omitempty"`

	// Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// Name of the metric
	Name *string `json:"name,omitempty"`

	// Name of the MDM namespace. Optional.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty"`

	// Supported aggregation types
	SupportedAggregationTypes []*string `json:"supportedAggregationTypes,omitempty"`

	// Supported time grain types
	SupportedTimeGrainTypes []*string `json:"supportedTimeGrainTypes,omitempty"`

	// Unit that makes sense for the metric
	Unit *string `json:"unit,omitempty"`
}

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.

type MonitoringSettingProperties 

type MonitoringSettingProperties struct {
	// Indicates the versions of application insight agent
	AppInsightsAgentVersions *ApplicationInsightsAgentVersions `json:"appInsightsAgentVersions,omitempty"`

	// Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
	AppInsightsInstrumentationKey *string `json:"appInsightsInstrumentationKey,omitempty"`

	// Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
	AppInsightsSamplingRate *float64 `json:"appInsightsSamplingRate,omitempty"`

	// Error when apply Monitoring Setting changes.
	Error *Error `json:"error,omitempty"`

	// 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 `json:"traceEnabled,omitempty"`

	// READ-ONLY; State of the Monitoring Setting.
	ProvisioningState *MonitoringSettingState `json:"provisioningState,omitempty" azure:"ro"`
}

MonitoringSettingProperties - Monitoring Setting properties payload

type MonitoringSettingResource 

type MonitoringSettingResource struct {
	// Properties of the Monitoring Setting resource
	Properties *MonitoringSettingProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

MonitoringSettingResource - Monitoring Setting resource

func (MonitoringSettingResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller 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) (*armruntime.Poller[MonitoringSettingsClientUpdatePatchResponse], error)

BeginUpdatePatch - Update the Monitoring Setting. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/MonitoringSettings_UpdatePatch.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewMonitoringSettingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdatePatch(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.MonitoringSettingResource{
			Properties: &armappplatform.MonitoringSettingProperties{
				AppInsightsInstrumentationKey: to.Ptr("<app-insights-instrumentation-key>"),
				AppInsightsSamplingRate:       to.Ptr[float64](10),
				TraceEnabled:                  to.Ptr(true),
			},
		},
		&armappplatform.MonitoringSettingsClientBeginUpdatePatchOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*MonitoringSettingsClient) BeginUpdatePut 

func (client *MonitoringSettingsClient) BeginUpdatePut(ctx context.Context, resourceGroupName string, serviceName string, monitoringSettingResource MonitoringSettingResource, options *MonitoringSettingsClientBeginUpdatePutOptions) (*armruntime.Poller[MonitoringSettingsClientUpdatePutResponse], error)

BeginUpdatePut - Update the Monitoring Setting. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/MonitoringSettings_UpdatePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewMonitoringSettingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdatePut(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.MonitoringSettingResource{
			Properties: &armappplatform.MonitoringSettingProperties{
				AppInsightsInstrumentationKey: to.Ptr("<app-insights-instrumentation-key>"),
				AppInsightsSamplingRate:       to.Ptr[float64](10),
				TraceEnabled:                  to.Ptr(true),
			},
		},
		&armappplatform.MonitoringSettingsClientBeginUpdatePutOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/MonitoringSettings_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewMonitoringSettingsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type MonitoringSettingsClientBeginUpdatePatchOptions added in v0.3.0 

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

MonitoringSettingsClientBeginUpdatePatchOptions contains the optional parameters for the MonitoringSettingsClient.BeginUpdatePatch method.

type MonitoringSettingsClientBeginUpdatePutOptions added in v0.3.0 

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

MonitoringSettingsClientBeginUpdatePutOptions contains the optional parameters for the MonitoringSettingsClient.BeginUpdatePut method.

type MonitoringSettingsClientGetOptions added in v0.3.0 

type MonitoringSettingsClientGetOptions struct {
}

MonitoringSettingsClientGetOptions contains the optional parameters for the MonitoringSettingsClient.Get method.

type MonitoringSettingsClientGetResponse added in v0.3.0 

type MonitoringSettingsClientGetResponse struct {
	MonitoringSettingResource
}

MonitoringSettingsClientGetResponse contains the response from method MonitoringSettingsClient.Get.

type MonitoringSettingsClientUpdatePatchResponse added in v0.3.0 

type MonitoringSettingsClientUpdatePatchResponse struct {
	MonitoringSettingResource
}

MonitoringSettingsClientUpdatePatchResponse contains the response from method MonitoringSettingsClient.UpdatePatch.

type MonitoringSettingsClientUpdatePutResponse added in v0.3.0 

type MonitoringSettingsClientUpdatePutResponse struct {
	MonitoringSettingResource
}

MonitoringSettingsClientUpdatePutResponse contains the response from method MonitoringSettingsClient.UpdatePut.

type NameAvailability 

type NameAvailability struct {
	// Message why the name is not available
	Message *string `json:"message,omitempty"`

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

	// Reason why the name is not available
	Reason *string `json:"reason,omitempty"`
}

NameAvailability - Name availability result payload

type NameAvailabilityParameters 

type NameAvailabilityParameters struct {
	// REQUIRED; Name to be checked
	Name *string `json:"name,omitempty"`

	// REQUIRED; Type of the resource to check name availability
	Type *string `json:"type,omitempty"`
}

NameAvailabilityParameters - Name availability parameters payload

type NetCoreZipUploadedUserSourceInfo added in v0.3.0 

type NetCoreZipUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// The path to the .NET executable relative to zip root
	NetCoreMainEntryPath *string `json:"netCoreMainEntryPath,omitempty"`

	// Relative path of the storage which stores the source
	RelativePath *string `json:"relativePath,omitempty"`

	// Runtime version of the .Net file
	RuntimeVersion *string `json:"runtimeVersion,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

NetCoreZipUploadedUserSourceInfo - Uploaded Jar binary for a deployment

func (*NetCoreZipUploadedUserSourceInfo) GetUploadedUserSourceInfo added in v0.3.0 

func (n *NetCoreZipUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type NetCoreZipUploadedUserSourceInfo.

func (*NetCoreZipUploadedUserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (n *NetCoreZipUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type NetCoreZipUploadedUserSourceInfo.

func (NetCoreZipUploadedUserSourceInfo) MarshalJSON added in v0.3.0 

func (n NetCoreZipUploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetCoreZipUploadedUserSourceInfo.

func (*NetCoreZipUploadedUserSourceInfo) UnmarshalJSON added in v0.3.0 

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 of Azure Spring Cloud Apps
	AppNetworkResourceGroup *string `json:"appNetworkResourceGroup,omitempty"`

	// Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps
	AppSubnetID *string `json:"appSubnetId,omitempty"`

	// Azure Spring Cloud service reserved CIDR
	ServiceCidr *string `json:"serviceCidr,omitempty"`

	// Name of the resource group containing network resources of Azure Spring Cloud Service Runtime
	ServiceRuntimeNetworkResourceGroup *string `json:"serviceRuntimeNetworkResourceGroup,omitempty"`

	// Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime
	ServiceRuntimeSubnetID *string `json:"serviceRuntimeSubnetId,omitempty"`

	// READ-ONLY; Desired outbound IP resources for Azure Spring Cloud instance.
	OutboundIPs *NetworkProfileOutboundIPs `json:"outboundIPs,omitempty" azure:"ro"`

	// READ-ONLY; Required inbound or outbound traffics for Azure Spring Cloud instance.
	RequiredTraffics []*RequiredTraffic `json:"requiredTraffics,omitempty" azure:"ro"`
}

NetworkProfile - Service network profile payload

func (NetworkProfile) MarshalJSON 

func (n NetworkProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkProfile.

type NetworkProfileOutboundIPs 

type NetworkProfileOutboundIPs struct {
	// READ-ONLY; A list of public IP addresses.
	PublicIPs []*string `json:"publicIPs,omitempty" azure:"ro"`
}

NetworkProfileOutboundIPs - Desired outbound IP resources for Azure Spring Cloud instance.

func (NetworkProfileOutboundIPs) MarshalJSON 

func (n NetworkProfileOutboundIPs) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkProfileOutboundIPs.

type OperationDetail 

type OperationDetail struct {
	// Display of the operation
	Display *OperationDisplay `json:"display,omitempty"`

	// Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Name of the operation
	Name *string `json:"name,omitempty"`

	// Origin of the operation
	Origin *string `json:"origin,omitempty"`

	// Properties of the operation
	Properties *OperationProperties `json:"properties,omitempty"`

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType `json:"actionType,omitempty" azure:"ro"`
}

OperationDetail - Operation detail payload

type OperationDisplay 

type OperationDisplay struct {
	// Localized friendly description for the operation
	Description *string `json:"description,omitempty"`

	// Localized friendly name for the operation
	Operation *string `json:"operation,omitempty"`

	// Resource provider of the operation
	Provider *string `json:"provider,omitempty"`

	// Resource of the operation
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Operation display payload

type OperationProperties 

type OperationProperties struct {
	// Service specifications of the operation
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - Extra Operation properties

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 added in v0.5.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available REST API operations of the Microsoft.AppPlatform provider. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Operations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	AvailableOperations
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PersistentDisk 

type PersistentDisk struct {
	// Mount path of the persistent disk
	MountPath *string `json:"mountPath,omitempty"`

	// Size of the persistent disk in GB
	SizeInGB *int32 `json:"sizeInGB,omitempty"`

	// READ-ONLY; Size of the used persistent disk in GB
	UsedInGB *int32 `json:"usedInGB,omitempty" azure:"ro"`
}

PersistentDisk - Persistent disk payload

type PowerState added in v0.2.0 

type PowerState string

PowerState - Power state of the Service 

const (
	PowerStateRunning PowerState = "Running"
	PowerStateStopped PowerState = "Stopped"
)

func PossiblePowerStateValues added in v0.2.0 

func PossiblePowerStateValues() []PowerState

PossiblePowerStateValues returns the possible values for the PowerState 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 `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

type RegenerateTestKeyRequestPayload 

type RegenerateTestKeyRequestPayload struct {
	// REQUIRED; Type of the test key
	KeyType *TestKeyType `json:"keyType,omitempty"`
}

RegenerateTestKeyRequestPayload - Regenerate test key request payload

type RequiredTraffic 

type RequiredTraffic struct {
	// READ-ONLY; The direction of required traffic
	Direction *TrafficDirection `json:"direction,omitempty" azure:"ro"`

	// READ-ONLY; The FQDN list of required traffic
	Fqdns []*string `json:"fqdns,omitempty" azure:"ro"`

	// READ-ONLY; The ip list of required traffic
	IPs []*string `json:"ips,omitempty" azure:"ro"`

	// READ-ONLY; The port of required traffic
	Port *int32 `json:"port,omitempty" azure:"ro"`

	// READ-ONLY; The protocol of required traffic
	Protocol *string `json:"protocol,omitempty" azure:"ro"`
}

RequiredTraffic - Required inbound or outbound traffic for Azure Spring Cloud instance.

func (RequiredTraffic) MarshalJSON 

func (r RequiredTraffic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequiredTraffic.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - The core properties of ARM resources.

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 `json:"cpu,omitempty"`

	// 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 `json:"memory,omitempty"`
}

ResourceRequests - Deployment resource request payload

type ResourceSKU 

type ResourceSKU struct {
	// Gets the capacity of SKU.
	Capacity *SKUCapacity `json:"capacity,omitempty"`

	// Gets a list of locations and availability zones in those locations where the SKU is available.
	LocationInfo []*ResourceSKULocationInfo `json:"locationInfo,omitempty"`

	// Gets the set of locations that the SKU is available.
	Locations []*string `json:"locations,omitempty"`

	// Gets the name of SKU.
	Name *string `json:"name,omitempty"`

	// Gets the type of resource the SKU applies to.
	ResourceType *string `json:"resourceType,omitempty"`

	// Gets the restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions []*ResourceSKURestrictions `json:"restrictions,omitempty"`

	// Gets the tier of SKU.
	Tier *string `json:"tier,omitempty"`
}

ResourceSKU - Describes an available Azure Spring Cloud SKU.

func (ResourceSKU) MarshalJSON 

func (r ResourceSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKU.

type ResourceSKUCapabilities 

type ResourceSKUCapabilities struct {
	// Gets an invariant to describe the feature.
	Name *string `json:"name,omitempty"`

	// Gets an invariant if the feature is measured by quantity.
	Value *string `json:"value,omitempty"`
}

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 `json:"nextLink,omitempty"`

	// Collection of resource SKU
	Value []*ResourceSKU `json:"value,omitempty"`
}

ResourceSKUCollection - Object that includes an array of Azure Spring Cloud 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.

type ResourceSKULocationInfo 

type ResourceSKULocationInfo struct {
	// Gets location of the SKU
	Location *string `json:"location,omitempty"`

	// Gets details of capabilities available to a SKU in specific zones.
	ZoneDetails []*ResourceSKUZoneDetails `json:"zoneDetails,omitempty"`

	// Gets list of availability zones where the SKU is supported.
	Zones []*string `json:"zones,omitempty"`
}

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.

type ResourceSKURestrictionInfo 

type ResourceSKURestrictionInfo struct {
	// Gets locations where the SKU is restricted
	Locations []*string `json:"locations,omitempty"`

	// Gets list of availability zones where the SKU is restricted.
	Zones []*string `json:"zones,omitempty"`
}

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.

type ResourceSKURestrictions 

type ResourceSKURestrictions struct {
	// Gets the reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription'
	ReasonCode *ResourceSKURestrictionsReasonCode `json:"reasonCode,omitempty"`

	// Gets the information about the restriction where the SKU cannot be used.
	RestrictionInfo *ResourceSKURestrictionInfo `json:"restrictionInfo,omitempty"`

	// Gets the type of restrictions. Possible values include: 'Location', 'Zone'
	Type *ResourceSKURestrictionsType `json:"type,omitempty"`

	// 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 `json:"values,omitempty"`
}

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.

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 `json:"capabilities,omitempty"`

	// Gets the set of zones that the SKU is available in with the specified capabilities.
	Name []*string `json:"name,omitempty"`
}

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.

type ResourceUploadDefinition 

type ResourceUploadDefinition struct {
	// Source relative path
	RelativePath *string `json:"relativePath,omitempty"`

	// Upload URL
	UploadURL *string `json:"uploadUrl,omitempty"`
}

ResourceUploadDefinition - Resource upload definition payload

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. options - RuntimeVersionsClientListRuntimeVersionsOptions contains the optional parameters for the RuntimeVersionsClient.ListRuntimeVersions method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/RuntimeVersions_ListRuntimeVersions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewRuntimeVersionsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListRuntimeVersions(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type RuntimeVersionsClientListRuntimeVersionsOptions added in v0.3.0 

type RuntimeVersionsClientListRuntimeVersionsOptions struct {
}

RuntimeVersionsClientListRuntimeVersionsOptions contains the optional parameters for the RuntimeVersionsClient.ListRuntimeVersions method.

type RuntimeVersionsClientListRuntimeVersionsResponse added in v0.3.0 

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 `json:"capacity,omitempty"`

	// Name of the Sku
	Name *string `json:"name,omitempty"`

	// Tier of the Sku
	Tier *string `json:"tier,omitempty"`
}

SKU - Sku of Azure Spring Cloud

type SKUCapacity 

type SKUCapacity struct {
	// REQUIRED; Gets or sets the minimum.
	Minimum *int32 `json:"minimum,omitempty"`

	// Gets or sets the default.
	Default *int32 `json:"default,omitempty"`

	// Gets or sets the maximum.
	Maximum *int32 `json:"maximum,omitempty"`

	// Gets or sets the type of the scale.
	ScaleType *SKUScaleType `json:"scaleType,omitempty"`
}

SKUCapacity - The SKU capacity

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 added in v0.5.0 

func (client *SKUsClient) NewListPager(options *SKUsClientListOptions) *runtime.Pager[SKUsClientListResponse]

NewListPager - Lists all of the available skus of the Microsoft.AppPlatform provider. If the operation fails it returns an *azcore.ResponseError type. options - SKUsClientListOptions contains the optional parameters for the SKUsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Skus_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewSKUsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type SKUsClientListOptions added in v0.3.0 

type SKUsClientListOptions struct {
}

SKUsClientListOptions contains the optional parameters for the SKUsClient.List method.

type SKUsClientListResponse added in v0.3.0 

type SKUsClientListResponse struct {
	ResourceSKUCollection
}

SKUsClientListResponse contains the response from method SKUsClient.List.

type ServiceRegistriesClient added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

func (client *ServiceRegistriesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, serviceRegistryName string, options *ServiceRegistriesClientBeginCreateOrUpdateOptions) (*armruntime.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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ServiceRegistries_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServiceRegistriesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<service-registry-name>",
		&armappplatform.ServiceRegistriesClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ServiceRegistriesClient) BeginDelete added in v0.3.0 

func (client *ServiceRegistriesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, serviceRegistryName string, options *ServiceRegistriesClientBeginDeleteOptions) (*armruntime.Poller[ServiceRegistriesClientDeleteResponse], error)

BeginDelete - Disable the default Service Registry. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ServiceRegistries_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServiceRegistriesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<service-registry-name>",
		&armappplatform.ServiceRegistriesClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ServiceRegistriesClient) Get added in v0.3.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ServiceRegistries_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServiceRegistriesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<service-registry-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ServiceRegistriesClient) NewListPager added in v0.5.0 

func (client *ServiceRegistriesClient) NewListPager(resourceGroupName string, serviceName string, options *ServiceRegistriesClientListOptions) *runtime.Pager[ServiceRegistriesClientListResponse]

NewListPager - Handles requests to list all resources in a Service. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/ServiceRegistries_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServiceRegistriesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ServiceRegistriesClientBeginCreateOrUpdateOptions added in v0.3.0 

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

ServiceRegistriesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceRegistriesClient.BeginCreateOrUpdate method.

type ServiceRegistriesClientBeginDeleteOptions added in v0.3.0 

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

ServiceRegistriesClientBeginDeleteOptions contains the optional parameters for the ServiceRegistriesClient.BeginDelete method.

type ServiceRegistriesClientCreateOrUpdateResponse added in v0.3.0 

type ServiceRegistriesClientCreateOrUpdateResponse struct {
	ServiceRegistryResource
}

ServiceRegistriesClientCreateOrUpdateResponse contains the response from method ServiceRegistriesClient.CreateOrUpdate.

type ServiceRegistriesClientDeleteResponse added in v0.3.0 

type ServiceRegistriesClientDeleteResponse struct {
}

ServiceRegistriesClientDeleteResponse contains the response from method ServiceRegistriesClient.Delete.

type ServiceRegistriesClientGetOptions added in v0.3.0 

type ServiceRegistriesClientGetOptions struct {
}

ServiceRegistriesClientGetOptions contains the optional parameters for the ServiceRegistriesClient.Get method.

type ServiceRegistriesClientGetResponse added in v0.3.0 

type ServiceRegistriesClientGetResponse struct {
	ServiceRegistryResource
}

ServiceRegistriesClientGetResponse contains the response from method ServiceRegistriesClient.Get.

type ServiceRegistriesClientListOptions added in v0.3.0 

type ServiceRegistriesClientListOptions struct {
}

ServiceRegistriesClientListOptions contains the optional parameters for the ServiceRegistriesClient.List method.

type ServiceRegistriesClientListResponse added in v0.3.0 

type ServiceRegistriesClientListResponse struct {
	ServiceRegistryResourceCollection
}

ServiceRegistriesClientListResponse contains the response from method ServiceRegistriesClient.List.

type ServiceRegistryInstance added in v0.3.0 

type ServiceRegistryInstance struct {
	// READ-ONLY; Name of the Service Registry instance
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Status of the Service Registry instance
	Status *string `json:"status,omitempty" azure:"ro"`
}

ServiceRegistryInstance - Collection of instances belong to the Service Registry

type ServiceRegistryProperties added in v0.3.0 

type ServiceRegistryProperties struct {
	// READ-ONLY; Collection of instances belong to Service Registry.
	Instances []*ServiceRegistryInstance `json:"instances,omitempty" azure:"ro"`

	// READ-ONLY; State of the Service Registry.
	ProvisioningState *ServiceRegistryProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The requested resource quantity for required CPU and Memory.
	ResourceRequests *ServiceRegistryResourceRequests `json:"resourceRequests,omitempty" azure:"ro"`
}

ServiceRegistryProperties - Service Registry properties payload

func (ServiceRegistryProperties) MarshalJSON added in v0.3.0 

func (s ServiceRegistryProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryProperties.

type ServiceRegistryProvisioningState added in v0.3.0 

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 added in v0.3.0 

func PossibleServiceRegistryProvisioningStateValues() []ServiceRegistryProvisioningState

PossibleServiceRegistryProvisioningStateValues returns the possible values for the ServiceRegistryProvisioningState const type.

type ServiceRegistryResource added in v0.3.0 

type ServiceRegistryResource struct {
	// Service Registry properties payload
	Properties *ServiceRegistryProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServiceRegistryResource - Service Registry resource

type ServiceRegistryResourceCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of Service Registry resources
	Value []*ServiceRegistryResource `json:"value,omitempty"`
}

ServiceRegistryResourceCollection - Object that includes an array of Service Registry resources and a possible link for next set

func (ServiceRegistryResourceCollection) MarshalJSON added in v0.3.0 

func (s ServiceRegistryResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceRegistryResourceCollection.

type ServiceRegistryResourceRequests added in v0.3.0 

type ServiceRegistryResourceRequests struct {
	// READ-ONLY; Cpu allocated to each Service Registry instance
	CPU *string `json:"cpu,omitempty" azure:"ro"`

	// READ-ONLY; Instance count of the Service Registry
	InstanceCount *int32 `json:"instanceCount,omitempty" azure:"ro"`

	// READ-ONLY; Memory allocated to each Service Registry instance
	Memory *string `json:"memory,omitempty" azure:"ro"`
}

ServiceRegistryResourceRequests - Resource request payload of Service Registry

type ServiceResource 

type ServiceResource struct {
	// The GEO location of the resource.
	Location *string `json:"location,omitempty"`

	// Properties of the Service resource
	Properties *ClusterResourceProperties `json:"properties,omitempty"`

	// Sku of the Service resource
	SKU *SKU `json:"sku,omitempty"`

	// Tags of the service which is a list of key value pairs that describe the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServiceResource - Service resource

func (ServiceResource) MarshalJSON 

func (s ServiceResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller 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 `json:"nextLink,omitempty"`

	// Collection of Service resources
	Value []*ServiceResource `json:"value,omitempty"`
}

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.

type ServiceSpecification 

type ServiceSpecification struct {
	// Specifications of the Log for Azure Monitoring
	LogSpecifications []*LogSpecification `json:"logSpecifications,omitempty"`

	// Specifications of the Metrics for Azure Monitoring
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification - Service specification payload

func (ServiceSpecification) MarshalJSON 

func (s ServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

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) (*armruntime.Poller[ServicesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a new Service or update an exiting Service. If the operation fails it returns an *azcore.ResponseError type. 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.ServiceResource{
			Location: to.Ptr("<location>"),
			Tags: map[string]*string{
				"key1": to.Ptr("value1"),
			},
			Properties: &armappplatform.ClusterResourceProperties{},
			SKU: &armappplatform.SKU{
				Name: to.Ptr("<name>"),
				Tier: to.Ptr("<tier>"),
			},
		},
		&armappplatform.ServicesClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ServicesClient) BeginDelete 

func (client *ServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginDeleteOptions) (*armruntime.Poller[ServicesClientDeleteResponse], error)

BeginDelete - Operation to delete a Service. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		&armappplatform.ServicesClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ServicesClient) BeginStart added in v0.2.0 

func (client *ServicesClient) BeginStart(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginStartOptions) (*armruntime.Poller[ServicesClientStartResponse], error)

BeginStart - Start a Service. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_Start.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginStart(ctx,
		"<resource-group-name>",
		"<service-name>",
		&armappplatform.ServicesClientBeginStartOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ServicesClient) BeginStop added in v0.2.0 

func (client *ServicesClient) BeginStop(ctx context.Context, resourceGroupName string, serviceName string, options *ServicesClientBeginStopOptions) (*armruntime.Poller[ServicesClientStopResponse], error)

BeginStop - Stop a Service. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_Stop.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginStop(ctx,
		"<resource-group-name>",
		"<service-name>",
		&armappplatform.ServicesClientBeginStopOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*ServicesClient) BeginUpdate 

func (client *ServicesClient) BeginUpdate(ctx context.Context, resourceGroupName string, serviceName string, resource ServiceResource, options *ServicesClientBeginUpdateOptions) (*armruntime.Poller[ServicesClientUpdateResponse], error)

BeginUpdate - Operation to update an exiting Service. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_Update.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.ServiceResource{
			Location: to.Ptr("<location>"),
			Tags: map[string]*string{
				"key1": to.Ptr("value1"),
			},
			Properties: &armappplatform.ClusterResourceProperties{},
			SKU: &armappplatform.SKU{
				Name: to.Ptr("<name>"),
				Tier: to.Ptr("<tier>"),
			},
		},
		&armappplatform.ServicesClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_CheckNameAvailability.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.CheckNameAvailability(ctx,
		"<location>",
		armappplatform.NameAvailabilityParameters{
			Name: to.Ptr("<name>"),
			Type: to.Ptr("<type>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_DisableTestEndpoint.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	_, err = client.DisableTestEndpoint(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_EnableTestEndpoint.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.EnableTestEndpoint(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_ListTestKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.ListTestKeys(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ServicesClient) NewListBySubscriptionPager added in v0.5.0 

func (client *ServicesClient) NewListBySubscriptionPager(options *ServicesClientListBySubscriptionOptions) *runtime.Pager[ServicesClientListBySubscriptionResponse]

NewListBySubscriptionPager - Handles requests to list all resources in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ServicesClientListBySubscriptionOptions contains the optional parameters for the ServicesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ServicesClient) NewListPager added in v0.5.0 

func (client *ServicesClient) NewListPager(resourceGroupName string, options *ServicesClientListOptions) *runtime.Pager[ServicesClientListResponse]

NewListPager - Handles requests to list all resources in a resource group. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Services_RegenerateTestKey.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewServicesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.RegenerateTestKey(ctx,
		"<resource-group-name>",
		"<service-name>",
		armappplatform.RegenerateTestKeyRequestPayload{
			KeyType: to.Ptr(armappplatform.TestKeyTypePrimary),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

type ServicesClientBeginCreateOrUpdateOptions added in v0.3.0 

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

ServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServicesClient.BeginCreateOrUpdate method.

type ServicesClientBeginDeleteOptions added in v0.3.0 

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

ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.

type ServicesClientBeginStartOptions added in v0.3.0 

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

ServicesClientBeginStartOptions contains the optional parameters for the ServicesClient.BeginStart method.

type ServicesClientBeginStopOptions added in v0.3.0 

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

ServicesClientBeginStopOptions contains the optional parameters for the ServicesClient.BeginStop method.

type ServicesClientBeginUpdateOptions added in v0.3.0 

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

ServicesClientBeginUpdateOptions contains the optional parameters for the ServicesClient.BeginUpdate method.

type ServicesClientCheckNameAvailabilityOptions added in v0.3.0 

type ServicesClientCheckNameAvailabilityOptions struct {
}

ServicesClientCheckNameAvailabilityOptions contains the optional parameters for the ServicesClient.CheckNameAvailability method.

type ServicesClientCheckNameAvailabilityResponse added in v0.3.0 

type ServicesClientCheckNameAvailabilityResponse struct {
	NameAvailability
}

ServicesClientCheckNameAvailabilityResponse contains the response from method ServicesClient.CheckNameAvailability.

type ServicesClientCreateOrUpdateResponse added in v0.3.0 

type ServicesClientCreateOrUpdateResponse struct {
	ServiceResource
}

ServicesClientCreateOrUpdateResponse contains the response from method ServicesClient.CreateOrUpdate.

type ServicesClientDeleteResponse added in v0.3.0 

type ServicesClientDeleteResponse struct {
}

ServicesClientDeleteResponse contains the response from method ServicesClient.Delete.

type ServicesClientDisableTestEndpointOptions added in v0.3.0 

type ServicesClientDisableTestEndpointOptions struct {
}

ServicesClientDisableTestEndpointOptions contains the optional parameters for the ServicesClient.DisableTestEndpoint method.

type ServicesClientDisableTestEndpointResponse added in v0.3.0 

type ServicesClientDisableTestEndpointResponse struct {
}

ServicesClientDisableTestEndpointResponse contains the response from method ServicesClient.DisableTestEndpoint.

type ServicesClientEnableTestEndpointOptions added in v0.3.0 

type ServicesClientEnableTestEndpointOptions struct {
}

ServicesClientEnableTestEndpointOptions contains the optional parameters for the ServicesClient.EnableTestEndpoint method.

type ServicesClientEnableTestEndpointResponse added in v0.3.0 

type ServicesClientEnableTestEndpointResponse struct {
	TestKeys
}

ServicesClientEnableTestEndpointResponse contains the response from method ServicesClient.EnableTestEndpoint.

type ServicesClientGetOptions added in v0.3.0 

type ServicesClientGetOptions struct {
}

ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.

type ServicesClientGetResponse added in v0.3.0 

type ServicesClientGetResponse struct {
	ServiceResource
}

ServicesClientGetResponse contains the response from method ServicesClient.Get.

type ServicesClientListBySubscriptionOptions added in v0.3.0 

type ServicesClientListBySubscriptionOptions struct {
}

ServicesClientListBySubscriptionOptions contains the optional parameters for the ServicesClient.ListBySubscription method.

type ServicesClientListBySubscriptionResponse added in v0.3.0 

type ServicesClientListBySubscriptionResponse struct {
	ServiceResourceList
}

ServicesClientListBySubscriptionResponse contains the response from method ServicesClient.ListBySubscription.

type ServicesClientListOptions added in v0.3.0 

type ServicesClientListOptions struct {
}

ServicesClientListOptions contains the optional parameters for the ServicesClient.List method.

type ServicesClientListResponse added in v0.3.0 

type ServicesClientListResponse struct {
	ServiceResourceList
}

ServicesClientListResponse contains the response from method ServicesClient.List.

type ServicesClientListTestKeysOptions added in v0.3.0 

type ServicesClientListTestKeysOptions struct {
}

ServicesClientListTestKeysOptions contains the optional parameters for the ServicesClient.ListTestKeys method.

type ServicesClientListTestKeysResponse added in v0.3.0 

type ServicesClientListTestKeysResponse struct {
	TestKeys
}

ServicesClientListTestKeysResponse contains the response from method ServicesClient.ListTestKeys.

type ServicesClientRegenerateTestKeyOptions added in v0.3.0 

type ServicesClientRegenerateTestKeyOptions struct {
}

ServicesClientRegenerateTestKeyOptions contains the optional parameters for the ServicesClient.RegenerateTestKey method.

type ServicesClientRegenerateTestKeyResponse added in v0.3.0 

type ServicesClientRegenerateTestKeyResponse struct {
	TestKeys
}

ServicesClientRegenerateTestKeyResponse contains the response from method ServicesClient.RegenerateTestKey.

type ServicesClientStartResponse added in v0.3.0 

type ServicesClientStartResponse struct {
}

ServicesClientStartResponse contains the response from method ServicesClient.Start.

type ServicesClientStopResponse added in v0.3.0 

type ServicesClientStopResponse struct {
}

ServicesClientStopResponse contains the response from method ServicesClient.Stop.

type ServicesClientUpdateResponse added in v0.3.0 

type ServicesClientUpdateResponse struct {
	ServiceResource
}

ServicesClientUpdateResponse contains the response from method ServicesClient.Update.

type SourceUploadedUserSourceInfo added in v0.3.0 

type SourceUploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// 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 `json:"artifactSelector,omitempty"`

	// Relative path of the storage which stores the source
	RelativePath *string `json:"relativePath,omitempty"`

	// Runtime version of the source file
	RuntimeVersion *string `json:"runtimeVersion,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

SourceUploadedUserSourceInfo - Uploaded Java source code binary for a deployment

func (*SourceUploadedUserSourceInfo) GetUploadedUserSourceInfo added in v0.3.0 

func (s *SourceUploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type SourceUploadedUserSourceInfo.

func (*SourceUploadedUserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (s *SourceUploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type SourceUploadedUserSourceInfo.

func (SourceUploadedUserSourceInfo) MarshalJSON added in v0.3.0 

func (s SourceUploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceUploadedUserSourceInfo.

func (*SourceUploadedUserSourceInfo) UnmarshalJSON added in v0.3.0 

func (s *SourceUploadedUserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceUploadedUserSourceInfo.

type SsoProperties added in v0.3.0 

type SsoProperties struct {
	// The public identifier for the application
	ClientID *string `json:"clientId,omitempty"`

	// The secret known only to the application and the authorization server
	ClientSecret *string `json:"clientSecret,omitempty"`

	// The URI of Issuer Identifier
	IssuerURI *string `json:"issuerUri,omitempty"`

	// It defines the specific actions applications can be allowed to do on a user's behalf
	Scope []*string `json:"scope,omitempty"`
}

SsoProperties - Single sign-on related configuration

func (SsoProperties) MarshalJSON added in v0.3.0 

func (s SsoProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsoProperties.

type StackProperties added in v0.3.0 

type StackProperties struct {
	// Id of the ClusterStack.
	ID *string `json:"id,omitempty"`

	// Version of the ClusterStack
	Version *string `json:"version,omitempty"`
}

StackProperties - KPack ClusterStack properties payload

type StorageAccount added in v0.2.0 

type StorageAccount struct {
	// REQUIRED; The account key of the Azure Storage Account.
	AccountKey *string `json:"accountKey,omitempty"`

	// REQUIRED; The account name of the Azure Storage Account.
	AccountName *string `json:"accountName,omitempty"`

	// REQUIRED; The type of the storage.
	StorageType *StorageType `json:"storageType,omitempty"`
}

StorageAccount - storage resource of type Azure Storage Account.

func (*StorageAccount) GetStorageProperties added in v0.3.0 

func (s *StorageAccount) GetStorageProperties() *StorageProperties

GetStorageProperties implements the StoragePropertiesClassification interface for type StorageAccount.

func (StorageAccount) MarshalJSON added in v0.2.0 

func (s StorageAccount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageAccount.

func (*StorageAccount) UnmarshalJSON added in v0.2.0 

func (s *StorageAccount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageAccount.

type StorageProperties added in v0.2.0 

type StorageProperties struct {
	// REQUIRED; The type of the storage.
	StorageType *StorageType `json:"storageType,omitempty"`
}

StorageProperties - Storage resource payload.

func (*StorageProperties) GetStorageProperties added in v0.2.0 

func (s *StorageProperties) GetStorageProperties() *StorageProperties

GetStorageProperties implements the StoragePropertiesClassification interface for type StorageProperties.

type StoragePropertiesClassification added in v0.2.0 

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 added in v0.2.0 

type StorageResource struct {
	// Properties of the storage resource payload.
	Properties StoragePropertiesClassification `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

StorageResource - Storage resource payload.

func (StorageResource) MarshalJSON added in v0.2.0 

func (s StorageResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageResource.

func (*StorageResource) UnmarshalJSON added in v0.2.0 

func (s *StorageResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageResource.

type StorageResourceCollection added in v0.2.0 

type StorageResourceCollection struct {
	// The link to next page of storage list.
	NextLink *string `json:"nextLink,omitempty"`

	// The storage resources list.
	Value []*StorageResource `json:"value,omitempty"`
}

StorageResourceCollection - Collection compose of storage resources list and a possible link for next page.

func (StorageResourceCollection) MarshalJSON added in v0.2.0 

func (s StorageResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageResourceCollection.

type StorageType added in v0.4.0 

type StorageType string

StorageType - The type of the storage. 

const (
	StorageTypeStorageAccount StorageType = "StorageAccount"
)

func PossibleStorageTypeValues added in v0.4.0 

func PossibleStorageTypeValues() []StorageType

PossibleStorageTypeValues returns the possible values for the StorageType const type.

type StoragesClient added in v0.2.0 

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 added in v0.2.0 

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 added in v0.2.0 

func (client *StoragesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, storageName string, storageResource StorageResource, options *StoragesClientBeginCreateOrUpdateOptions) (*armruntime.Poller[StoragesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update storage resource. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Storages_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewStoragesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<storage-name>",
		armappplatform.StorageResource{
			Properties: &armappplatform.StorageAccount{
				StorageType: to.Ptr(armappplatform.StorageTypeStorageAccount),
				AccountKey:  to.Ptr("<account-key>"),
				AccountName: to.Ptr("<account-name>"),
			},
		},
		&armappplatform.StoragesClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*StoragesClient) BeginDelete added in v0.2.0 

func (client *StoragesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, storageName string, options *StoragesClientBeginDeleteOptions) (*armruntime.Poller[StoragesClientDeleteResponse], error)

BeginDelete - Delete the storage resource. If the operation fails it returns an *azcore.ResponseError type. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Storages_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewStoragesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<storage-name>",
		&armappplatform.StoragesClientBeginDeleteOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
		return
	}
}

Output:

func (*StoragesClient) Get added in v0.2.0 

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. 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/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Storages_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewStoragesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<storage-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
		return
	}
	// TODO: use response item
	_ = res
}

Output:

func (*StoragesClient) NewListPager added in v0.5.0 

func (client *StoragesClient) NewListPager(resourceGroupName string, serviceName string, options *StoragesClientListOptions) *runtime.Pager[StoragesClientListResponse]

NewListPager - List all the storages of one Azure Spring Cloud instance. If the operation fails it returns an *azcore.ResponseError type. 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.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2022-03-01-preview/examples/Storages_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armappplatform.NewStoragesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListPager("<resource-group-name>",
		"<service-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type StoragesClientBeginCreateOrUpdateOptions added in v0.3.0 

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

StoragesClientBeginCreateOrUpdateOptions contains the optional parameters for the StoragesClient.BeginCreateOrUpdate method.

type StoragesClientBeginDeleteOptions added in v0.3.0 

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

StoragesClientBeginDeleteOptions contains the optional parameters for the StoragesClient.BeginDelete method.

type StoragesClientCreateOrUpdateResponse added in v0.3.0 

type StoragesClientCreateOrUpdateResponse struct {
	StorageResource
}

StoragesClientCreateOrUpdateResponse contains the response from method StoragesClient.CreateOrUpdate.

type StoragesClientDeleteResponse added in v0.3.0 

type StoragesClientDeleteResponse struct {
}

StoragesClientDeleteResponse contains the response from method StoragesClient.Delete.

type StoragesClientGetOptions added in v0.3.0 

type StoragesClientGetOptions struct {
}

StoragesClientGetOptions contains the optional parameters for the StoragesClient.Get method.

type StoragesClientGetResponse added in v0.3.0 

type StoragesClientGetResponse struct {
	StorageResource
}

StoragesClientGetResponse contains the response from method StoragesClient.Get.

type StoragesClientListOptions added in v0.3.0 

type StoragesClientListOptions struct {
}

StoragesClientListOptions contains the optional parameters for the StoragesClient.List method.

type StoragesClientListResponse added in v0.3.0 

type StoragesClientListResponse struct {
	StorageResourceCollection
}

StoragesClientListResponse contains the response from method StoragesClient.List.

type SupportedBuildpackResource added in v0.3.0 

type SupportedBuildpackResource struct {
	// Supported buildpack resource properties
	Properties *SupportedBuildpackResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SupportedBuildpackResource - Supported buildpack resource payload

type SupportedBuildpackResourceProperties added in v0.3.0 

type SupportedBuildpackResourceProperties struct {
	// The id of supported buildpack
	BuildpackID *string `json:"buildpackId,omitempty"`
}

SupportedBuildpackResourceProperties - Supported buildpack resource properties

type SupportedBuildpacksCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of supported buildpacks resources
	Value []*SupportedBuildpackResource `json:"value,omitempty"`
}

SupportedBuildpacksCollection - Object that includes an array of supported buildpacks resources and a possible link for next set

func (SupportedBuildpacksCollection) MarshalJSON added in v0.3.0 

func (s SupportedBuildpacksCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller 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 `json:"platform,omitempty"`

	// The raw value which could be passed to deployment CRUD operations.
	Value *SupportedRuntimeValue `json:"value,omitempty"`

	// The detailed version (major.minor) of the platform.
	Version *string `json:"version,omitempty"`
}

SupportedRuntimeVersion - Supported deployment runtime version descriptor.

type SupportedStackResource added in v0.3.0 

type SupportedStackResource struct {
	// Supported stack resource properties
	Properties *SupportedStackResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SupportedStackResource - Supported stack resource payload

type SupportedStackResourceProperties added in v0.3.0 

type SupportedStackResourceProperties struct {
	// The id of supported stack
	StackID *string `json:"stackId,omitempty"`

	// The version of supported stack
	Version *string `json:"version,omitempty"`
}

SupportedStackResourceProperties - Supported stack resource properties

type SupportedStacksCollection added in v0.3.0 

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 `json:"nextLink,omitempty"`

	// Collection of supported stacks resources
	Value []*SupportedStackResource `json:"value,omitempty"`
}

SupportedStacksCollection - Object that includes an array of supported stacks resources and a possible link for next set

func (SupportedStacksCollection) MarshalJSON added in v0.3.0 

func (s SupportedStacksCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SupportedStacksCollection.

type SystemData added in v0.2.0 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource modification (UTC).
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *LastModifiedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON added in v0.2.0 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON added in v0.2.0 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TemporaryDisk 

type TemporaryDisk struct {
	// Mount path of the temporary disk
	MountPath *string `json:"mountPath,omitempty"`

	// Size of the temporary disk in GB
	SizeInGB *int32 `json:"sizeInGB,omitempty"`
}

TemporaryDisk - Temporary disk payload

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 `json:"enabled,omitempty"`

	// Primary key
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// Primary test endpoint
	PrimaryTestEndpoint *string `json:"primaryTestEndpoint,omitempty"`

	// Secondary key
	SecondaryKey *string `json:"secondaryKey,omitempty"`

	// Secondary test endpoint
	SecondaryTestEndpoint *string `json:"secondaryTestEndpoint,omitempty"`
}

TestKeys - Test keys payload

type TrackedResource 

type TrackedResource struct {
	// The GEO location of the resource.
	Location *string `json:"location,omitempty"`

	// Tags of the service which is a list of key value pairs that describe the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

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.

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 added in v0.3.0 

type TriggeredBuildResult struct {
	// The unique build id of this build result
	ID *string `json:"id,omitempty"`
}

TriggeredBuildResult - The build result triggered by a build

type Type added in v0.4.0 

type Type string

Type - The type of the underlying resource to mount as a persistent disk. 

const (
	TypeAzureFileVolume Type = "AzureFileVolume"
)

func PossibleTypeValues added in v0.4.0 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UploadedUserSourceInfo added in v0.3.0 

type UploadedUserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// Relative path of the storage which stores the source
	RelativePath *string `json:"relativePath,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

UploadedUserSourceInfo - Source with uploaded location

func (*UploadedUserSourceInfo) GetUploadedUserSourceInfo added in v0.3.0 

func (u *UploadedUserSourceInfo) GetUploadedUserSourceInfo() *UploadedUserSourceInfo

GetUploadedUserSourceInfo implements the UploadedUserSourceInfoClassification interface for type UploadedUserSourceInfo.

func (*UploadedUserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (u *UploadedUserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type UploadedUserSourceInfo.

func (UploadedUserSourceInfo) MarshalJSON added in v0.3.0 

func (u UploadedUserSourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UploadedUserSourceInfo.

func (*UploadedUserSourceInfo) UnmarshalJSON added in v0.3.0 

func (u *UploadedUserSourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UploadedUserSourceInfo.

type UploadedUserSourceInfoClassification added in v0.3.0 

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

type UserAssignedManagedIdentity added in v0.4.0 

type UserAssignedManagedIdentity struct {
	// READ-ONLY; Client Id of user-assigned managed identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; Principal Id of user-assigned managed identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedManagedIdentity - The details of the user-assigned managed identity assigned to an App.

type UserSourceInfo 

type UserSourceInfo struct {
	// REQUIRED; Type of the source uploaded
	Type *string `json:"type,omitempty"`

	// Version of the source
	Version *string `json:"version,omitempty"`
}

UserSourceInfo - Source information for a deployment

func (*UserSourceInfo) GetUserSourceInfo added in v0.3.0 

func (u *UserSourceInfo) GetUserSourceInfo() *UserSourceInfo

GetUserSourceInfo implements the UserSourceInfoClassification interface for type UserSourceInfo.

type UserSourceInfoClassification added in v0.3.0 

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

type ValidationMessages added in v0.3.0 

type ValidationMessages struct {
	// Detailed validation messages.
	Messages []*string `json:"messages,omitempty"`

	// The name of the configuration service git repository.
	Name *string `json:"name,omitempty"`
}

ValidationMessages - Validate messages of the configuration service git repositories

func (ValidationMessages) MarshalJSON added in v0.3.0 

func (v ValidationMessages) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValidationMessages.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.