Today in this article, we shall see how to generate or how to use Use JSON array fields in a PowerShell script.

This conversion is often needed when you are trying to perform GET or POST requests with body parameters to understand examples.

Let’s use the below sample JSON which we want to represent/Generate in the PowerShell script.

Sample JSON Input

{
    "siteUrl": "https://www.thecodebuzz.com",
    "email": "info@thecodebuzz.com",
    "itemList": [
        "Item1",
        "Item2",
        "Item3"
    ],
    "details": [
        {
            "name": "test",
            "id": "213124"
        },
        {
            "name": "test2",
            "id": "453534"
        }
    ]
}

As shown above, we are dealing with two types of array i.e itemList and details.

We can very much create a Powershell script equivalent of the above JSON sample as below,

As we can see regular Array can be represented as,

  'urlList'= @(
                    "item1",
                    "item2",
                    "item3",
                    "item4"
                )

For complex array is represented(representing object or complex type) as below,

 'details'=@(
                 @{
                  "name"= "test"
                  "id"= "213124"
                 },
                 @{
                  "name"= "test2"
                  "id"= "64564"
                 }
              )

ConvertFrom-Json -InputObject $json

The above commands will convert JSON to Windows PowerShell objects.

Below is the final PowerShell script,

$body = @{
    'siteUrl' ="https://www.thecodebuzz.com"
    'urlList'= @(
                    "item1",
                    "item2",
                    "item3",
                    "item4"
                )

   'details'=@(
                 @{
                  "name"= "test"
                  "id"= "213124"
                 },
                 @{
                  "name"= "test2"
                  "id"= "64564"
                 }
              )
}

ConvertTo-Json -InputObject $body

The above utility method i.e ConvertTo-Json will produce the JSON string that we started with above confirming our representation in the form of ps script is correct.

Send Array in POST Request

PowerShell JSON Array examples as below.

Example 1

# Sample array of strings
$array = @("A", "B", "C")

# Convert the array to JSON format
$jsonBody = $array | ConvertTo-Json

# API endpoint URL
$apiUrl = "https://www.thecodebuzz.com/api/"

# Send the POST request with the array as the request body

$response = Invoke-RestMethod -Uri $apiUrl -Method Post -Body $jsonBody -ContentType "application/json"

# Display the response
$response

Example 2

$body = @{
    'siteUrl' = "https://www.thecodebuzz.com"
    'urlList'= @(
        "Item1",
        "Item2",
        "Item3")     
}

Here is the request format,

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"

References:

• Making a PowerShell POST request with body

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Use JSON array fields in a PowerShell script first appeared on TheCodeBuzz.

Today in this article, we shall learn how to Make PowerShell POST request with body parameters using easy-to-understand examples.

Please note that we can use Invoke-WebRequest or Invoke-RestMethod to achieve the same.

In PowerShell, you can use the Invoke-RestMethod or Invoke-WebRequest cmdlet to send a POST request with a simple object or array as the request body.

One can easily use these cmdlets to create powerful PowerShell-based API or PowerShell Web Services calls. This CMDLet helps you write PowerShell REST Client-side code.

We shall cover the below examples,

PowerShell POST request with body

Below is the expected body parameter in the form of JSON,

{
    "siteUrl": "https://www.thecodebuzz.com",
    "email": "infoATthecodebuzz.com"
}

We shall use Invoke-RestMethod to use the above request body and send it in the POST body parameter,

Below is an equivalent body parameter example in PowerShell,

$body = @{
    "siteUrl" ="https://www.thecodebuzz.com"
    "email" = "infoATthecodebuzz.com"
}

Below is the POST method example using Invoke-RestMethod,

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -ContentType "application/json"

Below is the POST method example using Invoke-WebRequest,

Invoke-WebRequest -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -ContentType "application/json"

PowerShell POST request with the body with Headers

Powershell requests with headers can be defined as below,

$headers = @{
 'Content-Type'='application/json'
 'apikey'='7bd43dc4216e15971'
 }

Below is the Powershell POST method example with Headers,

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"

Send Array in POST Request- Using Simple Array in request Body using Powershell

One can use Array in request Body using Powershell. We can easily send Array Data in REST API.

When sending an array in the request body, you need to convert it to JSON format.

Here we need to use $(..) to represent an array.

Example 1

I have a sample JSON with an array example as below,

{
    "siteUrl": "https://www.thecodebuzz.com",
    "email" : "infoATthecodebuzz.com",
    "itemList": [
        "Item1",
        "Item2",
        "Item3"],
    "details":[
         {    
          name:"test",
          id: "213124"
          }]
}

The PowerShell request body for Array looks as below,

$body = @{
    'siteUrl' = "https://www.thecodebuzz.com"
    'urlList'= @(
        "Item1",
        "Item2",
        "Item3")     
}

