< Back

Get-GcSqlInstance

Mon Jan 13, 2020 11:21 pm

NAME Get-GcSqlInstance



SYNOPSIS

Retrieves a resource containing information about a Cloud SQL instance, or lists all instances in a project.





SYNTAX

Get-GcSqlInstance [-Project <string>] [-Name] <string> [<CommonParameters>]





DESCRIPTION

Retrieves a resource containing the information for the specified Cloud SQL instance, or lists all instances in a

project. This is determined by if Instance is specified or not.





PARAMETERS

-Project <string>

Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <string>

Cloud SQL instance name.



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

Cloud SQL instance name.





OUTPUTS

Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance





---------- EXAMPLE 1 ----------



PS C:\\> Get-GcSqlInstance



Gets a list of instances in the project set in gcloud config.

---------- EXAMPLE 2 ----------



PS C:\\> Get-GcSqlInstance "myInstance"



Gets a resource for the instance named "myInstance" in our project.



RELATED LINKS