@azure/synapse-artifacts 1.0.0-beta.7 → 1.0.0-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/index.js +674 -327
  3. package/dist/index.js.map +1 -1
  4. package/dist-esm/src/artifactsClient.js +2 -1
  5. package/dist-esm/src/artifactsClient.js.map +1 -1
  6. package/dist-esm/src/artifactsClientContext.js +1 -1
  7. package/dist-esm/src/artifactsClientContext.js.map +1 -1
  8. package/dist-esm/src/models/index.js +22 -0
  9. package/dist-esm/src/models/index.js.map +1 -1
  10. package/dist-esm/src/models/mappers.js +214 -96
  11. package/dist-esm/src/models/mappers.js.map +1 -1
  12. package/dist-esm/src/models/parameters.js +31 -2
  13. package/dist-esm/src/models/parameters.js.map +1 -1
  14. package/dist-esm/src/operations/bigDataPools.js +2 -2
  15. package/dist-esm/src/operations/bigDataPools.js.map +1 -1
  16. package/dist-esm/src/operations/dataFlowDebugSession.js +6 -6
  17. package/dist-esm/src/operations/dataFlowDebugSession.js.map +1 -1
  18. package/dist-esm/src/operations/dataFlowOperations.js +6 -6
  19. package/dist-esm/src/operations/dataFlowOperations.js.map +1 -1
  20. package/dist-esm/src/operations/datasetOperations.js +6 -6
  21. package/dist-esm/src/operations/datasetOperations.js.map +1 -1
  22. package/dist-esm/src/operations/index.js +1 -0
  23. package/dist-esm/src/operations/index.js.map +1 -1
  24. package/dist-esm/src/operations/integrationRuntimes.js +2 -2
  25. package/dist-esm/src/operations/integrationRuntimes.js.map +1 -1
  26. package/dist-esm/src/operations/library.js +8 -8
  27. package/dist-esm/src/operations/library.js.map +1 -1
  28. package/dist-esm/src/operations/linkedServiceOperations.js +6 -6
  29. package/dist-esm/src/operations/linkedServiceOperations.js.map +1 -1
  30. package/dist-esm/src/operations/metastore.js +182 -0
  31. package/dist-esm/src/operations/metastore.js.map +1 -0
  32. package/dist-esm/src/operations/notebookOperationResult.js +1 -1
  33. package/dist-esm/src/operations/notebookOperationResult.js.map +1 -1
  34. package/dist-esm/src/operations/notebookOperations.js +8 -8
  35. package/dist-esm/src/operations/notebookOperations.js.map +1 -1
  36. package/dist-esm/src/operations/pipelineOperations.js +7 -7
  37. package/dist-esm/src/operations/pipelineOperations.js.map +1 -1
  38. package/dist-esm/src/operations/pipelineRunOperations.js +4 -4
  39. package/dist-esm/src/operations/pipelineRunOperations.js.map +1 -1
  40. package/dist-esm/src/operations/sparkConfigurationOperations.js +6 -6
  41. package/dist-esm/src/operations/sparkConfigurationOperations.js.map +1 -1
  42. package/dist-esm/src/operations/sparkJobDefinitionOperations.js +8 -8
  43. package/dist-esm/src/operations/sparkJobDefinitionOperations.js.map +1 -1
  44. package/dist-esm/src/operations/sqlPools.js +2 -2
  45. package/dist-esm/src/operations/sqlPools.js.map +1 -1
  46. package/dist-esm/src/operations/sqlScriptOperations.js +6 -6
  47. package/dist-esm/src/operations/sqlScriptOperations.js.map +1 -1
  48. package/dist-esm/src/operations/triggerOperations.js +10 -10
  49. package/dist-esm/src/operations/triggerOperations.js.map +1 -1
  50. package/dist-esm/src/operations/triggerRunOperations.js +3 -3
  51. package/dist-esm/src/operations/triggerRunOperations.js.map +1 -1
  52. package/dist-esm/src/operations/workspaceGitRepoManagement.js +1 -1
  53. package/dist-esm/src/operations/workspaceGitRepoManagement.js.map +1 -1
  54. package/dist-esm/src/operations/workspaceOperations.js +1 -1
  55. package/dist-esm/src/operations/workspaceOperations.js.map +1 -1
  56. package/dist-esm/src/operationsInterfaces/index.js +1 -0
  57. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  58. package/dist-esm/src/operationsInterfaces/metastore.js +9 -0
  59. package/dist-esm/src/operationsInterfaces/metastore.js.map +1 -0
  60. package/package.json +6 -8
  61. package/types/synapse-artifacts.d.ts +160 -4