Here is the request format,

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"

Below is the POST method example using Invoke-WebRequest,

Invoke-WebRequest -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"
 

Example 2

# Sample array of strings
$array = @("A", "B", "C")

# Convert the array to JSON format
$jsonBody = $array | ConvertTo-Json

# API endpoint URL
$apiUrl = "https://www.thecodebuzz.com/api/"

# Send the POST request with the array as the request body

$response = Invoke-RestMethod -Uri $apiUrl -Method Post -Body $jsonBody -ContentType "application/json"

# Display the response
$response

Send Array in POST Request

Using Array (key-Value pairs) in request Body using Powershell

$body = @{
‘siteUrl’ = “https://www.thecodebuzz.com”
‘urlList’= @(
{“Item1″=”value1”},
{“Item2″=”value2”},
{“Item3″=”value3”})
}

Here is the POST example request format,

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"

Differences between Invoke-RestMethod Vs Invoke-WebRequest

Invoke-RestMethod efficiently deal with XML and JSON results.

It doesn’t support straight HTML(except XML-compliant HTML) while Invoke-WebRequest efficiently deal with straight Web/HTML results.

For additional differences and guidelines, please visit this article.

For more details on handling array or JSON please refer to the below article,

HTTP/WebRequest using JSON body with array or list

• PowerShell Script- Using JSON Array or List

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Make PowerShell POST Request With Body first appeared on TheCodeBuzz.

Today in this article, we will see how to use Task Scheduler PowerShell with an example. We will schedule PowerShell Script using Windows Task Scheduler and automate PowerShell script execution.

Today in this article, we shall see below

There are many advantages of the Tasks scheduler, some of which are listed below,

• Automate the Job/Task
• Schedule tasks at a predefined schedule.
• Schedule the task as per predefined priority.
• Improves turnaround time by a running script at a convenient time. like nightly runs etc.

Let’s see in detail, how to schedule the PowerShell script through the Task scheduler.

Create Tasks Scheduler PowerShell Job

Open the Tasks Scheduler Windows -> search for Task scheduler or type taskschd.msc using Windows+R.

Click on “Create Task”

Define general configuration for Powershell Job

Define the below attributes,

• Name – Define Application Name,
• Description – Define a description of the task
• Security options- Please select the appropriate Radio button. We shall select the option “Run whether the user is logged on or not”
  • Run with the highest privileges – To run the program with administrator privileges, its recommended to use this option

Configure Powershell Tasks in the Task Scheduler

Click on the “Trigger” tab and define the configuration

In the next step, please click on the “Trigger” tab and click on “New” to create a new trigger.

You can define the condition of when to trigger the given task for example “On a schedule” or “On an event” or “on logon” or “on an event” etc.

Configure Action in Task scheduler PowerShell

Click on the “Action” tab and define the configuration

In the next step, please click on the “Action” tab and click on “New” to create a new action.

Please specify the following parameters:

• Action: Start a program
• Program\script: Powershell
• Add arguments (optional): -file [script path]

I have kept my script at the below path,

Configure Condition in Task Scheduler

Click on the “Condition” tab and define the configuration

In the next step, please click on the “Condition” tab and select the appropriate options.

These additional conditions let you configure the task based on a specified selection. The task will not run if any conditions specified here are not met…

Once configured, You should be able to run the PowerShell script using the task scheduler.

Reference :

• Making a PowerShell POST request with body

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Task scheduler PowerShell example and guidelines first appeared on TheCodeBuzz.

Today in this article we will see how to automate and perform Powershell Upload, Download file Google cloud Storage Bucket

Today in this article, we will cover below aspects,

Getting Started

Prerequisites

• Create an account in the google cloud project.

• Install the Google Cloud SDK

Above google cloud SDK needs to be installed on the Server or VM where we need to run the target scripts.

Powershell – Upload the File to Google Cloud Storage Bucket

Let’s use the below image(the official logo of the TheCodebuzz) as an example. We shall be uploading this file to the GCP bucket.

Let’s save the above file to the computer in the path C:\test\thecodebuzz.png

Make sure to activate the service account as below by providing the service account file path as below,

gccloud auth activate-service-account --key-file $googleServiceAccount

Command Pattern

gsutil cp [target-file-path] gs://[gcs-path]

Example

try
{  
  #Source file path
  $sourFilePath = "C:\test\CloudBlobTest.pdf"
  #Google Service Account
  $googleServiceAccount = dir "$sourFilePath\google-svc-thecodebuzz.json"
  #Destination path
  $destinationPath = "gs://thecodebuzz/"
  #Activate the google service account
  gccloud auth activate-service-account --key-file $googleServiceAccount
  #Copy files to GCS bucket
  gsutil cp $sourFilePath $destinationPath

}

