deploymentclient

Documentation

Overview

Package deploymentclient implements the client for azure deployments.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, deploymentName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, deploymentName string) *retry.Error
  • func (c *Client) ExportTemplate(ctx context.Context, resourceGroupName string, deploymentName string) (result resources.DeploymentExportResult, rerr *retry.Error)
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, deploymentName string) (resources.DeploymentExtended, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string) ([]resources.DeploymentExtended, *retry.Error)
• type DeploymentResultPage
  • func (page *DeploymentResultPage) Next() error
  • func (page *DeploymentResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page DeploymentResultPage) NotDone() bool
  • func (page DeploymentResultPage) Response() resources.DeploymentListResult
  • func (page DeploymentResultPage) Values() []resources.DeploymentExtended
• type Interface

Constants

const (
	// APIVersion is the API version for resources.
	APIVersion = "2017-05-10"
)

Types

type Client

type Client struct {

	// ARM throttling configures.
	RetryAfterReader time.Time
	RetryAfterWriter time.Time
	// contains filtered or unexported fields
}

Client implements ContainerService client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new ContainerServiceClient client with ratelimiting.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, deploymentName string, parameters resources.Deployment, etag string) *retry.Error

CreateOrUpdate creates or updates a deployment.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, resourceGroupName string, deploymentName string) *retry.Error

Delete deletes a deployment by name.

func (*Client) ExportTemplate

func (c *Client) ExportTemplate(ctx context.Context, resourceGroupName string, deploymentName string) (result resources.DeploymentExportResult, rerr *retry.Error)

ExportTemplate exports the template used for specified deployment

func (*Client) Get

func (c *Client) Get(ctx context.Context, resourceGroupName string, deploymentName string) (resources.DeploymentExtended, *retry.Error)

Get gets a deployment

func (*Client) List

func (c *Client) List(ctx context.Context, resourceGroupName string) ([]resources.DeploymentExtended, *retry.Error)

List gets a list of deployments in the resource group.

type DeploymentResultPage

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

DeploymentResultPage contains a page of deployments values.

func (*DeploymentResultPage) Next

func (page *DeploymentResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DeploymentResultPage) NextWithContext

func (page *DeploymentResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (DeploymentResultPage) NotDone

func (page DeploymentResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DeploymentResultPage) Response

func (page DeploymentResultPage) Response() resources.DeploymentListResult

Response returns the raw server response from the last page request.

func (DeploymentResultPage) Values

func (page DeploymentResultPage) Values() []resources.DeploymentExtended

Values returns the slice of values for the current page or nil if there are no values.

type Interface

type Interface interface {
	Get(ctx context.Context, resourceGroupName string, deploymentName string) (resources.DeploymentExtended, *retry.Error)
	List(ctx context.Context, resourceGroupName string) ([]resources.DeploymentExtended, *retry.Error)
	ExportTemplate(ctx context.Context, resourceGroupName string, deploymentName string) (result resources.DeploymentExportResult, rerr *retry.Error)
	CreateOrUpdate(ctx context.Context, resourceGroupName string, managedClusterName string, parameters resources.Deployment, etag string) *retry.Error
	Delete(ctx context.Context, resourceGroupName string, deploymentName string) *retry.Error
}

Interface is the client interface for Deployments. Don't forget to run "hack/update-mock-clients.sh" command to generate the mock client.