@azure/arm-deviceregistry 1.1.0 → 1.2.0-beta.1

package/dist/commonjs/models/models.d.ts

@@ -1,3 +1,7 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
 /** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
 export interface _OperationListResult {
     /** The Operation items on this page */
@@ -21,7 +25,7 @@ export interface Operation {
     readonly actionType?: ActionType;
 }
 export declare function operationDeserializer(item: any): Operation;
-/** Localized display information for and operation. */
+/** Localized display information for an operation. */
 export interface OperationDisplay {
     /** The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". */
     readonly provider?: string;
@@ -406,7 +410,7 @@ export interface Resource {
     /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
     readonly systemData?: SystemData;
 }
-export declare function resourceSerializer(item: Resource): any;
+export declare function resourceSerializer(_item: Resource): any;
 export declare function resourceDeserializer(item: any): Resource;
 /** Metadata pertaining to creation and last modification of the resource. */
 export interface SystemData {
@@ -640,7 +644,7 @@ export declare function billingContainerPropertiesDeserializer(item: any): Billi
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
 export interface ProxyResource extends Resource {
 }
-export declare function proxyResourceSerializer(item: ProxyResource): any;
+export declare function proxyResourceSerializer(_item: ProxyResource): any;
 export declare function proxyResourceDeserializer(item: any): ProxyResource;
 /** The response of a BillingContainer list operation. */
 export interface _BillingContainerListResult {
@@ -778,6 +782,182 @@ export interface ErrorDetails {
     readonly correlationId?: string;
 }
 export declare function errorDetailsDeserializer(item: any): ErrorDetails;
+/** A Credential Resource */
+export interface Credential extends TrackedResource {
+    /** The resource-specific properties for this resource. */
+    properties?: CredentialProperties;
+}
+export declare function credentialSerializer(item: Credential): any;
+export declare function credentialDeserializer(item: any): Credential;
+/** Details of the Credential Resource. */
+export interface CredentialProperties {
+    /** The status of the last operation. */
+    readonly provisioningState?: ProvisioningState;
+}
+export declare function credentialPropertiesSerializer(_item: CredentialProperties): any;
+export declare function credentialPropertiesDeserializer(item: any): CredentialProperties;
+/** The type used for update operations of the Credential. */
+export interface CredentialUpdate {
+    /** Resource tags. */
+    tags?: Record<string, string>;
+}
+export declare function credentialUpdateSerializer(item: CredentialUpdate): any;
+/** The response of a Credential list operation. */
+export interface _CredentialListResult {
+    /** The Credential items on this page */
+    value: Credential[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _credentialListResultDeserializer(item: any): _CredentialListResult;
+export declare function credentialArraySerializer(result: Array<Credential>): any[];
+export declare function credentialArrayDeserializer(result: Array<Credential>): any[];
+/** A Credential Policy */
+export interface Policy extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: PolicyProperties;
+}
+export declare function policySerializer(item: Policy): any;
+export declare function policyDeserializer(item: any): Policy;
+/** Details of the Credential Policy. */
+export interface PolicyProperties {
+    /** The status of the last operation. */
+    readonly provisioningState?: ProvisioningState;
+    /** The certificate configuration. */
+    certificate?: CertificateConfiguration;
+}
+export declare function policyPropertiesSerializer(item: PolicyProperties): any;
+export declare function policyPropertiesDeserializer(item: any): PolicyProperties;
+/** The certificate configuration. */
+export interface CertificateConfiguration {
+    /** The configuration to set up an ICA. */
+    certificateAuthorityConfiguration: CertificateAuthorityConfiguration;
+    /** The leaf certificate configuration. */
+    leafCertificateConfiguration: LeafCertificateConfiguration;
+}
+export declare function certificateConfigurationSerializer(item: CertificateConfiguration): any;
+export declare function certificateConfigurationDeserializer(item: any): CertificateConfiguration;
+/** The configuration to set up an ICA. */
+export interface CertificateAuthorityConfiguration {
+    /** Crypto type: ECC. */
+    keyType: SupportedKeyType;
+    /** Certificate subject. */
+    readonly subject?: string;
+    /** Certificate is valid not before this date. Format ISO8601. Generated based on on validity period. */
+    readonly validityNotBefore?: Date;
+    /** Certificate is valid not after this date. Format ISO8601. Generated based on validity period. */
+    readonly validityNotAfter?: Date;
+    /** Configuration for Bring Your Own Root. */
+    bringYourOwnRoot?: BringYourOwnRoot;
+}
+export declare function certificateAuthorityConfigurationSerializer(item: CertificateAuthorityConfiguration): any;
+export declare function certificateAuthorityConfigurationDeserializer(item: any): CertificateAuthorityConfiguration;
+/** Supported key types. */
+export declare enum KnownSupportedKeyType {
+    /** Indicates the ECC key type. */
+    ECC = "ECC"
+}
+/**
+ * Supported key types. \
+ * {@link KnownSupportedKeyType} can be used interchangeably with SupportedKeyType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **ECC**: Indicates the ECC key type.
+ */
+export type SupportedKeyType = string;
+/** Configuration for Bring Your Own Root. When enabled, customers provide their own CA-signed certificates instead of using the service-managed CA. */
+export interface BringYourOwnRoot {
+    /** Indicates whether Bring Your Own Root is enabled. This can only be set at creation time and cannot be changed afterward. */
+    enabled: boolean;
+    /** Certificate Signing Request (CSR) in PEM format, generated by the service. Sign this CSR with your Certificate Authority and activate via the activateBringYourOwnRoot action. A new CSR is generated at policy creation and when certificates near expiration. */
+    readonly certificateSigningRequest?: string;
+    /** Thumbprint of the issuing certificate. */
+    readonly issuingCertificateThumbprint?: string;
+    /** The status of the Bring Your Own Root configuration, indicating the current state of the certificate lifecycle. */
+    readonly status?: BringYourOwnRootStatus;
+}
+export declare function bringYourOwnRootSerializer(item: BringYourOwnRoot): any;
+export declare function bringYourOwnRootDeserializer(item: any): BringYourOwnRoot;
+/** Status of the Bring Your Own Root configuration. */
+export declare enum KnownBringYourOwnRootStatus {
+    /** The CSR has been generated and is waiting for the customer to provide the signed certificate. */
+    PendingActivation = "PendingActivation",
+    /** The signed certificate has been successfully uploaded and validated, and the CA is active. */
+    Active = "Active",
+    /** The certificate is nearing expiration (within renewal window) or has expired. A new CSR has been generated and is waiting for the customer to provide a new signed certificate. */
+    ActiveButPendingRenewal = "ActiveButPendingRenewal"
+}
+/**
+ * Status of the Bring Your Own Root configuration. \
+ * {@link KnownBringYourOwnRootStatus} can be used interchangeably with BringYourOwnRootStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **PendingActivation**: The CSR has been generated and is waiting for the customer to provide the signed certificate. \
+ * **Active**: The signed certificate has been successfully uploaded and validated, and the CA is active. \
+ * **ActiveButPendingRenewal**: The certificate is nearing expiration (within renewal window) or has expired. A new CSR has been generated and is waiting for the customer to provide a new signed certificate.
+ */
+export type BringYourOwnRootStatus = string;
+/** The leaf certificate configuration. */
+export interface LeafCertificateConfiguration {
+    /** The validity period in days. */
+    validityPeriodInDays: number;
+}
+export declare function leafCertificateConfigurationSerializer(item: LeafCertificateConfiguration): any;
+export declare function leafCertificateConfigurationDeserializer(item: any): LeafCertificateConfiguration;
+/** A Credential Policy */
+export interface PolicyUpdate {
+    /** Resource tags. */
+    tags?: Record<string, string>;
+    /** The resource-specific properties for this resource. */
+    properties?: PolicyUpdateProperties;
+}
+export declare function policyUpdateSerializer(item: PolicyUpdate): any;
+/** Details of the Credential Policy. */
+export interface PolicyUpdateProperties {
+    /** The certificate configuration. */
+    certificate?: CertificateConfigurationUpdate;
+}
+export declare function policyUpdatePropertiesSerializer(item: PolicyUpdateProperties): any;
+/** The updatable certificate configuration for Policy. */
+export interface CertificateConfigurationUpdate {
+    /** The configuration to set up an ICA. */
+    certificateAuthorityConfiguration?: CertificateAuthorityConfigurationUpdate;
+    /** The leaf certificate configuration. */
+    leafCertificateConfiguration: LeafCertificateConfigurationUpdate;
+}
+export declare function certificateConfigurationUpdateSerializer(item: CertificateConfigurationUpdate): any;
+/** The configuration to set up an ICA. */
+export interface CertificateAuthorityConfigurationUpdate {
+    /** Configuration for Bring Your Own Root. */
+    bringYourOwnRoot?: BringYourOwnRootUpdate;
+}
+export declare function certificateAuthorityConfigurationUpdateSerializer(item: CertificateAuthorityConfigurationUpdate): any;
+/** Configuration for Bring Your Own Root. When enabled, customers provide their own CA-signed certificates instead of using the service-managed CA. */
+export interface BringYourOwnRootUpdate {
+}
+export declare function bringYourOwnRootUpdateSerializer(_item: BringYourOwnRootUpdate): any;
+/** The updatable leaf certificate configuration for Policy. */
+export interface LeafCertificateConfigurationUpdate {
+    /** The validity period in days. */
+    validityPeriodInDays: number;
+}
+export declare function leafCertificateConfigurationUpdateSerializer(item: LeafCertificateConfigurationUpdate): any;
+/** The response of a Policy list operation. */
+export interface _PolicyListResult {
+    /** The Policy items on this page */
+    value: Policy[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _policyListResultDeserializer(item: any): _PolicyListResult;
+export declare function policyArraySerializer(result: Array<Policy>): any[];
+export declare function policyArrayDeserializer(result: Array<Policy>): any[];
+/** Request payload for activating a Bring Your Own Root policy with a customer-provided signed certificate. */
+export interface ActivateBringYourOwnRootRequest {
+    /** Certificate chain in PEM format, including the signed certificate. The first certificate must be the signed certificate (matching the CSR generated by the service), followed by any intermediate CAs, and optionally the root CA. Certificates must be ordered from leaf to root and concatenated in PEM format. */
+    certificateChain: string;
+}
+export declare function activateBringYourOwnRootRequestSerializer(item: ActivateBringYourOwnRootRequest): any;
 /** Asset definition. */
 export interface NamespaceAsset extends TrackedResource {
     /** The resource-specific properties for this resource. */
@@ -1429,6 +1609,8 @@ export interface NamespaceDeviceProperties {
     readonly lastTransitionTime?: Date;
     /** Provisioning state of the resource. */
     readonly provisioningState?: ProvisioningState;
+    /** Policy used to issue device certificates. */
+    policy?: DeviceCredentialPolicy;
 }
 export declare function namespaceDevicePropertiesSerializer(item: NamespaceDeviceProperties): any;
 export declare function namespaceDevicePropertiesDeserializer(item: any): NamespaceDeviceProperties;
@@ -1530,6 +1712,13 @@ export interface DeviceStatusEndpoint {
     readonly error?: StatusError;
 }
 export declare function deviceStatusEndpointDeserializer(item: any): DeviceStatusEndpoint;
+/** Defines the Policy used to issue device certificates if any. */
+export interface DeviceCredentialPolicy {
+    /** Resource Id of the Policy. */
+    resourceId?: string;
+}
+export declare function deviceCredentialPolicySerializer(item: DeviceCredentialPolicy): any;
+export declare function deviceCredentialPolicyDeserializer(item: any): DeviceCredentialPolicy;
 /** The type used for update operations of the NamespaceDevice. */
 export interface NamespaceDeviceUpdate {
     /** Resource tags. */
@@ -1546,6 +1735,8 @@ export interface NamespaceDeviceUpdateProperties {
     endpoints?: MessagingEndpoints;
     /** A set of key-value pairs that contain custom attributes set by the customer. */
     attributes?: Record<string, any>;
+    /** Policy used to issue device certificates. */
+    policy?: DeviceCredentialPolicy;
     /** Indicates if the resource and identity are enabled or not. A disabled device cannot authenticate with Microsoft Entra ID. */
     enabled?: boolean;
 }
@@ -1560,6 +1751,12 @@ export interface _NamespaceDeviceListResult {
 export declare function _namespaceDeviceListResultDeserializer(item: any): _NamespaceDeviceListResult;
 export declare function namespaceDeviceArraySerializer(result: Array<NamespaceDevice>): any[];
 export declare function namespaceDeviceArrayDeserializer(result: Array<NamespaceDevice>): any[];
+/** Request payload for revoking device credentials. */
+export interface DeviceCredentialsRevokeRequest {
+    /** Indicates whether to disable the device(s) after revoking credentials. Prevents new credentials to be issued. */
+    disable?: boolean;
+}
+export declare function deviceCredentialsRevokeRequestSerializer(item: DeviceCredentialsRevokeRequest): any;
 /** Discovered asset definition. */
 export interface NamespaceDiscoveredAsset extends TrackedResource {
     /** The resource-specific properties for this resource. */
@@ -2118,9 +2315,19 @@ export declare function schemaVersionArraySerializer(result: Array<SchemaVersion
 export declare function schemaVersionArrayDeserializer(result: Array<SchemaVersion>): any[];
 /** Microsoft.DeviceRegistry Resource Provider supported API versions. */
 export declare enum KnownVersions {
+    /** Microsoft.DeviceRegistry Resource Provider management API version 2023-11-01-preview. */
+    V20231101Preview = "2023-11-01-preview",
+    /** Microsoft.DeviceRegistry Resource Provider management API version 2024-09-01-preview. */
+    V20240901Preview = "2024-09-01-preview",
     /** Microsoft.DeviceRegistry Resource Provider management API version 2024-11-01. */
     V20241101 = "2024-11-01",
+    /** Microsoft.DeviceRegistry Resource Provider management API version 2025-07-01-preview. */
+    V20250701Preview = "2025-07-01-preview",
     /** Microsoft.DeviceRegistry Resource Provider management API version 2025-10-01. */
-    V20251001 = "2025-10-01"
+    V20251001 = "2025-10-01",
+    /** Microsoft.DeviceRegistry Resource Provider management API version 2025-11-01-preview. */
+    V20251101Preview = "2025-11-01-preview",
+    /** Microsoft.DeviceRegistry Resource Provider management API version 2026-03-01-preview. */
+    V20260301Preview = "2026-03-01-preview"
 }
 //# sourceMappingURL=models.d.ts.map