CosmosDB.psd1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
#
# Module manifest for module 'CosmosDB'
#
# Generated by: Daniel Scott-Raynsford
#
# Generated on: 2/6/2019
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'CosmosDB.psm1'

# Version number of this module.
ModuleVersion = '3.2.0.320'

# Supported PSEditions
CompatiblePSEditions = 'Core', 'Desktop'

# ID used to uniquely identify this module
GUID = '7d7aeb42-8ed9-4555-b5fd-020795a5aa01'

# Author of this module
Author = 'Daniel Scott-Raynsford'

# Company or vendor of this module
CompanyName = 'None'

# Copyright statement for this module
Copyright = '(c) 2019 Daniel Scott-Raynsford. All rights reserved.'

# Description of the functionality provided by this module
Description = 'This module provides cmdlets for working with Azure Cosmos DB databases, collections, documents, attachments, offers, users, permissions, triggers, stored procedures and user defined functions.'

# Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '5.1'

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @(@{ModuleName = 'Az.Accounts'; GUID = '17a2feff-488b-47f9-8729-e2cec094624c'; ModuleVersion = '1.0.0'; }, 
               @{ModuleName = 'Az.Resources'; GUID = '48bb344d-4c24-441e-8ea0-589947784700'; ModuleVersion = '1.0.0'; })

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
TypesToProcess = 'types\attachments.types.ps1xml', 'types\collections.types.ps1xml', 
               'types\databases.types.ps1xml', 'types\documents.types.ps1xml', 
               'types\offers.types.ps1xml', 'types\permissions.types.ps1xml', 
               'types\storedprocedures.types.ps1xml', 
               'types\triggers.types.ps1xml', 
               'types\userdefinedfunctions.types.ps1xml', 
               'types\users.types.ps1xml'

