Documentation
¶
Index ¶
- type Account
- type Action
- type ActionPackage
- type AuthenticationResource
- type AzureCloudServiceEndpointResource
- type AzureCloudServiceResource
- type AzureServiceFabricEndpointResource
- type AzureServiceFabricResource
- type AzureWebAppEndpointResource
- type AzureWebAppResource
- type BashHealthCheckPolicy
- type Branch
- type Certificate
- type CertificateChain
- type Channel
- type Claim
- type CloudRegionEndpointResource
- type CloudRegionResource
- type CommunityStepTemplate
- type Container
- type ConversionState
- type Credentials
- type DeploymentActionContainerResource
- type DeploymentFreeze
- type DeploymentFreezeRecurringSchedule
- type DeploymentFreezeTenantProjectEnvironmentScope
- type DeploymentFreezes
- type DeploymentProcess
- type Dn
- type DonorPackage
- type Email
- type Environment
- type ErrorResponse
- type Extension
- type ExtensionSetting
- type Feed
- type GeneralCollection
- type GitCredentials
- type GitCredentialsDetails
- type GitDependency
- type Identity
- type KubernetesAgentWorker
- type KubernetesAgentWorkerEndpoint
- type KubernetesAgentWorkerEndpointKubernetesAgentDetails
- type KubernetesAgentWorkerEndpointTentacleEndpointConfiguration
- type KubernetesEndpointResource
- type KubernetesTentacleEndpointResource
- type LibraryVariable
- type LibraryVariableSet
- type Lifecycle
- type ListeningEndpointResource
- type ListeningTentacleEndpointResource
- type Machine
- type MachineCleanupPolicy
- type MachineConnectivityPolicy
- type MachineEndpointResource
- type MachineHealthCheckPolicy
- type MachinePolicy
- type MachineProxy
- type MachineUpdatePolicy
- type NameId
- type NameIdParentResource
- type NamedResource
- type OctopusProcess
- type OfflineDropEndpointDestinationResource
- type OfflineDropEndpointResource
- type OfflineDropResource
- type Package
- type PersistenceSettings
- type Phase
- type Policy
- type PollingEndpointResource
- type PollingTentacleEndpointResource
- type PowerShellHealthCheckPolicy
- type Project
- type ProjectCacDeploymentSettings
- type ProjectConnectivityPolicy
- type ProjectGroup
- type ProjectTrigger
- type ProjectTriggerAction
- type ProjectTriggerFilter
- type ProjectTriggerFilterPackage
- type ProjectTriggerSources
- type ProjectVariable
- type Prompt
- type Role
- type Rule
- type RunRetentionPolicy
- type Runbook
- type RunbookProcess
- type Scope
- type Secret
- type Space
- type SshConnectionDeploymentTargetEndpoint
- type SshEndpointResource
- type Step
- type StepTemplate
- type StepTemplateParameterDisplaySettings
- type StepTemplateParameters
- type Tag
- type TagSet
- type Target
- type TargetResource
- type Team
- type Template
- type Tenant
- type TenantVariable
- type TentacleVersionDetails
- type User
- type Variable
- type VariableSet
- type VersioningStrategy
- type Worker
- type WorkerEndpoint
- type WorkerEndpointTentacleVersionDetails
- type WorkerPool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct {
Id string
Name string
Slug *string
Description *string
SpaceId string
EnvironmentIds []string
TenantedDeploymentParticipation *string
TenantIds []string
TenantTags []string
AccountType string
// token
Token Secret
// aws
AccessKey *string
SecretKey Secret
// azure
SubscriptionNumber *string
ClientId *string
TenantId *string
Password Secret
AzureEnvironment *string
ResourceManagementEndpointBaseUri *string
ActiveDirectoryEndpointBaseUri *string
// azure subscription
ServiceManagementEndpointBaseUri *string
ServiceManagementEndpointSuffix *string
CertificateBytes Secret
CertificateThumbprint *string
// username
Username *string
// google
JsonKey Secret
// aws oidc (also generic OIDC)
RoleArn *string
SessionDuration *string
DeploymentSubjectKeys []string
HealthCheckSubjectKeys []string
AccountTestSubjectKeys []string
// azure oidc
Audience *string
ApplicationId *string
}
type Action ¶
type Action struct {
Id string
Name *string
Slug *string
ActionType *string
Notes *string
IsDisabled bool
CanBeUsedForProjectVersioning bool
IsRequired bool
WorkerPoolId string
Container Container
WorkerPoolVariable *string
Environments []string
ExcludedEnvironments []string
Channels []string
TenantTags []string
Packages []Package
Condition *string
Properties map[string]any
Inputs map[string]any
GitDependencies []GitDependency
}
func (*Action) GenerateDeploymentProcessId ¶ added in v0.1.1402
func (a *Action) GenerateDeploymentProcessId(deploymentProcess OctopusProcess) string
GenerateDeploymentProcessId generates a unique identifier for the deployment process. This solves an issue where a deployment process has been copied and pasted in Git or cloned via the UI, reusing step and action IDs.
func (*Action) GenerateRunbookProcessId ¶ added in v0.1.1402
func (a *Action) GenerateRunbookProcessId(runbookProcess OctopusProcess) string
GenerateRunbookProcessId generates a unique identifier for the deployment process. This solves an issue where a deployment process has been copied and pasted in Git or cloned via the UI, reusing step and action IDs.
type ActionPackage ¶
type AuthenticationResource ¶
type AuthenticationResource struct {
AuthenticationType string
// KubernetesCertificateAuthenticationResource
ClientCertificate *string
// KubernetesPodServiceAuthenticationResource
TokenPath *string
// KubernetesStandardAccountAuthenticationResource
AccountId *string
// KubernetesAzureAuthenticationResource and KubernetesAwsAuthenticationResource
ClusterName *string
ClusterResourceGroup *string
// KubernetesAwsAuthenticationResource
UseInstanceRole *bool
AssumeRole *bool
AssumedRoleArn *string
AssumedRoleSession *string
AssumeRoleSessionDurationSeconds *int
AssumeRoleExternalId *string
// KubernetesGoogleCloudAuthenticationResource
UseVmServiceAccount *bool
ImpersonateServiceAccount *bool
ServiceAccountEmails *string
Project *string
Region *string
Zone *string
}
type AzureCloudServiceResource ¶
type AzureCloudServiceResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint AzureCloudServiceEndpointResource
}
type AzureServiceFabricEndpointResource ¶
type AzureServiceFabricEndpointResource struct {
CommunicationStyle string
ConnectionEndpoint string
SecurityMode string
ServerCertThumbprint string
ClientCertVariable string
CertificateStoreLocation string
CertificateStoreName string
AadCredentialType string
AadClientCredentialSecret string
AadUserCredentialUsername string
AadUserCredentialPassword Secret
DefaultWorkerPoolId string
}
type AzureServiceFabricResource ¶
type AzureServiceFabricResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint AzureServiceFabricEndpointResource
}
type AzureWebAppResource ¶
type AzureWebAppResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint AzureWebAppEndpointResource
}
type BashHealthCheckPolicy ¶
type Certificate ¶
type Certificate struct {
Id string
SpaceId string
Name string
Description *string
TenantedDeploymentParticipation string
EnvironmentIds []string
TenantIds []string
TenantTags []string
CertificateDataFormat string
Archived string
ReplacedBy string
SubjectDistinguishedName string
SubjectCommonName string
SubjectOrganization string
IssuerDistinguishedName string
IssuerCommonName string
IssuerOrganization string
SelfSigned bool
Thumbprint string
NotAfter string
NotBefore string
Notes string
IsExpired bool
HasPrivateKey bool
Version int
SerialNumber string
SignatureAlgorithmName string
SubjectAlternativeNames []string
CertificateChain []CertificateChain
}
type CertificateChain ¶ added in v0.1.829
type CloudRegionResource ¶
type CloudRegionResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint CloudRegionEndpointResource
}
type CommunityStepTemplate ¶ added in v0.1.1204
type CommunityStepTemplate struct {
Id string `json:"Id"`
Name string `json:"Name"`
Type string `json:"Type"`
Author string `json:"Author"`
Description string `json:"Description"`
Website string `json:"Website"`
HistoryUrl string `json:"HistoryUrl"`
Properties map[string]string `json:"Properties"`
Parameters []StepTemplateParameters `json:"Parameters"`
Version int `json:"Version"`
StepPackageId string `json:"StepPackageId"`
}
type ConversionState ¶
type ConversionState struct {
VariablesAreInGit bool
}
type Credentials ¶
type DeploymentFreeze ¶ added in v0.1.1434
type DeploymentFreeze struct {
Id string
Name string
Start string
End string
TenantProjectEnvironmentScope []DeploymentFreezeTenantProjectEnvironmentScope
ProjectEnvironmentScope map[string][]string
RecurringSchedule *DeploymentFreezeRecurringSchedule
}
type DeploymentFreezeRecurringSchedule ¶ added in v0.1.1434
type DeploymentFreezeTenantProjectEnvironmentScope ¶ added in v0.1.1434
type DeploymentFreezes ¶ added in v0.1.1469
type DeploymentFreezes struct {
DeploymentFreezes []DeploymentFreeze
Count int
}
type DeploymentProcess ¶
func (*DeploymentProcess) GetId ¶ added in v0.1.1566
func (a *DeploymentProcess) GetId() string
func (*DeploymentProcess) GetParentId ¶ added in v0.1.1566
func (a *DeploymentProcess) GetParentId() string
func (*DeploymentProcess) GetSteps ¶ added in v0.1.1566
func (a *DeploymentProcess) GetSteps() []Step
type DonorPackage ¶
type Environment ¶
type ErrorResponse ¶ added in v0.1.927
type ErrorResponse struct {
ErrorMessage string
}
type ExtensionSetting ¶ added in v1.1.47
type Feed ¶
type Feed struct {
Id string
SpaceId string
Name string
Slug *string
FeedType *string
FeedUri *string
Username *string
Password *Secret
PackageAcquisitionLocationOptions []string
RetentionPolicyId *string
DownloadAttempts *int
DownloadRetryBackoffSeconds *int
// Docker
RegistryPath *string
ApiVersion *string
// ECR
AccessKey *string
SecretKey *Secret
Region *string
// Nuget
EnhancedMode bool
// Artifactory
Repository *string
LayoutRegex *string
// S3
UseMachineCredentials *bool
}
type GeneralCollection ¶
type GitCredentials ¶
type GitCredentials struct {
Id string
SpaceId string
Name string
Description *string
Details GitCredentialsDetails
}
type GitCredentialsDetails ¶
type GitDependency ¶ added in v0.1.1114
type KubernetesAgentWorker ¶ added in v0.1.1450
type KubernetesAgentWorker struct {
Id string
SpaceId string
WorkerPoolIds []string
Name string
Thumbprint string
Uri *string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Slug string
SkipInitialHealthCheck bool
Endpoint KubernetesAgentWorkerEndpoint
}
type KubernetesAgentWorkerEndpoint ¶ added in v0.1.1450
type KubernetesAgentWorkerEndpoint struct {
CommunicationStyle string
TentacleEndpointConfiguration KubernetesAgentWorkerEndpointTentacleEndpointConfiguration
KubernetesAgentDetails KubernetesAgentWorkerEndpointKubernetesAgentDetails
UpgradeLocked bool
DefaultNamespace *string
LastModifiedOn *string
LastModifiedBy *string
// contains filtered or unexported fields
}
type KubernetesAgentWorkerEndpointKubernetesAgentDetails ¶ added in v0.1.1450
type KubernetesAgentWorkerEndpointTentacleEndpointConfiguration ¶ added in v0.1.1450
type KubernetesEndpointResource ¶
type KubernetesEndpointResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint *string
Uri *string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint KubernetesTentacleEndpointResource
}
type KubernetesTentacleEndpointResource ¶
type KubernetesTentacleEndpointResource struct {
CommunicationStyle string
ClusterCertificate *string
ClusterCertificatePath *string
ClusterUrl *string
Namespace *string
SkipTlsVerification *string
ProxyId *string
DefaultWorkerPoolId *string
Container DeploymentActionContainerResource
Authentication AuthenticationResource
}
KubernetesTentacleEndpointResource is based on KubernetesEndpointResource from the client library
type LibraryVariable ¶
type LibraryVariableSet ¶
type ListeningEndpointResource ¶
type ListeningEndpointResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint ListeningTentacleEndpointResource
}
type ListeningTentacleEndpointResource ¶
type ListeningTentacleEndpointResource struct {
CommunicationStyle string
Uri string
ProxyId string
TentacleVersionDetails TentacleVersionDetails
}
ListeningTentacleEndpointResource is based on ListeningTentacleEndpointResource from the client library
type Machine ¶ added in v0.1.433
type Machine struct {
NameId
Endpoint MachineEndpointResource
}
Machine is a minimal representation capturing the common fields required to distinguish and identify a target
type MachineCleanupPolicy ¶
type MachineConnectivityPolicy ¶
type MachineConnectivityPolicy struct {
MachineConnectivityBehavior string
}
type MachineEndpointResource ¶ added in v0.1.433
type MachineEndpointResource struct {
CommunicationStyle string
}
type MachineHealthCheckPolicy ¶
type MachineHealthCheckPolicy struct {
HealthCheckInterval *string
HealthCheckCron *string
HealthCheckCronTimezone *string
HealthCheckType *string
PowerShellHealthCheckPolicy PowerShellHealthCheckPolicy
BashHealthCheckPolicy BashHealthCheckPolicy
}
type MachinePolicy ¶
type MachinePolicy struct {
Id string
Name string
SpaceId string
Description *string
IsDefault bool
PollingRequestQueueTimeout string
PollingRequestMaximumMessageProcessingTimeout string
ConnectionRetrySleepInterval string
ConnectionRetryCountLimit *int
ConnectionRetryTimeLimit string
ConnectionConnectTimeout string
MachineHealthCheckPolicy MachineHealthCheckPolicy
MachineConnectivityPolicy MachineConnectivityPolicy
MachineCleanupPolicy MachineCleanupPolicy
MachineUpdatePolicy MachineUpdatePolicy
}
type MachineProxy ¶ added in v0.1.1463
type MachineUpdatePolicy ¶
type NameIdParentResource ¶ added in v0.1.1566
type NameIdParentResource interface {
NamedResource
GetParentId() *string
GetUltimateParent() string
}
NameIdParentResource provides a common interface for any resource that has a name, an ID, and an optional parent ID.
type NamedResource ¶ added in v0.1.989
NamedResource provides a common interface for any resource that has a name and an ID. This is almost every resource in Octopus Deploy.
type OctopusProcess ¶ added in v0.1.1566
OctopusProcess defines the interface for Octopus processes such as DeploymentProcess and RunbookProcess.
type OfflineDropEndpointResource ¶
type OfflineDropEndpointResource struct {
CommunicationStyle string
Destination OfflineDropEndpointDestinationResource
ApplicationsDirectory string
OctopusWorkingDirectory string
}
type OfflineDropResource ¶
type OfflineDropResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint OfflineDropEndpointResource
}
type PersistenceSettings ¶
type PersistenceSettings struct {
Type string
Url string
Credentials Credentials
DefaultBranch string
BasePath string
ProtectedDefaultBranch bool
ProtectedBranchNamePatterns []string
ConversionState ConversionState
}
type PollingEndpointResource ¶
type PollingEndpointResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint string
Uri string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint PollingTentacleEndpointResource
}
type PollingTentacleEndpointResource ¶
type PollingTentacleEndpointResource struct {
CommunicationStyle string
Uri string
TentacleVersionDetails TentacleVersionDetails
}
PollingTentacleEndpointResource is based on PollingTentacleEndpointResource from the client library
type Project ¶
type Project struct {
NameId
Slug *string
Description *string
AutoCreateRelease bool
DefaultGuidedFailureMode *string
DefaultToSkipIfAlreadyInstalled bool
DiscreteChannelRelease bool
IsDisabled bool
IsVersionControlled bool
LifecycleId string
ProjectGroupId string
DeploymentProcessId *string
TenantedDeploymentMode *string
ProjectConnectivityPolicy ProjectConnectivityPolicy
Templates []Template
VariableSetId *string
IncludedLibraryVariableSetIds []string
PersistenceSettings PersistenceSettings
VersioningStrategy VersioningStrategy
ExtensionSettings []ExtensionSetting
}
func (*Project) GetParentId ¶ added in v0.1.1566
func (*Project) GetUltimateParent ¶ added in v0.1.1566
func (*Project) HasCacConfigured ¶
type ProjectCacDeploymentSettings ¶ added in v0.1.1392
type ProjectCacDeploymentSettings struct {
Id string
SpaceId string
ProjectId string
ConnectivityPolicy ProjectConnectivityPolicy
DefaultGuidedFailureMode string
VersioningStrategy VersioningStrategy
ReleaseNotesTemplate *string
DefaultToSkipIfAlreadyInstalled bool
DeploymentChangesTemplate *string
ForcePackageDownload bool
}
type ProjectGroup ¶
type ProjectTrigger ¶
type ProjectTrigger struct {
Id string
Name string
Description *string
ProjectId string
IsDisabled bool
Filter ProjectTriggerFilter
Action ProjectTriggerAction
}
type ProjectTriggerAction ¶
type ProjectTriggerAction struct {
ActionType string
RunbookId *string
ShouldRedeployWhenMachineHasBeenDeployedTo bool
Id *string
LastModifiedOn *string
LastModifiedBy *string
SourceEnvironmentIds []string
EnvironmentIds []string
DestinationEnvironmentId *string
EnvironmentId *string
ShouldRedeployWhenReleaseIsCurrent *bool
ChannelId *string
TenantIds []string
TenantTags []string
}
type ProjectTriggerFilter ¶
type ProjectTriggerFilter struct {
FilterType string
EnvironmentIds []string
Roles []string
EventGroups []string
EventCategories []string
DaysOfWeek []string
Timezone *string
Id *string
LastModifiedOn *string
LastModifiedBy *string
Packages []ProjectTriggerFilterPackage
StartTime *string
MonthlyScheduleType *string
DateOfMonth *string
DayNumberOfMonth *string
DayOfWeek *string
Interval *string
RunAfter *string
RunUntil *string
CronExpression *string
HourInterval *int
MinuteInterval *int
Sources []ProjectTriggerSources
}
type ProjectTriggerFilterPackage ¶ added in v0.1.1112
type ProjectTriggerSources ¶ added in v0.1.1450
type ProjectVariable ¶
type Rule ¶
type Rule struct {
VersionRange *string
Tag *string
ActionPackages []ActionPackage
Actions []string
}
type RunRetentionPolicy ¶
type Runbook ¶
type Runbook struct {
NameId
Slug *string
Description *string
RunbookProcessId *string
PublishedRunbookSnapshotId *string
ProjectId string
MultiTenancyMode *string
ConnectivityPolicy ProjectConnectivityPolicy
EnvironmentScope *string
Environments []string
DefaultGuidedFailureMode *string
RunRetentionPolicy RunRetentionPolicy
ForcePackageDownload bool
}
func (*Runbook) GetParentId ¶ added in v0.1.1566
func (*Runbook) GetUltimateParent ¶ added in v0.1.1566
type RunbookProcess ¶
func (*RunbookProcess) GetId ¶ added in v0.1.1566
func (a *RunbookProcess) GetId() string
func (*RunbookProcess) GetParentId ¶ added in v0.1.1566
func (a *RunbookProcess) GetParentId() string
func (*RunbookProcess) GetSteps ¶ added in v0.1.1566
func (a *RunbookProcess) GetSteps() []Step
type Scope ¶
type Scope struct {
Environment []string
Role []string
Machine []string
Channel []string
TenantTag []string
Action []string
ProcessOwner []string
}
func (*Scope) ScopeDescription ¶ added in v0.1.940
type SshConnectionDeploymentTargetEndpoint ¶
type SshConnectionDeploymentTargetEndpoint struct {
CommunicationStyle string
AccountId string
Host string
Port int
Fingerprint string
ProxyId string
DotNetCorePlatform string
}
SshConnectionDeploymentTargetEndpoint is based on SshEndpointResource from the client library
type SshEndpointResource ¶
type SshEndpointResource struct {
Target
Id string
Name string
Roles []string
TenantIds []string
TenantTags []string
TenantedDeploymentParticipation string
Thumbprint *string
Uri *string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Endpoint SshConnectionDeploymentTargetEndpoint
}
type Step ¶
type Step struct {
Id *string
Name *string
PackageRequirement *string
Properties map[string]string
Condition *string
StartTrigger *string
Actions []Action
}
func (*Step) GenerateDeploymentProcessId ¶ added in v0.1.1403
func (a *Step) GenerateDeploymentProcessId(deploymentProcess *DeploymentProcess) string
GenerateDeploymentProcessId generates a unique identifier for the deployment process. This solves an issue where a deployment process has been copied and pasted in Git or cloned via the UI, reusing step and action IDs.
func (*Step) GenerateRunbookProcessId ¶ added in v0.1.1403
func (a *Step) GenerateRunbookProcessId(runbookProcess *RunbookProcess) string
GenerateRunbookProcessId generates a unique identifier for the deployment process. This solves an issue where a deployment process has been copied and pasted in Git or cloned via the UI, reusing step and action IDs.
type StepTemplate ¶ added in v0.1.1204
type StepTemplate struct {
Id string `json:"Id"`
SpaceId *string `json:"SpaceId"`
Version *int `json:"Version"`
Name string `json:"Name"`
Description *string `json:"Description"`
ActionType string `json:"ActionType"`
Packages []Package `json:"Packages"`
GitDependencies []string `json:"GitDependencies"`
Properties map[string]string `json:"Properties"`
LastModifiedBy string `json:"LastModifiedBy"`
Category string `json:"Category"`
StepPackageId string `json:"StepPackageId"`
Parameters []StepTemplateParameters `json:"Parameters"`
CommunityActionTemplateId *string `json:"CommunityActionTemplateId"`
}
type StepTemplateParameterDisplaySettings ¶ added in v0.1.1204
type StepTemplateParameterDisplaySettings struct {
OctopusControlType string `json:"Octopus.ControlType"`
}
type StepTemplateParameters ¶ added in v0.1.1204
type StepTemplateParameters struct {
Id string `json:"Id"`
Name string `json:"Name"`
Label string `json:"Label"`
HelpText string `json:"HelpText"`
DefaultValue any `json:"DefaultValue"`
DisplaySettings StepTemplateParameterDisplaySettings `json:"DisplaySettings"`
}
func (*StepTemplateParameters) GetId ¶ added in v0.1.1596
func (stepTemplateParameters *StepTemplateParameters) GetId() string
func (*StepTemplateParameters) GetName ¶ added in v0.1.1596
func (stepTemplateParameters *StepTemplateParameters) GetName() string
type Target ¶ added in v0.1.1080
func (Target) GetEnvironmentIds ¶ added in v0.1.1080
type TargetResource ¶ added in v0.1.1080
type TargetResource interface {
GetEnvironmentIds() []string
}
type Template ¶
type Template struct {
Id string
Name *string
Label *string
HelpText *string
DefaultValue any
DisplaySettings map[string]string
}
func (Template) GetDefaultValueString ¶ added in v0.1.617
type TenantVariable ¶
type TenantVariable struct {
Id string
TenantId string
SpaceId string
TenantName string
ConcurrencyToken string
ProjectVariables map[string]ProjectVariable
LibraryVariables map[string]LibraryVariable
}
type TentacleVersionDetails ¶
type Variable ¶
type Variable struct {
Id string
Name string
Value *string
Description *string
Scope Scope
IsEditable bool
Type string
IsSensitive bool
Prompt Prompt
}
func (*Variable) GetVariableSetId ¶ added in v0.1.1406
func (v *Variable) GetVariableSetId(variableSet *VariableSet) string
GetVariableSetId returns the ID of the variable set and the variable. This generates a unique value because cloning a project results in duplicate variable IDs.
type VariableSet ¶
type VersioningStrategy ¶
type VersioningStrategy struct {
Template string
DonorPackageStepId *string
DonorPackage *DonorPackage
}
type Worker ¶ added in v0.1.1454
type Worker struct {
Id string
SpaceId string
WorkerPoolIds []string
Name string
Thumbprint string
Uri *string
IsDisabled bool
MachinePolicyId string
HealthStatus string
HasLatestCalamari bool
StatusSummary string
IsInProcess bool
OperatingSystem string
ShellName string
ShellVersion string
Architecture string
Slug string
SkipInitialHealthCheck bool
Endpoint WorkerEndpoint
}
type WorkerEndpoint ¶ added in v0.1.1454
type WorkerEndpoint struct {
CommunicationStyle string
TentacleVersionDetails WorkerEndpointTentacleVersionDetails
Thumbprint string
Uri string
CertificateSignatureAlgorithm string
Id *string
LastModifiedOn *string
LastModifiedBy *string
ProxyId *string
AccountId *string
Host *string
Port *int
Fingerprint *string
HostKeyAlgorithm *string
DotNetCorePlatform *string
}
type WorkerEndpointTentacleVersionDetails ¶ added in v0.1.1454
Source Files
¶
- octopus_account.go
- octopus_azure_cloud_service_deployment_target.go
- octopus_azure_service_fabric_cluster_deployment_target.go
- octopus_azure_web_app_deployment_target.go
- octopus_branch.go
- octopus_certificate.go
- octopus_channel.go
- octopus_cloud_region_deployment_target.go
- octopus_collection.go
- octopus_deployment_freeze.go
- octopus_deployment_process.go
- octopus_environment.go
- octopus_error.go
- octopus_feed.go
- octopus_gitcredential.go
- octopus_kubernetes_agent_worker.go
- octopus_kubernetes_cluster_deployment_target.go
- octopus_library_variable_set.go
- octopus_lifecycle.go
- octopus_listening_tentacle_deployment_target.go
- octopus_machine.go
- octopus_machine_policy.go
- octopus_machine_proxy.go
- octopus_name_id.go
- octopus_name_id_parent.go
- octopus_offline_package_drop_deployment_target.go
- octopus_polling_tentacle_deployment_target.go
- octopus_process.go
- octopus_project.go
- octopus_project_group.go
- octopus_project_trigger.go
- octopus_role.go
- octopus_runbook.go
- octopus_runbook_process.go
- octopus_space.go
- octopus_ssh_connection_deployment_target.go
- octopus_step_template.go
- octopus_tag_set.go
- octopus_target.go
- octopus_team.go
- octopus_tenant.go
- octopus_tenant_variable.go
- octopus_user.go
- octopus_variable_set.go
- octopus_worker.go
- octopus_worker_pool.go