@octopusdeploy/api-client

Index

Enumerations

ActivityLogEntryCategory ActivityStatus AuthenticationType ConnectivityCheckResponseMessageCategory ControlType GuidedFailureMode IdentityType OverwriteMode PackageAcquisitionLocation PackageRequirement PackageSelectionMode Permission PersistenceSettingsType PropertyApplicabilityMode RetentionUnit RunCondition RunConditionForAction RunbookEnvironmentScope StartTrigger TaskState TenantedDeploymentMode

Classes

BasicRepository BuildInformationRepository Client DeploymentProcessRepository DeploymentRepository EnvironmentRepository LifecycleRepository NuGetPackageBuilder PackageIdentity PackageRepository ProjectGroupRepository ProjectRepository ReleaseRepository Resolver RunbookProcessRepository RunbookRepository RunbookRunRepository RunbookSnapshotRepository ServerTaskWaiter SpaceRepository SpaceScopedBasicRepository SpaceServerTaskRepository SubscriptionRecord TagSetRepository TenantRepository ZipPackageBuilder

Interfaces

ActionTemplateParameter ActionTemplateParameterDisplaySettings ActiveDirectoryIdentity ActivityElement ActivityLogElement AnonymousVcsCredentials ClaimsBasedIdentity ClientConfiguration ClientErrorResponseDetails ClientOptions ClientRequestDetails ClientResponseDetails CommitDetail ConnectivityCheck ConnectivityCheckResponse ConnectivityCheckResponseMessage ConnectivityPolicy ConvertProjectToVersionControlledResponse CreateDeploymentTenantedCommandV1 CreateDeploymentTenantedResponseV1 CreateDeploymentUntenantedCommandV1 CreateDeploymentUntenantedResponseV1 CreateExecutionBaseV1 CreateOctopusBuildInformationCommand CreateReleaseCommandV1 CreateReleaseResponseV1 CreateRunbookRunCommandV1 CreateRunbookRunRequest CreateRunbookRunResponseV1 Deployment DeploymentAction DeploymentActionContainer DeploymentActionPackage DeploymentEnvironment DeploymentProcessOclResource DeploymentServerTask DeploymentSettingsOclResource DeploymentSettingsResource DeploymentStep DisplayInfo ErrorResponseDetails Execution ExtensionSettingsValues ExternalIdentity ICanBeVersionControlled ICommitCommand IOctopusBuildInformationCommit IProcess IVersionControlReference Identity Lifecycle Logger MappedOctopusPackageVersionBuildInformation MetadataTypeCollection MissingVariable MultiTenancyStatus NamedResource NewDeploymentEnvironment NewDeploymentStep NewExecution NewNamedResource NewProject NewResource NewRunbookSnapshot NewSpace NewTag NewTagSet NewTenant OAuthIdentity Package PackageReference PhasedResource Project ProjectGroup ProjectSettingsMetadata ProjectSummary PromptedVariableValues PropertyApplicability PropertyMetadata RecentlyViewedProjectIds ReleaseChanges ReleaseCreationStrategy ReleasePackageVersionBuildInformation RequestDetails Resource ResourceCollection ResourceCollectionLinks ResponseDetails RetentionPeriod Runbook RunbookProcess RunbookRetentionPeriod RunbookRun RunbookRunServerTask RunbookSnapshot SensitiveValue ServerInformation ServerTask ServerTaskDetails Space SpaceScopedArgs SpaceScopedOperation SpaceScopedRequest SpaceScopedResource Tag TagSet TagTestResult TaskProgress Tenant TenantLibraryVariable TenantMissingVariable TenantProjectVariable TenantVariable TenantVariableTemplate TenantVariableTemplateDisplaySettings TypeMetadata User UserProjection UsernamePasswordVcsCredentials VariablesScopedToEnvironmentResponse VcsBranch VcsRef VersionControlCompatibilityResponse VersionControlledPersistenceSettings VersioningStrategy WorkItemLink

Type Aliases

ActionInputs ActionProperties Callback DataContext DeploymentProcess EnvironmentMachinesArgs EnvironmentSummaryArgs GitCommit GitRef LinksCollection ListArgs LocationProps ModifyDeploymentProcessCommand ModifyDeploymentProcessOclCommand ModifyDeploymentSettingsCommand ModifyDeploymentSettingsOclCommand ModifyRunbookCommand NameOrIdKey NewRunbook NewSpaceScopedResource NuGetPackArgs NuSpecArgs PackArgs PackageReferenceProperties Phase ProjectOrSummary PropertyValue ResourcesById ResourcesByNameOrId RouteArgs Unsubscribe ZipPackArgs

Variables

apiLocation spaceScopedRoutePrefix

Functions

GetNamedPackageReferences GetPrimaryPackageReference HasManualInterventionResponsibleTeams HasVersionControlledPersistenceSettings InitialisePrimaryPackageReference IsDeployReleaseAction IsNamedPackageReference IsPrimaryPackageReference IsUsingUsernamePasswordAuth NewProject NewSensitiveValue PackageReferenceNamesMatch RemovePrimaryPackageReference SetNamedPackageReference SetPrimaryPackageReference deploymentActionPackages determineServerEndpoint displayName ensurePrefix ensureSuffix getBranchNameFromRouteParameter getQueryValue getResolver getServerEndpoint getURISafeBranchName isDeploymentProcess isPropertyDefinedAndNotNull isResource isRunbookProcess isSensitiveValue isSpaceScopedArgs isSpaceScopedOperation isSpaceScopedRequest isSpaceScopedResource isVcsBranchResource processResourcePermission resolveSpaceId typeSafeHasOwnProperty userGetCurrent

Settings

Member Visibility

Theme

Generated using TypeDoc