-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from connorcarnes/dev
Dev [0.2.0]
- Loading branch information
Showing
40 changed files
with
1,594 additions
and
98 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| external help file: pwshCloudflare-help.xml | ||
| Module Name: pwshCloudflare | ||
| online version: https://developers.cloudflare.com/api/operations/accounts-list-accounts | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Get-CFAccount | ||
|
|
||
| ## SYNOPSIS | ||
| Get Cloudflare account information. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ### AccountId (Default) | ||
| ``` | ||
| Get-CFAccount [-AccountId <String>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ### AccountName | ||
| ``` | ||
| Get-CFAccount [-AccountName <String>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| Get Cloudflare account information. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
| ``` | ||
| Get-CFAccount -AccountId '12345' | ||
| Gets account with ID 12345. | ||
| ``` | ||
|
|
||
| ### EXAMPLE 2 | ||
| ``` | ||
| Get-CFAccount | ||
| Lists accounts available to current user. | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -AccountId | ||
| ID of account to retrieve. | ||
| If not specified, all accounts will be returned. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: AccountId | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -AccountName | ||
| Name of account to retrieve. | ||
| If not specified, all accounts will be returned. | ||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: AccountName | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### CommonParameters | ||
| This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. | ||
| For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). | ||
| ## INPUTS | ||
| ## OUTPUTS | ||
| ### Cloudflare.Account | ||
| ## NOTES | ||
| ## RELATED LINKS | ||
| [https://developers.cloudflare.com/api/operations/accounts-list-accounts](https://developers.cloudflare.com/api/operations/accounts-list-accounts) | ||
| [https://developers.cloudflare.com/api/operations/accounts-account-details](https://developers.cloudflare.com/api/operations/accounts-account-details) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| --- | ||
| external help file: pwshCloudflare-help.xml | ||
| Module Name: pwshCloudflare | ||
| online version: https://developers.cloudflare.com/api/operations/cloudflare-d1-list-databases | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Get-CFD1Database | ||
|
|
||
| ## SYNOPSIS | ||
| Gets Cloudflare D1 database(s). | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ### AccountId | ||
| ``` | ||
| Get-CFD1Database [-Name <String>] [-Id <String>] -AccountId <String> [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ### AccountName | ||
| ``` | ||
| Get-CFD1Database [-Name <String>] [-Id <String>] -AccountName <String> [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| Gets Cloudflare D1 database(s). | ||
| Must provide exactly one of AccountId or AccountName. | ||
| If Name or Id is not specified, all databases will be returned. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
| ``` | ||
| Get-CFD1Database -AccountId '12345' | ||
| Gets all databases for account with ID 12345. | ||
| ``` | ||
|
|
||
| ### EXAMPLE 2 | ||
| ``` | ||
| Get-CFD1Database -AccountName 'My Account' -Name 'myDb' | ||
| Gets databsse 'myDb' for account 'My Account'. | ||
| ``` | ||
|
|
||
| ### EXAMPLE 3 | ||
| ``` | ||
| Get-CFD1Database -AccountName 'My Account' -Id '12345' | ||
| Gets database with ID 12345 for account 'My Account'. | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Name | ||
| Name of database to retrieve. | ||
| If not specified, all databases will be returned. | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: DatabaseName | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -Id | ||
| ID of database to retrieve. | ||
| If not specified, all databases will be returned. | ||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: DatabaseId | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -AccountId | ||
| ID of account to retrieve. | ||
| If not specified, all accounts will be returned. | ||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: AccountId | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -AccountName | ||
| Name of account to retrieve. | ||
| If not specified, all accounts will be returned. | ||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: AccountName | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### CommonParameters | ||
| This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. | ||
| For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). | ||
| ## INPUTS | ||
| ## OUTPUTS | ||
| ### Cloudflare.D1Database | ||
| ## NOTES | ||
| The cloudflare-d1-list-databases API endpoint returns the properties uuid, name, version and created_at. | ||
| The cloudflare-d1-get-database API endpoint returns the same properties as well as num_tables, file_size and running_in region. | ||
| When listing all databases or getting a database by name this function makes multiple API calls. | ||
| The first call is to get the database ID(s). | ||
| The subsequent call(s) use the ID(s) to get the database details. | ||
| This is done so that the same output is returned regardless of parameters used. | ||
| ## RELATED LINKS | ||
| [https://developers.cloudflare.com/api/operations/cloudflare-d1-list-databases](https://developers.cloudflare.com/api/operations/cloudflare-d1-list-databases) | ||
| [https://developers.cloudflare.com/api/operations/cloudflare-d1-get-database](https://developers.cloudflare.com/api/operations/cloudflare-d1-get-database) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.