azapi

Documentation

Index

• Variables
• func CreateDeploymentOutput(rawOutputs interface{}) (result map[string]AzCliDeploymentOutput)
• type AzCliDeployment
• type AzCliDeploymentAdditionalInfo
• type AzCliDeploymentErrorResponse
• type AzCliDeploymentOutput
• type AzCliDeploymentProperties
• type AzCliDeploymentPropertiesBasicDependency
• type AzCliDeploymentPropertiesDependency
• type AzCliDeploymentResourceReference
• type AzCliDeploymentResult
• type AzCliDeploymentResultProperties
• type AzCliDeploymentStatusMessage
• type AzCliResourceOperation
• type AzCliResourceOperationProperties
• type AzCliResourceOperationTargetResource
• type AzureDeploymentError
  • func NewAzureDeploymentError(jsonErrorResponse string) *AzureDeploymentError
  • func (e *AzureDeploymentError) Error() string
• type DeploymentErrorLine
• type DeploymentOperations
  • func NewDeploymentOperations(credentialProvider account.SubscriptionCredentialProvider, ...) DeploymentOperations
• type Deployments
  • func NewDeployments(credentialProvider account.SubscriptionCredentialProvider, ...) Deployments

Variables

var (
	ErrDeploymentNotFound = errors.New("deployment not found")
)

Functions

func CreateDeploymentOutput

func CreateDeploymentOutput(rawOutputs interface{}) (result map[string]AzCliDeploymentOutput)

convert from: sdk client outputs: interface{} to map[string]azapi.AzCliDeploymentOutput sdk client parses http response from network as an interface{} this function keeps the compatibility with the previous AzCliDeploymentOutput model

Types

type AzCliDeployment

type AzCliDeployment struct {
	Id         string                    `json:"id"`
	Name       string                    `json:"name"`
	Properties AzCliDeploymentProperties `json:"properties"`
}

type AzCliDeploymentAdditionalInfo

type AzCliDeploymentAdditionalInfo struct {
	Type string      `json:"type"`
	Info interface{} `json:"info"`
}

type AzCliDeploymentErrorResponse

type AzCliDeploymentErrorResponse struct {
	Code           string                         `json:"code"`
	Message        string                         `json:"message"`
	Target         string                         `json:"target"`
	Details        []AzCliDeploymentErrorResponse `json:"details"`
	AdditionalInfo AzCliDeploymentAdditionalInfo  `json:"additionalInfo"`
}

type AzCliDeploymentOutput

type AzCliDeploymentOutput struct {
	Type  string      `json:"type"`
	Value interface{} `json:"value"`
}

type AzCliDeploymentProperties

type AzCliDeploymentProperties struct {
	CorrelationId   string                                `json:"correlationId"`
	Error           AzCliDeploymentErrorResponse          `json:"error"`
	Dependencies    []AzCliDeploymentPropertiesDependency `json:"dependencies"`
	OutputResources []AzCliDeploymentResourceReference    `json:"outputResources"`
	Outputs         map[string]AzCliDeploymentOutput      `json:"outputs"`
}

type AzCliDeploymentPropertiesBasicDependency

type AzCliDeploymentPropertiesBasicDependency struct {
	Id           string `json:"id"`
	ResourceName string `json:"resourceName"`
	ResourceType string `json:"resourceType"`
}

type AzCliDeploymentPropertiesDependency

type AzCliDeploymentPropertiesDependency struct {
	AzCliDeploymentPropertiesBasicDependency
	DependsOn []AzCliDeploymentPropertiesBasicDependency `json:"dependsOn"`
}

type AzCliDeploymentResourceReference

type AzCliDeploymentResourceReference struct {
	Id string `json:"id"`
}

type AzCliDeploymentResult

type AzCliDeploymentResult struct {
	Properties AzCliDeploymentResultProperties `json:"properties"`
}

type AzCliDeploymentResultProperties

type AzCliDeploymentResultProperties struct {
	Outputs map[string]AzCliDeploymentOutput `json:"outputs"`
}

type AzCliDeploymentStatusMessage

type AzCliDeploymentStatusMessage struct {
	Err    AzCliDeploymentErrorResponse `json:"error"`
	Status string                       `json:"status"`
}

type AzCliResourceOperation

type AzCliResourceOperation struct {
	Id          string                           `json:"id"`
	OperationId string                           `json:"operationId"`
	Properties  AzCliResourceOperationProperties `json:"properties"`
}

