< Back

Get-GcpsTopic

Mon Jan 13, 2020 11:18 pm

NAME Get-GcpsTopic



SYNOPSIS

Retrieves Google Cloud PubSub topics.





SYNTAX

Get-GcpsTopic [-Project <string>] [[-Topic] <string[]>] [<CommonParameters>]





DESCRIPTION

Retrieves one or more Gooogle Cloud PubSub topics. If -Topic is not used, the cmdlet will return all the topics

under the specified project (default project if -Project is not used). Otherwise, the cmdlet will return a list of

topics matching the topic names specified in -Topic and will raise an error for any topic that cannot be found.





PARAMETERS

-Project <string>

The project to check for topics. If not set via PowerShell parameter processing, will default to the Cloud

SDK's DefaultProject property.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Topic <string[]>

The names of the topics to be retrieved.



Required? false

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <string[]>

The names of the topics to be retrieved.



This is an alias of the Topic parameter.



Required? false

Position? 0

Default value

Accept pipeline input? false

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



OUTPUTS



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



PS C:\\> Get-GcpsTopic



This command retrieves all topics in the default project.

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



PS C:\\> Get-GcpsTopic -Topic "topic1", "topic2" -Project "my-project"



This command retrieves 2 topics ("topic1" and "topic2") in the project "my-project".



RELATED LINKS

[Listing a Topic] (https://cloud.google.com/pubsub/docs/pu ... ur-project)