@@ -432,6 +432,7 @@ export declare class ArtifactsClient extends ArtifactsClientContext {
432
432
  constructor(credentials: coreAuth.TokenCredential, endpoint: string, options?: ArtifactsClientOptionalParams);
433
433
  kqlScripts: KqlScripts;
434
434
  kqlScriptOperations: KqlScriptOperations;
435
+ metastore: Metastore;
435
436
  sparkConfigurationOperations: SparkConfigurationOperations;
436
437
  bigDataPools: BigDataPools;
437
438
  dataFlowOperations: DataFlowOperations;
@@ -621,6 +622,10 @@ export declare type AzureBlobFSLinkedService = LinkedService & {
621
622
  tenant?: any;
622
623
  /** Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */
623
624
  azureCloudType?: any;
625
+ /** The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */
626
+ servicePrincipalCredentialType?: any;
627
+ /** The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */
628
+ servicePrincipalCredential?: SecretBaseUnion;
624
629
  /** The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). */
625
630
  encryptedCredential?: any;
626
631
  };
@@ -4122,6 +4127,8 @@ export declare type FtpReadSettings = StoreReadSettings & {
4122
4127
  fileListPath?: any;
4123
4128
  /** Specify whether to use binary transfer mode for FTP stores. */
4124
4129
  useBinaryTransfer?: boolean;
4130
+ /** If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean). */
4131
+ disableChunking?: any;
4125
4132
  };
4126
4133
 
4127
4134
  /** A FTP server Linked Service. */
@@ -4207,12 +4214,14 @@ export declare type GoogleAdWordsAuthenticationType = string;
4207
4214
  export declare type GoogleAdWordsLinkedService = LinkedService & {
4208
4215
  /** Polymorphic discriminator, which specifies the different types this object can be */
4209
4216
  type: "GoogleAdWords";
4217
+ /** Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. */
4218
+ connectionProperties?: any;
4210
4219
  /** The Client customer ID of the AdWords account that you want to fetch report data for. */
4211
- clientCustomerID: any;
4220
+ clientCustomerID?: any;
4212
4221
  /** The developer token associated with the manager account that you use to grant access to the AdWords API. */
4213
- developerToken: SecretBaseUnion;
4222
+ developerToken?: SecretBaseUnion;
4214
4223
  /** The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. */
4215
- authenticationType: GoogleAdWordsAuthenticationType;
4224
+ authenticationType?: GoogleAdWordsAuthenticationType;
4216
4225
  /** The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. */
4217
4226
  refreshToken?: SecretBaseUnion;
4218
4227
  /** The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). */
@@ -5817,6 +5826,14 @@ export declare enum KnownNodeSizeFamily {
5817
5826
  MemoryOptimized = "MemoryOptimized"
5818
5827
  }
5819
5828
 
5829
+ /** Known values of {@link NotebookParameterType} that the service accepts. */
5830
+ export declare enum KnownNotebookParameterType {
5831
+ String = "string",
5832
+ Int = "int",
5833
+ Float = "float",
5834
+ Bool = "bool"
5835
+ }
5836
+
5820
5837
  /** Known values of {@link NotebookReferenceType} that the service accepts. */
5821
5838
  export declare enum KnownNotebookReferenceType {
5822
5839
  NotebookReference = "NotebookReference"
@@ -5917,6 +5934,20 @@ export declare enum KnownRecurrenceFrequency {
5917
5934
  Year = "Year"
5918
5935
  }
5919
5936
 
5937
+ /** Known values of {@link RequestStatus} that the service accepts. */
5938
+ export declare enum KnownRequestStatus {
5939
+ Running = "Running",
5940
+ Completed = "Completed",
5941
+ Failed = "Failed"
5942
+ }
5943
+
5944
+ /** Known values of {@link ResourceStatus} that the service accepts. */
5945
+ export declare enum KnownResourceStatus {
5946
+ Creating = "Creating",
5947
+ Created = "Created",
5948
+ Failed = "Failed"
5949
+ }
5950
+
5920
5951
  /** Known values of {@link RestServiceAuthenticationType} that the service accepts. */
5921
5952
  export declare enum KnownRestServiceAuthenticationType {
5922
5953
  Anonymous = "Anonymous",
@@ -7024,6 +7055,87 @@ export declare type MarketoSource = TabularSource & {
7024
7055
  query?: any;
7025
7056
  };
7026
7057
 
7058
+ /** Interface representing a Metastore. */
7059
+ export declare interface Metastore {
7060
+ /**
7061
+ * Register files in Syms
7062
+ * @param id The name of the database to be created. The name can contain only alphanumeric characters
7063
+ * and should not exceed 24 characters
7064
+ * @param registerBody The body for the register request
7065
+ * @param options The options parameters.
7066
+ */
7067
+ register(id: string, registerBody: MetastoreRegisterObject, options?: MetastoreRegisterOptionalParams): Promise<MetastoreRegisterResponse>;
7068
+ /**
7069
+ * Gets status of the database
7070
+ * @param id
7071
+ * @param options The options parameters.
7072
+ */
7073
+ getDatabaseOperations(id: string, options?: MetastoreGetDatabaseOperationsOptionalParams): Promise<MetastoreGetDatabaseOperationsResponse>;
7074
+ /**
7075
+ * Update files in Syms
7076
+ * @param id The name of the database to be updated
7077
+ * @param updateBody The body for the update request
7078
+ * @param options The options parameters.
7079
+ */
7080
+ update(id: string, updateBody: MetastoreUpdateObject, options?: MetastoreUpdateOptionalParams): Promise<MetastoreUpdateResponse>;
7081
+ /**
7082
+ * Remove files in Syms
7083
+ * @param id
7084
+ * @param options The options parameters.
7085
+ */
7086
+ delete(id: string, options?: MetastoreDeleteOptionalParams): Promise<void>;
7087
+ }
7088
+
7089
+ /** Optional parameters. */
7090
+ export declare interface MetastoreDeleteOptionalParams extends coreClient.OperationOptions {
7091
+ }
7092
+
7093
+ /** Optional parameters. */
7094
+ export declare interface MetastoreGetDatabaseOperationsOptionalParams extends coreClient.OperationOptions {
7095
+ }
7096
+
7097
+ /** Contains response data for the getDatabaseOperations operation. */
7098
+ export declare type MetastoreGetDatabaseOperationsResponse = MetastoreRequestSuccessResponse;
7099
+
7100
+ export declare interface MetastoreRegisterObject {
7101
+ /** The input folder containing CDM files. */
7102
+ inputFolder: string;
7103
+ }
7104
+
7105
+ /** Optional parameters. */
7106
+ export declare interface MetastoreRegisterOptionalParams extends coreClient.OperationOptions {
7107
+ }
7108
+
7109
+ /** Contains response data for the register operation. */
7110
+ export declare type MetastoreRegisterResponse = MetastoreRegistrationResponse;
7111
+
7112
+ export declare interface MetastoreRegistrationResponse {
7113
+ /** Enumerates possible request statuses. */
7114
+ status?: RequestStatus;
7115
+ }
7116
+
7117
+ export declare interface MetastoreRequestSuccessResponse {
7118
+ /** Enumerates possible Status of the resource. */
7119
+ status?: ResourceStatus;
7120
+ }
7121
+
7122
+ export declare interface MetastoreUpdateObject {
7123
+ /** The input folder containing CDM files. */
7124
+ inputFolder: string;
7125
+ }
7126
+
7127
+ /** Optional parameters. */
7128
+ export declare interface MetastoreUpdateOptionalParams extends coreClient.OperationOptions {
7129
+ }
7130
+
7131
+ /** Contains response data for the update operation. */
7132
+ export declare type MetastoreUpdateResponse = MetastoreUpdationResponse;
7133
+
7134
+ export declare interface MetastoreUpdationResponse {
7135
+ /** Enumerates possible request statuses. */
7136
+ status?: RequestStatus;
7137
+ }
7138
+
7027
7139
  /** Microsoft Access linked service. */
7028
7140
  export declare type MicrosoftAccessLinkedService = LinkedService & {
7029
7141
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -7554,6 +7666,26 @@ export declare interface NotebookOperations {
7554
7666
  beginRenameNotebookAndWait(notebookName: string, request: ArtifactRenameRequest, options?: NotebookRenameNotebookOptionalParams): Promise<void>;
7555
7667
  }
7556
7668
 
7669
+ /** Notebook parameter. */
7670
+ export declare interface NotebookParameter {
7671
+ /** Notebook parameter value. Type: string (or Expression with resultType string). */
7672
+ value?: any;
7673
+ /** Notebook parameter type. */
7674
+ type?: NotebookParameterType;
7675
+ }
7676
+
7677
+ /**
7678
+ * Defines values for NotebookParameterType. \
7679
+ * {@link KnownNotebookParameterType} can be used interchangeably with NotebookParameterType,
7680
+ * this enum contains the known values that the service supports.
7681
+ * ### Known values supported by the service
7682
+ * **string** \
7683
+ * **int** \
7684
+ * **float** \
7685
+ * **bool**
7686
+ */
7687
+ export declare type NotebookParameterType = string;
7688
+
7557
7689
  /**
7558
7690
  * Defines values for NotebookReferenceType. \
7559
7691
  * {@link KnownNotebookReferenceType} can be used interchangeably with NotebookReferenceType,
@@ -8776,6 +8908,17 @@ export declare type RelationalTableDataset = Dataset & {
8776
8908
  tableName?: any;
8777
8909
  };
8778
8910
 
8911
+ /**
8912
+ * Defines values for RequestStatus. \
8913
+ * {@link KnownRequestStatus} can be used interchangeably with RequestStatus,
8914
+ * this enum contains the known values that the service supports.
8915
+ * ### Known values supported by the service
8916
+ * **Running** \
8917
+ * **Completed** \
8918
+ * **Failed**
8919
+ */
8920
+ export declare type RequestStatus = string;
8921
+
8779
8922
  /** A list of rerun triggers. */
8780
8923
  export declare interface RerunTriggerListResponse {
8781
8924
  /** List of rerun triggers. */
@@ -8839,6 +8982,17 @@ export declare interface Resource {
8839
8982
  /** Defines values for ResourceIdentityType. */
8840
8983
  export declare type ResourceIdentityType = "None" | "SystemAssigned";
8841
8984
 
8985
+ /**
8986
+ * Defines values for ResourceStatus. \
8987
+ * {@link KnownResourceStatus} can be used interchangeably with ResourceStatus,
8988
+ * this enum contains the known values that the service supports.
8989
+ * ### Known values supported by the service
8990
+ * **Creating** \
8991
+ * **Created** \
8992
+ * **Failed**
8993
+ */
8994
+ export declare type ResourceStatus = string;
8995
+
8842
8996
  /** Responsys linked service. */
8843
8997
  export declare type ResponsysLinkedService = LinkedService & {
8844
8998
  /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -9740,6 +9894,8 @@ export declare type SftpReadSettings = StoreReadSettings & {
9740
9894
  modifiedDatetimeStart?: any;
9741
9895
  /** The end of file's modified datetime. Type: string (or Expression with resultType string). */
9742
9896
  modifiedDatetimeEnd?: any;
9897
+ /** If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean). */
9898
+ disableChunking?: any;
9743
9899
  };
9744
9900
 
9745
9901
  /** A linked service for an SSH File Transfer Protocol (SFTP) server. */
@@ -11391,7 +11547,7 @@ export declare type SynapseNotebookActivity = ExecutionActivity & {
11391
11547
  notebook: SynapseNotebookReference;
11392
11548
  /** Notebook parameters. */
11393
11549
  parameters?: {
11394
- [propertyName: string]: any;
11550
+ [propertyName: string]: NotebookParameter;
11395
11551
  };
11396
11552
  };
11397
11553