Share via


@azure/arm-artifactsigning package

Classes

CodeSigningClient

Interfaces

AccountSku

SKU of the artifact signing account.

AccountSkuPatch

SKU of the artifact signing account.

Certificate

Properties of the certificate.

CertificateProfile

Certificate profile resource.

CertificateProfileProperties

Properties of the certificate profile.

CertificateProfilesCreateOptionalParams

Optional parameters.

CertificateProfilesDeleteOptionalParams

Optional parameters.

CertificateProfilesGetOptionalParams

Optional parameters.

CertificateProfilesListByCodeSigningAccountOptionalParams

Optional parameters.

CertificateProfilesOperations

Interface representing a CertificateProfiles operations.

CertificateProfilesRevokeCertificateOptionalParams

Optional parameters.

CheckNameAvailability

The parameters used to check the availability of the artifact signing account name.

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

CodeSigningAccount

Artifact signing account resource.

CodeSigningAccountPatch

Parameters for creating or updating an artifact signing account.

CodeSigningAccountPatchProperties

Properties of the artifact signing account.

CodeSigningAccountProperties

Properties of the artifact signing account.

CodeSigningAccountsCheckNameAvailabilityOptionalParams

Optional parameters.

CodeSigningAccountsCreateOptionalParams

Optional parameters.

CodeSigningAccountsDeleteOptionalParams

Optional parameters.

CodeSigningAccountsGetOptionalParams

Optional parameters.

CodeSigningAccountsListByResourceGroupOptionalParams

Optional parameters.

CodeSigningAccountsListBySubscriptionOptionalParams

Optional parameters.

CodeSigningAccountsOperations

Interface representing a CodeSigningAccounts operations.

CodeSigningAccountsUpdateOptionalParams

Optional parameters.

CodeSigningClientOptionalParams

Optional parameters for the client.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for an operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
Revocation

Revocation details of the certificate.

RevokeCertificate

Defines the certificate revocation properties.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

CertificateProfileStatus

Status of the certificate profiles.
KnownCertificateProfileStatus can be used interchangeably with CertificateProfileStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: The certificate profile is active.
Disabled: The certificate profile is disabled.
Suspended: The certificate profile is suspended.

CertificateStatus

Status of the certificate
KnownCertificateStatus can be used interchangeably with CertificateStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: The certificate is active.
Expired: The certificate is expired.
Revoked: The certificate is revoked.

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

NameUnavailabilityReason

The reason that an artifact signing account name could not be used. The Reason element is only returned if nameAvailable is false.
KnownNameUnavailabilityReason can be used interchangeably with NameUnavailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

AccountNameInvalid: Account name is invalid
AlreadyExists: Account name already exists

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ProfileType

Type of the certificate
KnownProfileType can be used interchangeably with ProfileType, this enum contains the known values that the service supports.

Known values supported by the service

PublicTrust: Used for signing files which are distributed publicly.
PrivateTrust: Used for signing files which are distributed internally within organization or group boundary.
PrivateTrustCIPolicy: Used for signing CI policy files.
VBSEnclave: Used for signing files which are run in secure vbs enclave.
PublicTrustTest: Used for signing files for testing purpose.

ProvisioningState

The status of the current operation.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Updating: Updating in progress.
Deleting: Deletion in progress.
Accepted: Resource creation started.

RevocationStatus

Revocation status of the certificate.
KnownRevocationStatus can be used interchangeably with RevocationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Certificate revocation succeeded.
InProgress: Certificate revocation is in progress.
Failed: Certificate revocation failed.

SkuName

Name of the sku.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

Basic: Basic sku.
Premium: Premium sku.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownCertificateProfileStatus

Status of the certificate profiles.

KnownCertificateStatus

Status of the certificate

KnownCreatedByType

The kind of entity that created the resource.

KnownNameUnavailabilityReason

The reason that an artifact signing account name could not be used. The Reason element is only returned if nameAvailable is false.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownProfileType

Type of the certificate

KnownProvisioningState

The status of the current operation.

KnownRevocationStatus

Revocation status of the certificate.

KnownSkuName

Name of the sku.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(CodeSigningClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(CodeSigningClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: CodeSigningClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>