catch
{

  echo $_.Exception.GetType().FullName,$_.Exception.Message

}

After successful execution of the commands file will be uploaded to the google cloud storage bucket.

Powershell – Download the File to Google Cloud Storage Bucket

We shall now download the above-uploaded file from google Bucket using gsutil command line as below,

Command Pattern

gsutil cp gs://[gcs-file-path] [target-file-path]

Example

try
{  
  #Source file path
  $sourFilePath = "gs://thecodebuzz/load-from-gcutil/thecodebuzz.png"
  #Google Service Account
  $googleServiceAccount = dir "$sourFilePath\google-svc-thecodebuzz.json"
  #Destination path
  $destinationPath = "C:\Test\gcp\Download"
  #Activate the google service account
  gccloud auth activate-service-account --key-file $googleServiceAccount
  #Copy files from GCS bucket
  gsutil cp $sourFilePath $destinationPath 

}

catch
{

  echo $_.Exception.GetType().FullName,$_.Exception.Message

}

Once the command is successful, you shall see the file generated in the path.

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

References :

• Schedule PowerShell Script using Windows Task Scheduler

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Powershell Upload, Download file Google Cloud Storage Bucket first appeared on TheCodeBuzz.

Today in this article, we shall see how to use the PowerShell invoke-restmethod utility method to perform API GET and POST requests with parameters.

We shall cover below in today’s article,

The Invoke-RestMethod cmdlet sends HTTP and HTTPS and also supports REST( Representational State transfer) requests to a WEB API or service. It efficiently deals with JSON and XML content.

Powershell Invoke-RestMethod GET request

Below is the Invoke-RestMethod GET request example.

Example

PS C:\Test\File\load-sqldata>  Invoke-RestMethod https://catfact.ninja/fact

fact                                                                                                                                                                     
----                                                                                                                                                                     
Researchers are unsure exactly how a cat purrs. Most veterinarians believe that a cat purrs by vibrating vocal folds deep in the throat. To do this, a muscle in the l..

Powershell Invoke-RestMethod POST request

Let’s look at the Invoke-RestMethod POST request example below.

Below is an equivalent body parameter example in PowerShell,

$body = @{
    "siteUrl" ="https://www.thecodebuzz.com"
    "email" = "info1@thecodebuzz.com"
}

Below is the POST method example using Invoke-RestMethod,

Example

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"

Powershell Invoke-RestMethod POST request with Headers

Let’s look at the Invoke-RestMethod POST request with headers example.

Powershell requests with headers can be defined as below,

$headers = @{
 'Content-Type'='application/json'
 'apikey'='475646456456'
 }

Below is the Invoke-RestMethod POST method example with Headers,

Example

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers -ContentType "application/json"

Powershell Post request with JSON array example

Example here – Powershell Post request with JSON array example

Powershell Invoke-RestMethod POST request with Authentication headers

Let’s look at the Invoke-RestMethod POST request with Authentication headers.

APIs require you to authenticate via different authentication schemes like,

• Basic authentication

• OAuth token

• JWT Bearer Authentication

You can call Invoke-RestMethod POST request with Authentication headers like JWT bearer token as below,

JWT Bearer Authentication using Powershell

JSON Web Token( JWT) is an open standard used for securely transmitting information between parties as a JSON object. 

The client should always send the Authorization header with Bearer schema as below.

Authorization: Bearer <token>

Example :

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
eyJleHAiOjE1NzEwMDc3MzQsImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0OjQ0MzQxIiwiYXVkIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6NDQzNDEifQ.Ve2x6ueiHPyrP7wLjpmZrhx7QWrQKnkxWsu_1qUKKLA

Below is how the header can be defined to send with any request.

$token"='xxxxxxxxxxx'
$headers = @{
 'Content-Type'='application/json'
 'Authorization'= 'Bearer $token'
 }

Example

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers

Basic Authentication with PowerShell

Basic authentication is an Authentication Scheme built into the HTTP protocol which uses a simple username and password to access a restricted resource.

If you have UserName and Password is as “Test“, “Password” then Base64 string token should be as below,

Authorization: Basic VGVzdDpQYXNzd29yZA===

Create base64 string using Powershell in detail in the below article,

• Invoke-WebRequest with a username and password – Basic authentication

$token"='xxxxxxxxxxx' 
$headers = @{
 'Content-Type'='application/json'
 'Authorization'= 'Basic $token'
 }

Once you add the required secured header, you simply call API using the below way,

Example

Invoke-RestMethod -Method 'Post' -Uri $url -Body ($body|ConvertTo-Json) -Headers $headers

References :

• Differences Invoke-WebRequest Vs Invoke-RestMethod

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Powershell Invoke-RestMethod GET and POST Example first appeared on TheCodeBuzz.