@azure/arm-iotfirmwaredefense 1.0.1-alpha.20250424.1 → 2.0.0-alpha.20250428.3

package/review/arm-iotfirmwaredefense-models.api.md

@@ -0,0 +1,490 @@
+## API Report File for "@azure/arm-iotfirmwaredefense"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface BinaryHardeningFeatures {
+    canary?: boolean;
+    noExecute?: boolean;
+    positionIndependentExecutable?: boolean;
+    relocationReadOnly?: boolean;
+    stripped?: boolean;
+}
+
+// @public
+export interface BinaryHardeningResource extends ProxyResource {
+    properties?: BinaryHardeningResult;
+}
+
+// @public
+export interface BinaryHardeningResult {
+    binaryHardeningId?: string;
+    executableArchitecture?: string;
+    executableClass?: ExecutableClass;
+    filePath?: string;
+    readonly provisioningState?: ProvisioningState;
+    rpath?: string;
+    runpath?: string;
+    securityHardeningFeatures?: BinaryHardeningFeatures;
+}
+
+// @public
+export interface BinaryHardeningSummaryResource extends SummaryResourceProperties {
+    notExecutableStackCount?: number;
+    positionIndependentExecutableCount?: number;
+    relocationReadOnlyCount?: number;
+    stackCanaryCount?: number;
+    strippedBinaryCount?: number;
+    summaryType: "BinaryHardening";
+    totalFiles?: number;
+}
+
+// @public
+export type CertificateUsage = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface CryptoCertificate {
+    certificateKeyAlgorithm?: string;
+    certificateKeySize?: number;
+    certificateName?: string;
+    certificateRole?: string;
+    certificateUsage?: CertificateUsage[];
+    cryptoCertId?: string;
+    encoding?: string;
+    expirationDate?: Date;
+    readonly filePaths?: string[];
+    fingerprint?: string;
+    isExpired?: boolean;
+    isSelfSigned?: boolean;
+    isShortKeySize?: boolean;
+    issuedDate?: Date;
+    issuer?: CryptoCertificateEntity;
+    isWeakSignature?: boolean;
+    pairedKey?: PairedKey;
+    readonly provisioningState?: ProvisioningState;
+    serialNumber?: string;
+    signatureAlgorithm?: string;
+    subject?: CryptoCertificateEntity;
+}
+
+// @public
+export interface CryptoCertificateEntity {
+    commonName?: string;
+    country?: string;
+    organization?: string;
+    organizationalUnit?: string;
+    state?: string;
+}
+
+// @public
+export interface CryptoCertificateResource extends ProxyResource {
+    properties?: CryptoCertificate;
+}
+
+// @public
+export interface CryptoCertificateSummaryResource extends SummaryResourceProperties {
+    expiredCertificateCount?: number;
+    expiringSoonCertificateCount?: number;
+    pairedKeyCount?: number;
+    selfSignedCertificateCount?: number;
+    shortKeySizeCount?: number;
+    summaryType: "CryptoCertificate";
+    totalCertificateCount?: number;
+    weakSignatureCount?: number;
+}
+
+// @public
+interface CryptoKey_2 {
+    cryptoKeyId?: string;
+    cryptoKeySize?: number;
+    readonly filePaths?: string[];
+    isShortKeySize?: boolean;
+    keyAlgorithm?: string;
+    keyType?: CryptoKeyType;
+    pairedKey?: PairedKey;
+    readonly provisioningState?: ProvisioningState;
+    usage?: string[];
+}
+export { CryptoKey_2 as CryptoKey }
+
+// @public
+export interface CryptoKeyResource extends ProxyResource {
+    properties?: CryptoKey_2;
+}
+
+// @public
+export interface CryptoKeySummaryResource extends SummaryResourceProperties {
+    pairedKeyCount?: number;
+    privateKeyCount?: number;
+    publicKeyCount?: number;
+    shortKeySizeCount?: number;
+    summaryType: "CryptoKey";
+    totalKeyCount?: number;
+}
+
+// @public
+export type CryptoKeyType = string;
+
+// @public
+export interface CveLink {
+    href?: string;
+    label?: string;
+}
+
+// @public
+export interface CveResource extends ProxyResource {
+    properties?: CveResult;
+}
+
+// @public
+export interface CveResult {
+    componentId?: string;
+    componentName?: string;
+    componentVersion?: string;
+    cveId?: string;
+    cveName?: string;
+    cvssScores?: CvssScore[];
+    description?: string;
+    effectiveCvssScore?: number;
+    effectiveCvssVersion?: number;
+    readonly links?: CveLink[];
+    readonly provisioningState?: ProvisioningState;
+    severity?: string;
+}
+
+// @public
+export interface CveSummary extends SummaryResourceProperties {
+    criticalCveCount?: number;
+    highCveCount?: number;
+    lowCveCount?: number;
+    mediumCveCount?: number;
+    summaryType: "CommonVulnerabilitiesAndExposures";
+    unknownCveCount?: number;
+}
+
+// @public
+export interface CvssScore {
+    score?: number;
+    version: number;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, any>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export type ExecutableClass = string;
+
+// @public
+export interface Firmware extends ProxyResource {
+    properties?: FirmwareProperties;
+}
+
+// @public
+export interface FirmwareProperties {
+    description?: string;
+    fileName?: string;
+    fileSize?: number;
+    model?: string;
+    readonly provisioningState?: ProvisioningState;
+    status?: Status;
+    statusMessages?: StatusMessage[];
+    vendor?: string;
+    version?: string;
+}
+
+// @public
+export interface FirmwareSummary extends SummaryResourceProperties {
+    analysisTimeSeconds?: number;
+    binaryCount?: number;
+    componentCount?: number;
+    extractedFileCount?: number;
+    extractedSize?: number;
+    fileSize?: number;
+    rootFileSystems?: number;
+    summaryType: "Firmware";
+}
+
+// @public
+export interface FirmwareUpdateDefinition {
+    properties?: FirmwareProperties;
+}
+
+// @public
+export interface GenerateUploadUrlRequest {
+    firmwareId?: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCertificateUsage {
+    ClientAuthentication = "clientAuth",
+    CodeSigning = "codeSigning",
+    ContentCommitment = "contentCommitment",
+    CRLSign = "crlSign",
+    DataEncipherment = "dataEncipherment",
+    DecipherOnly = "decipherOnly",
+    DigitalSignature = "digitalSignature",
+    EmailProtection = "emailProtection",
+    EncipherOnly = "encipherOnly",
+    KeyAgreement = "keyAgreement",
+    KeyCertSign = "keyCertSign",
+    KeyEncipherment = "keyEncipherment",
+    NonRepudiation = "nonRepudiation",
+    OcspSigning = "ocspSigning",
+    ServerAuthentication = "serverAuth",
+    TimeStamping = "timeStamping"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownCryptoKeyType {
+    Private = "Private",
+    Public = "Public"
+}
+
+// @public
+export enum KnownExecutableClass {
+    X64 = "x64",
+    X86 = "x86"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Analyzing = "Analyzing",
+    Canceled = "Canceled",
+    Extracting = "Extracting",
+    Failed = "Failed",
+    Pending = "Pending",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownStatus {
+    Analyzing = "Analyzing",
+    Error = "Error",
+    Extracting = "Extracting",
+    Pending = "Pending",
+    Ready = "Ready"
+}
+
+// @public
+export enum KnownSummaryType {
+    BinaryHardening = "BinaryHardening",
+    CommonVulnerabilitiesAndExposures = "CommonVulnerabilitiesAndExposures",
+    CryptoCertificate = "CryptoCertificate",
+    CryptoKey = "CryptoKey",
+    Firmware = "Firmware"
+}
+
+// @public
+export enum KnownVersions {
+    V20250401Preview = "2025-04-01-preview"
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    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 type Origin = string;
+
+// @public
+export interface PairedKey {
+    pairedKeyId?: string;
+    type?: string;
+}
+
+// @public
+export interface PasswordHash {
+    algorithm?: string;
+    context?: string;
+    filePath?: string;
+    hash?: string;
+    passwordHashId?: string;
+    readonly provisioningState?: ProvisioningState;
+    salt?: string;
+    username?: string;
+}
+
+// @public
+export interface PasswordHashResource extends ProxyResource {
+    properties?: PasswordHash;
+}
+
+// @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 interface SbomComponent {
+    componentId?: string;
+    componentName?: string;
+    filePaths?: string[];
+    license?: string;
+    readonly provisioningState?: ProvisioningState;
+    version?: string;
+}
+
+// @public
+export interface SbomComponentResource extends ProxyResource {
+    properties?: SbomComponent;
+}
+
+// @public
+export interface Sku {
+    capacity?: number;
+    family?: string;
+    name: string;
+    size?: string;
+    tier?: SkuTier;
+}
+
+// @public
+export type SkuTier = "Free" | "Basic" | "Standard" | "Premium";
+
+// @public
+export type Status = string;
+
+// @public
+export interface StatusMessage {
+    errorCode?: number;
+    message?: string;
+}
+
+// @public
+export interface SummaryResource extends ProxyResource {
+    properties?: SummaryResourcePropertiesUnion;
+}
+
+// @public
+export interface SummaryResourceProperties {
+    readonly provisioningState?: ProvisioningState;
+    summaryType: SummaryType;
+}
+
+// @public
+export type SummaryResourcePropertiesUnion = FirmwareSummary | CveSummary | BinaryHardeningSummaryResource | CryptoCertificateSummaryResource | CryptoKeySummaryResource | SummaryResourceProperties;
+
+// @public
+export type SummaryType = 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>;
+}
+
+// @public
+export interface UrlToken {
+    readonly url?: string;
+}
+
+// @public
+export interface UsageMetric extends ProxyResource {
+    properties?: UsageMetricProperties;
+}
+
+// @public
+export interface UsageMetricProperties {
+    readonly monthlyFirmwareUploadCount: number;
+    readonly provisioningState?: ProvisioningState;
+    readonly totalFirmwareCount: number;
+}
+
+// @public
+export interface Workspace extends TrackedResource {
+    properties?: WorkspaceProperties;
+    sku?: Sku;
+}
+
+// @public
+export interface WorkspaceProperties {
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface WorkspaceUpdate {
+    sku?: Sku;
+    tags?: Record<string, string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```