# Format files (.ps1xml) to be loaded when importing this module
FormatsToProcess = 'formats\attachments.formats.ps1xml', 
               'formats\collections.formats.ps1xml', 
               'formats\databases.formats.ps1xml', 
               'formats\documents.formats.ps1xml', 'formats\offers.formats.ps1xml', 
               'formats\permissions.formats.ps1xml', 
               'formats\storedprocedures.formats.ps1xml', 
               'formats\triggers.formats.ps1xml', 
               'formats\userdefinedfunctions.formats.ps1xml', 
               'formats\users.formats.ps1xml'

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = 'Get-CosmosDbAccount', 'Get-CosmosDbAccountConnectionString', 
               'Get-CosmosDbAccountMasterKey', 'Get-CosmosDbAttachment', 
               'Get-CosmosDbAttachmentResourcePath', 'Get-CosmosDbCollection', 
               'Get-CosmosDbCollectionResourcePath', 'Get-CosmosDbCollectionSize', 
               'Get-CosmosDBDatabase', 'Get-CosmosDBDatabaseResourcePath', 
               'Get-CosmosDBDocument', 'Get-CosmosDBDocumentResourcePath', 
               'Get-CosmosDBOffer', 'Get-CosmosDBOfferResourcePath', 
               'Get-CosmosDbPermission', 'Get-CosmosDbPermissionResourcePath', 
               'Get-CosmosDbStoredProcedure', 
               'Get-CosmosDbStoredProcedureResourcePath', 'Get-CosmosDbTrigger', 
               'Get-CosmosDbTriggerResourcePath', 'Get-CosmosDbUser', 
               'Get-CosmosDbUserResourcePath', 'Get-CosmosDbUserDefinedFunction', 
               'Get-CosmosDbUserDefinedFunctionResourcePath', 
               'Invoke-CosmosDbStoredProcedure', 'New-CosmosDbAccount', 
               'New-CosmosDbAccountMasterKey', 'New-CosmosDbAttachment', 
               'New-CosmosDbBackoffPolicy', 'New-CosmosDbCollection', 
               'New-CosmosDbCollectionIncludedPathIndex', 
               'New-CosmosDbCollectionIncludedPath', 
               'New-CosmosDbCollectionExcludedPath', 
               'New-CosmosDbCollectionIndexingPolicy', 
               'New-CosmosDbCollectionUniqueKey', 
               'New-CosmosDbCollectionUniqueKeyPolicy', 'New-CosmosDbDatabase', 
               'New-CosmosDbDocument', 'New-CosmosDbContext', 
               'New-CosmosDbContextToken', 'New-CosmosDbPermission', 
               'New-CosmosDbStoredProcedure', 'New-CosmosDbTrigger', 
               'New-CosmosDbUser', 'New-CosmosDbUserDefinedFunction', 
               'Remove-CosmosDbAccount', 'Remove-CosmosDbAttachment', 
               'Remove-CosmosDbCollection', 'Remove-CosmosDbDatabase', 
               'Remove-CosmosDbDocument', 'Remove-CosmosDbPermission', 
               'Remove-CosmosDbStoredProcedure', 'Remove-CosmosDbTrigger', 
               'Remove-CosmosDbUser', 'Remove-CosmosDbUserDefinedFunction', 
               'Set-CosmosDbAccount', 'Set-CosmosDbAttachment', 
               'Set-CosmosDbCollection', 'Set-CosmosDbDocument', 'Set-CosmosDbOffer', 
               'Set-CosmosDbStoredProcedure', 'Set-CosmosDbTrigger', 
               'Set-CosmosDbUser', 'Set-CosmosDbUserDefinedFunction'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = 'New-CosmosDbConnection'

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        Tags = 'CosmosDB', 'DocumentDb', 'Azure', 'PSEdition_Core', 'PSEdition_Desktop'

        # A URL to the license for this module.
        LicenseUri = 'https://github.com/PlagueHO/CosmosDB/blob/master/LICENSE'

        # A URL to the main website for this project.
        ProjectUri = 'https://github.com/PlagueHO/CosmosDB'

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        ReleaseNotes = '
  ## What is New in CosmosDB 3.2.0.320
 
  February 6, 2018
 
  - Convert module name to be a variable in PSake file to make it more
    easily portable between projects.
  - Fix `Notes` display in Readme Markdown - fixes [Issue #269](https://github.com/PlagueHO/CosmosDB/issues/269).
  - Update `cosmosdb.psdepend.psd1` to install modules `Az` 1.2.1 and
    `Pester` 4.7.0.
  - Deprecate `Hash` index policy kind and throw exception when used
    in `New-CosmosDbCollectionIncludedPathIndex`. See [this page](https://docs.microsoft.com/en-us/azure/cosmos-db/index-types#index-kind)
    for more information - fixes [Issue #271](https://github.com/PlagueHO/CosmosDB/issues/271).
 
  ## What is New in CosmosDB 3.1.0.293
 
  December 26, 2018
 
  - Updated manifest to include required modules `Az.Accounts` 1.0.0
    and `Az.Resources` 1.0.0.
  - Updated manifest to include `CompatiblePSEditions` of ''Desktop'' and
    ''Core''.
  - Updated minimum supported PowerShell version to 5.1.
  - Updated `cosmosdb.depend.psd1` to ensure `Az` modules are installed
    when running ''Deploy'' PSake task.
  - Improve build task code to ensure Git tag is correctly set.
 
  ## What is New in CosmosDB 3.0.0.279
 
  December 23, 2018
 
  - BREAKING CHANGE: Converted to use `Az` PowerShell Module from
    `AzureRm` and `AzureRm.NetCore` PowerShell Module - fixes [Issue #190](https://github.com/PlagueHO/CosmosDB/issues/190).
  - Renamed `build.ps1` to `psake.ps1` to indicate that it is used
    to execute `Psake` tasks.
  - Add Codacy Code Quality badge to `README.MD`.
  - Configure PSScriptAnalyzer to show errors, warnings and informational
    violations in Visual Studio Code.
  - Fix generic tests to validate PSScriptAnalyzer errors, warnings and
    informational rules.
  - Converted use of alias `Add-AzAccount` to `Connect-AzAccount`.
  - Updated to use `Az` PowerShell Module 1.0.1.
  - Correct `AliasesToExport` in manifest.
  - Minor corrections to markdown to improve best practice adherence.
  - Minor corrections to CI support files to improve best practice
    adherence.
  - Added ShouldProcess support to `New-CosmosDbAccountMasterKey` and
    `New-CosmosDbContext`.
  - Added ShouldProcess support TestHelper functions.
  - Updated CONTRIBUTING.MD to more accurately reflect current process of
    contributing to the module.
  - Updated STYLEGUIDELINES.MD to match current standards and best practices.
  - Added support for setting and updating Cross-Origin Resource Sharing (CORS)
    allowed origins in `New-CosmosDbAccount` and `Set-CosmosDbAccount`
    respectively - fixes [Issue #249](https://github.com/PlagueHO/CosmosDB/issues/249).
  - Changed `Remove-CosmosDbAccount` to prevent second confirmation prompt
    when removing account.
  - Enabled `*-CosmosDbAccount` tests to run in AppVeyor.
 
  ## What is New in CosmosDB 2.1.15.237
 
  November 17, 2018
 
  - Added support for Continuation Tokens to `Get-CosmosDbCollection`
    to support getting more than 100 collections - fixes [Issue #244](https://github.com/PlagueHO/CosmosDB/issues/244).
  - Updated markdown documentation with PlatyPs 0.11.1.
  - Corrected markdown documentation for `Get-CosmosDbCollectionSize`.
  - Corrected continuation token examples for `Get-CosmosDbDocument`.
  - Updated CI pipeline to use Pester 4.4.2.
  - Updated CI pipeline to use PlatyPS 0.12.
  - Renamed `ResultHeaders` parameter to `ResponseHeader` in
    `Get-CosmosDbDocuments` function to adhere to PowerShell standards,
    but included alias for `ResultHeaders` to prevent breaking change.
 
  ## What is New in CosmosDB 2.1.14.220
 
  November 15, 2018
 
  - Extended maximum length of Account Name parameter to be 50 characters - fixes
    [Issue #201](https://github.com/PlagueHO/CosmosDB/issues/201).
 
  ## What is New in CosmosDB 2.1.13.214
 
  November 4, 2018
 
  - Added new integration tests for testing simple index policies.
  - Split the multiple functions scripts into single functions and
    change the build pipeline to combine them all during
    staging - fixes [Issue #201](https://github.com/PlagueHO/CosmosDB/issues/201).
  - Temporarily suppressed running tests using MacOS in Azure Pipelines
    because the Hosted Agent has been updated with Az, preventing the
    AzureRM.NetCore modules from being installed.
  - Improved validation on Name and ResourceGroupName parameters on
    `*-CosmosDBAccount*` functions - fixes [Issue #211](https://github.com/PlagueHO/CosmosDB/issues/211).
  - Improved validation on Account parameter on `*-CosmosDBDatabase*` functions.
  - Improved validation on Account and ResourceGroupName parameter on
    `New-CosmosDbContext` function.
  - Improved validation on Database Id parameter on
    `*-CosmosDBDatabase*` functions - fixes [Issue #212](https://github.com/PlagueHO/CosmosDB/issues/212).
  - Improved validation on Collection Id parameter on
    `*-CosmosDBCollection*` functions - fixes [Issue #213](https://github.com/PlagueHO/CosmosDB/issues/213).
  - Improved validation on Account parameter on `*-CosmosDBCollection*` functions.
  - Improved validation on Database parameter on `*-CosmosDBCollection*` functions.
  - Improved validation on Stored Procedure Id parameter on
    `*-CosmosDBStoredProcedure*` functions - fixes [Issue #214](https://github.com/PlagueHO/CosmosDB/issues/214).
  - Improved validation on Account parameter on `*-CosmosDBStoredProcedure*` functions.
  - Improved validation on Database parameter on `*-CosmosDBStoredProcedure*` functions.
  - Improved validation on Collection parameter on `*-CosmosDBStoredProcedure*` functions.
  - Improved validation on Trigger Id parameter on
    `*-CosmosDBTrigger*` functions - fixes [Issue #215](https://github.com/PlagueHO/CosmosDB/issues/215).
  - Improved validation on Account parameter on `*-CosmosDBTrigger*` functions.
  - Improved validation on Database parameter on `*-CosmosDBTrigger*` functions.
  - Improved validation on Collection parameter on `*-CosmosDBTrigger*` functions.
  - Improved validation on User Defined Function Id parameter on
    `*-CosmosDBUserDefinedFunction*` functions - fixes [Issue #216](https://github.com/PlagueHO/CosmosDB/issues/216).
  - Improved validation on Account parameter on `*-CosmosDBUserDefinedFunction*` functions.
  - Improved validation on Database parameter on `*-CosmosDBUserDefinedFunction*` functions.
  - Improved validation on Collection parameter on `*-CosmosDBUserDefinedFunction*` functions.
  - Improved validation on User Id parameter on
    `*-CosmosDBUser*` functions - fixes [Issue #217](https://github.com/PlagueHO/CosmosDB/issues/217).
  - Improved validation on Account parameter on `*-CosmosDBUser*` functions.
  - Improved validation on Database parameter on `*-CosmosDBUser*` functions.
  - Improved validation on Document Id parameter on
    `*-CosmosDBDocument*` functions - fixes [Issue #227](https://github.com/PlagueHO/CosmosDB/issues/227).
  - Improved validation on Account parameter on `*-CosmosDBDocument*` functions.
  - Improved validation on Database parameter on `*-CosmosDBDocument*` functions.
  - Improved validation on Collection parameter on `*-CosmosDBDocument*` functions.
  - Improved validation on Permission Id parameter on
    `*-CosmosDBPermission*` functions - fixes [Issue #218](https://github.com/PlagueHO/CosmosDB/issues/218).
  - Improved validation on Account parameter on `*-CosmosDBPermission*` functions.
  - Improved validation on Database parameter on `*-CosmosDBPermission*` functions.
  - Improved validation on User parameter on `*-CosmosDBPermission*` functions.
  - Improved validation on Attachment Id parameter on
    `*-CosmosDBAttachment*` functions - fixes [Issue #228](https://github.com/PlagueHO/CosmosDB/issues/228).
  - Improved validation on Account parameter on `*-CosmosDBAttachment*` functions.
  - Improved validation on Database parameter on `*-CosmosDBAttachment*` functions.
  - Improved validation on Collection parameter on `*-CosmosDBAttachment*` functions.
  - Improved validation on Document parameter on `*-CosmosDBAttachment*` functions.
  - Added tests to validate module manifest is valud - fixes [Issue #236](https://github.com/PlagueHO/CosmosDB/issues/236).
 
  ## What is New in CosmosDB 2.1.12.137
 
  October 30, 2018
 
  - Added support for setting Collection uniqueKeyPolicy in
    `New-CosmosDbCollection` and `Set-CosmosDbCollection` - fixes [Issue #197](https://github.com/PlagueHO/CosmosDB/issues/197).
  '


    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}