@azure/arm-trustedsigning 1.0.0-beta.1

package/review/arm-trustedsigning.api.md

@@ -0,0 +1,386 @@
+## API Report File for "@azure/arm-trustedsigning"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PathUncheckedResponse } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { PollerLike } from '@azure/core-lro';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export interface AccountSku {
+    name: SkuName;
+}
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface Certificate {
+    createdDate?: string;
+    expiryDate?: string;
+    revocation?: Revocation;
+    serialNumber?: string;
+    status?: CertificateStatus;
+    subjectName?: string;
+    thumbprint?: string;
+}
+
+// @public
+export interface CertificateProfile extends ProxyResource {
+    properties?: CertificateProfileProperties;
+}
+
+// @public
+export interface CertificateProfileProperties {
+    readonly certificates?: Certificate[];
+    readonly city?: string;
+    readonly commonName?: string;
+    readonly country?: string;
+    readonly enhancedKeyUsage?: string;
+    identityValidationId?: string;
+    includeCity?: boolean;
+    includeCountry?: boolean;
+    includePostalCode?: boolean;
+    includeState?: boolean;
+    includeStreetAddress?: boolean;
+    readonly organization?: string;
+    readonly organizationUnit?: string;
+    readonly postalCode?: string;
+    profileType: ProfileType;
+    readonly provisioningState?: ProvisioningState;
+    readonly state?: string;
+    readonly status?: CertificateProfileStatus;
+    readonly streetAddress?: string;
+}
+
+// @public
+export interface CertificateProfilesCreateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface CertificateProfilesDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface CertificateProfilesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface CertificateProfilesListByCodeSigningAccountOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface CertificateProfilesOperations {
+    create: (resourceGroupName: string, accountName: string, profileName: string, resource: CertificateProfile, options?: CertificateProfilesCreateOptionalParams) => PollerLike<OperationState<CertificateProfile>, CertificateProfile>;
+    delete: (resourceGroupName: string, accountName: string, profileName: string, options?: CertificateProfilesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, accountName: string, profileName: string, options?: CertificateProfilesGetOptionalParams) => Promise<CertificateProfile>;
+    listByCodeSigningAccount: (resourceGroupName: string, accountName: string, options?: CertificateProfilesListByCodeSigningAccountOptionalParams) => PagedAsyncIterableIterator<CertificateProfile>;
+    revokeCertificate: (resourceGroupName: string, accountName: string, profileName: string, body: RevokeCertificate, options?: CertificateProfilesRevokeCertificateOptionalParams) => Promise<void>;
+}
+
+// @public
+export interface CertificateProfilesRevokeCertificateOptionalParams extends OperationOptions {
+}
+
+// @public
+export type CertificateProfileStatus = string;
+
+// @public
+export type CertificateStatus = string;
+
+// @public
+export interface CheckNameAvailability {
+    name: string;
+}
+
+// @public
+export interface CheckNameAvailabilityResult {
+    readonly message?: string;
+    readonly nameAvailable?: boolean;
+    readonly reason?: NameUnavailabilityReason;
+}
+
+// @public
+export interface CodeSigningAccount extends TrackedResource {
+    properties?: CodeSigningAccountProperties;
+}
+
+// @public
+export interface CodeSigningAccountPatch {
+    properties?: CodeSigningAccountPatchProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface CodeSigningAccountPatchProperties {
+    sku?: AccountSku;
+}
+
+// @public
+export interface CodeSigningAccountProperties {
+    readonly accountUri?: string;
+    readonly provisioningState?: ProvisioningState;
+    sku?: AccountSku;
+}
+
+// @public
+export interface CodeSigningAccountsCheckNameAvailabilityOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface CodeSigningAccountsCreateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface CodeSigningAccountsDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface CodeSigningAccountsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface CodeSigningAccountsListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface CodeSigningAccountsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface CodeSigningAccountsOperations {
+    checkNameAvailability: (body: CheckNameAvailability, options?: CodeSigningAccountsCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResult>;
+    create: (resourceGroupName: string, accountName: string, resource: CodeSigningAccount, options?: CodeSigningAccountsCreateOptionalParams) => PollerLike<OperationState<CodeSigningAccount>, CodeSigningAccount>;
+    delete: (resourceGroupName: string, accountName: string, options?: CodeSigningAccountsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, accountName: string, options?: CodeSigningAccountsGetOptionalParams) => Promise<CodeSigningAccount>;
+    listByResourceGroup: (resourceGroupName: string, options?: CodeSigningAccountsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<CodeSigningAccount>;
+    listBySubscription: (options?: CodeSigningAccountsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<CodeSigningAccount>;
+    update: (resourceGroupName: string, accountName: string, properties: CodeSigningAccountPatch, options?: CodeSigningAccountsUpdateOptionalParams) => PollerLike<OperationState<CodeSigningAccount>, CodeSigningAccount>;
+}
+
+// @public
+export interface CodeSigningAccountsUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public (undocumented)
+export class CodeSigningClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: CodeSigningClientOptionalParams);
+    readonly certificateProfiles: CertificateProfilesOperations;
+    readonly codeSigningAccounts: CodeSigningAccountsOperations;
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+}
+
+// @public
+export interface CodeSigningClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCertificateProfileStatus {
+    Active = "Active",
+    Disabled = "Disabled",
+    Suspended = "Suspended"
+}
+
+// @public
+export enum KnownCertificateStatus {
+    Active = "Active",
+    Expired = "Expired",
+    Revoked = "Revoked"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownNameUnavailabilityReason {
+    AccountNameInvalid = "AccountNameInvalid",
+    AlreadyExists = "AlreadyExists"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProfileType {
+    PrivateTrust = "PrivateTrust",
+    PrivateTrustCIPolicy = "PrivateTrustCIPolicy",
+    PublicTrust = "PublicTrust",
+    PublicTrustTest = "PublicTrustTest",
+    VBSEnclave = "VBSEnclave"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownRevocationStatus {
+    Failed = "Failed",
+    InProgress = "InProgress",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownSkuName {
+    Basic = "Basic",
+    Premium = "Premium"
+}
+
+// @public
+export type NameUnavailabilityReason = string;
+
+// @public
+export interface Operation {
+    actionType?: ActionType;
+    readonly display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export type ProfileType = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: CodeSigningClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+
+// @public (undocumented)
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    abortSignal?: AbortSignalLike;
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface Revocation {
+    effectiveAt?: Date;
+    failureReason?: string;
+    reason?: string;
+    remarks?: string;
+    requestedAt?: Date;
+    status?: RevocationStatus;
+}
+
+// @public
+export type RevocationStatus = string;
+
+// @public
+export interface RevokeCertificate {
+    effectiveAt: Date;
+    reason: string;
+    remarks?: string;
+    serialNumber: string;
+    thumbprint: string;
+}
+
+// @public
+export type SkuName = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: Record<string, string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```