@azure/arm-deviceprovisioningservices 2.1.0 → 4.0.0

package/src/models/parameters.ts

@@ -0,0 +1,337 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import {
+  OperationParameter,
+  OperationURLParameter,
+  OperationQueryParameter
+} from "@azure/core-client";
+import {
+  CertificateBodyDescription as CertificateBodyDescriptionMapper,
+  VerificationCodeRequest as VerificationCodeRequestMapper,
+  ProvisioningServiceDescription as ProvisioningServiceDescriptionMapper,
+  TagsResource as TagsResourceMapper,
+  OperationInputs as OperationInputsMapper,
+  PrivateEndpointConnection as PrivateEndpointConnectionMapper
+} from "../models/mappers";
+
+export const accept: OperationParameter = {
+  parameterPath: "accept",
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Accept",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const $host: OperationURLParameter = {
+  parameterPath: "$host",
+  mapper: {
+    serializedName: "$host",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const apiVersion: OperationQueryParameter = {
+  parameterPath: "apiVersion",
+  mapper: {
+    defaultValue: "2020-03-01",
+    isConstant: true,
+    serializedName: "api-version",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const nextLink: OperationURLParameter = {
+  parameterPath: "nextLink",
+  mapper: {
+    serializedName: "nextLink",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const certificateName: OperationURLParameter = {
+  parameterPath: "certificateName",
+  mapper: {
+    serializedName: "certificateName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const subscriptionId: OperationURLParameter = {
+  parameterPath: "subscriptionId",
+  mapper: {
+    serializedName: "subscriptionId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const resourceGroupName: OperationURLParameter = {
+  parameterPath: "resourceGroupName",
+  mapper: {
+    serializedName: "resourceGroupName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const provisioningServiceName: OperationURLParameter = {
+  parameterPath: "provisioningServiceName",
+  mapper: {
+    serializedName: "provisioningServiceName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const ifMatch: OperationParameter = {
+  parameterPath: ["options", "ifMatch"],
+  mapper: {
+    serializedName: "If-Match",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const contentType: OperationParameter = {
+  parameterPath: ["options", "contentType"],
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Content-Type",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const certificateDescription: OperationParameter = {
+  parameterPath: "certificateDescription",
+  mapper: CertificateBodyDescriptionMapper
+};
+
+export const certificateName1: OperationURLParameter = {
+  parameterPath: "certificateName",
+  mapper: {
+    constraints: {
+      MaxLength: 256
+    },
+    serializedName: "certificateName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const ifMatch1: OperationParameter = {
+  parameterPath: "ifMatch",
+  mapper: {
+    serializedName: "If-Match",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const certificateName11: OperationQueryParameter = {
+  parameterPath: ["options", "certificateName1"],
+  mapper: {
+    serializedName: "certificate.name",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const certificateRawBytes: OperationQueryParameter = {
+  parameterPath: ["options", "certificateRawBytes"],
+  mapper: {
+    serializedName: "certificate.rawBytes",
+    type: {
+      name: "ByteArray"
+    }
+  }
+};
+
+export const certificateIsVerified: OperationQueryParameter = {
+  parameterPath: ["options", "certificateIsVerified"],
+  mapper: {
+    serializedName: "certificate.isVerified",
+    type: {
+      name: "Boolean"
+    }
+  }
+};
+
+export const certificatePurpose: OperationQueryParameter = {
+  parameterPath: ["options", "certificatePurpose"],
+  mapper: {
+    serializedName: "certificate.purpose",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const certificateCreated: OperationQueryParameter = {
+  parameterPath: ["options", "certificateCreated"],
+  mapper: {
+    serializedName: "certificate.created",
+    type: {
+      name: "DateTime"
+    }
+  }
+};
+
+export const certificateLastUpdated: OperationQueryParameter = {
+  parameterPath: ["options", "certificateLastUpdated"],
+  mapper: {
+    serializedName: "certificate.lastUpdated",
+    type: {
+      name: "DateTime"
+    }
+  }
+};
+
+export const certificateHasPrivateKey: OperationQueryParameter = {
+  parameterPath: ["options", "certificateHasPrivateKey"],
+  mapper: {
+    serializedName: "certificate.hasPrivateKey",
+    type: {
+      name: "Boolean"
+    }
+  }
+};
+
+export const certificateNonce: OperationQueryParameter = {
+  parameterPath: ["options", "certificateNonce"],
+  mapper: {
+    serializedName: "certificate.nonce",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const request: OperationParameter = {
+  parameterPath: "request",
+  mapper: VerificationCodeRequestMapper
+};
+
+export const iotDpsDescription: OperationParameter = {
+  parameterPath: "iotDpsDescription",
+  mapper: ProvisioningServiceDescriptionMapper
+};
+
+export const provisioningServiceTags: OperationParameter = {
+  parameterPath: "provisioningServiceTags",
+  mapper: TagsResourceMapper
+};
+
+export const operationId: OperationURLParameter = {
+  parameterPath: "operationId",
+  mapper: {
+    serializedName: "operationId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const asyncinfo: OperationQueryParameter = {
+  parameterPath: "asyncinfo",
+  mapper: {
+    defaultValue: "true",
+    serializedName: "asyncinfo",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const argumentsParam: OperationParameter = {
+  parameterPath: "argumentsParam",
+  mapper: OperationInputsMapper
+};
+
+export const keyName: OperationURLParameter = {
+  parameterPath: "keyName",
+  mapper: {
+    serializedName: "keyName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const resourceName: OperationURLParameter = {
+  parameterPath: "resourceName",
+  mapper: {
+    serializedName: "resourceName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const groupId: OperationURLParameter = {
+  parameterPath: "groupId",
+  mapper: {
+    serializedName: "groupId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const privateEndpointConnectionName: OperationURLParameter = {
+  parameterPath: "privateEndpointConnectionName",
+  mapper: {
+    serializedName: "privateEndpointConnectionName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const privateEndpointConnection: OperationParameter = {
+  parameterPath: "privateEndpointConnection",
+  mapper: PrivateEndpointConnectionMapper
+};

package/src/operations/dpsCertificate.ts

@@ -0,0 +1,374 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { DpsCertificate } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { IotDpsClient } from "../iotDpsClient";
+import {
+  DpsCertificateGetOptionalParams,
+  DpsCertificateGetResponse,
+  CertificateBodyDescription,
+  DpsCertificateCreateOrUpdateOptionalParams,
+  DpsCertificateCreateOrUpdateResponse,
+  DpsCertificateDeleteOptionalParams,
+  DpsCertificateListOptionalParams,
+  DpsCertificateListResponse,
+  DpsCertificateGenerateVerificationCodeOptionalParams,
+  DpsCertificateGenerateVerificationCodeResponse,
+  VerificationCodeRequest,
+  DpsCertificateVerifyCertificateOptionalParams,
+  DpsCertificateVerifyCertificateResponse
+} from "../models";
+
+/** Class containing DpsCertificate operations. */
+export class DpsCertificateImpl implements DpsCertificate {
+  private readonly client: IotDpsClient;
+
+  /**
+   * Initialize a new instance of the class DpsCertificate class.
+   * @param client Reference to the service client
+   */
+  constructor(client: IotDpsClient) {
+    this.client = client;
+  }
+
+  /**
+   * Get the certificate from the provisioning service.
+   * @param certificateName Name of the certificate to retrieve.
+   * @param resourceGroupName Resource group identifier.
+   * @param provisioningServiceName Name of the provisioning service the certificate is associated with.
+   * @param options The options parameters.
+   */
+  get(
+    certificateName: string,
+    resourceGroupName: string,
+    provisioningServiceName: string,
+    options?: DpsCertificateGetOptionalParams
+  ): Promise<DpsCertificateGetResponse> {
+    return this.client.sendOperationRequest(
+      { certificateName, resourceGroupName, provisioningServiceName, options },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * Add new certificate or update an existing certificate.
+   * @param resourceGroupName Resource group identifier.
+   * @param provisioningServiceName The name of the provisioning service.
+   * @param certificateName The name of the certificate create or update.
+   * @param certificateDescription The certificate body.
+   * @param options The options parameters.
+   */
+  createOrUpdate(
+    resourceGroupName: string,
+    provisioningServiceName: string,
+    certificateName: string,
+    certificateDescription: CertificateBodyDescription,
+    options?: DpsCertificateCreateOrUpdateOptionalParams
+  ): Promise<DpsCertificateCreateOrUpdateResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        provisioningServiceName,
+        certificateName,
+        certificateDescription,
+        options
+      },
+      createOrUpdateOperationSpec
+    );
+  }
+
+  /**
+   * Deletes the specified certificate associated with the Provisioning Service
+   * @param resourceGroupName Resource group identifier.
+   * @param ifMatch ETag of the certificate
+   * @param provisioningServiceName The name of the provisioning service.
+   * @param certificateName This is a mandatory field, and is the logical name of the certificate that
+   *                        the provisioning service will access by.
+   * @param options The options parameters.
+   */
+  delete(
+    resourceGroupName: string,
+    ifMatch: string,
+    provisioningServiceName: string,
+    certificateName: string,
+    options?: DpsCertificateDeleteOptionalParams
+  ): Promise<void> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        ifMatch,
+        provisioningServiceName,
+        certificateName,
+        options
+      },
+      deleteOperationSpec
+    );
+  }
+
+  /**
+   * Get all the certificates tied to the provisioning service.
+   * @param resourceGroupName Name of resource group.
+   * @param provisioningServiceName Name of provisioning service to retrieve certificates for.
+   * @param options The options parameters.
+   */
+  list(
+    resourceGroupName: string,
+    provisioningServiceName: string,
+    options?: DpsCertificateListOptionalParams
+  ): Promise<DpsCertificateListResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, provisioningServiceName, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * Generate verification code for Proof of Possession.
+   * @param certificateName The mandatory logical name of the certificate, that the provisioning service
+   *                        uses to access.
+   * @param ifMatch ETag of the certificate. This is required to update an existing certificate, and
+   *                ignored while creating a brand new certificate.
+   * @param resourceGroupName name of resource group.
+   * @param provisioningServiceName Name of provisioning service.
+   * @param options The options parameters.
+   */
+  generateVerificationCode(
+    certificateName: string,
+    ifMatch: string,
+    resourceGroupName: string,
+    provisioningServiceName: string,
+    options?: DpsCertificateGenerateVerificationCodeOptionalParams
+  ): Promise<DpsCertificateGenerateVerificationCodeResponse> {
+    return this.client.sendOperationRequest(
+      {
+        certificateName,
+        ifMatch,
+        resourceGroupName,
+        provisioningServiceName,
+        options
+      },
+      generateVerificationCodeOperationSpec
+    );
+  }
+
+  /**
+   * Verifies the certificate's private key possession by providing the leaf cert issued by the verifying
+   * pre uploaded certificate.
+   * @param certificateName The mandatory logical name of the certificate, that the provisioning service
+   *                        uses to access.
+   * @param ifMatch ETag of the certificate.
+   * @param resourceGroupName Resource group name.
+   * @param provisioningServiceName Provisioning service name.
+   * @param request The name of the certificate
+   * @param options The options parameters.
+   */
+  verifyCertificate(
+    certificateName: string,
+    ifMatch: string,
+    resourceGroupName: string,
+    provisioningServiceName: string,
+    request: VerificationCodeRequest,
+    options?: DpsCertificateVerifyCertificateOptionalParams
+  ): Promise<DpsCertificateVerifyCertificateResponse> {
+    return this.client.sendOperationRequest(
+      {
+        certificateName,
+        ifMatch,
+        resourceGroupName,
+        provisioningServiceName,
+        request,
+        options
+      },
+      verifyCertificateOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CertificateResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorDetails
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.certificateName,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.provisioningServiceName
+  ],
+  headerParameters: [Parameters.accept, Parameters.ifMatch],
+  serializer
+};
+const createOrUpdateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}",
+  httpMethod: "PUT",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CertificateResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorDetails
+    }
+  },
+  requestBody: Parameters.certificateDescription,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.provisioningServiceName,
+    Parameters.certificateName1
+  ],
+  headerParameters: [
+    Parameters.accept,
+    Parameters.ifMatch,
+    Parameters.contentType
+  ],
+  mediaType: "json",
+  serializer
+};
+const deleteOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}",
+  httpMethod: "DELETE",
+  responses: {
+    200: {},
+    204: {},
+    default: {
+      bodyMapper: Mappers.ErrorDetails
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.certificateName11,
+    Parameters.certificateRawBytes,
+    Parameters.certificateIsVerified,
+    Parameters.certificatePurpose,
+    Parameters.certificateCreated,
+    Parameters.certificateLastUpdated,
+    Parameters.certificateHasPrivateKey,
+    Parameters.certificateNonce
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.certificateName,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.provisioningServiceName
+  ],
+  headerParameters: [Parameters.accept, Parameters.ifMatch1],
+  serializer
+};
+const listOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CertificateListDescription
+    },
+    default: {
+      bodyMapper: Mappers.ErrorDetails
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.provisioningServiceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const generateVerificationCodeOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.VerificationCodeResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorDetails
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.certificateName11,
+    Parameters.certificateRawBytes,
+    Parameters.certificateIsVerified,
+    Parameters.certificatePurpose,
+    Parameters.certificateCreated,
+    Parameters.certificateLastUpdated,
+    Parameters.certificateHasPrivateKey,
+    Parameters.certificateNonce
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.certificateName,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.provisioningServiceName
+  ],
+  headerParameters: [Parameters.accept, Parameters.ifMatch1],
+  serializer
+};
+const verifyCertificateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CertificateResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorDetails
+    }
+  },
+  requestBody: Parameters.request,
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.certificateName11,
+    Parameters.certificateRawBytes,
+    Parameters.certificateIsVerified,
+    Parameters.certificatePurpose,
+    Parameters.certificateCreated,
+    Parameters.certificateLastUpdated,
+    Parameters.certificateHasPrivateKey,
+    Parameters.certificateNonce
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.certificateName,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.provisioningServiceName
+  ],
+  headerParameters: [
+    Parameters.accept,
+    Parameters.contentType,
+    Parameters.ifMatch1
+  ],
+  mediaType: "json",
+  serializer
+};