type AzCliResourceOperationProperties

type AzCliResourceOperationProperties struct {
	ProvisioningOperation string                               `json:"provisioningOperation"`
	ProvisioningState     string                               `json:"provisioningState"`
	TargetResource        AzCliResourceOperationTargetResource `json:"targetResource"`
	StatusCode            string                               `json:"statusCode"`
	StatusMessage         AzCliDeploymentStatusMessage         `json:"statusMessage"`
	// While the operation is in progress, this timestamp effectively represents "InProgressTimestamp".
	// When the operation ends, this timestamp effectively represents "EndTimestamp".
	Timestamp time.Time `json:"timestamp"`
}

type AzCliResourceOperationTargetResource

type AzCliResourceOperationTargetResource struct {
	Id            string `json:"id"`
	ResourceType  string `json:"resourceType"`
	ResourceName  string `json:"resourceName"`
	ResourceGroup string `json:"resourceGroup"`
}

type AzureDeploymentError

type AzureDeploymentError struct {
	Json string

	Details *DeploymentErrorLine
}

func NewAzureDeploymentError

func NewAzureDeploymentError(jsonErrorResponse string) *AzureDeploymentError

func (*AzureDeploymentError) Error

func (e *AzureDeploymentError) Error() string

type DeploymentErrorLine

type DeploymentErrorLine struct {
	// The code of the error line, if applicable
	Code string
	// The message that represents the error
	Message string
	// Inner errors
	Inner []*DeploymentErrorLine
}

type DeploymentOperations

type DeploymentOperations interface {
	ListSubscriptionDeploymentOperations(
		ctx context.Context,
		subscriptionId string,
		deploymentName string,
	) ([]*armresources.DeploymentOperation, error)
	ListResourceGroupDeploymentOperations(
		ctx context.Context,
		subscriptionId string,
		resourceGroupName string,
		deploymentName string,
	) ([]*armresources.DeploymentOperation, error)
}

func NewDeploymentOperations

func NewDeploymentOperations(
	credentialProvider account.SubscriptionCredentialProvider,
	armClientOptions *arm.ClientOptions,
) DeploymentOperations

type Deployments

type Deployments interface {
	ListSubscriptionDeployments(
		ctx context.Context,
		subscriptionId string,
	) ([]*armresources.DeploymentExtended, error)
	GetSubscriptionDeployment(
		ctx context.Context,
		subscriptionId string,
		deploymentName string,
	) (*armresources.DeploymentExtended, error)
	ListResourceGroupDeployments(
		ctx context.Context,
		subscriptionId string,
		resourceGroupName string,
	) ([]*armresources.DeploymentExtended, error)
	GetResourceGroupDeployment(
		ctx context.Context,
		subscriptionId string,
		resourceGroupName string,
		deploymentName string,
	) (*armresources.DeploymentExtended, error)
	DeployToSubscription(
		ctx context.Context,
		subscriptionId string,
		location string,
		deploymentName string,
		armTemplate azure.RawArmTemplate,
		parameters azure.ArmParameters,
		tags map[string]*string,
	) (*armresources.DeploymentExtended, error)
	DeployToResourceGroup(
		ctx context.Context,
		subscriptionId,
		resourceGroup,
		deploymentName string,
		armTemplate azure.RawArmTemplate,
		parameters azure.ArmParameters,
		tags map[string]*string,
	) (*armresources.DeploymentExtended, error)
	WhatIfDeployToSubscription(
		ctx context.Context,
		subscriptionId string,
		location string,
		deploymentName string,
		armTemplate azure.RawArmTemplate,
		parameters azure.ArmParameters,
	) (*armresources.WhatIfOperationResult, error)
	WhatIfDeployToResourceGroup(
		ctx context.Context,
		subscriptionId,
		resourceGroup,
		deploymentName string,
		armTemplate azure.RawArmTemplate,
		parameters azure.ArmParameters,
	) (*armresources.WhatIfOperationResult, error)
	DeleteSubscriptionDeployment(ctx context.Context, subscriptionId string, deploymentName string) error
	CalculateTemplateHash(
		ctx context.Context,
		subscriptionId string,
		template azure.RawArmTemplate) (armresources.DeploymentsClientCalculateTemplateHashResponse, error)
}

func NewDeployments

func NewDeployments(
	credentialProvider account.SubscriptionCredentialProvider,
	armClientOptions *arm.ClientOptions,
) Deployments