Documentation ¶
Index ¶
- Constants
- func GetEventTypes() []string
- type CancelDeploymentResponse
- type Client
- func (client *Client) Cancel(ctx context.Context, deploymentId int) (*CancelDeploymentResponse, error)
- func (client *Client) Create(ctx context.Context, request CreateDeployment) (*Deployment, error)
- func (client *Client) CreateEventHook(ctx context.Context, request CreateEventHookRequest) (*CreateEventHookResponse, error)
- func (client *Client) DryRun(ctx context.Context, deploymentId int, ...) (*InvokeDryRunResponse, error)
- func (client *Client) Get(ctx context.Context, deploymentId int) (*GetResponse, error)
- func (client *Client) GetDeploymentOperationStatus(ctx context.Context, deploymentId int, operationName OperationType) (*StatusResponse, error)
- func (client *Client) GetStatus(ctx context.Context, id uuid.UUID) (*StatusResponse, error)
- func (client *Client) HealthStatus(ctx context.Context) (*GetHealthResponse, error)
- func (client *Client) List(ctx context.Context) (*ListResponse, error)
- func (client *Client) ListEventTypes(ctx context.Context) ([]*EventType, error)
- func (client *Client) ListInvokedOperations(ctx context.Context) ([]*InvokedOperation, error)
- func (client *Client) Retry(ctx context.Context, deploymentId int, options *RetryOptions) (*RetryResponse, error)
- func (client *Client) Start(ctx context.Context, deploymentId int, ...) (*StartDeploymentResponse, error)
- type ClientOptions
- type CreateDeployment
- type CreateEventHookRequest
- type CreateEventHookResponse
- type Deployment
- type DeploymentEventData
- type DeploymentManagementClient
- func (client *DeploymentManagementClient) CreateDeployment(ctx context.Context, body CreateDeployment, ...) (DeploymentManagementClientCreateDeploymentResponse, error)
- func (client *DeploymentManagementClient) CreateEvenHook(ctx context.Context, body CreateEventHookRequest, ...) (DeploymentManagementClientCreateEvenHookResponse, error)
- func (client *DeploymentManagementClient) DeleteEventHook(ctx context.Context, hookID string, ...) (DeploymentManagementClientDeleteEventHookResponse, error)
- func (client *DeploymentManagementClient) GetDeployment(ctx context.Context, deploymentID int32, ...) (DeploymentManagementClientGetDeploymentResponse, error)
- func (client *DeploymentManagementClient) GetEventHook(ctx context.Context, hookID string, ...) (DeploymentManagementClientGetEventHookResponse, error)
- func (client *DeploymentManagementClient) GetEventTypes(ctx context.Context, options *DeploymentManagementClientGetEventTypesOptions) (DeploymentManagementClientGetEventTypesResponse, error)
- func (client *DeploymentManagementClient) GetHealth(ctx context.Context, options *DeploymentManagementClientGetHealthOptions) (DeploymentManagementClientGetHealthResponse, error)
- func (client *DeploymentManagementClient) GetInvokedDeploymentOperation(ctx context.Context, operationID string, ...) (DeploymentManagementClientGetInvokedDeploymentOperationResponse, error)
- func (client *DeploymentManagementClient) InvokeDeploymentOperation(ctx context.Context, deploymentID int32, body InvokeDeploymentOperationRequest, ...) (DeploymentManagementClientInvokeDeploymentOperationResponse, error)
- func (client *DeploymentManagementClient) ListDeployments(ctx context.Context, options *DeploymentManagementClientListDeploymentsOptions) (DeploymentManagementClientListDeploymentsResponse, error)
- func (client *DeploymentManagementClient) ListEventHooks(ctx context.Context, options *DeploymentManagementClientListEventHooksOptions) (DeploymentManagementClientListEventHooksResponse, error)
- func (client *DeploymentManagementClient) ListInvokedOperations(ctx context.Context, ...) (DeploymentManagementClientListInvokedOperationsResponse, error)
- func (client *DeploymentManagementClient) UpdateDeployment(ctx context.Context, body Deployment, ...) (DeploymentManagementClientUpdateDeploymentResponse, error)
- type DeploymentManagementClientCreateDeploymentOptions
- type DeploymentManagementClientCreateDeploymentResponse
- type DeploymentManagementClientCreateEvenHookOptions
- type DeploymentManagementClientCreateEvenHookResponse
- type DeploymentManagementClientDeleteEventHookOptions
- type DeploymentManagementClientDeleteEventHookResponse
- type DeploymentManagementClientGetDeploymentOptions
- type DeploymentManagementClientGetDeploymentResponse
- type DeploymentManagementClientGetEventHookOptions
- type DeploymentManagementClientGetEventHookResponse
- type DeploymentManagementClientGetEventTypesOptions
- type DeploymentManagementClientGetEventTypesResponse
- type DeploymentManagementClientGetHealthOptions
- type DeploymentManagementClientGetHealthResponse
- type DeploymentManagementClientGetInvokedDeploymentOperationOptions
- type DeploymentManagementClientGetInvokedDeploymentOperationResponse
- type DeploymentManagementClientInvokeDeploymentOperationOptions
- type DeploymentManagementClientInvokeDeploymentOperationResponse
- type DeploymentManagementClientListDeploymentsOptions
- type DeploymentManagementClientListDeploymentsResponse
- type DeploymentManagementClientListEventHooksOptions
- type DeploymentManagementClientListEventHooksResponse
- type DeploymentManagementClientListInvokedOperationsOptions
- type DeploymentManagementClientListInvokedOperationsResponse
- type DeploymentManagementClientOptions
- type DeploymentManagementClientUpdateDeploymentOptions
- type DeploymentManagementClientUpdateDeploymentResponse
- type DeploymentStage
- type DryRunError
- type DryRunEventData
- type DryRunOptions
- type DryRunResponse
- type DryRunResult
- type ErrorAdditionalInfo
- type EventData
- type EventHookMessage
- func (m *EventHookMessage) DeploymentEventData() (*DeploymentEventData, error)
- func (m *EventHookMessage) DeploymentId() (uint, error)
- func (m *EventHookMessage) DryRunEventData() (*DryRunEventData, error)
- func (m *EventHookMessage) HashCode() string
- func (m *EventHookMessage) SetSubject(deploymentId uint, stageId *uuid.UUID)
- func (m *EventHookMessage) StageEventData() (*StageEventData, error)
- type EventHookResponse
- type EventType
- type EventTypeName
- type GetHealthResponse
- type GetInvokedOperationResponse
- type GetResponse
- type InvokeDeploymentOperationRequest
- type InvokeDryRunResponse
- type InvokedDeploymentOperationResponse
- type InvokedOperation
- type ListInvokedOperationResponse
- type ListResponse
- type OperationType
- type RetryOptions
- type RetryResponse
- type StageEventData
- type StartDeploymentResponse
- type StartOptions
- type Status
- type StatusResponse
Constants ¶
const ( EventDataTypePrefixDeployment = "deployment" EventDataTypePrefixStage = "stage" EventDataTypePrefixDryRun = "dryRun" )
const DefaultRetries = 3
DefaultRetries is the default number of retries for an operation against a deployment default is 3
Variables ¶
This section is empty.
Functions ¶
func GetEventTypes ¶ added in v1.0.0
func GetEventTypes() []string
Types ¶
type CancelDeploymentResponse ¶ added in v1.3.0
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the struct for interacting with an Azure App Configuration instance.
func NewClient ¶
func NewClient(endpoint string, credential azcore.TokenCredential, options *ClientOptions) (*Client, error)
NewClient creates a new instance of Client with the specified values.
- endpoint - the endpoint of the Marketplace Offer Deployment Management service.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - client options, pass nil to accept the default values.
func (*Client) Create ¶ added in v0.2.1
func (client *Client) Create(ctx context.Context, request CreateDeployment) (*Deployment, error)
Creates a deployment record that will be used to kick off all available deployment operations (dry run, start, retry, etc.)
func (*Client) CreateEventHook ¶ added in v0.2.1
func (client *Client) CreateEventHook(ctx context.Context, request CreateEventHookRequest) (*CreateEventHookResponse, error)
func (*Client) DryRun ¶ added in v0.2.1
func (client *Client) DryRun(ctx context.Context, deploymentId int, templateParameters map[string]interface{}, options *DryRunOptions) (*InvokeDryRunResponse, error)
Performs a dry run of a deployment and returns the verification results returns: verification results
func (*Client) GetDeploymentOperationStatus ¶ added in v0.3.1
func (client *Client) GetDeploymentOperationStatus(ctx context.Context, deploymentId int, operationName OperationType) (*StatusResponse, error)
Gets the status of an invoked operation by deployment and operation name
deploymentId: the id of the deployment operationName: the name of the operation
func (*Client) GetStatus ¶ added in v0.2.1
Gets the status of an invoked operation, including adry run or a start deployment operation
id: the instance id of invoked operation
returns: the status of the invoked operation
func (*Client) HealthStatus ¶ added in v1.2.0
func (client *Client) HealthStatus(ctx context.Context) (*GetHealthResponse, error)
func (*Client) List ¶ added in v0.2.1
func (client *Client) List(ctx context.Context) (*ListResponse, error)
list all deployments
func (*Client) ListEventTypes ¶
lists the event topics available to register a web hook
func (*Client) ListInvokedOperations ¶ added in v0.3.1
func (client *Client) ListInvokedOperations(ctx context.Context) ([]*InvokedOperation, error)
List all invoked operations
func (*Client) Retry ¶ added in v0.2.1
func (client *Client) Retry(ctx context.Context, deploymentId int, options *RetryOptions) (*RetryResponse, error)
Retries a deployment, regardless of the current status
id: deployment id
func (*Client) Start ¶ added in v0.2.1
func (client *Client) Start(ctx context.Context, deploymentId int, templateParameters map[string]interface{}, options *StartOptions) (*StartDeploymentResponse, error)
Starts a deployment, asynchonously. The deployment response immediately returns with a status of "accepted" or "rejected".
remarks: The deployment will be executed asynchronously, and the status of the deployment can be queried using the GetDeployment operation. id: deployment id
returns: the unique UUID of the deployment execution instance
type ClientOptions ¶
type ClientOptions struct {
azcore.ClientOptions
}
ClientOptions contains the optional parameters for the NewClient method.
type CreateDeployment ¶ added in v1.0.0
type CreateDeployment struct { // REQUIRED Name *string `json:"name,omitempty"` // REQUIRED; Anything Template any `json:"template,omitempty"` Location *string `json:"location,omitempty"` ResourceGroup *string `json:"resourceGroup,omitempty"` SubscriptionID *string `json:"subscriptionId,omitempty"` }
func (CreateDeployment) MarshalJSON ¶ added in v1.0.0
func (c CreateDeployment) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateDeployment.
func (*CreateDeployment) UnmarshalJSON ¶ added in v1.0.0
func (c *CreateDeployment) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateDeployment.
type CreateEventHookRequest ¶ added in v1.0.0
type CreateEventHookRequest struct { // API key to be used in the Authorization header, e.g. 'apiKey =234dfsdf324234', to call the webhook callback URL. APIKey *string `json:"apiKey,omitempty"` // The webhook callback Callback *string `json:"callback,omitempty"` // the name of the subscription Name *string `json:"name,omitempty"` }
func (CreateEventHookRequest) MarshalJSON ¶ added in v1.0.0
func (c CreateEventHookRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateEventHookRequest.
func (*CreateEventHookRequest) UnmarshalJSON ¶ added in v1.0.0
func (c *CreateEventHookRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateEventHookRequest.
type CreateEventHookResponse ¶ added in v1.0.0
type CreateEventHookResponse struct { ID *string `json:"id,omitempty"` // the name of the subscription Name *string `json:"name,omitempty"` }
func (CreateEventHookResponse) MarshalJSON ¶ added in v1.0.0
func (c CreateEventHookResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateEventHookResponse.
func (*CreateEventHookResponse) UnmarshalJSON ¶ added in v1.0.0
func (c *CreateEventHookResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateEventHookResponse.
type Deployment ¶ added in v1.0.0
type Deployment struct { ID *int32 `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` ResourceGroup *string `json:"resourceGroup,omitempty"` Stages []*DeploymentStage `json:"stages,omitempty"` Status *string `json:"status,omitempty"` SubscriptionID *string `json:"subscriptionId,omitempty"` // Anything Template any `json:"template,omitempty"` }
func (Deployment) MarshalJSON ¶ added in v1.0.0
func (d Deployment) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type Deployment.
func (*Deployment) UnmarshalJSON ¶ added in v1.0.0
func (d *Deployment) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type Deployment.
type DeploymentEventData ¶ added in v1.0.0
type DeploymentManagementClient ¶ added in v1.0.0
type DeploymentManagementClient struct {
// contains filtered or unexported fields
}
DeploymentManagementClient contains the methods for the DeploymentManagementClient group. Don't use this type directly, use a constructor function instead.
func NewDeploymentManagementClient ¶ added in v1.0.0
func NewDeploymentManagementClient(endpoint string, credential azcore.TokenCredential, options *DeploymentManagementClientOptions) (*DeploymentManagementClient, error)
func (*DeploymentManagementClient) CreateDeployment ¶ added in v1.0.0
func (client *DeploymentManagementClient) CreateDeployment(ctx context.Context, body CreateDeployment, options *DeploymentManagementClientCreateDeploymentOptions) (DeploymentManagementClientCreateDeploymentResponse, error)
CreateDeployment - Creates a new deployment instances If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- body - Deployment object that needs to be added to the store
- options - DeploymentManagementClientCreateDeploymentOptions contains the optional parameters for the DeploymentManagementClient.CreateDeployment method.
func (*DeploymentManagementClient) CreateEvenHook ¶ added in v1.0.0
func (client *DeploymentManagementClient) CreateEvenHook(ctx context.Context, body CreateEventHookRequest, options *DeploymentManagementClientCreateEvenHookOptions) (DeploymentManagementClientCreateEvenHookResponse, error)
CreateEvenHook - Create an event hook If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- body - Create event hook
- options - DeploymentManagementClientCreateEvenHookOptions contains the optional parameters for the DeploymentManagementClient.CreateEvenHook method.
func (*DeploymentManagementClient) DeleteEventHook ¶ added in v1.0.0
func (client *DeploymentManagementClient) DeleteEventHook(ctx context.Context, hookID string, options *DeploymentManagementClientDeleteEventHookOptions) (DeploymentManagementClientDeleteEventHookResponse, error)
DeleteEventHook - Deletes an event hook by id If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- hookID - ID of the hook
- options - DeploymentManagementClientDeleteEventHookOptions contains the optional parameters for the DeploymentManagementClient.DeleteEventHook method.
func (*DeploymentManagementClient) GetDeployment ¶ added in v1.0.0
func (client *DeploymentManagementClient) GetDeployment(ctx context.Context, deploymentID int32, options *DeploymentManagementClientGetDeploymentOptions) (DeploymentManagementClientGetDeploymentResponse, error)
GetDeployment - Returns a single deployment If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- deploymentID - ID of deployment to return
- options - DeploymentManagementClientGetDeploymentOptions contains the optional parameters for the DeploymentManagementClient.GetDeployment method.
func (*DeploymentManagementClient) GetEventHook ¶ added in v1.0.0
func (client *DeploymentManagementClient) GetEventHook(ctx context.Context, hookID string, options *DeploymentManagementClientGetEventHookOptions) (DeploymentManagementClientGetEventHookResponse, error)
GetEventHook - Gets an event hook instance If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- hookID - ID of the hook
- options - DeploymentManagementClientGetEventHookOptions contains the optional parameters for the DeploymentManagementClient.GetEventHook method.
func (*DeploymentManagementClient) GetEventTypes ¶ added in v1.0.0
func (client *DeploymentManagementClient) GetEventTypes(ctx context.Context, options *DeploymentManagementClientGetEventTypesOptions) (DeploymentManagementClientGetEventTypesResponse, error)
GetEventTypes - Returns a list of all event types If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- options - DeploymentManagementClientGetEventTypesOptions contains the optional parameters for the DeploymentManagementClient.GetEventTypes method.
func (*DeploymentManagementClient) GetHealth ¶ added in v1.2.0
func (client *DeploymentManagementClient) GetHealth(ctx context.Context, options *DeploymentManagementClientGetHealthOptions) (DeploymentManagementClientGetHealthResponse, error)
GetHealth - List all deployments If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- options - DeploymentManagementClientGetHealthOptions contains the optional parameters for the DeploymentManagementClient.GetHealth method.
func (*DeploymentManagementClient) GetInvokedDeploymentOperation ¶ added in v1.0.0
func (client *DeploymentManagementClient) GetInvokedDeploymentOperation(ctx context.Context, operationID string, options *DeploymentManagementClientGetInvokedDeploymentOperationOptions) (DeploymentManagementClientGetInvokedDeploymentOperationResponse, error)
GetInvokedDeploymentOperation - Gets the state of a command operation that's been invoked If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- operationID - ID of the triggered operation
- options - DeploymentManagementClientGetInvokedDeploymentOperationOptions contains the optional parameters for the DeploymentManagementClient.GetInvokedDeploymentOperation method.
func (*DeploymentManagementClient) InvokeDeploymentOperation ¶ added in v1.0.0
func (client *DeploymentManagementClient) InvokeDeploymentOperation(ctx context.Context, deploymentID int32, body InvokeDeploymentOperationRequest, options *DeploymentManagementClientInvokeDeploymentOperationOptions) (DeploymentManagementClientInvokeDeploymentOperationResponse, error)
InvokeDeploymentOperation - Invokes a deployment operation with parameters If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- deploymentID - ID of deployment
- body - Deployment operation invocation
- options - DeploymentManagementClientInvokeDeploymentOperationOptions contains the optional parameters for the DeploymentManagementClient.InvokeDeploymentOperation method.
func (*DeploymentManagementClient) ListDeployments ¶ added in v1.0.0
func (client *DeploymentManagementClient) ListDeployments(ctx context.Context, options *DeploymentManagementClientListDeploymentsOptions) (DeploymentManagementClientListDeploymentsResponse, error)
ListDeployments - List all deployments If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- options - DeploymentManagementClientListDeploymentsOptions contains the optional parameters for the DeploymentManagementClient.ListDeployments method.
func (*DeploymentManagementClient) ListEventHooks ¶ added in v1.0.0
func (client *DeploymentManagementClient) ListEventHooks(ctx context.Context, options *DeploymentManagementClientListEventHooksOptions) (DeploymentManagementClientListEventHooksResponse, error)
ListEventHooks - List all event hooks If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- options - DeploymentManagementClientListEventHooksOptions contains the optional parameters for the DeploymentManagementClient.ListEventHooks method.
func (*DeploymentManagementClient) ListInvokedOperations ¶ added in v1.0.0
func (client *DeploymentManagementClient) ListInvokedOperations(ctx context.Context, options *DeploymentManagementClientListInvokedOperationsOptions) (DeploymentManagementClientListInvokedOperationsResponse, error)
ListInvokedOperations - Returns a list of invoked operations If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- options - DeploymentManagementClientListInvokedOperationsOptions contains the optional parameters for the DeploymentManagementClient.ListInvokedOperations method.
func (*DeploymentManagementClient) UpdateDeployment ¶ added in v1.0.0
func (client *DeploymentManagementClient) UpdateDeployment(ctx context.Context, body Deployment, options *DeploymentManagementClientUpdateDeploymentOptions) (DeploymentManagementClientUpdateDeploymentResponse, error)
UpdateDeployment - Update an existing deployment If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 0.1.0
- body - Deployment object that needs to be added to the store
- options - DeploymentManagementClientUpdateDeploymentOptions contains the optional parameters for the DeploymentManagementClient.UpdateDeployment method.
type DeploymentManagementClientCreateDeploymentOptions ¶ added in v1.0.0
type DeploymentManagementClientCreateDeploymentOptions struct { }
DeploymentManagementClientCreateDeploymentOptions contains the optional parameters for the DeploymentManagementClient.CreateDeployment method.
type DeploymentManagementClientCreateDeploymentResponse ¶ added in v1.0.0
type DeploymentManagementClientCreateDeploymentResponse struct {
Deployment
}
DeploymentManagementClientCreateDeploymentResponse contains the response from method DeploymentManagementClient.CreateDeployment.
type DeploymentManagementClientCreateEvenHookOptions ¶ added in v1.0.0
type DeploymentManagementClientCreateEvenHookOptions struct { }
DeploymentManagementClientCreateEvenHookOptions contains the optional parameters for the DeploymentManagementClient.CreateEvenHook method.
type DeploymentManagementClientCreateEvenHookResponse ¶ added in v1.0.0
type DeploymentManagementClientCreateEvenHookResponse struct {
CreateEventHookResponse
}
DeploymentManagementClientCreateEvenHookResponse contains the response from method DeploymentManagementClient.CreateEvenHook.
type DeploymentManagementClientDeleteEventHookOptions ¶ added in v1.0.0
type DeploymentManagementClientDeleteEventHookOptions struct { }
DeploymentManagementClientDeleteEventHookOptions contains the optional parameters for the DeploymentManagementClient.DeleteEventHook method.
type DeploymentManagementClientDeleteEventHookResponse ¶ added in v1.0.0
type DeploymentManagementClientDeleteEventHookResponse struct { }
DeploymentManagementClientDeleteEventHookResponse contains the response from method DeploymentManagementClient.DeleteEventHook.
type DeploymentManagementClientGetDeploymentOptions ¶ added in v1.0.0
type DeploymentManagementClientGetDeploymentOptions struct { }
DeploymentManagementClientGetDeploymentOptions contains the optional parameters for the DeploymentManagementClient.GetDeployment method.
type DeploymentManagementClientGetDeploymentResponse ¶ added in v1.0.0
type DeploymentManagementClientGetDeploymentResponse struct {
Deployment
}
DeploymentManagementClientGetDeploymentResponse contains the response from method DeploymentManagementClient.GetDeployment.
type DeploymentManagementClientGetEventHookOptions ¶ added in v1.0.0
type DeploymentManagementClientGetEventHookOptions struct { }
DeploymentManagementClientGetEventHookOptions contains the optional parameters for the DeploymentManagementClient.GetEventHook method.
type DeploymentManagementClientGetEventHookResponse ¶ added in v1.0.0
type DeploymentManagementClientGetEventHookResponse struct {
EventHookResponse
}
DeploymentManagementClientGetEventHookResponse contains the response from method DeploymentManagementClient.GetEventHook.
type DeploymentManagementClientGetEventTypesOptions ¶ added in v1.0.0
type DeploymentManagementClientGetEventTypesOptions struct { }
DeploymentManagementClientGetEventTypesOptions contains the optional parameters for the DeploymentManagementClient.GetEventTypes method.
type DeploymentManagementClientGetEventTypesResponse ¶ added in v1.0.0
type DeploymentManagementClientGetEventTypesResponse struct { // Array of EventType EventTypeArray []*EventType }
DeploymentManagementClientGetEventTypesResponse contains the response from method DeploymentManagementClient.GetEventTypes.
type DeploymentManagementClientGetHealthOptions ¶ added in v1.2.0
type DeploymentManagementClientGetHealthOptions struct { }
DeploymentManagementClientGetHealthOptions contains the optional parameters for the DeploymentManagementClient.GetHealth method.
type DeploymentManagementClientGetHealthResponse ¶ added in v1.2.0
type DeploymentManagementClientGetHealthResponse struct {
GetHealthResponse
}
DeploymentManagementClientGetHealthResponse contains the response from method DeploymentManagementClient.GetHealth.
type DeploymentManagementClientGetInvokedDeploymentOperationOptions ¶ added in v1.0.0
type DeploymentManagementClientGetInvokedDeploymentOperationOptions struct { }
DeploymentManagementClientGetInvokedDeploymentOperationOptions contains the optional parameters for the DeploymentManagementClient.GetInvokedDeploymentOperation method.
type DeploymentManagementClientGetInvokedDeploymentOperationResponse ¶ added in v1.0.0
type DeploymentManagementClientGetInvokedDeploymentOperationResponse struct {
GetInvokedOperationResponse
}
DeploymentManagementClientGetInvokedDeploymentOperationResponse contains the response from method DeploymentManagementClient.GetInvokedDeploymentOperation.
type DeploymentManagementClientInvokeDeploymentOperationOptions ¶ added in v1.0.0
type DeploymentManagementClientInvokeDeploymentOperationOptions struct { }
DeploymentManagementClientInvokeDeploymentOperationOptions contains the optional parameters for the DeploymentManagementClient.InvokeDeploymentOperation method.
type DeploymentManagementClientInvokeDeploymentOperationResponse ¶ added in v1.0.0
type DeploymentManagementClientInvokeDeploymentOperationResponse struct {
InvokedDeploymentOperationResponse
}
DeploymentManagementClientInvokeDeploymentOperationResponse contains the response from method DeploymentManagementClient.InvokeDeploymentOperation.
type DeploymentManagementClientListDeploymentsOptions ¶ added in v1.0.0
type DeploymentManagementClientListDeploymentsOptions struct { // Status values that need to be considered for filter Status []Status }
DeploymentManagementClientListDeploymentsOptions contains the optional parameters for the DeploymentManagementClient.ListDeployments method.
type DeploymentManagementClientListDeploymentsResponse ¶ added in v1.0.0
type DeploymentManagementClientListDeploymentsResponse struct { // Array of Deployment DeploymentArray []*Deployment }
DeploymentManagementClientListDeploymentsResponse contains the response from method DeploymentManagementClient.ListDeployments.
type DeploymentManagementClientListEventHooksOptions ¶ added in v1.0.0
type DeploymentManagementClientListEventHooksOptions struct { }
DeploymentManagementClientListEventHooksOptions contains the optional parameters for the DeploymentManagementClient.ListEventHooks method.
type DeploymentManagementClientListEventHooksResponse ¶ added in v1.0.0
type DeploymentManagementClientListEventHooksResponse struct { // Array of EventHookResponse EventHookResponseArray []*EventHookResponse }
DeploymentManagementClientListEventHooksResponse contains the response from method DeploymentManagementClient.ListEventHooks.
type DeploymentManagementClientListInvokedOperationsOptions ¶ added in v1.0.0
type DeploymentManagementClientListInvokedOperationsOptions struct { }
DeploymentManagementClientListInvokedOperationsOptions contains the optional parameters for the DeploymentManagementClient.ListInvokedOperations method.
type DeploymentManagementClientListInvokedOperationsResponse ¶ added in v1.0.0
type DeploymentManagementClientListInvokedOperationsResponse struct {
ListInvokedOperationResponse
}
DeploymentManagementClientListInvokedOperationsResponse contains the response from method DeploymentManagementClient.ListInvokedOperations.
type DeploymentManagementClientOptions ¶ added in v1.0.0
type DeploymentManagementClientOptions struct { ClientName string Version string ClientOptions *policy.ClientOptions }
type DeploymentManagementClientUpdateDeploymentOptions ¶ added in v1.0.0
type DeploymentManagementClientUpdateDeploymentOptions struct { }
DeploymentManagementClientUpdateDeploymentOptions contains the optional parameters for the DeploymentManagementClient.UpdateDeployment method.
type DeploymentManagementClientUpdateDeploymentResponse ¶ added in v1.0.0
type DeploymentManagementClientUpdateDeploymentResponse struct { }
DeploymentManagementClientUpdateDeploymentResponse contains the response from method DeploymentManagementClient.UpdateDeployment.
type DeploymentStage ¶ added in v1.0.0
type DeploymentStage struct { // custom publisher attributes for this stage Attributes any `json:"attributes,omitempty"` DeploymentName *string `json:"deploymentName,omitempty"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` // the default number of retries. can be set with tag modm.retry. defaults to 0. Retries *int32 `json:"retries,omitempty"` }
func (DeploymentStage) MarshalJSON ¶ added in v1.0.0
func (d DeploymentStage) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DeploymentStage.
func (*DeploymentStage) UnmarshalJSON ¶ added in v1.0.0
func (d *DeploymentStage) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentStage.
type DryRunError ¶ added in v1.1.0
type DryRunError struct { // READ-ONLY; The error additional info. AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro" mapstructure:"additionalInfo"` // READ-ONLY; The error code. Code *string `json:"code,omitempty" azure:"ro" mapstructure:"code"` // READ-ONLY; The error message. Message *string `json:"message,omitempty" azure:"ro" mapstructure:"message"` // READ-ONLY; The error target. Target *string `json:"target,omitempty" azure:"ro" mapstructure:"target"` // READ-ONLY; The error details. Details []*DryRunError `json:"details,omitempty" azure:"ro" mapstructure:"details"` }
type DryRunEventData ¶ added in v1.0.0
type DryRunEventData struct { EventData `mapstructure:",squash"` Status string `json:"status,omitempty" mapstructure:"status"` Errors []DryRunError `json:"errors,omitempty" mapstructure:"errors"` }
type DryRunOptions ¶ added in v1.3.0
type DryRunOptions struct {
Retries int
}
type DryRunResponse ¶ added in v0.2.1
type DryRunResponse struct {
Result DryRunResult `json:"result,omitempty" mapstructure:"result"`
}
type DryRunResult ¶
type DryRunResult struct { Status string `json:"status,omitempty" mapstructure:"status"` Errors []DryRunError `json:"errors,omitempty" mapstructure:"errors"` }
type ErrorAdditionalInfo ¶ added in v1.0.0
type ErrorAdditionalInfo struct { // READ-ONLY; The additional info. Info interface{} `json:"info,omitempty" azure:"ro"` // READ-ONLY; The additional info type. Type *string `json:"type,omitempty" azure:"ro"` }
ErrorAdditionalInfo - The resource management error additional info.
type EventData ¶ added in v1.3.2
type EventData struct { DeploymentId int `json:"deploymentId" mapstructure:"deploymentId"` OperationId uuid.UUID `json:"operationId" mapstructure:"operationId"` Attempts int `json:"attempts" mapstructure:"attempts"` ScheduledAt *time.Time `json:"scheduledAt,omitempty" mapstructure:"scheduledAt"` StartedAt *time.Time `json:"startedAt,omitempty" mapstructure:"startedAt"` CompletedAt *time.Time `json:"completedAt,omitempty" mapstructure:"completedAt"` }
Event data for a message
type EventHookMessage ¶ added in v1.0.0
type EventHookMessage struct { // the ID of the message Id uuid.UUID `json:"id,omitempty"` // the ID of the hook HookId uuid.UUID `json:"hookId,omitempty"` // the type of the event, .e.g. "dryRunCompleted" found in pkg/events Type string `json:"type,omitempty"` // the status of the event, e.g. "success" Status string `json:"status,omitempty"` Error string `json:"error,omitempty"` // subject is in format like /deployments/{deploymentId}/stages/{stageId}/operations/{operationName} // /deployments/{deploymentId}/operations/{operationName} Subject string `json:"subject,omitempty"` Data any `json:"data,omitempty"` }
subscription model for MODM webhook events
func (*EventHookMessage) DeploymentEventData ¶ added in v1.0.0
func (m *EventHookMessage) DeploymentEventData() (*DeploymentEventData, error)
func (*EventHookMessage) DeploymentId ¶ added in v1.0.0
func (m *EventHookMessage) DeploymentId() (uint, error)
func (*EventHookMessage) DryRunEventData ¶ added in v1.0.0
func (m *EventHookMessage) DryRunEventData() (*DryRunEventData, error)
func (*EventHookMessage) HashCode ¶ added in v1.3.2
func (m *EventHookMessage) HashCode() string
func (*EventHookMessage) SetSubject ¶ added in v1.0.0
func (m *EventHookMessage) SetSubject(deploymentId uint, stageId *uuid.UUID)
func (*EventHookMessage) StageEventData ¶ added in v1.3.2
func (m *EventHookMessage) StageEventData() (*StageEventData, error)
type EventHookResponse ¶ added in v1.0.0
type EventHookResponse struct { // The webhook callback Callback *string `json:"callback,omitempty"` ID *string `json:"id,omitempty"` // the name of the subscription Name *string `json:"name,omitempty"` }
func (EventHookResponse) MarshalJSON ¶ added in v1.0.0
func (e EventHookResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EventHookResponse.
func (*EventHookResponse) UnmarshalJSON ¶ added in v1.0.0
func (e *EventHookResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EventHookResponse.
type EventType ¶ added in v1.0.0
type EventType struct { // The type of event, e.g. the topic Name *string `json:"name,omitempty"` }
func (EventType) MarshalJSON ¶ added in v1.0.0
MarshalJSON implements the json.Marshaller interface for type EventType.
func (*EventType) UnmarshalJSON ¶ added in v1.0.0
UnmarshalJSON implements the json.Unmarshaller interface for type EventType.
type EventTypeName ¶ added in v1.0.0
type EventTypeName string
Defines an event that occurs in MODM
const ( EventTypeDeploymentCreated EventTypeName = "deploymentCreated" EventTypeDeploymentUpdated EventTypeName = "deploymentUpdated" EventTypeDeploymentDeleted EventTypeName = "deploymentDeleted" EventTypeDeploymentScheduled EventTypeName = "deploymentScheduled" EventTypeDeploymentRetryScheduled EventTypeName = "deploymentRetryScheduled" EventTypeDeploymentPending EventTypeName = "deploymentPending" EventTypeDeploymentStarted EventTypeName = "deploymentStarted" EventTypeDeploymentRetryStarted EventTypeName = "deploymentRetryScheduled" EventTypeDeploymentCompleted EventTypeName = "deploymentCompleted" )
deployment event types
const ( EventTypeStageScheduled EventTypeName = "stageScheduled" EventTypeStageRetryScheduled EventTypeName = "stageRetryScheduled" EventTypeStagePending EventTypeName = "stagePending" EventTypeStageStarted EventTypeName = "stageStarted" EventTypeStageRetryStarted EventTypeName = "stageRetryStarted" EventTypeStageCompleted EventTypeName = "stageCompleted" )
stage event types
const ( EventTypeDryRunSchedule EventTypeName = "dryRunScheduled" EventTypeDryRunStarted EventTypeName = "dryRunStarted" EventTypeDryRunCompleted EventTypeName = "dryRunCompleted" )
dry run event types
const (
EventTypeDeploymentEventReceived EventTypeName = "deploymentEventReceived"
)
generic event type
func (EventTypeName) String ¶ added in v1.0.0
func (e EventTypeName) String() string
type GetHealthResponse ¶ added in v1.2.0
type GetHealthResponse struct { // REQUIRED IsHealthy *bool `json:"isHealthy,omitempty"` }
func (GetHealthResponse) MarshalJSON ¶ added in v1.2.0
func (g GetHealthResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type GetHealthResponse.
func (*GetHealthResponse) UnmarshalJSON ¶ added in v1.2.0
func (g *GetHealthResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type GetHealthResponse.
type GetInvokedOperationResponse ¶ added in v1.0.0
type GetInvokedOperationResponse struct { // An invoked operation InvokedOperation *InvokedOperation `json:"invokedOperation,omitempty"` }
func (GetInvokedOperationResponse) MarshalJSON ¶ added in v1.0.0
func (g GetInvokedOperationResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type GetInvokedOperationResponse.
func (*GetInvokedOperationResponse) UnmarshalJSON ¶ added in v1.0.0
func (g *GetInvokedOperationResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type GetInvokedOperationResponse.
type GetResponse ¶ added in v0.2.1
type GetResponse struct {
Deployment *Deployment
}
type InvokeDeploymentOperationRequest ¶ added in v1.0.0
type InvokeDeploymentOperationRequest struct { Name *string `json:"name,omitempty"` // Anything Parameters any `json:"parameters,omitempty"` Retries *int32 `json:"retries,omitempty"` // whether the call wants to wait for the operation or if the result of the invocation will be received async from an event // susbscription Wait *bool `json:"wait,omitempty"` }
func (InvokeDeploymentOperationRequest) MarshalJSON ¶ added in v1.0.0
func (i InvokeDeploymentOperationRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InvokeDeploymentOperationRequest.
func (*InvokeDeploymentOperationRequest) UnmarshalJSON ¶ added in v1.0.0
func (i *InvokeDeploymentOperationRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InvokeDeploymentOperationRequest.
type InvokeDryRunResponse ¶ added in v1.0.0
type InvokedDeploymentOperationResponse ¶ added in v1.0.0
type InvokedDeploymentOperationResponse struct { // An invoked operation InvokedOperation *InvokedOperation `json:"invokedOperation,omitempty"` }
func (InvokedDeploymentOperationResponse) MarshalJSON ¶ added in v1.0.0
func (i InvokedDeploymentOperationResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InvokedDeploymentOperationResponse.
func (*InvokedDeploymentOperationResponse) UnmarshalJSON ¶ added in v1.0.0
func (i *InvokedDeploymentOperationResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InvokedDeploymentOperationResponse.
type InvokedOperation ¶ added in v1.0.0
type InvokedOperation struct { Attempts *int32 `json:"attempts,omitempty"` // the associated deployment ID if the operation was invoked against a deployment DeploymentID *int32 `json:"deploymentId,omitempty"` ID *string `json:"id,omitempty"` InvokedOn *time.Time `json:"invokedOn,omitempty"` Name *string `json:"name,omitempty"` // Anything Parameters any `json:"parameters,omitempty"` // Anything Result any `json:"result,omitempty"` Retries *int32 `json:"retries,omitempty"` Status *string `json:"status,omitempty"` }
InvokedOperation - An invoked operation
func (InvokedOperation) MarshalJSON ¶ added in v1.0.0
func (i InvokedOperation) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InvokedOperation.
func (*InvokedOperation) UnmarshalJSON ¶ added in v1.0.0
func (i *InvokedOperation) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InvokedOperation.
type ListInvokedOperationResponse ¶ added in v1.0.0
type ListInvokedOperationResponse struct {
Items []*InvokedOperation `json:"items,omitempty"`
}
ListInvokedOperationResponse - List response of invoked operations
func (ListInvokedOperationResponse) MarshalJSON ¶ added in v1.0.0
func (l ListInvokedOperationResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ListInvokedOperationResponse.
func (*ListInvokedOperationResponse) UnmarshalJSON ¶ added in v1.0.0
func (l *ListInvokedOperationResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ListInvokedOperationResponse.
type ListResponse ¶ added in v0.2.1
type ListResponse struct {
Deployments []*Deployment
}
type OperationType ¶ added in v1.0.0
type OperationType string
OperationType is an enum for the type of operation
const ( OperationDeploy OperationType = "deploy" OperationDeployStage OperationType = "deployStage" OperationRetry OperationType = "retry" OperationRetryStage OperationType = "retryStage" OperationDryRun OperationType = "dryRun" OperationCancel OperationType = "cancel" OperationUnknown OperationType = "unknown" )
func Type ¶ added in v1.0.0
func Type(o string) (OperationType, error)
func (OperationType) String ¶ added in v1.0.0
func (o OperationType) String() string
type RetryOptions ¶ added in v0.2.1
type RetryResponse ¶ added in v0.2.1
type StageEventData ¶ added in v1.3.2
type StageEventData struct { EventData `mapstructure:",squash"` ParentOperationId *uuid.UUID `json:"parentOperationId,omitempty" mapstructure:"parentOperationId"` StageId *uuid.UUID `json:"stageId,omitempty" mapstructure:"stageId"` CorrelationId *uuid.UUID `json:"correlationId,omitempty" mapstructure:"correlationId"` Message string `json:"message,omitempty" mapstructure:"message"` }
type StartDeploymentResponse ¶ added in v0.2.1
type StartOptions ¶ added in v0.2.1
type StartOptions struct {
Retries int
}
Source Files ¶
- client.go
- client_deployment.go
- client_events.go
- client_healthcheck.go
- client_operation.go
- clientfactory.go
- event_messages.go
- event_types.go
- models.go
- operation_dryrun.go
- operation_status.go
- operation_type.go
- version.go
- zz_generated_constants.go
- zz_generated_deploymentmanagement_client.go
- zz_generated_models.go
- zz_generated_models_serde.go
- zz_generated_response_types.go
- zz_generated_time_rfc3339.go